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:37 UTC
[27/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/deliveryservice_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt
deleted file mode 100644
index 8d9dadb..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt
+++ /dev/null
@@ -1,155 +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-ds-stats:
-
-Delivery Service Statistics
-===========================
-
-.. _to-api-v12-ds-stats-route:
-
-/api/1.2/deliveryservice_stats
-++++++++++++++++++++++++++++++
-
-**GET /api/1.2/deliveryservice_stats.json**
-
- Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +==========================+==========+==============================================================================================================================================+
- | ``deliveryServiceName`` | yes | The delivery service with the desired stats |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``metricType`` | yes | The metric type (valid metric types: 'kbps', 'out_bytes', 'status_4xx', 'status_5xx', tps_total', 'tps_2xx','tps_3xx', 'tps_4xx', 'tps_5xx') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Properties**
-
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +============================+===============+=========================================================================================+
- |``source`` | string | The source of the data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``summary`` | hash | Summary data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>totalBytes`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>count`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>min`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>max`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>fifthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>ninetyEighthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>ninetyFifthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>average`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>totalTransactions`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``series`` | hash | Series data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>count`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>columns`` | array | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>name`` | string | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>values`` | array | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>>time`` | string | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>>value`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "source": "TrafficStats",
- "summary": {
- "average": 1081172.785,
- "count": 28,
- "fifthPercentile": 888827.26,
- "max": 1326680.31,
- "min": 888827.26,
- "ninetyEighthPercentile": 1324785.47,
- "ninetyFifthPercentile": 1324785.47,
- "totalBytes": 37841047.475,
- "totalTransactions": 1020202030101
- },
- "series": {
- "columns": [
- "time",
- ""
- ],
- "count": 60,
- "name": "kbps",
- "tags": {
- "cachegroup": "total"
- },
- "values": [
- [
- "2015-08-11T11:36:00Z",
- 888827.26
- ],
- [
- "2015-08-11T11:37:00Z",
- 980336.563333333
- ],
- [
- "2015-08-11T11:38:00Z",
- 952111.975
- ],
- [
- "2015-08-11T11:39:00Z",
- null
- ],
- [
- "2015-08-11T11:43:00Z",
- null
- ],
- [
- "2015-08-11T11:44:00Z",
- 934682.943333333
- ],
- [
- "2015-08-11T11:45:00Z",
- 1251121.28
- ],
- [
- "2015-08-11T11:46:00Z",
- 1111012.99
- ]
- ]
- }
- }
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
new file mode 100644
index 0000000..8d9dadb
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
@@ -0,0 +1,155 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-ds-stats:
+
+Delivery Service Statistics
+===========================
+
+.. _to-api-v12-ds-stats-route:
+
+/api/1.2/deliveryservice_stats
+++++++++++++++++++++++++++++++
+
+**GET /api/1.2/deliveryservice_stats.json**
+
+ Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+==============================================================================================================================================+
+ | ``deliveryServiceName`` | yes | The delivery service with the desired stats |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``metricType`` | yes | The metric type (valid metric types: 'kbps', 'out_bytes', 'status_4xx', 'status_5xx', tps_total', 'tps_2xx','tps_3xx', 'tps_4xx', 'tps_5xx') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +============================+===============+=========================================================================================+
+ |``source`` | string | The source of the data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``summary`` | hash | Summary data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalBytes`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>min`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>max`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>fifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyEighthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyFifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>average`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalTransactions`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``series`` | hash | Series data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>columns`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>name`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>values`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>time`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>value`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "source": "TrafficStats",
+ "summary": {
+ "average": 1081172.785,
+ "count": 28,
+ "fifthPercentile": 888827.26,
+ "max": 1326680.31,
+ "min": 888827.26,
+ "ninetyEighthPercentile": 1324785.47,
+ "ninetyFifthPercentile": 1324785.47,
+ "totalBytes": 37841047.475,
+ "totalTransactions": 1020202030101
+ },
+ "series": {
+ "columns": [
+ "time",
+ ""
+ ],
+ "count": 60,
+ "name": "kbps",
+ "tags": {
+ "cachegroup": "total"
+ },
+ "values": [
+ [
+ "2015-08-11T11:36:00Z",
+ 888827.26
+ ],
+ [
+ "2015-08-11T11:37:00Z",
+ 980336.563333333
+ ],
+ [
+ "2015-08-11T11:38:00Z",
+ 952111.975
+ ],
+ [
+ "2015-08-11T11:39:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:43:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:44:00Z",
+ 934682.943333333
+ ],
+ [
+ "2015-08-11T11:45:00Z",
+ 1251121.28
+ ],
+ [
+ "2015-08-11T11:46:00Z",
+ 1111012.99
+ ]
+ ]
+ }
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt
deleted file mode 100644
index 934c393..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt
+++ /dev/null
@@ -1,202 +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-division:
-
-Divisions
-=========
-
-.. _to-api-v12-division-route:
-
-/api/1.2/divisions
-++++++++++++++++
-
-**GET /api/1.2/divisions**
- Get all divisions.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+=================================================+
- |``id`` | string | Division id |
- +----------------------+--------+-------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+-------------------------------------------------+
- |``name`` | string | Division name |
- +----------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "1"
- "name": "Central",
- "lastUpdated": "2014-10-02 08:22:43"
- },
- {
- "id": "2"
- "name": "West",
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-
-**GET /api/1.2/divisions/:id**
- Get division by Id.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+=================================================+
- |``id`` | string | Division id |
- +----------------------+--------+-------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+-------------------------------------------------+
- |``name`` | string | Division name |
- +----------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "1"
- "name": "Central",
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-
-**PUT /api/1.2/divisions/:id**
- Update a division
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | Division id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-----------+----------+--------------------------+
- | Parameter | Required | Description |
- +===========+==========+==========================+
- | ``name`` | yes | The name of the division |
- +-----------+----------+--------------------------+
-
- **Request Example** ::
-
- {
- "name": "mydivision1"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Division update was successful."
- }
- ],
- "response": {
- "id": "1",
- "lastUpdated": "2014-03-18 08:57:39",
- "name": "mydivision1"
- }
- }
-|
-
-
-**POST /api/1.2/divisions**
- Create division
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Properties**
-
- +-----------+----------+--------------------------+
- | Parameter | Required | Description |
- +===========+==========+==========================+
- | ``name`` | yes | The name of the division |
- +-----------+----------+--------------------------+
-
- **Request Example** ::
-
- {
- "name": "mydivision1"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- 'name': 'mydivision1',
- 'id': '4'
- }
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/division.txt b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
new file mode 100644
index 0000000..934c393
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
@@ -0,0 +1,202 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-division:
+
+Divisions
+=========
+
+.. _to-api-v12-division-route:
+
+/api/1.2/divisions
+++++++++++++++++
+
+**GET /api/1.2/divisions**
+ Get all divisions.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "West",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/divisions/:id**
+ Get division by Id.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/divisions/:id**
+ Update a division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Division id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Division update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "mydivision1"
+ }
+ }
+|
+
+
+**POST /api/1.2/divisions**
+ Create division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'name': 'mydivision1',
+ 'id': '4'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/federation.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/federation.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/federation.rst.txt
deleted file mode 100644
index a15922e..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/federation.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-federation:
-
-Federation
-==========
-
-.. _to-api-v12-federation-route:
-
-/api/1.2/federations
-++++++++++++++++++++
-
-**GET /api/1.2/federations.json**
-
- Retrieves a list of federations for a user's delivery service(s).
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
- **Response Properties**
-
- +---------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+========+====================================================+
- | ``cname`` | string | |
- +---------------------+--------+----------------------------------------------------+
- | ``ttl`` | int | Time to live for the cname. |
- +---------------------+--------+----------------------------------------------------+
- | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
- +---------------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "mappings": [
- "cname": "cname-01.",
- "ttl": 8865,
- ]
- "deliveryService": "ds-01",
- }
- ]
- }
-
-|
-
-**POST /api/1.2/federations.json**
-
- Allows a user to add federations for their delivery service(s).
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
- **Request Properties**
-
- +---------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+========+====================================================+
- | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve4`` | array | Array of IPv4 Addresses. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve6`` | array | Array of IPv6 Addresses. |
- +---------------------+--------+----------------------------------------------------+
-
- **Request Example** ::
-
- {
- "federations": [
- {
- "deliveryService": "ccp-omg-01",
- "mappings": {
- "resolve4": [
- "255.255.255.255"
- ],
- "resolve6": [
- "FE80::0202:B3FF:FE1E:8329",
- ]
- }
- }
- ]
- }
-
-|
-
-**DELETE /api/1.2/federations.json**
-
- Deletes **all** federations associated with a user's delivery service(s).
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
-|
-
-
-**PUT /api/1.2/federations.json**
-
- Deletes **all** federations associated with a user's delivery service(s) then adds the new federations.
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
- **Request Properties**
-
- +---------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+========+====================================================+
- | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve4`` | array | Array of IPv4 Addresses. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve6`` | array | Array of IPv6 Addresses. |
- +---------------------+--------+----------------------------------------------------+
-
- **Request Example** ::
-
- {
- "federations": [
- {
- "deliveryService": "ccp-omg-01",
- "mappings": {
- "resolve4": [
- "255.255.255.255"
- ],
- "resolve6": [
- "FE80::0202:B3FF:FE1E:8329",
- ]
- }
- }
- ]
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt b/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
new file mode 100644
index 0000000..a15922e
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/federation.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-federation:
+
+Federation
+==========
+
+.. _to-api-v12-federation-route:
+
+/api/1.2/federations
+++++++++++++++++++++
+
+**GET /api/1.2/federations.json**
+
+ Retrieves a list of federations for a user's delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "mappings": [
+ "cname": "cname-01.",
+ "ttl": 8865,
+ ]
+ "deliveryService": "ds-01",
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations.json**
+
+ Allows a user to add federations for their delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+|
+
+
+**PUT /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s) then adds the new federations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt
deleted file mode 100644
index 2da59c5..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt
+++ /dev/null
@@ -1,68 +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-hwinfo:
-
-Hardware Info
-=============
-
-.. _to-api-v12-hwinfo-route:
-
-/api/1.2/hwinfo
-+++++++++++++++
-
-**GET /api/1.2/hwinfo.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------+--------+----------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+======================================================================+
- | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``serverHostName`` | string | Hostname for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``val`` | string | Freeform value used to track anything about a server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``description`` | string | Freeform description for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "serverId": "odol-atsmid-cen-09",
- "lastUpdated": "2014-05-27 09:06:02",
- "val": "D1S4",
- "description": "Physical Disk 0:1:0"
- },
- {
- "serverId": "odol-atsmid-cen-09",
- "lastUpdated": "2014-05-27 09:06:02",
- "val": "D1S4",
- "description": "Physical Disk 0:1:1"
- }
- ]
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
new file mode 100644
index 0000000..2da59c5
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
@@ -0,0 +1,68 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-hwinfo:
+
+Hardware Info
+=============
+
+.. _to-api-v12-hwinfo-route:
+
+/api/1.2/hwinfo
++++++++++++++++
+
+**GET /api/1.2/hwinfo.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------+--------+----------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+======================================================================+
+ | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``serverHostName`` | string | Hostname for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``val`` | string | Freeform value used to track anything about a server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``description`` | string | Freeform description for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:0"
+ },
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:1"
+ }
+ ]
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt
deleted file mode 100644
index ca82cf5..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt
+++ /dev/null
@@ -1,65 +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-influxdb:
-
-InfluxDB
-==========
-
-.. Note:: The documentation needs a thorough review!
-
-**GET /api/1.2/traffic_monitor/stats.json**
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Response Properties**
-
-+----------------------+--------+------------------------------------------------+
-| Parameter | Type | Description |
-+======================+========+================================================+
-| ``aaData`` | array | |
-+----------------------+--------+------------------------------------------------+
-
-**Response Example**
-::
-
- {
- "aaData": [
- [
- "0",
- "ALL",
- "ALL",
- "ALL",
- "true",
- "ALL",
- "142035",
- "172365661.85"
- ],
- [
- 1,
- "EDGE1_TOP_421_PSPP",
- "odol-atsec-atl-03",
- "us-ga-atlanta",
- "1",
- "REPORTED",
- "596",
- "923510.04",
- "69.241.82.126"
- ]
- ],
- }
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
new file mode 100644
index 0000000..ca82cf5
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
@@ -0,0 +1,65 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-influxdb:
+
+InfluxDB
+==========
+
+.. Note:: The documentation needs a thorough review!
+
+**GET /api/1.2/traffic_monitor/stats.json**
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++----------------------+--------+------------------------------------------------+
+| Parameter | Type | Description |
++======================+========+================================================+
+| ``aaData`` | array | |
++----------------------+--------+------------------------------------------------+
+
+**Response Example**
+::
+
+ {
+ "aaData": [
+ [
+ "0",
+ "ALL",
+ "ALL",
+ "ALL",
+ "true",
+ "ALL",
+ "142035",
+ "172365661.85"
+ ],
+ [
+ 1,
+ "EDGE1_TOP_421_PSPP",
+ "odol-atsec-atl-03",
+ "us-ga-atlanta",
+ "1",
+ "REPORTED",
+ "596",
+ "923510.04",
+ "69.241.82.126"
+ ]
+ ],
+ }
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt
deleted file mode 100644
index 307d4c7..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt
+++ /dev/null
@@ -1,516 +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-parameter:
-
-Parameter
-=========
-
-.. _to-api-v12-parameters-route:
-
-/api/1.2/parameters
-+++++++++++++++++++
-
-**GET /api/1.2/parameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": true,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-|
-
-**GET /api/1.2/parameters/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``id`` | integer | The parameter index |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "foo.bar.net",
- "name": "domain_name",
- "id": "27",
- "config_file": "FooConfig.xml",
- }
- ]
- }
-
-|
-
-**GET /api/1.2/profiles/:id/parameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-----------------------+
- | Name | Required | Description |
- +==================+==========+=======================+
- | ``id`` | yes | Profile id |
- +------------------+----------+-----------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": true,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-|
-
-**GET /api/1.2/profiles/name/:name/parameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-----------------------+
- | Name | Required | Description |
- +==================+==========+=======================+
- | ``name`` | yes | Profile name |
- +------------------+----------+-----------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": true,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-|
-
-**POST /api/1.2/parameters**
- Create parameters.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
- The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.
-
- single parameter format:
-
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +================+==========+=========+======================================================================================+
- | ``name`` | yes | string | parameter name |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``configFile`` | yes | string | parameter config_file |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``value`` | yes | string | parameter value |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- parameters array format:
-
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +=================+==========+=========+======================================================================================+
- | | yes | array | parameters array |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>name`` | yes | string | parameter name |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>configFile`` | yes | string | parameter config_file |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>value`` | yes | string | parameter value |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- **Response Properties**
-
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+=========+======================================================================================+
- | | array | parameters array |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>id`` | integer | The parameter id |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>name`` | string | parameter name |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>configFile`` | string | parameter config_file |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>value`` | string | parameter value |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+---------+--------------------------------------------------------------------------------------+
-
-
- **Request Example** ::
-
- 1. single parameter format exampe:
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":0,
- }
-
- 2. array format example:
- [
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":0,
- },
- {
- "name":"param2",
- "configFile":"configFile2"
- "value":"value2",
- "secure":1,
- }
- ]
-
- **Response Example** ::
-
- {
- "response": [
- {
- "value":"value1",
- "secure":0,
- "name":"param1",
- "id":"1139",
- "configFile":"configFile1"
- },
- {
- "value":"value2",
- "secure":1,
- "name":"param2",
- "id":"1140",
- "configFile":"configFile2"
- }
- ]
- }
-
-|
-
-**PUT /api/1.2/parameters/{:id}**
- Edit parameter.
-
- Authentication Required: Yes
-
- Role(s) Required: if the parameter's secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.
-
- **Request Parameters**
-
- +-----------+---------+------------------+
- | Parameter | Type | Description |
- +===========+=========+==================+
- | ``id`` | integer | The parameter id |
- +-----------+---------+------------------+
-
- **Request Route Parameters**
-
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +================+==========+=========+======================================================================================+
- | ``name`` | no | string | parameter name |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``configFile`` | no | string | parameter config_file |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``value`` | no | string | parameter value |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``secure`` | no | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``id`` | integer | The parameter id |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":"0",
- }
-
- **Response Example** ::
-
- {
- "response": {
- "value":"value1",
- "secure":"0",
- "name":"param1",
- "id":"1134",
- "configFile":"configFile1"
- }
- }
-
-|
-
-**DELETE /api/1.2/parameters/{:id}**
- delete parameter. If the parameter have profile associated, can not be deleted.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper role
-
- **Request Parameters**
-
- +-----------+---------+------------------+
- | Parameter | Type | Description |
- +===========+=========+==================+
- | ``id`` | integer | The parameter id |
- +-----------+---------+------------------+
-
- **No Request Route Parameters**
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- Response Example:
-
- {
- "alerts":
- [
- {
- "level": "success",
- "text": "Parameter was successfully deleted."
- }
- ],
- }
-
-|
-
-**POST /api/1.2/parameters/validate**
- Validate if the parameter exists.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------------+----------+--------------------------------+
- | Name | Required | Type | Description |
- +================+==========+================================+
- | ``name`` | yes | string | parameter name |
- +----------------+----------+--------------------------------+
- | ``configFile`` | yes | string | parameter config_file |
- +----------------+----------+--------------------------------+
- | ``value`` | yes | string | parameter value |
- +----------------+----------+--------------------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``id`` | integer | The parameter id |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- }
-
- **Response Example** ::
-
- {
- "response": {
- "value":"value1",
- "secure":"0",
- "name":"param1",
- "id":"1134",
- "configFile":"configFile1"
- }
- }
-
-|
-