You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2016/11/01 21:44:47 UTC
[23/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
index 01987eb..61d6c0b 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
@@ -24,7 +24,7 @@ Physical Location
/api/1.1/phys_locations
+++++++++++++++++++++++
-**GET /api/1.1/phys_locations.json**
+**GET /api/1.1/phys_locations**
Authentication Required: Yes
@@ -35,30 +35,34 @@ Physical Location
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
+ |``address`` | string | |
+----------------------+--------+------------------------------------------------+
- |``name`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
|``comments`` | string | |
+----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
+ |``email`` | string | |
+----------------------+--------+------------------------------------------------+
- |``state`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
- |``email`` | string | |
+ |``lastUpdated`` | string | |
+----------------------+--------+------------------------------------------------+
- |``city`` | string | |
+ |``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
+ |``phone`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``poc`` | string | |
+----------------------+--------+------------------------------------------------+
- |``address`` | string | |
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+----------------------+--------+------------------------------------------------+
|``shortName`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -66,7 +70,9 @@ Physical Location
"response": [
{
"region": "Mile High",
+ "region": "4",
"poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
"name": "Albuquerque",
"comments": "Albuquerque",
"phone": "(123) 555-1111",
@@ -79,20 +85,22 @@ Physical Location
"shortName": "Albuquerque"
},
{
- "region": "Chicago",
- "poc": "John Doe",
- "name": "Chicago",
- "comments": "",
- "phone": "(321) 555-1111",
- "state": "IL",
- "email": "john.doe@email.com",
- "city": "Chicago",
- "zip": "60636",
- "id": "3",
- "address": "123 East 4th Street",
- "shortName": "chicago"
+ "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"
}
- ],
+ ]
}
|
@@ -121,7 +129,322 @@ Physical Location
{
"name": "Ashburn"
}
- ],
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/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.1/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.1/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/91716725/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
index 83d54f2..97075d8 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
@@ -24,7 +24,7 @@ Profiles
/api/1.1/profiles
+++++++++++++++++
-**GET /api/1.1/profiles.json**
+**GET /api/1.1/profiles**
Authentication Required: Yes
@@ -59,7 +59,7 @@ Profiles
|
-**GET /api/1.1/profiles/trimmed.json**
+**GET /api/1.1/profiles/trimmed**
Authentication Required: Yes
@@ -84,3 +84,47 @@ Profiles
}
|
+
+**GET /api/1.1/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 |
+ +=================+========+====================================================+
+ | ``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"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/region.txt b/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
index f7d993d..7eda251 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
@@ -24,7 +24,7 @@ Regions
/api/1.1/regions
++++++++++++++++
-**GET /api/1.1/regions.json**
+**GET /api/1.1/regions**
Authentication Required: Yes
@@ -35,9 +35,13 @@ Regions
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``name`` | string | |
+ |``id`` | string | Region ID. |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -45,13 +49,188 @@ Regions
{
"response": [
{
+ "id": "6",
"name": "Atlanta",
- "id": "6"
+ "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": [
{
- "name": "Beltway",
- "id": "1"
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
}
- ],
+ ]
+ }
+
+
+**PUT /api/1.1/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.1/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/91716725/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/server.txt b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
index 9c437b8..61184f9 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
@@ -24,7 +24,7 @@ Server
/api/1.1/servers
++++++++++++++++
-**GET /api/1.1/servers.json**
+**GET /api/1.1/servers**
Retrieves properties of CDN servers.
@@ -34,10 +34,170 @@ Server
**Request Query Parameters**
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+-----------+----------+---------------------------------------------+
| Name | Required | Description |
+===========+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
+ | ``id`` | yes | Server id. |
+-----------+----------+---------------------------------------------+
**Response Properties**
@@ -47,10 +207,20 @@ Server
+====================+========+============================================================================================================+
| ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``domainName`` | string | The domain name part of the FQDN of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``hostName`` | string | The host name part of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``id`` | string | The server id (database row number). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
@@ -85,10 +255,18 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``rack`` | string | A string indicating rack location. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``routerHostName`` | string | The human readable name of the router. |
@@ -97,15 +275,15 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
+ | ``updPending`` | bool | |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -114,7 +292,11 @@ Server
"response": [
{
"cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
"domainName": "chi.kabletown.net",
+ "guid": null,
"hostName": "atsec-chi-00",
"id": "19",
"iloIpAddress": "172.16.2.6",
@@ -133,27 +315,30 @@ Server
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
+ "offlineReason": "N/A",
"physLocation": "plocation-chi-1",
+ "physLocationId": "9",
"profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
"rack": "RR 119.02",
"routerHostName": "rtr-chi.kabletown.net",
"routerPortName": "2",
"status": "ONLINE",
+ "statusId": "6",
"tcpPort": "80",
"httpsPort": "443",
"type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "**********"
- },
- {
- ... more server data
+ "typeId": "3",
+ "updPending": false
}
]
}
|
-**GET /api/1.1/servers/summary.json**
+
+**GET /api/1.1/servers/summary**
Retrieves a count of CDN servers by type.
@@ -199,7 +384,7 @@ Server
|
-**GET /api/1.1/servers/hostname/:name/details.json**
+**GET /api/1.1/servers/hostname/:name/details**
Retrieves the details of a server.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/status.txt b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
index 0f2b7e0..853f276 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
@@ -24,9 +24,9 @@ Status
/api/1.1/statuses
+++++++++++++++++
-**GET /api/1.1/statuses.json**
+**GET /api/1.1/statuses**
- Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.
+ Retrieves a list of the server status codes available.
Authentication Required: Yes
@@ -37,49 +37,92 @@ Status
+-----------------+--------+--------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+================================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+-----------------+--------+--------------------------------------------------------------------------------+
| ``name`` | string | The string equivalent of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
| ``description`` | string | A short description of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"id": "4",
"name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
},
{
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
"id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
"id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "2",
+ "name": "ONLINE",
"description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
+**GET /api/1.1/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
}
- ],
+ ]
}
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/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
index c2d52d6..2430b97 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
@@ -24,46 +24,54 @@ Types
/api/1.1/types
++++++++++++++
-**GET /api/1.1/types.json**
+**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 |
+======================+========+================================================+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
|``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
|``description`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "lastUpdated": "2013-10-23 15:28:31",
- "useInTable": "staticdnsentry",
- "name": "AAAA_RECORD",
"id": "22",
- "description": "Static DNS AAAA entry"
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
}
- ],
+ ]
}
|
-**GET /api/1.1/types/trimmed.json**
+**GET /api/1.1/types/trimmed**
Authentication Required: Yes
@@ -96,3 +104,49 @@ Types
],
}
+**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/91716725/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/user.txt b/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
index 2339d10..5b06ccc 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
@@ -24,7 +24,7 @@ Users
/api/1.1/users
++++++++++++++
-**GET /api/1.1/users.json**
+**GET /api/1.1/users**
Retrieves all users.
@@ -37,70 +37,177 @@ Users
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``email`` | string | |
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+----------------------+--------+------------------------------------------------+
|``city`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
|``id`` | hash | |
+----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
|``phoneNumber`` | string | |
+----------------------+--------+------------------------------------------------+
- |``company`` | string | |
+ |``postalCode`` | string | |
+----------------------+--------+------------------------------------------------+
- |``country`` | string | |
+ |``publicSshKey`` | string | |
+----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
+ |``registrationSent`` | string | |
+----------------------+--------+------------------------------------------------+
- |``localUser`` | string | |
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+----------------------+--------+------------------------------------------------+
|``uid`` | string | |
+----------------------+--------+------------------------------------------------+
|``username`` | string | |
+----------------------+--------+------------------------------------------------+
- |``rolename`` | 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**
+
+----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+----------------------+--------+------------------------------------------------+
|``addressLine2`` | string | |
+----------------------+--------+------------------------------------------------+
- |``role`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
- |``addressLine1`` | string | |
+ |``company`` | string | |
+----------------------+--------+------------------------------------------------+
- |``postalCode`` | 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** ::
-
- [
- {
- "email": "email@email.com",
- "city": "",
- "id": "54",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Bob Simpson",
- "localUser": false,
- "uid": "0",
- "stateOrProvince": "",
- "username": "bsimpson",
- "rolename": "portal",
- "newUser": true,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "postalCode": "",
- "gid": "0"
- }
- ]
+ {
+ "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.json**
+
+**GET /api/1.1/user/current**
Retrieves the profile for the authenticated user.