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 2018/04/26 17:57:45 UTC
[39/48] incubator-trafficcontrol-website git commit: Update docs from
commit 28336db2850f4454450ada86de9643e59a61deaa
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/deliveryservice_regex.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/deliveryservice_regex.rst.txt b/docs/master/_sources/api/v12/deliveryservice_regex.rst.txt
new file mode 100644
index 0000000..ccd12c4
--- /dev/null
+++ b/docs/master/_sources/api/v12/deliveryservice_regex.rst.txt
@@ -0,0 +1,374 @@
+..
+..
+.. 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-ds-regexes:
+
+Delivery Service Regexes
+========================
+
+.. _to-api-v12-ds-regexes-route:
+
+
+**GET /api/1.2/deliveryservices_regexes**
+
+ Retrieves regexes for all delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``dsName`` | array | Delivery service name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``regexes`` | array | An array of regexes for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>type`` | string | The regex type. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>pattern`` | string | The regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>setNumber`` | string | The order in which the regex is evaluated. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "dsName": "foo-bar",
+ "regexes": [
+ {
+ "type": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ {
+ "type": "HOST_REGEXP",
+ "pattern": "foo.bar.com",
+ "setNumber": 1
+ }
+ ]
+ },
+ { ... }
+ ]
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/{:dsId}/regexes**
+
+ Retrieves regexes for a specific delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ {
+ "id": 853,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": "foo.bar.com",
+ "setNumber": 1
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/{:dsId}/regexes/{:id}**
+
+ Retrieves a regex for a specific delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+ | ``id`` | yes | Delivery service regex id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/{:dsId}/regexes**
+
+ Create a regex for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Request Properties**
+
+ +---------------+----------+---------------------------------------------+
+ | Parameter | Required | Description |
+ +===============+==========+=============================================+
+ | ``pattern`` | yes | Regex pattern. |
+ +---------------+----------+---------------------------------------------+
+ | ``type`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+ | ``setNumber`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "pattern": ".*\.foo-bar\..*"
+ "type": 18
+ "setNumber": 0
+ }
+
+|
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Delivery service regex creation was successful."
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/deliveryservices/{:dsId}/regexes/{:id}**
+
+ Update a regex for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+ | ``id`` | yes | Delivery service regex id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Request Properties**
+
+ +---------------+----------+---------------------------------------------+
+ | Parameter | Required | Description |
+ +===============+==========+=============================================+
+ | ``pattern`` | yes | Regex pattern. |
+ +---------------+----------+---------------------------------------------+
+ | ``type`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+ | ``setNumber`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "pattern": ".*\.foo-bar\..*"
+ "type": 18
+ "setNumber": 0
+ }
+
+|
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Delivery service regex update was successful."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/deliveryservices/{:dsId}/regexes/{:id}**
+
+ Delete delivery service regex.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+ | ``id`` | yes | Delivery service regex id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery service regex delete was successful."
+ }
+ ],
+ }
+
+|
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/deliveryservice_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/deliveryservice_stats.rst.txt b/docs/master/_sources/api/v12/deliveryservice_stats.rst.txt
new file mode 100644
index 0000000..8d9dadb
--- /dev/null
+++ b/docs/master/_sources/api/v12/deliveryservice_stats.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-ds-stats:
+
+Delivery Service Statistics
+===========================
+
+.. _to-api-v12-ds-stats-route:
+
+/api/1.2/deliveryservice_stats
+++++++++++++++++++++++++++++++
+
+**GET /api/1.2/deliveryservice_stats.json**
+
+ Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+==============================================================================================================================================+
+ | ``deliveryServiceName`` | yes | The delivery service with the desired stats |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``metricType`` | yes | The metric type (valid metric types: 'kbps', 'out_bytes', 'status_4xx', 'status_5xx', tps_total', 'tps_2xx','tps_3xx', 'tps_4xx', 'tps_5xx') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +============================+===============+=========================================================================================+
+ |``source`` | string | The source of the data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``summary`` | hash | Summary data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalBytes`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>min`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>max`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>fifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyEighthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyFifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>average`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalTransactions`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``series`` | hash | Series data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>columns`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>name`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>values`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>time`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>value`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "source": "TrafficStats",
+ "summary": {
+ "average": 1081172.785,
+ "count": 28,
+ "fifthPercentile": 888827.26,
+ "max": 1326680.31,
+ "min": 888827.26,
+ "ninetyEighthPercentile": 1324785.47,
+ "ninetyFifthPercentile": 1324785.47,
+ "totalBytes": 37841047.475,
+ "totalTransactions": 1020202030101
+ },
+ "series": {
+ "columns": [
+ "time",
+ ""
+ ],
+ "count": 60,
+ "name": "kbps",
+ "tags": {
+ "cachegroup": "total"
+ },
+ "values": [
+ [
+ "2015-08-11T11:36:00Z",
+ 888827.26
+ ],
+ [
+ "2015-08-11T11:37:00Z",
+ 980336.563333333
+ ],
+ [
+ "2015-08-11T11:38:00Z",
+ 952111.975
+ ],
+ [
+ "2015-08-11T11:39:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:43:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:44:00Z",
+ 934682.943333333
+ ],
+ [
+ "2015-08-11T11:45:00Z",
+ 1251121.28
+ ],
+ [
+ "2015-08-11T11:46:00Z",
+ 1111012.99
+ ]
+ ]
+ }
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/division.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/division.rst.txt b/docs/master/_sources/api/v12/division.rst.txt
new file mode 100644
index 0000000..e0f1756
--- /dev/null
+++ b/docs/master/_sources/api/v12/division.rst.txt
@@ -0,0 +1,203 @@
+..
+..
+.. 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-division:
+
+Divisions
+=========
+
+.. _to-api-v12-division-route:
+
+/api/1.2/divisions
+++++++++++++++++++
+
+**GET /api/1.2/divisions**
+ Get all divisions.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "West",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/divisions/:id**
+ Get division by Id.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/divisions/:id**
+ Update a division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Division id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Division update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "mydivision1"
+ }
+ }
+
+|
+
+
+**POST /api/1.2/divisions**
+ Create division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'name': 'mydivision1',
+ 'id': '4'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/federation.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/federation.rst.txt b/docs/master/_sources/api/v12/federation.rst.txt
new file mode 100644
index 0000000..84ef4c8
--- /dev/null
+++ b/docs/master/_sources/api/v12/federation.rst.txt
@@ -0,0 +1,434 @@
+..
+..
+.. 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:
+
+Federation
+==========
+
+.. _to-api-v12-federation-route:
+
+/api/1.2/federations
+++++++++++++++++++++
+
+**GET /api/1.2/federations.json**
+
+ Retrieves a list of federation mappings (aka federation resolvers) for a the current user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "mappings": [
+ "cname": "cname-01.",
+ "ttl": 8865,
+ ]
+ "deliveryService": "ds-01",
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations.json**
+
+ Allows a user to add federations for their delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+|
+
+
+**PUT /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s) then adds the new federations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
+
+**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/2ca12610/docs/master/_sources/api/v12/federation_deliveryservice.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/federation_deliveryservice.rst.txt b/docs/master/_sources/api/v12/federation_deliveryservice.rst.txt
new file mode 100644
index 0000000..395e73f
--- /dev/null
+++ b/docs/master/_sources/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/2ca12610/docs/master/_sources/api/v12/federation_federationresolver.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/federation_federationresolver.rst.txt b/docs/master/_sources/api/v12/federation_federationresolver.rst.txt
new file mode 100644
index 0000000..86e6649
--- /dev/null
+++ b/docs/master/_sources/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/2ca12610/docs/master/_sources/api/v12/federation_resolver.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/federation_resolver.rst.txt b/docs/master/_sources/api/v12/federation_resolver.rst.txt
new file mode 100644
index 0000000..2f24f20
--- /dev/null
+++ b/docs/master/_sources/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/2ca12610/docs/master/_sources/api/v12/federation_user.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/federation_user.rst.txt b/docs/master/_sources/api/v12/federation_user.rst.txt
new file mode 100644
index 0000000..55b4188
--- /dev/null
+++ b/docs/master/_sources/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/2ca12610/docs/master/_sources/api/v12/hwinfo.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/hwinfo.rst.txt b/docs/master/_sources/api/v12/hwinfo.rst.txt
new file mode 100644
index 0000000..2da59c5
--- /dev/null
+++ b/docs/master/_sources/api/v12/hwinfo.rst.txt
@@ -0,0 +1,68 @@
+..
+..
+.. 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-hwinfo:
+
+Hardware Info
+=============
+
+.. _to-api-v12-hwinfo-route:
+
+/api/1.2/hwinfo
++++++++++++++++
+
+**GET /api/1.2/hwinfo.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------+--------+----------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+======================================================================+
+ | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``serverHostName`` | string | Hostname for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``val`` | string | Freeform value used to track anything about a server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``description`` | string | Freeform description for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:0"
+ },
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:1"
+ }
+ ]
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/index.rst.txt b/docs/master/_sources/api/v12/index.rst.txt
new file mode 100644
index 0000000..15e839c
--- /dev/null
+++ b/docs/master/_sources/api/v12/index.rst.txt
@@ -0,0 +1,62 @@
+..
+..
+.. 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.
+..
+
+
+API 1.2 Reference
+*****************
+Traffic Ops API V1.2
+
+.. toctree::
+ :maxdepth: 1
+
+ api_capability
+ asn
+ cache
+ cachegroup
+ cachegroup_parameter
+ cache_stats
+ capability
+ cdn
+ changelog
+ configfiles_ats
+ deliveryservice
+ deliveryservice_regex
+ deliveryservice_stats
+ division
+ federation
+ federation_deliveryservice
+ federation_federationresolver
+ federation_resolver
+ federation_user
+ hwinfo
+ iso
+ job
+ parameter
+ phys_location
+ profile
+ profile_parameter
+ influxdb
+ region
+ role
+ server
+ static_dns
+ status
+ steering_target
+ system
+ tenant
+ to_extension
+ type
+ user
+ topology
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/influxdb.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/influxdb.rst.txt b/docs/master/_sources/api/v12/influxdb.rst.txt
new file mode 100644
index 0000000..ca82cf5
--- /dev/null
+++ b/docs/master/_sources/api/v12/influxdb.rst.txt
@@ -0,0 +1,65 @@
+..
+..
+.. 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-influxdb:
+
+InfluxDB
+==========
+
+.. Note:: The documentation needs a thorough review!
+
+**GET /api/1.2/traffic_monitor/stats.json**
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++----------------------+--------+------------------------------------------------+
+| Parameter | Type | Description |
++======================+========+================================================+
+| ``aaData`` | array | |
++----------------------+--------+------------------------------------------------+
+
+**Response Example**
+::
+
+ {
+ "aaData": [
+ [
+ "0",
+ "ALL",
+ "ALL",
+ "ALL",
+ "true",
+ "ALL",
+ "142035",
+ "172365661.85"
+ ],
+ [
+ 1,
+ "EDGE1_TOP_421_PSPP",
+ "odol-atsec-atl-03",
+ "us-ga-atlanta",
+ "1",
+ "REPORTED",
+ "596",
+ "923510.04",
+ "69.241.82.126"
+ ]
+ ],
+ }
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/iso.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/iso.rst.txt b/docs/master/_sources/api/v12/iso.rst.txt
new file mode 100644
index 0000000..feb534b
--- /dev/null
+++ b/docs/master/_sources/api/v12/iso.rst.txt
@@ -0,0 +1,132 @@
+..
+..
+.. 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-iso:
+
+ISO
+===
+
+.. _to-api-v12-iso-route:
+
+**GET /api/1.2/osversions**
+
+ Get all OS versions for ISO generation and the directory where the kickstarter files are found. The values are retrieved from osversions.cfg found in either /var/www/files or in the location defined by the kickstart.files.location parameter (if defined).
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------------------------------------------------------------------------+
+ | Parameter | Description |
+ +======================+==========================================================================+
+ |``OS version name`` | OS version name. For example, "CentOS 7.2 vda". |
+ +----------------------+--------------------------------------------------------------------------+
+ |``OS version dir`` | The directory where the kickstarter ISO files are found. For example, |
+ | | centos72-netinstall. |
+ +----------------------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":
+ {
+ "CentOS 7.2": "centos72-netinstall"
+ "CentOS 7.2 vda": "centos72-netinstall-vda"
+ }
+ }
+
+|
+
+**POST /api/1.2/isos**
+
+ Generate an ISO.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+ **Request Properties**
+
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===============================+==========+=================================================================================================+
+ | ``osversionDir`` | yes | The directory name where the kickstarter ISO files are found. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``hostName`` | yes | |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``domainName`` | yes | |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``rootPass`` | yes | |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``dhcp`` | yes | Valid values are 'yes' or 'no'. If yes, other IP settings will be ignored. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | yes | 1500 or 9000 |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | yes|no | Required if dhcp=no |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | yes|no | Required if dhcp=no |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | yes|no | Required if dhcp=no |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | no | /64 is assumed if prefix is omitted. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | no | Ignored if an IPV4 gateway is specified. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | no | Typical values are bond0, eth4, etc. If you enter bond0, a LACP bonding config will be written. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``disk`` | no | Typical values are "sda" |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "osversionDir": "centos72-netinstall-vda",
+ "hostName": "foo-bar",
+ "domainName": "baz.com",
+ "rootPass": "password",
+ "dhcp": "no",
+ "interfaceMtu": 1500,
+ "ipAddress": "10.10.10.10",
+ "ipNetmask": "255.255.255.252",
+ "ipGateway": "10.10.10.10"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+-------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===============================================================================+
+ |``isoURL`` | string | The URL location of the ISO. ISO locations can be found in cnd.conf file. |
+ +-----------------+--------+-------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "isoURL": "https://traffic_ops.domain.net/iso/fqdn-centos72-netinstall.iso"
+ },
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Generate ISO was successful."
+ }
+ ]
+ }
+
+|