You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by gi...@apache.org on 2018/04/26 17:57:44 UTC
[38/48] incubator-trafficcontrol-website git commit: Update docs from
commit 28336db2850f4454450ada86de9643e59a61deaa
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/job.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/job.rst.txt b/docs/master/_sources/api/v12/job.rst.txt
new file mode 100644
index 0000000..be27309
--- /dev/null
+++ b/docs/master/_sources/api/v12/job.rst.txt
@@ -0,0 +1,136 @@
+..
+..
+.. 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-job:
+
+Jobs
+====
+
+.. _to-api-v12-job-route:
+
+/api/1.2/jobs
+++++++++++++++++++
+
+**GET /api/1.2/jobs**
+
+ Get all jobs (currently limited to invalidate content (PURGE) jobs) sorted by start time (descending).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations or Admin
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``dsId`` | no | Filter jobs by Delivery Service ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``userId`` | no | Filter jobs by User ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Job id |
+ +----------------------+--------+-------------------------------------------------+
+ |``assetUrl`` | string | URL of the asset to invalidate. |
+ +----------------------+--------+-------------------------------------------------+
+ |``deliveryService`` | string | Unique identifier of the job's DS. |
+ +----------------------+--------+-------------------------------------------------+
+ |``keyword`` | string | Job keyword (PURGE) |
+ +----------------------+--------+-------------------------------------------------+
+ |``parameters`` | string | Parameters associated with the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``startTime`` | string | Start time of the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``createdBy`` | string | Username that initiated the job. |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 1
+ "assetUrl": "http:\/\/foo-bar.domain.net\/taco.html",
+ "deliveryService": "foo-bar",
+ "keyword": "PURGE",
+ "parameters": "TTL:48h",
+ "startTime": "2015-05-14 08:56:36-06",
+ "createdBy": "jdog24"
+ },
+ {
+ "id": 2
+ "assetUrl": "http:\/\/foo-bar.domain.net\/bell.html",
+ "deliveryService": "foo-bar",
+ "keyword": "PURGE",
+ "parameters": "TTL:72h",
+ "startTime": "2015-05-16 08:56:36-06",
+ "createdBy": "jdog24"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/jobs/:id**
+
+ Get a job by ID (currently limited to invalidate content (PURGE) jobs).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations or Admin
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Job id |
+ +----------------------+--------+-------------------------------------------------+
+ |``assetUrl`` | string | URL of the asset to invalidate. |
+ +----------------------+--------+-------------------------------------------------+
+ |``deliveryService`` | string | Unique identifier of the job's DS. |
+ +----------------------+--------+-------------------------------------------------+
+ |``keyword`` | string | Job keyword (PURGE) |
+ +----------------------+--------+-------------------------------------------------+
+ |``parameters`` | string | Parameters associated with the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``startTime`` | string | Start time of the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``createdBy`` | string | Username that initiated the job. |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 1
+ "assetUrl": "http:\/\/foo-bar.domain.net\/taco.html",
+ "deliveryService": "foo-bar",
+ "keyword": "PURGE",
+ "parameters": "TTL:48h",
+ "startTime": "2015-05-14 08:56:36-06",
+ "createdBy": "jdog24"
+ }
+ ]
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/parameter.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/parameter.rst.txt b/docs/master/_sources/api/v12/parameter.rst.txt
new file mode 100644
index 0000000..9c0f65b
--- /dev/null
+++ b/docs/master/_sources/api/v12/parameter.rst.txt
@@ -0,0 +1,691 @@
+..
+..
+.. 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
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | no | Filter parameters by name. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``configFile`` | no | Filter parameters by config file. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``lastUpdated`` | 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 |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``configFile`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``profiles`` | array | An array of profiles attached to this parameter. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "configFile": "FooConfig.xml",
+ "profiles": [ "EDGE-FOO, MID-FOO" ]
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "configFile": "storage.config",
+ "profiles": [ "EDGE-FOO, MID-FOO" ]
+
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "configFile": "records.config"
+ "profiles": [ ]
+ }
+ ],
+ }
+
+|
+
+**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/parameters/:id/profiles**
+
+ Retrieves all profiles assigned to the parameter.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``id`` | yes | Parameter ID. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``type`` | string | The type for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net",
+ "type": "ATS_PROFILE"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/parameters/:id/unassigned_profiles**
+
+ Retrieves all profiles NOT assigned to the parameter.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``id`` | yes | Parameter ID. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/profiles/:id/parameters**
+
+ Retrieves all parameters assigned to the profile.
+
+ 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/:id/unassigned_parameters**
+
+ Retrieves all parameters NOT assigned to the profile.
+
+ 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 example: ::
+
+ {
+ "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** ::
+
+ {
+ "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"
+ }
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/phys_location.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/phys_location.rst.txt b/docs/master/_sources/api/v12/phys_location.rst.txt
new file mode 100644
index 0000000..67359e5
--- /dev/null
+++ b/docs/master/_sources/api/v12/phys_location.rst.txt
@@ -0,0 +1,456 @@
+..
+..
+.. 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-phys-loc:
+
+Physical Location
+=================
+
+.. _to-api-v12-phys-loc-route:
+
+/api/1.2/phys_locations
++++++++++++++++++++++++
+
+**GET /api/1.2/phys_locations**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+=============================================+
+ | ``region`` | no | Filter by Region ID. |
+ +--------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ },
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/phys_locations/trimmed.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``name`` | string | |
+ +----------------------+---------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "Albuquerque"
+ },
+ {
+ "name": "Ashburn"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/regions/:region_name/phys_locations**
+ Create physical location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ region_name: the name of the region to create physical location into.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================+
+ | ``region_name`` | yes | The name of the physical location |
+ +-----------------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``shortName`` | yes | The short name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``address`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``city`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``state`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``zip`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``phone`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``poc`` | no | Point of contact |
+ +-----------------+----------+---------------------------------------------------+
+ | ``email`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``comments`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name" : "my physical location1",
+ "shortName" : "myphylocation1",
+ "address" : "",
+ "city" : "Shanghai",
+ "state": "SH",
+ "zip": "200000",
+ "comments": "this is physical location1"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===================================================+
+ | ``id`` | string | The id of the physical location created. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``name`` | string | The name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``shortName`` | string | The short name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionName`` | string | The region name the physical location belongs to. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionId`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``address`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``city`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``state`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``zip`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``phone`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``poc`` | string | Point of contact |
+ +-----------------+--------+---------------------------------------------------+
+ | ``email`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``comments`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/profile.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/profile.rst.txt b/docs/master/_sources/api/v12/profile.rst.txt
new file mode 100644
index 0000000..73d8043
--- /dev/null
+++ b/docs/master/_sources/api/v12/profile.rst.txt
@@ -0,0 +1,415 @@
+..
+..
+.. 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-profile:
+
+
+Profiles
+========
+
+.. _to-api-v12-profiles-route:
+
+/api/1.2/profiles
++++++++++++++++++
+
+**GET /api/1.2/profiles**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``param`` | no | Used to filter profiles by parameter ID. |
+ +---------------+----------+----------------------------------------------------+
+ | ``cdn`` | no | Used to filter profiles by CDN ID. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+======================================================+
+ | ``id`` | string | Primary key |
+ +---------------------+--------+------------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +---------------------+--------+------------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +---------------------+--------+------------------------------------------------------+
+ | ``cdn`` | int | The CDN ID |
+ +---------------------+--------+------------------------------------------------------+
+ | ``cdnName`` | string | The CDN name |
+ +---------------------+--------+------------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +---------------------+--------+------------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled - defaults to false. |
+ +---------------------+--------+------------------------------------------------------+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +---------------------+--------+------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "8",
+ "name": "EDGE_27_PROFILE",
+ "description": "A profile with all the Foo parameters"
+ "cdn": 1
+ "cdnName": "cdn1"
+ "type": "ATS_PROFILE"
+ "routingDisabled": false
+ "lastUpdated": "2012-10-08 19:34:45",
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "EDGE_27_PROFILE"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``id`` | string | Primary key |
+ +---------------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +---------------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +---------------------+--------+----------------------------------------------------+
+ | ``cdn`` | int | The CDN ID |
+ +---------------------+--------+----------------------------------------------------+
+ | ``cdnName`` | string | The CDN name |
+ +---------------------+--------+----------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +---------------------+--------+----------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled |
+ +---------------------+--------+----------------------------------------------------+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "8",
+ "name": "EDGE_27_PROFILE",
+ "description": "A profile with all the Foo parameters"
+ "cdn": 1
+ "cdnName": "cdn1"
+ "type": "ATS_PROFILE"
+ "routingDisabled": true
+ "lastUpdated": "2012-10-08 19:34:45",
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/profiles**
+ Create a new empty profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-----------------------+--------+----------+-----------------------------------------+
+ | Parameter | Type | Required | Description |
+ +=======================+========+==========+=========================================+
+ | ``name`` | string | yes | Profile name |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``description`` | string | yes | Profile description |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``cdn`` | int | no | CDN ID |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``type`` | string | yes | Profile type |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``routingDisabled`` | bool | no | Traffic router routing disabled. |
+ | | | | Defaults to false. |
+ +-----------------------+--------+----------+-----------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description",
+ "cdn": 1,
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Profile ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | Profile name |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | Profile description |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``cdn`` | int | CDN ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "66",
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description",
+ "cdn": 1,
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/:profile_name/copy/:profile_copy_from**
+ Copy profile to a new profile. The new profile name must not exist.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------------+----------+-------------------------------+
+ | Name | Required | Description |
+ +=======================+==========+===============================+
+ | ``profile_name`` | yes | The name of profile to copy |
+ +-----------------------+----------+-------------------------------+
+ | ``profile_copy_from`` | yes | The name of profile copy from |
+ +-----------------------+----------+-------------------------------+
+
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Id of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``profileCopyFrom`` | string | The name of profile to copy |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``idCopyFrom`` | string | The id of profile to copy |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | new profile's description (copied) |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "66",
+ "name": "CCR_COPY",
+ "profileCopyFrom": "CCR1",
+ "description": "CCR_COPY description",
+ "idCopyFrom": "3"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/profiles/{:id}**
+
+ Allows user to edit a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------------------+--------+----------+--------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +=======================+========+==========+============================================+
+ | ``name`` | string | yes | Profile name |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``description`` | string | yes | Profile description |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``cdn`` | int | no | CDN ID - must use the same ID as any |
+ | | | | servers assigned to the profile. |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``type`` | string | yes | Profile type |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``routingDisabled`` | bool | no | Traffic router routing disabled. |
+ | | | | When not present, value defaults to false. |
+ +-----------------------+--------+----------+--------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description",
+ "cdn": 1,
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Profile ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | Profile name |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | Profile description |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``cdn`` | int | CDN ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": "219",
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description"
+ "cdn": 1
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile was updated: 219"
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profiles/{:id}**
+
+ Allows user to delete a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------------+
+ | Name | Required | Description |
+ +=================+==========+============================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+----------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Profile was deleted."
+ }
+ ]
+ }
+
+|
+