http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/static_dns.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/static_dns.rst.txt b/docs/master/_sources/api/v12/static_dns.rst.txt new file mode 100644 index 0000000..0e44cec --- /dev/null +++ b/docs/master/_sources/api/v12/static_dns.rst.txt @@ -0,0 +1,66 @@ +.. +.. +.. 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-dns: + +Static DNS Entries +================== + +.. _to-api-v12-static-dns-route: + +/api/1.2/staticdnsentries ++++++++++++++++++++++++++ + +**GET /api/1.2/staticdnsentries.json** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +---------------------+-----------+------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+===========+============================================================+ + | ``deliveryservice`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``ttl`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``type`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``address`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``cachegroup`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``host`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "deliveryservice": "foo-ds", + "ttl": "30", + "type": "CNAME_RECORD", + "address": "bar.foo.baz.tv.", + "cachegroup": "us-co-denver", + "host": "mm" + } + ] + } + +| +
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/status.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/status.rst.txt b/docs/master/_sources/api/v12/status.rst.txt new file mode 100644 index 0000000..a97a313 --- /dev/null +++ b/docs/master/_sources/api/v12/status.rst.txt @@ -0,0 +1,127 @@ +.. +.. +.. 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-status: + +Status +====== + +.. _to-api-v12-statuses-route: + +/api/1.2/statuses ++++++++++++++++++ + +**GET /api/1.2/statuses** + + Retrieves a list of the server status codes available. + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +-----------------+--------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+================================================================================+ + | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``name`` | string | The string equivalent of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``description`` | string | A short description of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time / Date this server entry was last updated | + +-----------------+--------+--------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "4", + "name": "ADMIN_DOWN", + "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "5", + "name": "CCR_IGNORE", + "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "1", + "name": "OFFLINE", + "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "2", + "name": "ONLINE", + "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "3", + "name": "REPORTED", + "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now", + "lastUpdated": "2013-02-13 16:34:29" + } + ] + } + +**GET /api/1.2/statuses/:id** + + Retrieves a server status by ID. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``id`` | yes | Status id. | + +-----------+----------+---------------------------------------------+ + + **Response Properties** + + +-----------------+--------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+================================================================================+ + | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``name`` | string | The string equivalent of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``description`` | string | A short description of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time / Date this server entry was last updated | + +-----------------+--------+--------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "4", + "name": "ADMIN_DOWN", + "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches", + "lastUpdated": "2013-02-13 16:34:29" + } + ] + } + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/steering_target.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/steering_target.rst.txt b/docs/master/_sources/api/v12/steering_target.rst.txt new file mode 100644 index 0000000..0708240 --- /dev/null +++ b/docs/master/_sources/api/v12/steering_target.rst.txt @@ -0,0 +1,333 @@ +.. +.. +.. 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-steering-targets: + +Steering Targets +================ + +.. _to-api-v12-steering-target-route: + +**GET /api/1.2/steering/:dsId/targets** + + Get all targets for a steering delivery service. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-------------+----------+---------------------------------------------+ + | Name | Required | Description | + +=============+==========+=============================================+ + | ``dsId`` | yes | DS ID. | + +-------------+----------+---------------------------------------------+ + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``deliveryServiceId`` | int | DS ID | + +----------------------+--------+-------------------------------------------------+ + |``deliveryService`` | string | DS XML ID | + +----------------------+--------+-------------------------------------------------+ + |``targetId`` | int | Target DS ID | + +----------------------+--------+-------------------------------------------------+ + |``target`` | string | Target DS XML ID | + +----------------------+--------+-------------------------------------------------+ + |``value`` | int | Value is weight or order depending on type | + +----------------------+--------+-------------------------------------------------+ + |``typeId`` | int | Steering target type ID | + +----------------------+--------+-------------------------------------------------+ + |``type`` | string | Steering target type name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "deliveryServiceId": 1 + "deliveryService": "steering-ds-one", + "targetId": 2, + "target": "steering-target-one", + "value": 1, + "typeId": 35, + "type": "STEERING_ORDER" + }, + { + "deliveryServiceId": 1 + "deliveryService": "steering-ds-one", + "targetId": 3, + "target": "steering-target-two", + "value": 2, + "typeId": 35, + "type": "STEERING_ORDER" + }, + ] + } + +| + +**GET /api/1.2/steering/:dsId/targets/:targetId** + + Get a steering target. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-------------+----------+---------------------------------------------+ + | Name | Required | Description | + +=============+==========+=============================================+ + | ``dsId`` | yes | DS ID. | + +-------------+----------+---------------------------------------------+ + | ``targetId``| yes | DS Target ID. | + +-------------+----------+---------------------------------------------+ + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``deliveryServiceId`` | int | DS ID | + +----------------------+--------+-------------------------------------------------+ + |``deliveryService`` | string | DS XML ID | + +----------------------+--------+-------------------------------------------------+ + |``targetId`` | int | Target DS ID | + +----------------------+--------+-------------------------------------------------+ + |``target`` | string | Target DS XML ID | + +----------------------+--------+-------------------------------------------------+ + |``value`` | int | Value is weight or order depending on type | + +----------------------+--------+-------------------------------------------------+ + |``typeId`` | int | Steering target type ID | + +----------------------+--------+-------------------------------------------------+ + |``type`` | string | Steering target type name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "deliveryServiceId": 1 + "deliveryService": "steering-ds-one", + "targetId": 2, + "target": "steering-target-one", + "value": 1, + "typeId": 35, + "type": "STEERING_ORDER" + } + ] + } + +| + + +**PUT /api/1.2/steering/:dsId/targets/:targetId** + + Update a steering target. + + Authentication Required: Yes + + Role(s) Required: Portal + + **Request Route Parameters** + + +-------------+----------+---------------------------------------------+ + | Name | Required | Description | + +=============+==========+=============================================+ + | ``dsId`` | yes | DS ID. | + +-------------+----------+---------------------------------------------+ + | ``targetId``| yes | DS Target ID. | + +-------------+----------+---------------------------------------------+ + + **Request Properties** + + +------------------------+----------+--------------------------+ + | Parameter | Required | Description | + +========================+==========+==========================+ + | ``value`` | yes | Target value | + +------------------------+----------+--------------------------+ + | ``typeId`` | yes | Target type ID | + +------------------------+----------+--------------------------+ + + **Request Example** :: + + { + "value": 34, + "typeId": 46, + } + +| + + **Response Properties** + + +------------------------+----------+--------------------------+ + | Parameter | Type | Description | + +========================+==========+==========================+ + | ``deliveryServiceId`` | int | Steering DS ID | + +------------------------+----------+--------------------------+ + | ``deliveryService`` | string | DS XML ID | + +------------------------+----------+--------------------------+ + | ``targetId`` | int | Target DS ID | + +------------------------+----------+--------------------------+ + | ``target`` | string | Target DS XML ID | + +------------------------+----------+--------------------------+ + | ``value`` | string | Target value | + +------------------------+----------+--------------------------+ + | ``typeId`` | int | Target type ID | + +------------------------+----------+--------------------------+ + | ``type`` | string | Steering target type name| + +------------------------+----------+--------------------------+ + + **Response Example** :: + + { + "response": { + "deliveryServiceId": 1, + "deliveryService": "steering-ds-one", + "targetId": 2, + "target": "steering-target-two", + "value": "34", + "typeId": 45, + "type": "STEERING_ORDER" + }, + "alerts": [ + { + "level": "success", + "text": "Delivery service steering target update was successful." + } + ] + } + +| + + +**POST /api/1.2/steering/:dsId/targets** + + Create a steering target. + + Authentication Required: Yes + + Role(s) Required: Portal + + **Request Route Parameters** + + +-------------+----------+---------------------------------------------+ + | Name | Required | Description | + +=============+==========+=============================================+ + | ``dsId`` | yes | DS ID. | + +-------------+----------+---------------------------------------------+ + + **Request Properties** + + +------------------------+----------+--------------------------+ + | Parameter | Required | Description | + +========================+==========+==========================+ + | ``targetId`` | yes | Target DS ID | + +------------------------+----------+--------------------------+ + | ``value`` | yes | Target value | + +------------------------+----------+--------------------------+ + | ``typeId`` | yes | Target type ID | + +------------------------+----------+--------------------------+ + + **Request Example** :: + + { + "targetId": 6, + "value": 22, + "typeId": 47, + } + +| + + **Response Properties** + + +------------------------+----------+--------------------------+ + | Parameter | Type | Description | + +========================+==========+==========================+ + | ``deliveryServiceId`` | int | Steering DS ID | + +------------------------+----------+--------------------------+ + | ``deliveryService`` | string | DS XML ID | + +------------------------+----------+--------------------------+ + | ``targetId`` | int | Target DS ID | + +------------------------+----------+--------------------------+ + | ``target`` | string | Target DS XML ID | + +------------------------+----------+--------------------------+ + | ``value`` | string | Target value | + +------------------------+----------+--------------------------+ + | ``typeId`` | int | Target type ID | + +------------------------+----------+--------------------------+ + | ``type`` | string | Steering target type name| + +------------------------+----------+--------------------------+ + + **Response Example** :: + + { + "response": { + "deliveryServiceId": 1, + "deliveryService": "steering-ds-one", + "targetId": 6, + "target": "steering-target-six", + "value": "22", + "typeId": 47, + "type": "STEERING_ORDER" + }, + "alerts": [ + { + "level": "success", + "text": "Delivery service target creation was successful." + } + ] + } + +| + +**DELETE /api/1.2/steering/:dsId/targets/:targetId** + + Delete a steering target. + + Authentication Required: Yes + + Role(s) Required: Portal + + **Request Route Parameters** + + +-------------+----------+---------------------------------------------+ + | Name | Required | Description | + +=============+==========+=============================================+ + | ``dsId`` | yes | DS ID. | + +-------------+----------+---------------------------------------------+ + | ``targetId``| yes | DS Target ID. | + +-------------+----------+---------------------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "Delivery service target delete was successful." + } + ], + } + +| + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/system.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/system.rst.txt b/docs/master/_sources/api/v12/system.rst.txt new file mode 100644 index 0000000..2740d22 --- /dev/null +++ b/docs/master/_sources/api/v12/system.rst.txt @@ -0,0 +1,80 @@ +.. +.. +.. 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-sys: + +System +====== + +.. _to-api-v12-sys-route: + +/api/1.1/system ++++++++++++++++ + +**GET /api/1.2/system/info.json** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | Key | Type | Description | + +============================+========+======================================================================================================================================+ + | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. | + | | | These are all the parameters in the ``GLOBAL`` profile. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated | + | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. | + | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting | + | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to | + | | | set this parameter on a production system. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated | + | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. | + | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting | + | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to | + | | | set this parameter on a production system. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "parameters": { + "tm.toolname": "Traffic Ops", + "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info", + "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81", + "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81", + "tm.logourl": "\/images\/tc_logo.png", + "tm.url": "https:\/\/tm.kabletown.net\/", + "tm.instance_name": "Kabletown CDN" + } + }, + } + +| + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/tenant.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/tenant.rst.txt b/docs/master/_sources/api/v12/tenant.rst.txt new file mode 100644 index 0000000..f75868e --- /dev/null +++ b/docs/master/_sources/api/v12/tenant.rst.txt @@ -0,0 +1,255 @@ +.. +.. +.. 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-tenant: + +Tenants +======= + +.. _to-api-v12-tenant-route: + +/api/1.2/tenants +++++++++++++++++++ + +**GET /api/1.2/tenants** + + Get all tenants. + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 1 + "name": "root", + "active": true, + "parentId": null, + "parentName": null, + }, + { + "id": 2 + "name": "tenant-a", + "active": true, + "parentId": 1 + "parentName": "root" + } + ] + } + +| + + +**GET /api/1.2/tenants/:id** + + Get a tenant by ID. + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 2 + "name": "tenant-a", + "active": true, + "parentId": 1, + "parentName": "root" + } + ] + } + +| + + +**PUT /api/1.2/tenants/:id** + + Update a tenant. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Route Parameters** + + +-------------------+----------+------------------------------------------------+ + | Name | Type | Description | + +===================+==========+================================================+ + | ``id`` | int | Tenant id | + +-------------------+----------+------------------------------------------------+ + + **Request Properties** + + +-------------------+----------+--------------------------+ + | Parameter | Required | Description | + +===================+==========+==========================+ + | ``name`` | yes | The name of the tenant | + +-------------------+----------+--------------------------+ + | ``active`` | yes | True or false | + +-------------------+----------+--------------------------+ + | ``parentId`` | yes | Parent tenant | + +-------------------+----------+--------------------------+ + + **Request Example** :: + + { + "name": "my-tenant" + "active": true + "parentId": 1 + } + +| + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "id": 2, + "name": "my-tenant", + "active": true, + "parentId": 1, + "parentName": "root", + "lastUpdated": "2014-03-18 08:57:39" + }, + "alerts": [ + { + "level": "success", + "text": "Tenant update was successful." + } + ] + } + +| + + +**POST /api/1.2/tenants** + + Create a tenant. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Properties** + + +-------------------+----------+--------------------------+ + | Parameter | Required | Description | + +===================+==========+==========================+ + | ``name`` | yes | The name of the tenant | + +-------------------+----------+--------------------------+ + | ``active`` | no | Defaults to false | + +-------------------+----------+--------------------------+ + | ``parentId`` | yes | Parent tenant | + +-------------------+----------+--------------------------+ + + **Request Example** :: + + { + "name": "your-tenant" + "parentId": 2 + } + +| + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "id": 2, + "name": "your-tenant", + "active": false, + "parentId": 2, + "parentName": "my-tenant", + "lastUpdated": "2014-03-18 08:57:39" + }, + "alerts": [ + { + "level": "success", + "text": "Tenant create was successful." + } + ] + } + +| http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/to_extension.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/to_extension.rst.txt b/docs/master/_sources/api/v12/to_extension.rst.txt new file mode 100644 index 0000000..44c0246 --- /dev/null +++ b/docs/master/_sources/api/v12/to_extension.rst.txt @@ -0,0 +1,206 @@ +.. +.. +.. 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-ext: + +TO Extensions +============= + +.. _to-api-v12-ext-route: + +/api/1.2/to_extensions +++++++++++++++++++++++ + +**GET /api/1.2/to_extensions.json** + +Retrieves the list of extensions. + +Authentication Required: Yes + +Role(s) Required: None + +**Response Properties** + ++--------------------------+--------+--------------------------------------------+ +| Parameter | Type | Description | ++==========================+========+============================================+ +|``script_file`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``version`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``name`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``description`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``info_url`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``additional_config_json``| string | | ++--------------------------+--------+--------------------------------------------+ +|``isactive`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``id`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``type`` | string | | ++--------------------------+--------+--------------------------------------------+ +|``servercheck_short_name``| string | | ++--------------------------+--------+--------------------------------------------+ + +**Response Example** :: + + { + "response": [ + { + script_file: "ping", + version: "1.0.0", + name: "ILO_PING", + description: null, + info_url: "http://foo.com/bar.html";, + additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }", + isactive: "1", + id: "1", + type: "CHECK_EXTENSION_BOOL", + servercheck_short_name: "ILO" + }, + { + script_file: "ping", + version: "1.0.0", + name: "10G_PING", + description: null, + info_url: "http://foo.com/bar.html";, + additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }", + isactive: "1", + id: "2", + type: "CHECK_EXTENSION_BOOL", + servercheck_short_name: "10G" + } + ], + } + +| + +**POST /api/1.2/to_extensions** + + Creates a Traffic Ops extension. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Parameters** + + +--------------------------+--------+--------------------------------------------+ + | Parameter | Type | Description | + +==========================+========+============================================+ + |``name`` | string | | + +--------------------------+--------+--------------------------------------------+ + |``version`` | string | | + +--------------------------+--------+--------------------------------------------+ + |``info_url`` | string | | + +--------------------------+--------+--------------------------------------------+ + |``script_file`` | string | | + +--------------------------+--------+--------------------------------------------+ + |``isactive`` | string | | + +--------------------------+--------+--------------------------------------------+ + |``additional_config_json``| string | | + +--------------------------+--------+--------------------------------------------+ + |``description`` | string | | + +--------------------------+--------+--------------------------------------------+ + |``servercheck_short_name``| string | | + +--------------------------+--------+--------------------------------------------+ + |``type`` | string | | + +--------------------------+--------+--------------------------------------------+ + + **Request Example** :: + + { + "name": "ILO_PING", + "version": "1.0.0", + "info_url": "http://foo.com/bar.html";, + "script_file": "ping", + "isactive": "1", + "additional_config_json": "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}", + "description": null, + "servercheck_short_name": "ILO" + "type": "CHECK_EXTENSION_BOOL", + } + +| + + **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": "Check Extension loaded." + } + ], + } + +| + +**POST /api/1.2/to_extensions/:id/delete** + + Deletes a Traffic Ops extension. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +--------+----------+-----------------+ + | Name | Required | Description | + +========+==========+=================+ + | ``id`` | yes | TO extension 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": "Extension deleted." + } + ], + } + + +| http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/topology.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/topology.rst.txt b/docs/master/_sources/api/v12/topology.rst.txt new file mode 100644 index 0000000..9b7cf9f --- /dev/null +++ b/docs/master/_sources/api/v12/topology.rst.txt @@ -0,0 +1,152 @@ +.. +.. +.. 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-topology: + +Snapshot CRConfig +================= + +.. _to-api-v12-topology-route: + +/api/1.2/snapshot/{:cdn_name} ++++++++++++++++++++++++++++++ + +**GET /api/1.2/cdns/{:cdn_name}/snapshot** + + Retrieves the CURRENT snapshot for a CDN which doesn't necessarily represent the current state of the CDN. The contents of this snapshot are currently used by Traffic Monitor and Traffic Router. + + Authentication Required: Yes + + Role(s) Required: Admin or Operations + + **Request Route Parameters** + + +----------------+----------+---------------------------------------------+ + | Name | Required | Description | + +================+==========+=============================================+ + | ``cdn_name`` | yes | CDN name. | + +----------------+----------+---------------------------------------------+ + + **Response Properties** + + +-----------------------+--------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+==============================================================================+ + | ``config`` | hash | General CDN configuration settings. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentRouters`` | hash | A list of Traffic Routers. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentServers`` | hash | A list of Traffic Servers and the delivery services associated with each. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``deliveryServices`` | hash | A list of delivery services. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``edgeLocations`` | hash | A list of cache groups. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``stats`` | hash | Snapshot properties. | + +-----------------------+--------+------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "config": { ... }, + "contentRouters": { ... }, + "contentServers": { ... }, + "deliveryServices": { ... }, + "edgeLocations": { ... }, + "stats": { ... }, + }, + } + +| + +**GET /api/1.2/cdns/{:cdn_name}/snapshot/new** + + Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN. The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router. Once a snapshot is performed, this snapshot will become the CURRENT snapshot and will be used by Traffic Monitor and Traffic Router. + + Authentication Required: Yes + + Role(s) Required: Admin or Operations + + **Request Route Parameters** + + +----------------+----------+---------------------------------------------+ + | Name | Required | Description | + +================+==========+=============================================+ + | ``cdn_name`` | yes | CDN name. | + +----------------+----------+---------------------------------------------+ + + **Response Properties** + + +-----------------------+--------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+==============================================================================+ + | ``config`` | hash | General CDN configuration settings. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentRouters`` | hash | A list of Traffic Routers. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentServers`` | hash | A list of Traffic Servers and the delivery services associated with each. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``deliveryServices`` | hash | A list of delivery services. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``edgeLocations`` | hash | A list of cache groups. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``stats`` | hash | Snapshot properties. | + +-----------------------+--------+------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "config": { ... }, + "contentRouters": { ... }, + "contentServers": { ... }, + "deliveryServices": { ... }, + "edgeLocations": { ... }, + "stats": { ... }, + }, + } + +| + +**PUT /api/1.2/snapshot/{:cdn_name}** + + Authentication Required: Yes + + Role(s) Required: Admin or Operations + + **Request Route Parameters** + + +----------+----------+-------------------------------------------+ + | Name | Required | Description | + +==========+==========+===========================================+ + | cdn_name | yes | The name of the cdn to snapshot configure | + +----------+----------+-------------------------------------------+ + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |response | string | "SUCCESS" | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + { + "response": "SUCCESS" + } + +| http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/type.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v12/type.rst.txt b/docs/master/_sources/api/v12/type.rst.txt new file mode 100644 index 0000000..6d614c5 --- /dev/null +++ b/docs/master/_sources/api/v12/type.rst.txt @@ -0,0 +1,151 @@ +.. +.. +.. 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-type: + +Types +===== + +.. _to-api-v12-types-route: + +/api/1.2/types +++++++++++++++ + +**GET /api/1.1/types** + + Authentication Required: Yes + + Role(s) Required: None + + **Request Query Parameters** + + +----------------+----------+----------------------------------------------------+ + | Name | Required | Description | + +================+==========+====================================================+ + | ``useInTable`` | no | Filter types by the table in which they apply | + +----------------+----------+----------------------------------------------------+ + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``name`` | string | | + +----------------------+--------+------------------------------------------------+ + |``description`` | string | | + +----------------------+--------+------------------------------------------------+ + |``useInTable`` | string | | + +----------------------+--------+------------------------------------------------+ + |``lastUpdated`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "22", + "name": "AAAA_RECORD", + "description": "Static DNS AAAA entry", + "useInTable": "staticdnsentry", + "lastUpdated": "2013-10-23 15:28:31" + } + ] + } + + +| + +**GET /api/1.1/types/trimmed** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``name`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "name": "AAAA_RECORD" + }, + { + "name": "ACTIVE_DIRECTORY" + }, + { + "name": "A_RECORD" + }, + { + "name": "CCR" + } + ], + } + +**GET /api/1.1/types/:id** + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +----------------+----------+----------------------------------------------------+ + | Name | Required | Description | + +================+==========+====================================================+ + | ``id`` | yes | Type ID. | + +----------------+----------+----------------------------------------------------+ + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``name`` | string | | + +----------------------+--------+------------------------------------------------+ + |``description`` | string | | + +----------------------+--------+------------------------------------------------+ + |``useInTable`` | string | | + +----------------------+--------+------------------------------------------------+ + |``lastUpdated`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "22", + "name": "AAAA_RECORD", + "description": "Static DNS AAAA entry", + "useInTable": "staticdnsentry", + "lastUpdated": "2013-10-23 15:28:31" + } + ] + } + + +|
