You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by da...@apache.org on 2017/06/07 23:54:44 UTC
[34/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt
new file mode 100644
index 0000000..5ed2654
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt
@@ -0,0 +1,210 @@
+..
+..
+.. 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-v11-ext:
+
+TO Extensions
+=============
+
+.. _to-api-v11-ext-route:
+
+/api/1.1/to_extensions
+++++++++++++++++++++++
+
+**GET /api/1.1/to_extensions.json**
+
+Retrieves the list of extensions.
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++--------------------------+--------+--------------------------------------------+
+| Parameter | Type | Description |
++==========================+========+============================================+
+|``script_file`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``version`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``name`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``description`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``info_url`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``additional_config_json``| string | |
++--------------------------+--------+--------------------------------------------+
+|``isactive`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``id`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``type`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``servercheck_short_name``| string | |
++--------------------------+--------+--------------------------------------------+
+
+**Response Example** ::
+
+ {
+ "response": [
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "ILO_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
+ isactive: "1",
+ id: "1",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "ILO"
+ },
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "10G_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
+ isactive: "1",
+ id: "2",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "10G"
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/to_extensions**
+
+ Creates a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Parameters**
+
+ +--------------------------+--------+--------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+============================================+
+ |``name`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``version`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``info_url`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``script_file`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``isactive`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``additional_config_json``| string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``description`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``servercheck_short_name``| string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``type`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+
+ **Request Example** ::
+
+
+ {
+ "name": "ILO_PING",
+ "version": "1.0.0",
+ "info_url": "http://foo.com/bar.html",
+ "script_file": "ping",
+ "isactive": "1",
+ "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}",
+ "description": null,
+ "servercheck_short_name": "ILO"
+ "type": "CHECK_EXTENSION_BOOL",
+ }
+
+|
+
+ **Response Properties**
+
+ +------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Check Extension loaded."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/to_extensions/:id/delete**
+
+ Deletes a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +--------+----------+-----------------+
+ | Name | Required | Description |
+ +========+==========+=================+
+ | ``id`` | yes | TO extension id |
+ +--------+----------+-----------------+
+
+ **Response Properties**
+
+ +------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Extension deleted."
+ }
+ ],
+ }
+
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt
deleted file mode 100644
index 6c7806b..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt
+++ /dev/null
@@ -1,151 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-type:
-
-Types
-=====
-
-.. _to-api-v11-types-route:
-
-/api/1.1/types
-++++++++++++++
-
-**GET /api/1.1/types**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +----------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +================+==========+====================================================+
- | ``useInTable`` | no | Filter types by the table in which they apply |
- +----------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "22",
- "name": "AAAA_RECORD",
- "description": "Static DNS AAAA entry",
- "useInTable": "staticdnsentry",
- "lastUpdated": "2013-10-23 15:28:31"
- }
- ]
- }
-
-
-|
-
-**GET /api/1.1/types/trimmed**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "AAAA_RECORD"
- },
- {
- "name": "ACTIVE_DIRECTORY"
- },
- {
- "name": "A_RECORD"
- },
- {
- "name": "CCR"
- }
- ],
- }
-
-**GET /api/1.1/types/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +================+==========+====================================================+
- | ``id`` | yes | Type ID. |
- +----------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "22",
- "name": "AAAA_RECORD",
- "description": "Static DNS AAAA entry",
- "useInTable": "staticdnsentry",
- "lastUpdated": "2013-10-23 15:28:31"
- }
- ]
- }
-
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/type.txt b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
new file mode 100644
index 0000000..6c7806b
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
@@ -0,0 +1,151 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-type:
+
+Types
+=====
+
+.. _to-api-v11-types-route:
+
+/api/1.1/types
+++++++++++++++
+
+**GET /api/1.1/types**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
+
+**GET /api/1.1/types/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "AAAA_RECORD"
+ },
+ {
+ "name": "ACTIVE_DIRECTORY"
+ },
+ {
+ "name": "A_RECORD"
+ },
+ {
+ "name": "CCR"
+ }
+ ],
+ }
+
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt
deleted file mode 100644
index 2ef5012..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt
+++ /dev/null
@@ -1,778 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-users:
-
-Users
-=====
-
-.. _to-api-v11-users-route:
-
-/api/1.1/users
-++++++++++++++
-
-**GET /api/1.1/users**
-
- Retrieves all users.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``publicSshKey`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``registrationSent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``roleName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "addressLine1": "",
- "addressLine2": "",
- "city": "",
- "company": "",
- "country": "",
- "email": "email1@email.com",
- "fullName": "Tom Simpson",
- "gid": "0",
- "id": "53",
- "lastUpdated": "2016-01-26 10:22:07",
- "newUser": true,
- "phoneNumber": "",
- "postalCode": "",
- "publicSshKey": "xxx",
- "registrationSent": true,
- "role": "6",
- "rolename": "admin",
- "stateOrProvince": "",
- "uid": "0",
- "username": "tsimpson"
- },
- {
- ... more users
- },
- ]
- }
-
-|
-
-
-**GET /api/1.1/users/:id**
-
- Retrieves user by ID.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | User id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``publicSshKey`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``registrationSent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``roleName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "addressLine1": "",
- "addressLine2": "",
- "city": "",
- "company": "",
- "country": "",
- "email": "email1@email.com",
- "fullName": "Tom Simpson",
- "gid": "0",
- "id": "53",
- "lastUpdated": "2016-01-26 10:22:07",
- "newUser": true,
- "phoneNumber": "",
- "postalCode": "",
- "publicSshKey": "xxx",
- "registrationSent": true,
- "role": "6",
- "rolename": "admin",
- "stateOrProvince": "",
- "uid": "0",
- "username": "tsimpson"
- }
- ]
- }
-
-|
-
-
-**GET /api/1.1/user/current**
-
- Retrieves the profile for the authenticated user.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``localUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "email": "email@email.com",
- "city": "",
- "id": "50",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Tom Callahan",
- "localUser": true,
- "uid": "0",
- "stateOrProvince": "",
- "username": "tommyboy",
- "newUser": false,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "gid": "0",
- "postalCode": ""
- },
- }
-
-|
-
-**POST /api/1.1/user/current/update**
-
- Updates the date for the authenticated user.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``localUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "user": {
- "email": "",
- "city": "",
- "id": "",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "",
- "localUser": true,
- "uid": "0",
- "stateOrProvince": "",
- "username": "tommyboy",
- "newUser": false,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "gid": "0",
- "postalCode": ""
- }
- }
-
- **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": "UserProfile was successfully updated."
- }
- ],
- }
-
-|
-
-**GET /api/1.1/user/current/jobs.json**
-
- Retrieves the user's list of jobs.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------+----------+----------------------------------------+
- | Name | Required | Description |
- +==============+==========+========================================+
- | ``keyword`` | no | PURGE |
- +--------------+----------+----------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``keyword`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``objectName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``assetUrl`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``assetType`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``status`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``dsId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``dsXmlId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``parameters`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``enteredTime`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``objectType`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``agent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``startTime`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example**
- ::
-
- {
- "response": [
- {
- "id": "1",
- "keyword": "PURGE",
- "objectName": null,
- "assetUrl": "",
- "assetType": "file",
- "status": "PENDING",
- "dsId": "9999",
- "dsXmlId": "ds-xml-id",
- "username": "peewee",
- "parameters": "TTL:56h",
- "enteredTime": "2015-01-21 18:00:16",
- "objectType": null,
- "agent": "",
- "startTime": "2015-01-21 10:45:38"
- }
- ],
- }
-
-
-|
-
-**POST/api/1.1/user/current/jobs**
-
-Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
-
-.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
-
-Authentication Required: Yes
-
-Role(s) Required: Yes
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``dsId`` | string | Unique Delivery Service ID |
- +----------------------+--------+------------------------------------------------+
- |``regex`` | string | Path Regex this should be a |
- | | | `PCRE <http://www.pcre.org/>`_ compatible |
- | | | regular expression for the path to match for |
- | | | forcing the revalidation. Be careful to only |
- | | | match on the content you need to remove - |
- | | | revalidation is an expensive operation for |
- | | | many origins, and a simple ``/.*`` can cause |
- | | | an overload condition of the origin. |
- +----------------------+--------+------------------------------------------------+
- |``startTime`` | string | Start Time is the time when the revalidation |
- | | | rule will be made active. Populate |
- | | | with the current time to schedule ASAP. |
- +----------------------+--------+------------------------------------------------+
- |``ttl`` | int | Time To Live is how long the revalidation rule |
- | | | will be active for in hours. It usually makes |
- | | | sense to make this the same as the |
- | | | ``Cache-Control`` header from the origin which |
- | | | sets the object time to live in cache |
- | | | (by ``max-age`` or ``Expires``). Entering a |
- | | | longer TTL here will make the caches do |
- | | | unnecessary work. |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "dsId": "9999",
- "regex": "/path/to/content.jpg",
- "startTime": "2015-01-27 11:08:37",
- "ttl": 54
- }
-
-|
-
- **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": "Successfully created purge job for: ."
- }
- ],
- }
-
-
-|
-
-**POST /api/1.1/user/login**
-
- Authentication of a user using username and password. Traffic Ops will send back a session cookie.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``u`` | string | username |
- +----------------------+--------+------------------------------------------------+
- |``p`` | string | password |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "u": "username",
- "p": "password"
- }
-
-|
-
- **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": "Successfully logged in."
- }
- ],
- }
-
-|
-
-**GET /api/1.1/user/:id/deliveryservices/available.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |id | yes | |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``xmlId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "xmlId": "ns-img",
- "id": "90"
- },
- {
- "xmlId": "ns-img-secure",
- "id": "280"
- }
- ],
- }
-
-|
-
-**POST /api/1.1/user/login/token**
-
- Authentication of a user using a token.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``t`` | string | token-value |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "t": "token-value"
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+-------------+
- | Parameter | Type | Description |
- +=============+========+=============+
- | ``alerts`` | array | |
- +-------------+--------+-------------+
- | ``>level`` | string | |
- +-------------+--------+-------------+
- | ``>text`` | string | |
- +-------------+--------+-------------+
- | ``version`` | string | |
- +-------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "error",
- "text": "Unauthorized, please log in."
- }
- ],
- }
-
-|
-
-**POST /api/1.1/user/logout**
-
- User logout. Invalidates the session cookie.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``alerts`` | array | |
- +----------------------+--------+------------------------------------------------+
- |* ``level`` | string | |
- +----------------------+--------+------------------------------------------------+
- |* ``text`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example**
-
- ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "You are logged out."
- }
- ],
- }
-
-
-|
-
-**POST /api/1.1/user/reset_password**
-
- Reset user password.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``email`` | string | The email address of the user to initiate |
- | | | password reset. |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example**
- ::
-
- {
- "email": "email@email.com"
- }
-
-|
-
- **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": "Successfully sent password reset to email 'email@email.com'"
- }
- ],
- }
-
-