blob: ecb17bce5cf2817444468cf0cfbfd157bc13f427 [file] [log] [blame]
..
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
.. http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
..
.. _to-api-v12-ds:
Delivery Service
================
.. _to-api-v12-ds-route:
/api/1.2/deliveryservices
+++++++++++++++++++++++++
**GET /api/1.2/deliveryservices**
Retrieves all delivery services (if admin or ops) or all delivery services assigned to user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
Authentication Required: Yes
Role(s) Required: None
**Request Query Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
| ``cdn`` | no | Filter delivery services by CDN ID. |
+-----------------+----------+---------------------------------------------------+
| ``profile`` | no | Filter delivery services by Profile ID. |
+-----------------+----------+---------------------------------------------------+
| ``type`` | no | Filter delivery services by Type ID. |
+-----------------+----------+---------------------------------------------------+
| ``logsEnabled`` | no | Filter by logs enabled (true|false). |
+-----------------+----------+---------------------------------------------------+
**Response Properties**
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+========+======================================================================================================================================+
| ``active`` | bool | true if active, false if inactive. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``displayName`` | string | The display name of the delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassCname`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitRedirectUrl`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimit`` | int | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
| | | |
| | | Note that this does not prevent access to content or makes content secure; it just prevents |
| | | routing to the content by Traffic Router. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitCountries`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoProvider`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
| | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| | | HTTP deliveryservices |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``id`` | int | The deliveryservice id (database row number). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``initialDispersion`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``lastUpdated`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``logsEnabled`` | bool | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc`` | string | Description field. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc1`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc2`` | string | Description field 2. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | |
| | | - e.g. 39.7391500 or null |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | |
| | | - e.g. -104.9847000 or null |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``originShield`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``protocol`` | int | - 0: serve with http:// at EDGE |
| | | - 1: serve with https:// at EDGE |
| | | - 2: serve with both http:// and https:// at EDGE |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``rangeRequestHandling`` | int | How to treat range requests: |
| | | |
| | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
| | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
| | | - 2 Use the cache_range_requests plugin. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``remapText`` | string | Additional raw remap line text. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
| | | - true: token based auth is enabled for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``sslKeyVersion`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenant`` | string | Owning tenant name |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenantId`` | int | Owning tenant ID |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trRequestHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``xmlId`` | string | Unique string that describes this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
"active": true,
"cacheurl": null,
"ccrDnsTtl": "3600",
"cdnId": "2",
"cdnName": "over-the-top",
"checkPath": "",
"displayName": "My Cool Delivery Service",
"dnsBypassCname": "",
"dnsBypassIp": "",
"dnsBypassIp6": "",
"dnsBypassTtl": "30",
"dscp": "40",
"edgeHeaderRewrite": null,
"exampleURLs": [
"http://edge.foo-ds.foo.bar.net"
],
"geoLimit": "0",
"geoLimitCountries": null,
"geoLimitRedirectURL": null,
"geoProvider": "0",
"globalMaxMbps": null,
"globalMaxTps": "0",
"httpBypassFqdn": "",
"id": "442",
"infoUrl": "",
"initialDispersion": "1",
"ipv6RoutingEnabled": true,
"lastUpdated": "2016-01-26 08:49:35",
"logsEnabled": false,
"longDesc": "",
"longDesc1": "",
"longDesc2": "",
"maxDnsAnswers": "0",
"midHeaderRewrite": null,
"missLat": "39.7391500",
"missLong": "-104.9847000",
"multiSiteOrigin": false,
"orgServerFqdn": "http://baz.boo.net",
"originShield": null,
"profileDescription": "Content Router for over-the-top",
"profileId": "5",
"profileName": "ROUTER_TOP",
"protocol": "0",
"qstringIgnore": "1",
"rangeRequestHandling": "0",
"regexRemap": null,
"regionalGeoBlocking": false,
"remapText": null,
"signed": false,
"sslKeyVersion": "0",
"tenant": "root",
"tenantId": 1,
"trRequestHeaders": null,
"trResponseHeaders": "Access-Control-Allow-Origin: *",
"type": "HTTP",
"typeId": "8",
"xmlId": "foo-ds"
}
{ .. },
{ .. }
]
}
|
**GET /api/1.2/deliveryservices/:id**
Retrieves a specific delivery service. If not admin / ops, delivery service must be assigned to user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
Authentication Required: Yes
Role(s) Required: None
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
| ``id`` | yes | Delivery service ID. |
+-----------------+----------+---------------------------------------------------+
**Response Properties**
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+========+======================================================================================================================================+
| ``active`` | bool | true if active, false if inactive. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``displayName`` | string | The display name of the delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassCname`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitRedirectUrl`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimit`` | int | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
| | | |
| | | Note that this does not prevent access to content or makes content secure; it just prevents |
| | | routing to the content by Traffic Router. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitCountries`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoProvider`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
| | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| | | HTTP deliveryservices |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``id`` | int | The deliveryservice id (database row number). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``initialDispersion`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``lastUpdated`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``logsEnabled`` | bool | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc`` | string | Description field. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc1`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc2`` | string | Description field 2. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``matchList`` | array | Array of matchList hashes. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``>>setNumber`` | string | The set Number of the matchList. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``>>pattern`` | string | The regexp for the matchList. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | |
| | | - e.g. 39.7391500 or null |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | |
| | | - e.g. -104.9847000 or null |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``originShield`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``protocol`` | int | - 0: serve with http:// at EDGE |
| | | - 1: serve with https:// at EDGE |
| | | - 2: serve with both http:// and https:// at EDGE |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``rangeRequestHandling`` | int | How to treat range requests: |
| | | |
| | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
| | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
| | | - 2 Use the cache_range_requests plugin. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``remapText`` | string | Additional raw remap line text. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
| | | - true: token based auth is enabled for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``sslKeyVersion`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenant`` | string | Owning tenant name |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenantId`` | int | Owning tenant ID |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trRequestHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``xmlId`` | string | Unique string that describes this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
"active": true,
"cacheurl": null,
"ccrDnsTtl": "3600",
"cdnId": "2",
"cdnName": "over-the-top",
"checkPath": "",
"displayName": "My Cool Delivery Service",
"dnsBypassCname": "",
"dnsBypassIp": "",
"dnsBypassIp6": "",
"dnsBypassTtl": "30",
"dscp": "40",
"edgeHeaderRewrite": null,
"exampleURLs": [
"http://edge.foo-ds.foo.bar.net"
],
"geoLimit": "0",
"geoLimitCountries": null,
"geoLimitRedirectURL": null,
"geoProvider": "0",
"globalMaxMbps": null,
"globalMaxTps": "0",
"httpBypassFqdn": "",
"id": "442",
"infoUrl": "",
"initialDispersion": "1",
"ipv6RoutingEnabled": true,
"lastUpdated": "2016-01-26 08:49:35",
"logsEnabled": false,
"longDesc": "",
"longDesc1": "",
"longDesc2": "",
"matchList": [
{
"pattern": ".*\\.foo-ds\\..*",
"setNumber": "0",
"type": "HOST_REGEXP"
}
],
"maxDnsAnswers": "0",
"midHeaderRewrite": null,
"missLat": "39.7391500",
"missLong": "-104.9847000",
"multiSiteOrigin": false,
"orgServerFqdn": "http://baz.boo.net",
"originShield": null,
"profileDescription": "Content Router for over-the-top",
"profileId": "5",
"profileName": "ROUTER_TOP",
"protocol": "0",
"qstringIgnore": "1",
"rangeRequestHandling": "0",
"regexRemap": null,
"regionalGeoBlocking": false,
"remapText": null,
"signed": false,
"sslKeyVersion": "0",
"tenant": "root",
"tenantId": 1,
"trRequestHeaders": null,
"trResponseHeaders": "Access-Control-Allow-Origin: *",
"type": "HTTP",
"typeId": "8",
"xmlId": "foo-ds"
}
]
}
|
**GET /api/1.2/deliveryservices/:id/servers**
Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.
Authentication Required: Yes
Role(s) Required: Admin or Operations or delivery service must be assigned to user.
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
| ``id`` | yes | Delivery service ID. |
+-----------------+----------+---------------------------------------------------+
**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.2/deliveryservices/:id/servers/unassigned**
Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.
Authentication Required: Yes
Role(s) Required: Admin or Operations or delivery service must be assigned to user
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
| ``id`` | yes | Delivery service ID. |
+-----------------+----------+---------------------------------------------------+
**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.2/deliveryservices/:id/servers/eligible**
Retrieves properties of CDN EDGE or ORG servers not eligible for assignment to a delivery service.
Authentication Required: Yes
Role(s) Required: Admin or Operations or delivery service must be assigned to user
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
| ``id`` | yes | Delivery service ID. |
+-----------------+----------+---------------------------------------------------+
**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
}
]
}
|
.. _to-api-v12-ds-health:
Health
++++++
**GET /api/1.2/deliveryservices/:id/state**
Retrieves the failover state for a delivery service. Delivery service must be assigned to user if user is not admin or operations.
Authentication Required: Yes
Role(s) Required: None
**Response Properties**
+------------------+---------+-------------------------------------------------+
| Parameter | Type | Description |
+==================+=========+=================================================+
| ``failover`` | hash | |
+------------------+---------+-------------------------------------------------+
| ``>locations`` | array | |
+------------------+---------+-------------------------------------------------+
| ``>destination`` | hash | |
+------------------+---------+-------------------------------------------------+
| ``>>location`` | string | |
+------------------+---------+-------------------------------------------------+
| ``>>type`` | string | |
+------------------+---------+-------------------------------------------------+
| ``>configured`` | boolean | |
+------------------+---------+-------------------------------------------------+
| ``>enabled`` | boolean | |
+------------------+---------+-------------------------------------------------+
| ``enabled`` | boolean | |
+------------------+---------+-------------------------------------------------+
**Response Example** ::
{
"response": {
"failover": {
"locations": [ ],
"destination": {
"location": null,
"type": "DNS",
},
"configured": false,
"enabled": false
},
"enabled": true
}
}
|
**GET /api/1.2/deliveryservices/:id/health**
Retrieves the health of all locations (cache groups) for a delivery service. Delivery service must be assigned to user if user is not admin or operations.
Authentication Required: Yes
Role(s) Required: None
**Response Properties**
+------------------+--------+-------------------------------------------------+
| Parameter | Type | Description |
+==================+========+=================================================+
| ``totalOnline`` | int | Total number of online caches across all CDNs. |
+------------------+--------+-------------------------------------------------+
| ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+------------------+--------+-------------------------------------------------+
| ``cachegroups`` | array | A collection of cache groups. |
+------------------+--------+-------------------------------------------------+
| ``>online`` | int | The number of online caches for the cache group |
+------------------+--------+-------------------------------------------------+
| ``>offline`` | int | The number of offline caches for the cache |
| | | group. |
+------------------+--------+-------------------------------------------------+
| ``>name`` | string | Cache group name. |
+------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": {
"totalOnline": 148,
"totalOffline": 0,
"cachegroups": [
{
"online": 8,
"offline": 0,
"name": "us-co-denver"
},
{
"online": 7,
"offline": 0,
"name": "us-de-newcastle"
}
]
}
}
|
**GET /api/1.2/deliveryservices/:id/capacity**
Retrieves the capacity percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.
Authentication Required: Yes
Role(s) Required: None
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
|id | yes | delivery service id. |
+-----------------+----------+---------------------------------------------------+
**Response Properties**
+------------------------+--------+---------------------------------------------------+
| Parameter | Type | Description |
+========================+========+===================================================+
| ``availablePercent`` | number | The percentage of server capacity assigned to |
| | | the delivery service that is available. |
+------------------------+--------+---------------------------------------------------+
| ``unavailablePercent`` | number | The percentage of server capacity assigned to the |
| | | delivery service that is unavailable. |
+------------------------+--------+---------------------------------------------------+
| ``utilizedPercent`` | number | The percentage of server capacity assigned to the |
| | | delivery service being used. |
+------------------------+--------+---------------------------------------------------+
| ``maintenancePercent`` | number | The percentage of server capacity assigned to the |
| | | delivery service that is down for maintenance. |
+------------------------+--------+---------------------------------------------------+
**Response Example** ::
{
"response": {
"availablePercent": 89.0939840205533,
"unavailablePercent": 0,
"utilizedPercent": 10.9060020300395,
"maintenancePercent": 0.0000139494071146245
},
}
|
**GET /api/1.2/deliveryservices/:id/routing**
Retrieves the routing method percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.
Authentication Required: Yes
Role(s) Required: None
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
|id | yes | delivery service id. |
+-----------------+----------+---------------------------------------------------+
**Response Properties**
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+========+=============================================================================================================================+
| ``staticRoute`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``miss`` | number | The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP). |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``geo`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``err`` | number | The percentage of Traffic Router requests for this deliveryservice resulting in an error. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``cz`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``dsr`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the |
| | | client to the overflow CDN. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``fed`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``regionalAlternate`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate |
| | | regional geoblocking URL. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| ``regionalDenied`` | number | The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy. |
+--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": {
"staticRoute": 0,
"miss": 0,
"geo": 37.8855391018869,
"err": 0,
"cz": 62.1144608981131,
"dsr": 0,
"fed": 0,
"regionalAlternate": 0,
"regionalDenied": 0
},
}
.. _to-api-v12-ds-server:
Delivery Service Server
+++++++++++++++++++++++
**GET /api/1.2/deliveryserviceserver**
Retrieves delivery service / server assignments.
Authentication Required: Yes
Role(s) Required: None
**Request Query Parameters**
+-----------+----------+----------------------------------------+
| Name | Required | Description |
+===========+==========+========================================+
| ``page`` | no | The page number for use in pagination. |
+-----------+----------+----------------------------------------+
| ``limit`` | no | For use in limiting the result set. |
+-----------+----------+----------------------------------------+
**Response Properties**
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
|``lastUpdated`` | array | |
+----------------------+--------+------------------------------------------------+
|``server`` | string | |
+----------------------+--------+------------------------------------------------+
|``deliveryService`` | string | |
+----------------------+--------+------------------------------------------------+
**Response Example** ::
{
"page": 2,
"orderby": "deliveryservice",
"response": [
{
"lastUpdated": "2014-09-26 17:53:43",
"server": "20",
"deliveryService": "1"
},
{
"lastUpdated": "2014-09-26 17:53:44",
"server": "21",
"deliveryService": "1"
},
],
"limit": 2
}
**POST /api/1.2/deliveryserviceserver**
Create one or more delivery service / server assignments.
Authentication Required: Yes
Role(s) Required: Admin or Operations or the delivery service is assigned to the user.
**Request Parameters**
+---------------------------------+----------+-------------------------------------------------------------------+
| Name | Required | Description |
+=================================+==========+===================================================================+
| ``dsId`` | yes | The ID of the delivery service. |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``servers`` | yes | An array of server IDs. |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``replace`` | no | Replace existing ds/server assignments? (true|false) |
+---------------------------------+----------+-------------------------------------------------------------------+
**Request Example** ::
{
"dsId": 246,
"servers": [ 2, 3, 4, 5, 6 ],
"replace": true
}
**Response Properties**
+------------------------------------+--------+-------------------------------------------------------------------+
| Parameter | Type | Description |
+====================================+========+===================================================================+
| ``dsId`` | int | The ID of the delivery service. |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``servers`` | array | An array of server IDs. |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``replace`` | array | Existing ds/server assignments replaced? (true|false). |
+------------------------------------+--------+-------------------------------------------------------------------+
**Response Example** ::
{
"alerts": [
{
"level": "success",
"text": "Server assignments complete."
}
],
"response": {
"dsId" : 246,
"servers" : [ 2, 3, 4, 5, 6 ],
"replace" : true
}
}
|
**DELETE /api/1.2/deliveryservice_server/:dsId/:serverId**
Removes a server (cache) from a delivery service.
Authentication Required: Yes
Role(s) Required: Admin or Oper (if delivery service is not assigned to user)
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
| ``dsId`` | yes | Delivery service ID. |
+-----------------+----------+---------------------------------------------------+
| ``serverId`` | yes | Server (cache) ID. |
+-----------------+----------+---------------------------------------------------+
**Response Example** ::
{
"alerts": [
{
"level": "success",
"text": "Server unlinked from delivery service."
}
],
}
|
.. _to-api-v12-ds-user:
Delivery Service User
+++++++++++++++++++++
**POST /api/1.2/deliveryservice_user**
Create one or more user / delivery service assignments.
Authentication Required: Yes
Role(s) Required: Admin or Operations
**Request Parameters**
+---------------------------------+----------+-------------------------------------------------------------------+
| Name | Required | Description |
+=================================+==========+===================================================================+
| ``userId`` | yes | The ID of the user. |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``deliveryServices`` | yes | An array of delivery service IDs. |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``replace`` | no | Replace existing user/ds assignments? (true|false). |
+---------------------------------+----------+-------------------------------------------------------------------+
**Request Example** ::
{
"userId": 50,
"deliveryServices": [ 23, 34, 45, 56, 67 ],
"replace": true
}
**Response Properties**
+------------------------------------+--------+-------------------------------------------------------------------+
| Parameter | Type | Description |
+====================================+========+===================================================================+
| ``userId`` | int | The ID of the user. |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``deliveryServices`` | array | An array of delivery service IDs. |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``replace`` | array | Existing user/ds assignments replaced? (true|false). |
+------------------------------------+--------+-------------------------------------------------------------------+
**Response Example** ::
{
"alerts": [
{
"level": "success",
"text": "Delivery service assignments complete."
}
],
"response": {
"userId" : 50,
"deliveryServices": [ 23, 34, 45, 56, 67 ],
"replace": true
}
}
|
**DELETE /api/1.2/deliveryservice_user/:dsId/:userId**
Removes a delivery service from a user.
Authentication Required: Yes
Role(s) Required: Admin or Operations
**Request Route Parameters**
+-----------------+----------+---------------------------------------------------+
| Name | Required | Description |
+=================+==========+===================================================+
| ``dsId`` | yes | Delivery service ID. |
+-----------------+----------+---------------------------------------------------+
| ``userId`` | yes | User ID. |
+-----------------+----------+---------------------------------------------------+
**Response Example** ::
{
"alerts": [
{
"level": "success",
"text": "User and delivery service were unlinked."
}
],
}
|
.. _to-api-v12-ds-sslkeys:
SSL Keys
+++++++++
**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys**
Retrieves ssl keys for a delivery service.
Authentication Required: Yes
Role(s) Required: Admin
**Request Route Parameters**
+-----------+----------+----------------------------------------+
| Name | Required | Description |
+===========+==========+========================================+
| ``xmlId`` | yes | xml_id of the desired delivery service |
+-----------+----------+----------------------------------------+
**Request Query Parameters**
+-------------+----------+--------------------------------+
| Name | Required | Description |
+=============+==========+================================+
| ``version`` | no | The version number to retrieve |
+-------------+----------+--------------------------------+
**Response Properties**
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=====================+========+=========================================================================================================================================+
| ``crt`` | string | base64 encoded crt file for delivery service |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``csr`` | string | base64 encoded csr file for delivery service |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``key`` | string | base64 encoded private key file for delivery service |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``cdn`` | string | The CDN of the delivery service for which the certs were generated. |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``deliveryservice`` | string | The XML ID of the delivery service for which the cert was generated. |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``hostname`` | string | The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
| | | This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services. |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``version`` | string | The version of the certificate record in Riak |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": {
"certificate": {
"crt": "crt",
"key": "key",
"csr": "csr"
},
"deliveryservice": "my-ds",
"cdn": "qa",
"businessUnit": "CDN_Eng",
"city": "Denver",
"organization": "KableTown",
"hostname": "foober.com",
"country": "US",
"state": "Colorado",
"version": "1"
}
}
|
**GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys**
Authentication Required: Yes
Role(s) Required: Admin
**Request Route Parameters**
+--------------+----------+---------------------------------------------------+
| Name | Required | Description |
+==============+==========+===================================================+
| ``hostname`` | yes | pristine hostname of the desired delivery service |
+--------------+----------+---------------------------------------------------+
**Request Query Parameters**
+-------------+----------+--------------------------------+
| Name | Required | Description |
+=============+==========+================================+
| ``version`` | no | The version number to retrieve |
+-------------+----------+--------------------------------+
**Response Properties**
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=====================+========+=========================================================================================================================================+
| ``crt`` | string | base64 encoded crt file for delivery service |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``csr`` | string | base64 encoded csr file for delivery service |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``key`` | string | base64 encoded private key file for delivery service |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``cdn`` | string | The CDN of the delivery service for which the certs were generated. |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``deliveryservice`` | string | The XML ID of the delivery service for which the cert was generated. |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``hostname`` | string | The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
| | | This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services. |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
| ``version`` | string | The version of the certificate record in Riak |
+---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": {
"certificate": {
"crt": "crt",
"key": "key",
"csr": "csr"
},
"deliveryservice": "my-ds",
"cdn": "qa",
"businessUnit": "CDN_Eng",
"city": "Denver",
"organization": "KableTown",
"hostname": "foober.com",
"country": "US",
"state": "Colorado",
"version": "1"
}
}
|
**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete**
Authentication Required: Yes
Role Required: Admin
**Request Route Parameters**
+-----------+----------+----------------------------------------+
| Name | Required | Description |
+===========+==========+========================================+
| ``xmlId`` | yes | xml_id of the desired delivery service |
+-----------+----------+----------------------------------------+
**Request Query Parameters**
+-------------+----------+--------------------------------+
| Name | Required | Description |
+=============+==========+================================+
| ``version`` | no | The version number to retrieve |
+-------------+----------+--------------------------------+
**Response Properties**
+--------------+--------+------------------+
| Parameter | Type | Description |
+==============+========+==================+
| ``response`` | string | success response |
+--------------+--------+------------------+
**Response Example** ::
{
"response": "Successfully deleted ssl keys for <xml_id>"
}
|
**POST /api/1.2/deliveryservices/sslkeys/generate**
Generates SSL crt, csr, and private key for a delivery service
Authentication Required: Yes
Role(s) Required: Admin
**Request Properties**
+--------------+---------+-------------------------------------------------+
| Parameter | Type | Description |
+==============+=========+=================================================+
| ``key`` | string | xml_id of the delivery service |
+--------------+---------+-------------------------------------------------+
| ``version`` | string | version of the keys being generated |
+--------------+---------+-------------------------------------------------+
| ``hostname`` | string | the *pristine hostname* of the delivery service |
+--------------+---------+-------------------------------------------------+
| ``country`` | string | |
+--------------+---------+-------------------------------------------------+
| ``state`` | string | |
+--------------+---------+-------------------------------------------------+
| ``city`` | string | |
+--------------+---------+-------------------------------------------------+
| ``org`` | string | |
+--------------+---------+-------------------------------------------------+
| ``unit`` | boolean | |
+--------------+---------+-------------------------------------------------+
**Request Example** ::
{
"key": "ds-01",
"businessUnit": "CDN Engineering",
"version": "3",
"hostname": "tr.ds-01.ott.kabletown.com",
"certificate": {
"key": "some_key",
"csr": "some_csr",
"crt": "some_crt"
},
"country": "US",
"organization": "Kabletown",
"city": "Denver",
"state": "Colorado"
}
|
**Response Properties**
+--------------+--------+-----------------+
| Parameter | Type | Description |
+==============+========+=================+
| ``response`` | string | response string |
+--------------+--------+-----------------+
| ``version`` | string | API version |
+--------------+--------+-----------------+
**Response Example** ::
{
"response": "Successfully created ssl keys for ds-01"
}
|
**POST /api/1.2/deliveryservices/sslkeys/add**
Allows user to add SSL crt, csr, and private key for a delivery service.
Authentication Required: Yes
Role(s) Required: Admin
**Request Properties**
+-------------+--------+-------------------------------------+
| Parameter | Type | Description |
+=============+========+=====================================+
| ``key`` | string | xml_id of the delivery service |
+-------------+--------+-------------------------------------+
| ``version`` | string | version of the keys being generated |
+-------------+--------+-------------------------------------+
| ``csr`` | string | |
+-------------+--------+-------------------------------------+
| ``crt`` | string | |
+-------------+--------+-------------------------------------+
| ``key`` | string | |
+-------------+--------+-------------------------------------+
**Request Example** ::
{
"key": "ds-01",
"version": "1",
"certificate": {
"key": "some_key",
"csr": "some_csr",
"crt": "some_crt"
}
}
|
**Response Properties**
+--------------+--------+-----------------+
| Parameter | Type | Description |
+==============+========+=================+
| ``response`` | string | response string |
+--------------+--------+-----------------+
| ``version`` | string | API version |
+--------------+--------+-----------------+
**Response Example** ::
{
"response": "Successfully added ssl keys for ds-01"
}
**POST /api/1.2/deliveryservices/request**
Allows a user to send delivery service request details to a specified email address.
Authentication Required: Yes
Role(s) Required: None
**Request Properties**
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| Parameter | Type | Required | Description |
+========================================+========+==========+=============================================================================================+
| ``emailTo`` | string | yes | The email to which the delivery service request will be sent. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``details`` | hash | yes | Parameters for the delivery service request. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>customer`` | string | yes | Name of the customer to associated with the delivery service. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>deliveryProtocol`` | string | yes | Eg. http or http/https |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>routingType`` | string | yes | Eg. DNS or HTTP Redirect |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>serviceDesc`` | string | yes | A description of the delivery service. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>peakBPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>peakTPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>maxLibrarySizeEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>originURL`` | string | yes | The URL path to the origin server. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>hasOriginDynamicRemap`` | bool | yes | This is a feature which allows services to use multiple origin URLs for the same service. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>originTestFile`` | string | yes | A URL path to a test file available on the origin server. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>hasOriginACLWhitelist`` | bool | yes | Is access to your origin restricted using an access control list (ACL or whitelist) of Ips? |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>originHeaders`` | string | no | Header values that must be passed to requests to your origin. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>otherOriginSecurity`` | string | no | Other origin security measures that need to be considered for access. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>queryStringHandling`` | string | yes | How to handle query strings that come with the request. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>rangeRequestHandling`` | string | yes | How to handle range requests. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>hasSignedURLs`` | bool | yes | Are Urls signed? |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>hasNegativeCachingCustomization`` | bool | yes | Any customization required for negative caching? |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>negativeCachingCustomizationNote`` | string | yes | Negative caching customization instructions. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>serviceAliases`` | array | no | Service aliases which will be used for this service. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>rateLimitingGBPS`` | int | no | Rate Limiting - Bandwidth (Gbps) |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>rateLimitingTPS`` | int | no | Rate Limiting - Transactions/Second |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>overflowService`` | string | no | An overflow point (URL or IP address) used if rate limits are met. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>headerRewriteEdge`` | string | no | Headers can be added or altered at each layer of the CDN. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>headerRewriteMid`` | string | no | Headers can be added or altered at each layer of the CDN. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>headerRewriteRedirectRouter`` | string | no | Headers can be added or altered at each layer of the CDN. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
| ``>notes`` | string | no | Additional instructions to provide the delivery service provisioning team. |
+----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
**Request Example** ::
{
"emailTo": "foo@bar.com",
"details": {
"customer": "XYZ Corporation",
"contentType": "video-on-demand",
"deliveryProtocol": "http",
"routingType": "dns",
"serviceDesc": "service description goes here",
"peakBPSEstimate": "less-than-5-Gbps",
"peakTPSEstimate": "less-than-1000-TPS",
"maxLibrarySizeEstimate": "less-than-200-GB",
"originURL": "http://myorigin.com",
"hasOriginDynamicRemap": false,
"originTestFile": "http://myorigin.com/crossdomain.xml",
"hasOriginACLWhitelist": true,
"originHeaders": "",
"otherOriginSecurity": "",
"queryStringHandling": "ignore-in-cache-key-and-pass-up",
"rangeRequestHandling": "range-requests-not-used",
"hasSignedURLs": true,
"hasNegativeCachingCustomization": true,
"negativeCachingCustomizationNote": "negative caching instructions",
"serviceAliases": [
"http://alias1.com",
"http://alias2.com"
],
"rateLimitingGBPS": 50,
"rateLimitingTPS": 5000,
"overflowService": "http://overflowcdn.com",
"headerRewriteEdge": "",
"headerRewriteMid": "",
"headerRewriteRedirectRouter": "",
"notes": ""
}
}
|
**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": "Delivery Service request sent to foo@bar.com."
}
]
}
|
**POST /api/1.2/deliveryservices**
Allows user to create a delivery service.
Authentication Required: Yes
Role(s) Required: admin or oper
**Request Properties**
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| Parameter | Required | Description |
+========================+==========+=========================================================================================================+
| active | yes | true if active, false if inactive. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| tenantId | No | Owning tenant ID |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| cacheurl | no | Cache URL rule to apply to this delivery service. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| cdnId | yes | cdn id |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| checkPath | no | The path portion of the URL to check this deliveryservice for health. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| displayName | yes | Display name |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| dnsBypassCname | no | Bypass CNAME |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| dnsBypassIp6 | no | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| dnsBypassTtl | no | The TTL of the DNS bypass response. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| dscp | yes | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoLimit | yes | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from geo limit countries |
| | | |
| | | Note that this does not prevent access to content or makes content secure; it just prevents |
| | | routing to the content by Traffic Router. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoLimitCountries | no | The geo limit countries. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoProvider | yes | - 0: Maxmind(default) |
| | | - 1: Neustar |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| globalMaxMbps | no | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| globalMaxTps | no | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
| | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| | | HTTP deliveryservices |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| httpBypassFqdn | no | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more |
| | | than the globalMaxMbps traffic on this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| initialDispersion | yes | Initial dispersion |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| ipv6RoutingEnabled | yes | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| logsEnabled | yes | - false: No |
| | | - true: Yes |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc | no | Description field. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc1 | no | Description field 1. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc2 | no | Description field 2. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| midHeaderRewrite | no | The MID header rewrite actions to perform. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| missLat | no | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | |
| | | - e.g. 39.7391500 or null |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| missLong | no | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | |
| | | - e.g. -104.9847000 or null |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| multiSiteOrigin | yes | 1 if enabled, 0 if disabled. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| orgServerFqdn | yes|no | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. This field is |
| | | NOT required if type is ANY_MAP, STEERING OR CLIENT_STEERING. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| originShield | no | Origin shield |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| profileId | no | DS profile ID |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| protocol | yes | - 0: serve with http:// at EDGE |
| | | - 1: serve with https:// at EDGE |
| | | - 2: serve with both http:// and https:// at EDGE |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| qstringIgnore | yes | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| rangeRequestHandling | yes | How to treat range requests: |
| | | |
| | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
| | | be a HIT) |
| | | - 1 Use the background_fetch plugin. |
| | | - 2 Use the cache_range_requests plugin. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| regionalGeoBlocking | no | Is the Regional Geo Blocking feature enabled for this delivery service. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| remapText | no | Additional raw remap line text. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
| | | - true: token based auth is enabled for this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| sslKeyVersion | no | SSL key version |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| trRequestHeaders | no | Traffic router log request headers |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| trResponseHeaders | no | Traffic router additional response headers |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| typeId | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| xmlId | yes | Unique string that describes this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
**Request Example** ::
{
"xmlId": "my_ds_1",
"displayName": "my_ds_displayname_1",
"tenantId": 1,
"protocol": 1,
"orgServerFqdn": "http://10.75.168.91",
"cdnId": 2,
"typeId": 42,
"active": false,
"dscp": 10,
"geoLimit": 0,
"geoProvider": 0,
"initialDispersion": 1,
"ipv6RoutingEnabled": false,
"logsEnabled": false,
"multiSiteOrigin": false,
"missLat": 39.7391500,
"missLong": -104.9847000,
"qstringIgnore": 0,
"rangeRequestHandling": 0,
"regionalGeoBlocking": false,
"signed": false
}
**Response Properties<