You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by da...@apache.org on 2017/06/07 23:54:32 UTC
[22/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/status.txt b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
new file mode 100644
index 0000000..a97a313
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/status.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/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt
deleted file mode 100644
index 2740d22..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt
+++ /dev/null
@@ -1,80 +0,0 @@
-..
-..
-.. 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/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/system.txt b/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
new file mode 100644
index 0000000..2740d22
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/system.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/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt
deleted file mode 100644
index 44c0246..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt
+++ /dev/null
@@ -1,206 +0,0 @@
-..
-..
-.. 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/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
new file mode 100644
index 0000000..44c0246
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.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/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt
deleted file mode 100644
index 89444f0..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt
+++ /dev/null
@@ -1,54 +0,0 @@
-..
-..
-.. 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}
-+++++++++++++++++++++++++++++
-
-**PUT /api/1.2/snapshot/{:cdn_name}**
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **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/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
new file mode 100644
index 0000000..89444f0
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
@@ -0,0 +1,54 @@
+..
+..
+.. 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}
++++++++++++++++++++++++++++++
+
+**PUT /api/1.2/snapshot/{:cdn_name}**
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **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/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt
deleted file mode 100644
index 6d614c5..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt
+++ /dev/null
@@ -1,151 +0,0 @@
-..
-..
-.. 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"
- }
- ]
- }
-
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/type.txt b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
new file mode 100644
index 0000000..6d614c5
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/type.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"
+ }
+ ]
+ }
+
+
+|