deliveryservices
GET
Retrieves Delivery Services
- Auth. Required
Yes
- Roles Required
None1
- Response Type
Array
Request Structure
Name |
Required |
Description |
---|---|---|
cdn |
no |
Show only the Delivery Services belonging to the CDN identified by this integral, unique identifier |
id |
no |
Show only the Delivery Service that has this integral, unique identifier |
logsEnabled |
no |
Show only the Delivery Services that have Logs Enabled set or not based on this boolean |
profile |
no |
Return only Delivery Services using the Profile that has this ID |
tenant |
no |
Show only the Delivery Services belonging to the Tenant identified by this integral, unique identifier |
topology |
no |
Show only the Delivery Services assigned to the Topology identified by this unique name |
type |
no |
Return only Delivery Services of the Delivery Service Type identified by this integral, unique identifier |
accessibleTo |
no |
Return the Delivery Services accessible from a Tenant or it’s children identified by this integral, unique identifier |
serviceCategory |
no |
Show only the Delivery Services belonging to the Service Category that has this name |
xmlId |
no |
Show only the 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 |
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 nth page of results, where “n” is the value of this parameter, pages are |
active |
no |
Show only the Delivery Services that have Active set or not based on this boolean (whether or not they are active) |
Response Structure
- active
A boolean that defines Active.
- anonymousBlockingEnabled
A boolean that defines Anonymous Blocking
- cacheurl
-
Deprecated since version 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 DNS TTL - named “ccrDnsTtl” for legacy reasons
- cdnId
The integral, unique identifier of the CDN to which the Delivery Service belongs
- cdnName
Name of the CDN to which the Delivery Service belongs
- checkPath
- consistentHashRegex
- consistentHashQueryParams
An array of Consistent Hashing Query Parameters
- deepCachingType
The Deep Caching setting for this Delivery Service
- displayName
The Display Name
- dnsBypassCname
- dnsBypassIp
- dnsBypassIp6
- dnsBypassTtl
The DNS Bypass TTL
- dscp
A DSCP to be used within the Delivery Service
- ecsEnabled
A boolean that defines the EDNS0 Client Subnet Enabled setting on this Delivery Service
- edgeHeaderRewrite
A set of Edge Header Rewrite Rules
- exampleURLs
An array of Example URLs
- firstHeaderRewrite
A set of First Header Rewrite Rules
- fqPacingRate
- geoLimit
An integer that defines the Geo Limit
- geoLimitCountries
A string containing a comma-separated list defining the Geo Limit Countries
- geoLimitRedirectUrl
- geoProvider
- globalMaxMbps
The Global Max Mbps
- globalMaxTps
The Global Max TPS
- httpBypassFqdn
- id
An integral, unique identifier for this Delivery Service
- infoUrl
An Info URL
- initialDispersion
- innerHeaderRewrite
A set of Inner Header Rewrite Rules
- ipv6RoutingEnabled
A boolean that defines the IPv6 Routing Enabled setting on this Delivery Service
- lastHeaderRewrite
A set of Last Header Rewrite Rules
- lastUpdated
The date and time at which this Delivery Service was last updated, in Traffic Ops’s Custom Date/Time Format
- logsEnabled
A boolean that defines the Logs Enabled setting on this Delivery Service
- longDesc
The Long Description of this Delivery Service
- longDesc1
The 2nd long description of this Delivery Service
- longDesc2
the 3rd long description of this Delivery Service
- matchList
The Delivery Service’s Match List
- 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 Match List 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 Max DNS Answers allowed for this Delivery Service
- maxOriginConnections
- maxRequestHeaderBytes
- midHeaderRewrite
A set of Mid Header Rewrite Rules
- missLat
The Geo Miss Default Latitude used by this Delivery Service
- missLong
The Geo Miss Default Longitude used by this Delivery Service
- multiSiteOrigin
A boolean that defines the use of Use Multi-Site Origin Feature by this Delivery Service
- orgServerFqdn
- originShield
A Origin Shield string
- profileDescription
The Description of the Profile with which this Delivery Service is associated
- profileId
The ID of the Profile with which this Delivery Service is associated
- profileName
The Name of the Profile with which this Delivery Service is associated
- protocol
An integral, unique identifier that corresponds to the Protocol used by this Delivery Service
- qstringIgnore
An integral, unique identifier that corresponds to the Query String Handling setting on this Delivery Service
- rangeRequestHandling
An integral, unique identifier that corresponds to the Range Request Handling setting on this Delivery Service
- regexRemap
- regionalGeoBlocking
A boolean defining the Regional Geoblocking setting on this Delivery Service
- remapText
- serviceCategory
The name of the Service Category with which the Delivery Service is associated
- signed
true
if and only ifsigningAlgorithm
is notnull
,false
otherwise- signingAlgorithm
Either a Signing Algorithm or
null
to indicate URL/URI signing is not implemented on this 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 SSL Key Version
- tenantId
The integral, unique identifier of the Tenant who owns this Delivery Service
- topology
The unique name of the Topology that this Delivery Service is assigned to
- trRequestHeaders
If defined, this defines the Traffic Router Log Request Headers used by Traffic Router for this Delivery Service
- trResponseHeaders
If defined, this defines the Traffic Router Additional Response Headers used by Traffic Router for this Delivery Service
- type
The Type of this Delivery Service
- typeId
The integral, unique identifier of the Type of this Delivery Service
- xmlId
This Delivery Service’s xml_id
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 Delivery Service.
- Auth. Required
Yes
- Roles Required
“admin” or “operations”1
- Response Type
Array
Request Structure
- active
A boolean that defines Active.
- anonymousBlockingEnabled
A boolean that defines Anonymous Blocking
- cacheurl
-
Deprecated since version 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 DNS TTL - named “ccrDnsTtl” for legacy reasons
- cdnId
The integral, unique identifier of the CDN to which the Delivery Service belongs
- checkPath
- consistentHashRegex
- consistentHashQueryParams
An array of Consistent Hashing Query Parameters
- deepCachingType
The Deep Caching setting for this Delivery Service
- displayName
The Display Name
- dnsBypassCname
- dnsBypassIp
- dnsBypassIp6
- dnsBypassTtl
The DNS Bypass TTL
- dscp
A DSCP to be used within the Delivery Service
- ecsEnabled
A boolean that defines the EDNS0 Client Subnet Enabled setting on this Delivery Service
- edgeHeaderRewrite
A set of Edge Header Rewrite Rules
- firstHeaderRewrite
A set of First Header Rewrite Rules
- fqPacingRate
- geoLimit
An integer that defines the Geo Limit
- geoLimitCountries
A string containing a comma-separated list defining the Geo Limit Countries2
- geoLimitRedirectUrl
- geoProvider
- globalMaxMbps
The Global Max Mbps
- globalMaxTps
The Global Max TPS
- httpBypassFqdn
- infoUrl
An Info URL
- initialDispersion
- innerHeaderRewrite
A set of Inner Header Rewrite Rules
- ipv6RoutingEnabled
A boolean that defines the IPv6 Routing Enabled setting on this Delivery Service
- lastHeaderRewrite
A set of Last Header Rewrite Rules
- logsEnabled
A boolean that defines the Logs Enabled setting on this Delivery Service
- longDesc
The Long Description of this Delivery Service
- longDesc1
An optional field containing the 2nd long description of this Delivery Service
- longDesc2
An optional field containing the 3rd long description of this Delivery Service
- maxDnsAnswers
The Max DNS Answers allowed for this Delivery Service
- maxOriginConnections
- maxRequestHeaderBytes
- midHeaderRewrite
A set of Mid Header Rewrite Rules
- missLat
The Geo Miss Default Latitude used by this Delivery Service
- missLong
The Geo Miss Default Longitude used by this Delivery Service
- multiSiteOrigin
A boolean that defines the use of Use Multi-Site Origin Feature by this Delivery Service
- orgServerFqdn
- originShield
A Origin Shield string
- profileId
An optional ID of a Profile with which this Delivery Service shall be associated
- protocol
An integral, unique identifier that corresponds to the Protocol used by this Delivery Service
- qstringIgnore
An integral, unique identifier that corresponds to the Query String Handling setting on this Delivery Service
- rangeRequestHandling
An integral, unique identifier that corresponds to the Range Request Handling setting on this Delivery Service
- regexRemap
- regionalGeoBlocking
A boolean defining the Regional Geoblocking setting on this Delivery Service
- remapText
- serviceCategory
The name of the Service Category with which the Delivery Service is associated - or
null
if there is to be no such category- signed
true
if and only ifsigningAlgorithm
is notnull
,false
otherwise- signingAlgorithm
Either a Signing Algorithm or
null
to indicate URL/URI signing is not implemented on this 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 SSL Key Version
- tenantId
The integral, unique identifier of the Tenant who owns this Delivery Service
- topology
The unique name of the Topology that this Delivery Service is assigned to
- trRequestHeaders
If defined, this defines the Traffic Router Log Request Headers used by Traffic Router for this Delivery Service
- trResponseHeaders
If defined, this defines the Traffic Router Additional Response Headers used by Traffic Router for this Delivery Service
- type
The Type of this Delivery Service
- typeId
The integral, unique identifier of the Type of this Delivery Service
- xmlId
This Delivery Service’s xml_id
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 Active.
- anonymousBlockingEnabled
A boolean that defines Anonymous Blocking
- cacheurl
-
Deprecated since version 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 DNS TTL - named “ccrDnsTtl” for legacy reasons
- cdnId
The integral, unique identifier of the CDN to which the Delivery Service belongs
- cdnName
Name of the CDN to which the Delivery Service belongs
- checkPath
- consistentHashRegex
- consistentHashQueryParams
An array of Consistent Hashing Query Parameters
- deepCachingType
The Deep Caching setting for this Delivery Service
- displayName
The Display Name
- dnsBypassCname
- dnsBypassIp
- dnsBypassIp6
- dnsBypassTtl
The DNS Bypass TTL
- dscp
A DSCP to be used within the Delivery Service
- ecsEnabled
A boolean that defines the EDNS0 Client Subnet Enabled setting on this Delivery Service
- edgeHeaderRewrite
A set of Edge Header Rewrite Rules
- exampleURLs
An array of Example URLs
- firstHeaderRewrite
A set of First Header Rewrite Rules
- fqPacingRate
- geoLimit
An integer that defines the Geo Limit
- geoLimitCountries
A string containing a comma-separated list defining the Geo Limit Countries
- geoLimitRedirectUrl
- geoProvider
- globalMaxMbps
The Global Max Mbps
- globalMaxTps
The Global Max TPS
- httpBypassFqdn
- id
An integral, unique identifier for this Delivery Service
- infoUrl
An Info URL
- initialDispersion
- innerHeaderRewrite
A set of Inner Header Rewrite Rules
- ipv6RoutingEnabled
A boolean that defines the IPv6 Routing Enabled setting on this Delivery Service
- lastHeaderRewrite
A set of Last Header Rewrite Rules
- lastUpdated
The date and time at which this Delivery Service was last updated, in Traffic Ops’s Custom Date/Time Format
- logsEnabled
A boolean that defines the Logs Enabled setting on this Delivery Service
- longDesc
The Long Description of this Delivery Service
- longDesc1
The 2nd long description of this Delivery Service
- longDesc2
the 3rd long description of this Delivery Service
- matchList
The Delivery Service’s Match List
- 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 Match List 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 Max DNS Answers allowed for this Delivery Service
- maxOriginConnections
- maxRequestHeaderBytes
- midHeaderRewrite
A set of Mid Header Rewrite Rules
- missLat
The Geo Miss Default Latitude used by this Delivery Service
- missLong
The Geo Miss Default Longitude used by this Delivery Service
- multiSiteOrigin
A boolean that defines the use of Use Multi-Site Origin Feature by this Delivery Service
- orgServerFqdn
- originShield
A Origin Shield string
- profileDescription
The Description of the Profile with which this Delivery Service is associated
- profileId
The ID of the Profile with which this Delivery Service is associated
- profileName
The Name of the Profile with which this Delivery Service is associated
- protocol
An integral, unique identifier that corresponds to the Protocol used by this Delivery Service
- qstringIgnore
An integral, unique identifier that corresponds to the Query String Handling setting on this Delivery Service
- rangeRequestHandling
An integral, unique identifier that corresponds to the Range Request Handling setting on this Delivery Service
- regexRemap
- regionalGeoBlocking
A boolean defining the Regional Geoblocking setting on this Delivery Service
- remapText
- serviceCategory
The name of the Service Category with which the Delivery Service is associated
- signed
true
if and only ifsigningAlgorithm
is notnull
,false
otherwise- signingAlgorithm
Either a Signing Algorithm or
null
to indicate URL/URI signing is not implemented on this 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 SSL Key Version
- tenantId
The integral, unique identifier of the Tenant who owns this Delivery Service
- topology
The unique name of the Topology that this Delivery Service is assigned to
- trRequestHeaders
If defined, this defines the Traffic Router Log Request Headers used by Traffic Router for this Delivery Service
- trResponseHeaders
If defined, this defines the Traffic Router Additional Response Headers used by Traffic Router for this Delivery Service
- type
The Type of this Delivery Service
- typeId
The integral, unique identifier of the Type of this Delivery Service
- xmlId
This Delivery Service’s xml_id
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 Delivery Services assigned to Tenants that are the requesting user’s Tenant or children thereof will appear in the output of a
GET
request, and the same constraints are placed on the allowed values of thetenantId
field of aPOST
request to create a new Delivery Service- 2(1,2)
These fields must be defined if and only if
geoLimit
is non-zero