You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by gi...@apache.org on 2017/11/14 23:37:24 UTC
[3/3] incubator-trafficcontrol-website git commit: Update docs from
commit 6d84f57cb5bdd01356e4f4877726136c23484280
Update docs from commit 6d84f57cb5bdd01356e4f4877726136c23484280
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/d2e94210
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/d2e94210
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/d2e94210
Branch: refs/heads/asf-site
Commit: d2e942100aeb0c1d898ed700612433928b43fc9c
Parents: 2957f61
Author: jenkins <bu...@apache.org>
Authored: Tue Nov 14 23:37:19 2017 +0000
Committer: jenkins <bu...@apache.org>
Committed: Tue Nov 14 23:37:19 2017 +0000
----------------------------------------------------------------------
.../_sources/development/traffic_ops.rst.txt | 4 +
.../traffic_ops_api/v12/federation.rst.txt | 285 ++++++++++-
.../v12/federation_deliveryservice.rst.txt | 155 ++++++
.../v12/federation_federationresolver.rst.txt | 118 +++++
.../v12/federation_resolver.rst.txt | 110 ++++
.../traffic_ops_api/v12/federation_user.rst.txt | 161 ++++++
docs/master/development/traffic_ops.html | 4 +
.../traffic_ops_api/v12/federation.html | 468 ++++++++++++++++-
.../v12/federation_deliveryservice.html | 491 ++++++++++++++++++
.../v12/federation_federationresolver.html | 440 ++++++++++++++++
.../v12/federation_resolver.html | 423 ++++++++++++++++
.../traffic_ops_api/v12/federation_user.html | 501 +++++++++++++++++++
docs/master/objects.inv | Bin 4469 -> 4623 bytes
docs/master/searchindex.js | 2 +-
14 files changed, 3156 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/_sources/development/traffic_ops.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_ops.rst.txt b/docs/master/_sources/development/traffic_ops.rst.txt
index e310e59..107ae90 100644
--- a/docs/master/_sources/development/traffic_ops.rst.txt
+++ b/docs/master/_sources/development/traffic_ops.rst.txt
@@ -618,6 +618,10 @@ API 1.2 Reference
traffic_ops_api/v12/deliveryservice_stats
traffic_ops_api/v12/division
traffic_ops_api/v12/federation
+ traffic_ops_api/v12/federation_deliveryservice
+ traffic_ops_api/v12/federation_federationresolver
+ traffic_ops_api/v12/federation_resolver
+ traffic_ops_api/v12/federation_user
traffic_ops_api/v12/hwinfo
traffic_ops_api/v12/iso
traffic_ops_api/v12/job
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/_sources/development/traffic_ops_api/v12/federation.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_ops_api/v12/federation.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/federation.rst.txt
index a15922e..84ef4c8 100644
--- a/docs/master/_sources/development/traffic_ops_api/v12/federation.rst.txt
+++ b/docs/master/_sources/development/traffic_ops_api/v12/federation.rst.txt
@@ -25,7 +25,7 @@ Federation
**GET /api/1.2/federations.json**
- Retrieves a list of federations for a user's delivery service(s).
+ Retrieves a list of federation mappings (aka federation resolvers) for a the current user.
Authentication Required: Yes
@@ -149,3 +149,286 @@ Federation
}
|
+
+**GET /api/1.2/cdns/:name/federations**
+
+ Retrieves a list of federations for a cdn.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | hash | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>id`` | int | Delivery service ID |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>xmlId`` | string | Delivery service xml id |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "cname": "booya.com.",
+ "ttl": 34,
+ "description": "fooya",
+ "deliveryService": {
+ "id": 61,
+ "xmlId": "the-xml-id"
+ }
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/:name/federations/:id**
+
+ Retrieves a federation for a cdn.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | hash | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>id`` | int | Delivery service ID |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>xmlId`` | string | Delivery service xml id |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "cname": "booya.com.",
+ "ttl": 34,
+ "description": "fooya",
+ "deliveryService": {
+ "id": 61,
+ "xmlId": "the-xml-id"
+ }
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/cdns/:name/federations**
+ Create a federation
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +======================+==========+==========================+
+ | ``cname`` | yes | CNAME ending with a dot |
+ +----------------------+----------+--------------------------+
+ | ``ttl`` | yes | TTL |
+ +----------------------+----------+--------------------------+
+ | ``description`` | no | Description |
+ +----------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``cname`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation created [ cname = the.cname. ] with id: 26."
+ }
+ ],
+ "response": {
+ "id": 26,
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description",
+ }
+ }
+
+|
+
+**PUT /api/1.2/cdns/:name/federations/:id**
+ Update a federation
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +======================+==========+==========================+
+ | ``cname`` | yes | CNAME ending with a dot |
+ +----------------------+----------+--------------------------+
+ | ``ttl`` | yes | TTL |
+ +----------------------+----------+--------------------------+
+ | ``description`` | no | Description |
+ +----------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``cname`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation updated [ cname = the.cname. ] with id: 26."
+ }
+ ],
+ "response": {
+ "id": 26,
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description",
+ }
+ }
+
+|
+
+**DELETE /api/1.2/cdns/:name/federations/{:id}**
+
+ Allow user to delete a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation deleted [ cname = the.cname. ] with id: 26."
+ }
+ ],
+ }
+
+|
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/_sources/development/traffic_ops_api/v12/federation_deliveryservice.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_ops_api/v12/federation_deliveryservice.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/federation_deliveryservice.rst.txt
new file mode 100644
index 0000000..395e73f
--- /dev/null
+++ b/docs/master/_sources/development/traffic_ops_api/v12/federation_deliveryservice.rst.txt
@@ -0,0 +1,155 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-federation-deliveryservice:
+
+Federation Delivery Service
+===========================
+
+.. _to-api-v12-federation-deliveryservice-route:
+
+/api/1.2/federations/:id/deliveryservices
++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/federations/:id/deliveryservices**
+
+ Retrieves delivery services assigned to a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``id`` | int | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``cdn`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``xmlId`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "cdn": "cdn1",
+ "type": "DNS",
+ "xmlId": "booya-12"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations/:id/deliveryservices**
+
+ Create one or more federation / delivery service assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``dsIds`` | yes | An array of delivery service IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing fed/ds assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "dsIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``dsIds`` | array | An array of delivery service IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing fed/ds assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "5 delivery service(s) were assigned to the cname. federation"
+ }
+ ],
+ "response": {
+ "dsIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
+**DELETE /api/1.2/federations/:id/deliveryservices/:id**
+
+ Removes a delivery service from a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``federation`` | yes | Federation ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``ds`` | yes | Delivery Service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Removed delivery service [ booya-12 ] from federation [ cname1. ]"
+ }
+ ],
+ }
+
+|
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/_sources/development/traffic_ops_api/v12/federation_federationresolver.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_ops_api/v12/federation_federationresolver.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/federation_federationresolver.rst.txt
new file mode 100644
index 0000000..86e6649
--- /dev/null
+++ b/docs/master/_sources/development/traffic_ops_api/v12/federation_federationresolver.rst.txt
@@ -0,0 +1,118 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-federation-federationresolver:
+
+Federation Federation Resolver
+==============================
+
+.. _to-api-v12-federation-federationresolver-route:
+
+/api/1.2/federations/:id/federation_resolvers
++++++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/federations/:id/federation_resolvers**
+
+ Retrieves federation resolvers assigned to a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``id`` | int | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ipAddress`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "ipAddress": "2.2.2.2/16",
+ "type": "RESOLVE4"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations/:id/federation_resolvers**
+
+ Create one or more federation / federation resolver assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``fedResolverIds`` | yes | An array of federation resolver IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing fed/ds assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "fedResolverIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``fedResolverIds`` | array | An array of federation resolver IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing fed/fed resolver assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "5 resolvers(s) were assigned to the cname. federation"
+ }
+ ],
+ "response": {
+ "fedResolverIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/_sources/development/traffic_ops_api/v12/federation_resolver.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_ops_api/v12/federation_resolver.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/federation_resolver.rst.txt
new file mode 100644
index 0000000..2f24f20
--- /dev/null
+++ b/docs/master/_sources/development/traffic_ops_api/v12/federation_resolver.rst.txt
@@ -0,0 +1,110 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-federation-resolver:
+
+Federation Resolver
+===================
+
+.. _to-api-v12-federation-resolver-route:
+
+/api/1.2/federation_resolvers
++++++++++++++++++++++++++++++
+
+**POST /api/1.2/federation_resolvers**
+
+ Create a federation resolver.
+
+ Authentication Required: Yes
+
+ Role(s) Required: ADMIN
+
+ **Request Properties**
+
+ +-------------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +=========================+==========+==========================================+
+ | ``ipAddress`` | yes | IP or CIDR range |
+ +-------------------------+----------+------------------------------------------+
+ | ``typeId`` | yes | Type Id where useintable=federation |
+ +-------------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "ipAddress": "2.2.2.2/32",
+ "typeId": 245
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``ipAddress`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``type`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation resolver created [ IP = 2.2.2.2/32 ] with id: 27"
+ }
+ ],
+ "response": {
+ "id" : 27,
+ "ipAddress" : "2.2.2.2/32",
+ "typeId" : 245,
+ }
+ }
+
+|
+
+**DELETE /api/1.2/federation_resolvers/:id**
+
+ Deletes a federation resolver.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``resolver`` | yes | Federation resolver ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation resolver deleted [ IP = 2.2.2.2/32 ] with id: 27"
+ }
+ ],
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/_sources/development/traffic_ops_api/v12/federation_user.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_ops_api/v12/federation_user.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/federation_user.rst.txt
new file mode 100644
index 0000000..55b4188
--- /dev/null
+++ b/docs/master/_sources/development/traffic_ops_api/v12/federation_user.rst.txt
@@ -0,0 +1,161 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-federation-user:
+
+Federation User
+===============
+
+.. _to-api-v12-federation-user-route:
+
+/api/1.2/federations/:id/users
+++++++++++++++++++++++++++++++
+
+**GET /api/1.2/federations/:id/users**
+
+ Retrieves users assigned to a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``company`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``id`` | int | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``username`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``role`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``email`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``fullName`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "username": "booya",
+ "company": "XYZ Corporation",
+ "role": "federation",
+ "email": "booya@fooya.com",
+ "fullName": "Booya Fooya"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations/:id/users**
+
+ Create one or more federation / user assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``userIds`` | yes | An array of user IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing fed/user assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "userIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``userIds`` | array | An array of user IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing fed/user assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "5 user(s) were assigned to the cname. federation"
+ }
+ ],
+ "response": {
+ "userIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
+**DELETE /api/1.2/federations/:id/users/:id**
+
+ Removes a user from a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``federation`` | yes | Federation ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``user`` | yes | User ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Removed user [ bobmack ] from federation [ cname1. ]"
+ }
+ ],
+ }
+
+|
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/development/traffic_ops.html
----------------------------------------------------------------------
diff --git a/docs/master/development/traffic_ops.html b/docs/master/development/traffic_ops.html
index 369fc37..24a23f2 100644
--- a/docs/master/development/traffic_ops.html
+++ b/docs/master/development/traffic_ops.html
@@ -829,6 +829,10 @@ Extensions::YourCustomExtension</p>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/division.html">Divisions</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation.html">Federation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation_deliveryservice.html">Federation Delivery Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation_federationresolver.html">Federation Federation Resolver</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation_resolver.html">Federation Resolver</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation_user.html">Federation User</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/hwinfo.html">Hardware Info</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/iso.html">ISO</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/job.html">Jobs</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/development/traffic_ops_api/v12/federation.html
----------------------------------------------------------------------
diff --git a/docs/master/development/traffic_ops_api/v12/federation.html b/docs/master/development/traffic_ops_api/v12/federation.html
index 524f29b..20a0888 100644
--- a/docs/master/development/traffic_ops_api/v12/federation.html
+++ b/docs/master/development/traffic_ops_api/v12/federation.html
@@ -40,7 +40,7 @@
<link rel="search" title="Search" href="../../../search.html"/>
<link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
- <link rel="next" title="Hardware Info" href="hwinfo.html"/>
+ <link rel="next" title="Federation Delivery Service" href="federation_deliveryservice.html"/>
<link rel="prev" title="Divisions" href="division.html"/>
@@ -187,7 +187,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="federation_deliveryservice.html" class="btn btn-neutral float-right" title="Federation Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -202,7 +202,7 @@
<span id="to-api-v12-federation-route"></span><h2>/api/1.2/federations<a class="headerlink" href="#api-1-2-federations" title="Permalink to this headline">¶</a></h2>
<p><strong>GET /api/1.2/federations.json</strong></p>
<blockquote>
-<div><p>Retrieves a list of federations for a user’s delivery service(s).</p>
+<div><p>Retrieves a list of federation mappings (aka federation resolvers) for a the current user.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: Federation</p>
<p><strong>Response Properties</strong></p>
@@ -370,6 +370,466 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>GET /api/1.2/cdns/:name/federations</strong></p>
+<blockquote>
+<div><p>Retrieves a list of federations for a cdn.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ttl</span></code></td>
+<td>int</td>
+<td>Time to live for the cname.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>id</span></code></td>
+<td>int</td>
+<td>Delivery service ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>xmlId</span></code></td>
+<td>string</td>
+<td>Delivery service xml id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"booya.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"fooya"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">61</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"the-xml-id"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/federations/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a federation for a cdn.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ttl</span></code></td>
+<td>int</td>
+<td>Time to live for the cname.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>id</span></code></td>
+<td>int</td>
+<td>Delivery service ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>xmlId</span></code></td>
+<td>string</td>
+<td>Delivery service xml id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"booya.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"fooya"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">61</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"the-xml-id"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/cdns/:name/federations</strong></dt>
+<dd><p class="first">Create a federation</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="38%" />
+<col width="17%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cname</span></code></td>
+<td>yes</td>
+<td>CNAME ending with a dot</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ttl</span></code></td>
+<td>yes</td>
+<td>TTL</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>no</td>
+<td>Description</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation created [ cname = the.cname. ] with id: 26."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">26</span><span class="p">,</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/cdns/:name/federations/:id</strong></dt>
+<dd><p class="first">Update a federation</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="38%" />
+<col width="17%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cname</span></code></td>
+<td>yes</td>
+<td>CNAME ending with a dot</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ttl</span></code></td>
+<td>yes</td>
+<td>TTL</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>no</td>
+<td>Description</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation updated [ cname = the.cname. ] with id: 26."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">26</span><span class="p">,</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/cdns/:name/federations/{:id}</strong></p>
+<blockquote>
+<div><p>Allow user to delete a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation deleted [ cname = the.cname. ] with id: 26."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>
@@ -379,7 +839,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="federation_deliveryservice.html" class="btn btn-neutral float-right" title="Federation Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d2e94210/docs/master/development/traffic_ops_api/v12/federation_deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/master/development/traffic_ops_api/v12/federation_deliveryservice.html b/docs/master/development/traffic_ops_api/v12/federation_deliveryservice.html
new file mode 100644
index 0000000..5a2a260
--- /dev/null
+++ b/docs/master/development/traffic_ops_api/v12/federation_deliveryservice.html
@@ -0,0 +1,491 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Federation Delivery Service — Traffic Control 2.1-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../../genindex.html"/>
+ <link rel="search" title="Search" href="../../../search.html"/>
+ <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/>
+ <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
+ <link rel="next" title="Federation Federation Resolver" href="federation_federationresolver.html"/>
+ <link rel="prev" title="Federation" href="federation.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li>
+
+ <li><a href="../../index.html">Developer’s Guide</a> »</li>
+
+ <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li>
+
+ <li>Federation Delivery Service</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../../_sources/development/traffic_ops_api/v12/federation_deliveryservice.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_federationresolver.html" class="btn btn-neutral float-right" title="Federation Federation Resolver">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation.html" class="btn btn-neutral" title="Federation"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="federation-delivery-service">
+<span id="to-api-v12-federation-deliveryservice"></span><h1>Federation Delivery Service<a class="headerlink" href="#federation-delivery-service" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-federations-id-deliveryservices">
+<span id="to-api-v12-federation-deliveryservice-route"></span><h2>/api/1.2/federations/:id/deliveryservices<a class="headerlink" href="#api-1-2-federations-id-deliveryservices" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/federations/:id/deliveryservices</strong></p>
+<blockquote>
+<div><p>Retrieves delivery services assigned to a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"booya-12"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/federations/:id/deliveryservices</strong></p>
+<blockquote>
+<div><p>Create one or more federation / delivery service assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsIds</span></code></td>
+<td>yes</td>
+<td>An array of delivery service IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing fed/ds assignments? (true|false)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"dsIds"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsIds</span></code></td>
+<td>array</td>
+<td>An array of delivery service IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">replace</span></code></td>
+<td>array</td>
+<td>Existing fed/ds assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"5 delivery service(s) were assigned to the cname. federation"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"dsIds"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span> <span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/federations/:id/deliveryservices/:id</strong></p>
+<blockquote>
+<div><p>Removes a delivery service from a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">federation</span></code></td>
+<td>yes</td>
+<td>Federation ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ds</span></code></td>
+<td>yes</td>
+<td>Delivery Service ID.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Removed delivery service [ booya-12 ] from federation [ cname1. ]"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_federationresolver.html" class="btn btn-neutral float-right" title="Federation Federation Resolver">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation.html" class="btn btn-neutral" title="Federation"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../../',
+ VERSION:'2.1-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file