You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by gi...@apache.org on 2017/04/05 15:01:26 UTC
[39/51] [partial] incubator-trafficcontrol-website git commit: Update
docs from commit 5735b8d2e79b50f9bdd0302578dac0d76bab252e
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0672d6e1/docs/2.0.x/html/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt
----------------------------------------------------------------------
diff --git a/docs/2.0.x/html/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt b/docs/2.0.x/html/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt
new file mode 100644
index 0000000..9e81b92
--- /dev/null
+++ b/docs/2.0.x/html/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt
@@ -0,0 +1,1942 @@
+..
+..
+.. 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. 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. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``type`` | no | Filter delivery services by Type 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`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | 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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 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`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | 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`` | string | 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`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>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`` | string | 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`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | 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`` | string | 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`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 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`` | string | 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`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | 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,
+ "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": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "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",
+ "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. 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`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | 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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | 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`` | string | - 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`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | 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`` | string | 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`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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`` | string | 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`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | 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`` | string | 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`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 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`` | string | 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`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | 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": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "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",
+ "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 servers assigned to a 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 |
+ +====================+========+============================================================================================================+
+ | ``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.
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 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:
+
+Server
+++++++
+
+**GET /api/1.2/deliveryserviceserver**
+
+ 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
+ }
+
+
+
+.. _to-api-v12-ds-sslkeys:
+
+SSL Keys
++++++++++
+
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys**
+
+ 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": {
+
<TRUNCATED>