`deliveryservices`

`GET`

Retrieves :term:`Delivery Services`

Auth. Required:	Yes
Roles Required:	None[1]
Response Type:	Array

Request Structure

Request Query Parameters

Name	Required	Description
cdn	no	Show only the :term:`Delivery Services` belonging to the :ref:`ds-cdn` identified by this integral, unique identifier
id	no	Show only the :term:`Delivery Service` that has this integral, unique identifier
logsEnabled	no	Show only the :term:`Delivery Services` that have :ref:`ds-logs-enabled` set or not based on this boolean
profile	no	Return only :term:`Delivery Services` using the :term:`Profile` that has this :ref:`profile-id`
tenant	no	Show only the :term:`Delivery Services` belonging to the :term:`Tenant` identified by this integral, unique identifier
topology	no	Show only the :term:`Delivery Services` assigned to the :term:`Topology` identified by this unique name
type	no	Return only :term:`Delivery Services` of the :term:`Delivery Service` :ref:`ds-types` identified by this integral, unique identifier
accessibleTo	no	Return the :term:`Delivery Services` accessible from a :term:`Tenant` or it's children identified by this integral, unique identifier
serviceCategory	no	Show only the :term:`Delivery Services` belonging to the :term:`Service Category` that has this name
xmlId	no	Show only the :term:`Delivery Service` that has this text-based, unique identifier
orderby	no	Choose the ordering of the results - must be the name of one of the fields of the objects in the `response` array
sortOrder	no	Changes the order of sorting. Either ascending (default or "asc") or descending ("desc")
limit	no	Choose the maximum number of results to return
offset	no	The number of results to skip before beginning to return results. Must use in conjunction with limit
page	no	Return the n^th page of results, where "n" is the value of this parameter, pages are `limit` long and the first page is 1. If `offset` was defined, this query parameter has no effect. `limit` must be defined to make use of `page`.
active	no	Show only the :term:`Delivery Services` that have :ref:`ds-active` set or not based on this boolean (whether or not they are active)

Response Structure

active:

A boolean that defines :ref:`ds-active`.

anonymousBlockingEnabled:

A boolean that defines :ref:`ds-anonymous-blocking`

cacheurl:

A :ref:`ds-cacheurl`

.. deprecated:: ATCv3.0
        This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later

ccrDnsTtl:

The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons

cdnId:

The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs

cdnName:

Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs

checkPath:

A :ref:`ds-check-path`

consistentHashRegex:

A :ref:`ds-consistent-hashing-regex`

consistentHashQueryParams:

An array of :ref:`ds-consistent-hashing-qparams`

deepCachingType:

The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`

displayName:

The :ref:`ds-display-name`

dnsBypassCname:

A :ref:`ds-dns-bypass-cname`

dnsBypassIp:

A :ref:`ds-dns-bypass-ip`

dnsBypassIp6:

A :ref:`ds-dns-bypass-ipv6`

dnsBypassTtl:

The :ref:`ds-dns-bypass-ttl`

dscp:

A :ref:`ds-dscp` to be used within the :term:`Delivery Service`

ecsEnabled:

A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`

edgeHeaderRewrite:

A set of :ref:`ds-edge-header-rw-rules`

exampleURLs:

An array of :ref:`ds-example-urls`

firstHeaderRewrite:

A set of :ref:`ds-first-header-rw-rules`

fqPacingRate:

The :ref:`ds-fqpr`

geoLimit:

An integer that defines the :ref:`ds-geo-limit`

geoLimitCountries:

A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`

geoLimitRedirectUrl:

A :ref:`ds-geo-limit-redirect-url`

geoProvider:

The :ref:`ds-geo-provider`

globalMaxMbps:

The :ref:`ds-global-max-mbps`

globalMaxTps:

The :ref:`ds-global-max-tps`

httpBypassFqdn:

A :ref:`ds-http-bypass-fqdn`

id:

An integral, unique identifier for this :term:`Delivery Service`

infoUrl:

An :ref:`ds-info-url`

initialDispersion:

The :ref:`ds-initial-dispersion`

innerHeaderRewrite:

A set of :ref:`ds-inner-header-rw-rules`

ipv6RoutingEnabled:

A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`

lastHeaderRewrite:

A set of :ref:`ds-last-header-rw-rules`

lastUpdated:

The date and time at which this :term:`Delivery Service` was last updated, in :ref:`non-rfc-datetime`

logsEnabled:

A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`

longDesc:

The :ref:`ds-longdesc` of this :term:`Delivery Service`

longDesc1:

The 2nd long description of this :term:`Delivery Service`

longDesc2:

the 3rd long description of this :term:`Delivery Service`

matchList:

The :term:`Delivery Service`'s :ref:`ds-matchlist`

pattern:	A regular expression - the use of this pattern is dependent on the `type` field (backslashes are escaped)
setNumber:	An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
type:	The type of match performed using `pattern`.

maxDnsAnswers:

The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`

maxOriginConnections:

The :ref:`ds-max-origin-connections`

maxRequestHeaderBytes:

The :ref:`ds-max-request-header-bytes`

midHeaderRewrite:

A set of :ref:`ds-mid-header-rw-rules`

missLat:

The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`

missLong:

The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`

multiSiteOrigin:

A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`

orgServerFqdn:

The :ref:`ds-origin-url`

originShield:

A :ref:`ds-origin-shield` string

profileDescription:

The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated

profileId:

The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated

profileName:

The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated

protocol:

An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`

qstringIgnore:

An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`

rangeRequestHandling:

An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`

regexRemap:

A :ref:`ds-regex-remap`

regionalGeoBlocking:

A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`

remapText:

:ref:`ds-raw-remap`

serviceCategory:

The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated

signed:

true if and only if signingAlgorithm is not null, false otherwise

signingAlgorithm:

Either a :ref:`ds-signing-algorithm` or null to indicate URL/URI signing is not implemented on this :term:`Delivery Service`

rangeSliceBlockSize:

An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if rangeRequestHandling is set to 3.

sslKeyVersion:

This integer indicates the :ref:`ds-ssl-key-version`

tenantId:

The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`

topology:

The unique name of the :term:`Topology` that this :term:`Delivery Service` is assigned to

trRequestHeaders:

If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`

trResponseHeaders:

If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`

type:

The :ref:`ds-types` of this :term:`Delivery Service`

typeId:

The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`

xmlId:

This :term:`Delivery Service`'s :ref:`ds-xmlid`

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: mCLMjvACRKHNGP/OSx4javkOtxxzyiDdQzsV78IamUhVmvyKyKaCeOKRmpsG69w+nhh3OkPZ6e9MMeJpcJSKcA==
X-Server-Name: traffic_ops_golang/
Date: Thu, 15 Nov 2018 19:04:29 GMT
Transfer-Encoding: chunked

{ "response": [{
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": null,
        "cdnId": 2,
        "cdnName": "CDN-in-a-Box",
        "checkPath": null,
        "displayName": "Demo 1",
        "dnsBypassCname": null,
        "dnsBypassIp": null,
        "dnsBypassIp6": null,
        "dnsBypassTtl": null,
        "dscp": 0,
        "edgeHeaderRewrite": null,
        "firstHeaderRewrite": null,
        "geoLimit": 0,
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": 0,
        "globalMaxMbps": null,
        "globalMaxTps": null,
        "httpBypassFqdn": null,
        "id": 1,
        "infoUrl": null,
        "initialDispersion": 1,
        "innerHeaderRewrite": null,
        "ipv6RoutingEnabled": true,
        "lastHeaderRewrite": null,
        "lastUpdated": "2019-05-15 14:32:05+00",
        "logsEnabled": true,
        "longDesc": "Apachecon North America 2018",
        "longDesc1": null,
        "longDesc2": null,
        "matchList": [
                {
                        "type": "HOST_REGEXP",
                        "setNumber": 0,
                        "pattern": ".*\\.demo1\\..*"
                }
        ],
        "maxDnsAnswers": null,
        "midHeaderRewrite": null,
        "missLat": 42,
        "missLong": -88,
        "multiSiteOrigin": false,
        "originShield": null,
        "orgServerFqdn": "http://origin.infra.ciab.test",
        "profileDescription": null,
        "profileId": null,
        "profileName": null,
        "protocol": 2,
        "qstringIgnore": 0,
        "rangeRequestHandling": 0,
        "regexRemap": null,
        "regionalGeoBlocking": false,
        "remapText": null,
        "routingName": "video",
        "signed": false,
        "sslKeyVersion": null,
        "tenantId": 1,
        "type": "HTTP",
        "typeId": 1,
        "xmlId": "demo1",
        "exampleURLs": [
                "http://video.demo1.mycdn.ciab.test",
                "https://video.demo1.mycdn.ciab.test"
        ],
        "deepCachingType": "NEVER",
        "fqPacingRate": null,
        "signingAlgorithm": null,
        "tenant": "root",
        "trResponseHeaders": null,
        "trRequestHeaders": null,
        "consistentHashRegex": null,
        "consistentHashQueryParams": [
                "abc",
                "pdq",
                "xxx",
                "zyx"
        ],
        "maxOriginConnections": 0,
        "maxRequestHeaderBytes": 131072,
        "ecsEnabled": false,
        "rangeSliceBlockSize": null,
        "topology": null
        "serviceCategory": null
}]}

`POST`

Allows users to create :term:`Delivery Service`.

Auth. Required:	Yes
Roles Required:	"admin" or "operations"[1]
Response Type:	Array

Request Structure

active:	A boolean that defines :ref:`ds-active`.
anonymousBlockingEnabled:	A boolean that defines :ref:`ds-anonymous-blocking`
cacheurl:	A :ref:`ds-cacheurl` .. deprecated:: ATCv3.0 This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
ccrDnsTtl:	The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
cdnId:	The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
checkPath:	A :ref:`ds-check-path`
consistentHashRegex:	A :ref:`ds-consistent-hashing-regex`
consistentHashQueryParams:	An array of :ref:`ds-consistent-hashing-qparams`
deepCachingType:	The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
displayName:	The :ref:`ds-display-name`
dnsBypassCname:	A :ref:`ds-dns-bypass-cname`
dnsBypassIp:	A :ref:`ds-dns-bypass-ip`
dnsBypassIp6:	A :ref:`ds-dns-bypass-ipv6`
dnsBypassTtl:	The :ref:`ds-dns-bypass-ttl`
dscp:	A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
ecsEnabled:	A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
edgeHeaderRewrite:	A set of :ref:`ds-edge-header-rw-rules`
firstHeaderRewrite:	A set of :ref:`ds-first-header-rw-rules`
fqPacingRate:	The :ref:`ds-fqpr`
geoLimit:	An integer that defines the :ref:`ds-geo-limit`
geoLimitCountries:	A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`[2]
geoLimitRedirectUrl:	A :ref:`ds-geo-limit-redirect-url`[2]
geoProvider:	The :ref:`ds-geo-provider`
globalMaxMbps:	The :ref:`ds-global-max-mbps`
globalMaxTps:	The :ref:`ds-global-max-tps`
httpBypassFqdn:	A :ref:`ds-http-bypass-fqdn`
infoUrl:	An :ref:`ds-info-url`
initialDispersion:	The :ref:`ds-initial-dispersion`
innerHeaderRewrite:	A set of :ref:`ds-inner-header-rw-rules`
ipv6RoutingEnabled:	A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
lastHeaderRewrite:	A set of :ref:`ds-last-header-rw-rules`
logsEnabled:	A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
longDesc:	The :ref:`ds-longdesc` of this :term:`Delivery Service`
longDesc1:	An optional field containing the 2nd long description of this :term:`Delivery Service`
longDesc2:	An optional field containing the 3rd long description of this :term:`Delivery Service`
maxDnsAnswers:	The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
maxOriginConnections:	The :ref:`ds-max-origin-connections`
maxRequestHeaderBytes:	The :ref:`ds-max-request-header-bytes`
midHeaderRewrite:	A set of :ref:`ds-mid-header-rw-rules`
missLat:	The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`
missLong:	The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`
multiSiteOrigin:	A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
orgServerFqdn:	The :ref:`ds-origin-url`
originShield:	A :ref:`ds-origin-shield` string
profileId:	An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be associated
protocol:	An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
qstringIgnore:	An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
rangeRequestHandling:	An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
regexRemap:	A :ref:`ds-regex-remap`
regionalGeoBlocking:	A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
remapText:	:ref:`ds-raw-remap`
serviceCategory:	The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated - or `null` if there is to be no such category
signed:	`true` if and only if `signingAlgorithm` is not `null`, `false` otherwise
signingAlgorithm:	Either a :ref:`ds-signing-algorithm` or `null` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
rangeSliceBlockSize:	An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if `rangeRequestHandling` is set to 3. It can only be between (inclusive) 262144 (256KB) - 33554432 (32MB).
sslKeyVersion:	This integer indicates the :ref:`ds-ssl-key-version`
tenantId:	The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`
topology:	The unique name of the :term:`Topology` that this :term:`Delivery Service` is assigned to
trRequestHeaders:	If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
trResponseHeaders:	If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
type:	The :ref:`ds-types` of this :term:`Delivery Service`
typeId:	The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
xmlId:	This :term:`Delivery Service`'s :ref:`ds-xmlid`

POST /api/3.0/deliveryservices HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 761
Content-Type: application/json

{
        "active": false,
        "anonymousBlockingEnabled": false,
        "cdnId": 2,
        "deepCachingType": "NEVER",
        "displayName": "test",
        "dscp": 0,
        "ecsEnabled": true,
        "geoLimit": 0,
        "geoProvider": 0,
        "initialDispersion": 1,
        "ipv6RoutingEnabled": false,
        "logsEnabled": true,
        "longDesc": "A Delivery Service created expressly for API documentation examples",
        "missLat": 0,
        "missLong": 0,
        "maxOriginConnections": 0,
        "maxRequestHeaderBytes": 131072,
        "multiSiteOrigin": false,
        "orgServerFqdn": "http://origin.infra.ciab.test",
        "protocol": 0,
        "qstringIgnore": 0,
        "rangeRequestHandling": 0,
        "regionalGeoBlocking": false,
        "routingName": "test",
        "serviceCategory": null,
        "signed": false,
        "tenant": "root",
        "tenantId": 1,
        "typeId": 1,
        "xmlId": "test"
}

Response Structure

active:

A boolean that defines :ref:`ds-active`.

anonymousBlockingEnabled:

A boolean that defines :ref:`ds-anonymous-blocking`

cacheurl:

A :ref:`ds-cacheurl`

.. deprecated:: ATCv3.0
        This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later

ccrDnsTtl:

The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons

cdnId:

The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs

cdnName:

Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs

checkPath:

A :ref:`ds-check-path`

consistentHashRegex:

A :ref:`ds-consistent-hashing-regex`

consistentHashQueryParams:

An array of :ref:`ds-consistent-hashing-qparams`

deepCachingType:

The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`

displayName:

The :ref:`ds-display-name`

dnsBypassCname:

A :ref:`ds-dns-bypass-cname`

dnsBypassIp:

A :ref:`ds-dns-bypass-ip`

dnsBypassIp6:

A :ref:`ds-dns-bypass-ipv6`

dnsBypassTtl:

The :ref:`ds-dns-bypass-ttl`

dscp:

A :ref:`ds-dscp` to be used within the :term:`Delivery Service`

ecsEnabled:

A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`

edgeHeaderRewrite:

A set of :ref:`ds-edge-header-rw-rules`

exampleURLs:

An array of :ref:`ds-example-urls`

firstHeaderRewrite:

A set of :ref:`ds-first-header-rw-rules`

fqPacingRate:

The :ref:`ds-fqpr`

geoLimit:

An integer that defines the :ref:`ds-geo-limit`

geoLimitCountries:

A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`

geoLimitRedirectUrl:

A :ref:`ds-geo-limit-redirect-url`

geoProvider:

The :ref:`ds-geo-provider`

globalMaxMbps:

The :ref:`ds-global-max-mbps`

globalMaxTps:

The :ref:`ds-global-max-tps`

httpBypassFqdn:

A :ref:`ds-http-bypass-fqdn`

id:

An integral, unique identifier for this :term:`Delivery Service`

infoUrl:

An :ref:`ds-info-url`

initialDispersion:

The :ref:`ds-initial-dispersion`

innerHeaderRewrite:

A set of :ref:`ds-inner-header-rw-rules`

ipv6RoutingEnabled:

A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`

lastHeaderRewrite:

A set of :ref:`ds-last-header-rw-rules`

lastUpdated:

The date and time at which this :term:`Delivery Service` was last updated, in :ref:`non-rfc-datetime`

logsEnabled:

A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`

longDesc:

The :ref:`ds-longdesc` of this :term:`Delivery Service`

longDesc1:

The 2nd long description of this :term:`Delivery Service`

longDesc2:

the 3rd long description of this :term:`Delivery Service`

matchList:

The :term:`Delivery Service`'s :ref:`ds-matchlist`

pattern:	A regular expression - the use of this pattern is dependent on the `type` field (backslashes are escaped)
setNumber:	An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
type:	The type of match performed using `pattern`.

maxDnsAnswers:

The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`

maxOriginConnections:

The :ref:`ds-max-origin-connections`

maxRequestHeaderBytes:

The :ref:`ds-max-request-header-bytes`

midHeaderRewrite:

A set of :ref:`ds-mid-header-rw-rules`

missLat:

The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`

missLong:

The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`

multiSiteOrigin:

A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`

orgServerFqdn:

The :ref:`ds-origin-url`

originShield:

A :ref:`ds-origin-shield` string

profileDescription:

The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated

profileId:

The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated

profileName:

The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated

protocol:

An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`

qstringIgnore:

An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`

rangeRequestHandling:

An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`

regexRemap:

A :ref:`ds-regex-remap`

regionalGeoBlocking:

A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`

remapText:

:ref:`ds-raw-remap`

serviceCategory:

The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated

signed:

true if and only if signingAlgorithm is not null, false otherwise

signingAlgorithm:

Either a :ref:`ds-signing-algorithm` or null to indicate URL/URI signing is not implemented on this :term:`Delivery Service`

rangeSliceBlockSize:

An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if rangeRequestHandling is set to 3.

sslKeyVersion:

This integer indicates the :ref:`ds-ssl-key-version`

tenantId:

The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`

topology:

The unique name of the :term:`Topology` that this :term:`Delivery Service` is assigned to

trRequestHeaders:

If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`

trResponseHeaders:

If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`

type:

The :ref:`ds-types` of this :term:`Delivery Service`

typeId:

The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`

xmlId:

This :term:`Delivery Service`'s :ref:`ds-xmlid`

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: SVveQ5hGwfPv8N5APUskwLOzwrTUVA+z8wuFLsSLCr1/vVnFJJ0VQOGMUctg1NbqhAuQ795MJmuuAaAwR8dSOQ==
X-Server-Name: traffic_ops_golang/
Date: Mon, 19 Nov 2018 19:45:49 GMT
Content-Length: 1404

{ "alerts": [
        {
                "text": "Deliveryservice creation was successful.",
                "level": "success"
        }
],
"response": [
        {
                "active": false,
                "anonymousBlockingEnabled": false,
                "cacheurl": null,
                "ccrDnsTtl": null,
                "cdnId": 2,
                "cdnName": "CDN-in-a-Box",
                "checkPath": null,
                "displayName": "test",
                "dnsBypassCname": null,
                "dnsBypassIp": null,
                "dnsBypassIp6": null,
                "dnsBypassTtl": null,
                "dscp": 0,
                "edgeHeaderRewrite": null,
                "firstHeaderRewrite": null,
                "geoLimit": 0,
                "geoLimitCountries": null,
                "geoLimitRedirectURL": null,
                "geoProvider": 0,
                "globalMaxMbps": null,
                "globalMaxTps": null,
                "httpBypassFqdn": null,
                "id": 2,
                "infoUrl": null,
                "initialDispersion": 1,
                "innerHeaderRewrite": null,
                "ipv6RoutingEnabled": false,
                "lastHeaderRewrite": null,
                "lastUpdated": "2018-11-19 19:45:49+00",
                "logsEnabled": true,
                "longDesc": "A Delivery Service created expressly for API documentation examples",
                "longDesc1": null,
                "longDesc2": null,
                "matchList": [
                        {
                                "type": "HOST_REGEXP",
                                "setNumber": 0,
                                "pattern": ".*\\.test\\..*"
                        }
                ],
                "maxDnsAnswers": null,
                "maxOriginConnections": 0,
                "maxRequestHeaderBytes": 131072,
                "midHeaderRewrite": null,
                "missLat": -1,
                "missLong": -1,
                "multiSiteOrigin": false,
                "originShield": null,
                "orgServerFqdn": "http://origin.infra.ciab.test",
                "profileDescription": null,
                "profileId": null,
                "profileName": null,
                "protocol": 0,
                "qstringIgnore": 0,
                "rangeRequestHandling": 0,
                "regexRemap": null,
                "regionalGeoBlocking": false,
                "remapText": null,
                "routingName": "test",
                "serviceCategory": null,
                "signed": false,
                "sslKeyVersion": null,
                "tenantId": 1,
                "type": "HTTP",
                "typeId": 1,
                "xmlId": "test",
                "exampleURLs": [
                        "http://test.test.mycdn.ciab.test"
                ],
                "deepCachingType": "NEVER",
                "signingAlgorithm": null,
                "tenant": "root",
                "ecsEnabled": true,
                "rangeSliceBlockSize": null,
                "topology": null
        }
]}

[1] (1, 2) Only those :term:`Delivery Services` assigned to :term:`Tenants` that are the requesting user's :term:`Tenant` or children thereof will appear in the output of a GET request, and the same constraints are placed on the allowed values of the tenantId field of a POST request to create a new :term:`Delivery Service`

[2]	(1, 2) These fields must be defined if and only if `geoLimit` is non-zero

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

deliveryservices.rst

deliveryservices.rst

`deliveryservices`

`GET`

Request Structure

Response Structure

`POST`

Request Structure

Response Structure

Files

deliveryservices.rst

Latest commit

History

deliveryservices.rst

File metadata and controls

deliveryservices

GET

Request Structure

Response Structure

POST

Request Structure

Response Structure

`deliveryservices`

`GET`

`POST`