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:43 UTC
[37/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/profile_parameter.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/profile_parameter.rst.txt b/docs/master/_sources/api/v12/profile_parameter.rst.txt
new file mode 100644
index 0000000..e8534d9
--- /dev/null
+++ b/docs/master/_sources/api/v12/profile_parameter.rst.txt
@@ -0,0 +1,573 @@
+..
+..
+.. 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-profileparameters:
+
+
+Profile parameters
+==================
+
+.. _to-api-v12-profileparameters-route:
+
+/api/1.2/profileparameters
+++++++++++++++++++++++++++
+
+**POST /api/1.2/profileparameters**
+
+ Associate parameter to profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+ This accept two formats: single profile-parameter, profile-parameter array.
+
+ Single profile-parameter format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | ``profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ Profile-parameter array format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | | yes | profile-parameter array. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ Single profile-parameter format:
+
+ {
+ "profileId": 2,
+ "parameterId": 6
+ }
+
+ Profile-parameter array format:
+
+ [
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+ ]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":[
+ {
+ "profileId": "2",
+ "parameterId": "6"
+ },
+ {
+ "profileId": "2",
+ "parameterId": "7"
+ },
+ {
+ "profileId": "3",
+ "parameterId": "6"
+ }
+ ]
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter associations were created."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}**
+
+ Delete a profile parameter association.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+====================================================+
+ | ``profile_id`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameter_id`` | yes | parameter 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 parameter association was deleted."
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/{:name}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``name`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties 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. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters 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. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **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 Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>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. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/id/{:id}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``id`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties 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. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters 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. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **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 Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>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. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profileparameter**
+
+ Create one or more profile / parameter assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``profileId`` | yes | The ID of the profile. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``paramIds`` | yes | An array of parameter IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing profile/param assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "profileId": 22,
+ "paramIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``profileId`` | int | The ID of the profile. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``paramIds`` | array | An array of parameter IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | bool | Existing profile/param assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "14 parameters where assigned to the foo profile."
+ }
+ ],
+ "response": {
+ "profileId" : 22,
+ "paramIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
+**POST /api/1.2/parameterprofile**
+
+ Create one or more parameter / profile assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``paramId`` | yes | The ID of the parameter. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``profileIds`` | yes | An array of profile IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing param/profile assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "paramId": 22,
+ "profileIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``paramId`` | int | The ID of the parameter. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``profileIds`` | array | An array of profile IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | bool | Existing param/profile assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "14 profiles where assigned to the bar parameter."
+ }
+ ],
+ "response": {
+ "paramId" : 22,
+ "profileIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/region.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/region.rst.txt b/docs/master/_sources/api/v12/region.rst.txt
new file mode 100644
index 0000000..74e6fbf
--- /dev/null
+++ b/docs/master/_sources/api/v12/region.rst.txt
@@ -0,0 +1,244 @@
+..
+..
+.. 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-region:
+
+Regions
+=======
+
+.. _to-api-v12-regions-route:
+
+/api/1.2/regions
+++++++++++++++++
+
+**GET /api/1.1/regions**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +---------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+=============================================+
+ | ``division`` | no | Filter regions by Division ID. |
+ +---------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ },
+ {
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
+ },
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ }
+ ]
+ }
+
+
+**PUT /api/1.2/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+
+|
+
+**POST /api/1.2/divisions/:division_name/regions**
+ Create Region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ division_name - The name of division to create new region into.
+
+ ** Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+================================================+
+ | ``division_name`` | yes | The name of division will create new region in |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================================+
+ | ``name`` | yes | The name of the region |
+ +-------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+===========================================+
+ | ``name`` | string | name of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``id`` | string | id of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionName`` | string | the division name the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionId`` | string | the id of division the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'divisionName': 'mydivision1',
+ 'divsionId': '4',
+ 'name': 'myregion1',
+ 'id': '19'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/_sources/api/v12/role.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/role.rst.txt b/docs/master/_sources/api/v12/role.rst.txt
new file mode 100644
index 0000000..b993c97
--- /dev/null
+++ b/docs/master/_sources/api/v12/role.rst.txt
@@ -0,0 +1,59 @@
+..
+..
+.. 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-roles:
+
+Roles
+=====
+
+.. _to-api-v12-roles-route:
+
+/api/1.2/roles
+++++++++++++++
+
+**GET /api/1.2/roles.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``privLevel`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "read-only",
+ "id": "2",
+ "privLevel": "10",
+ "description": "read-only user"
+ }
+ ]
+ }
+
+|