Delivery Service¶

/api/1.2/deliveryservices¶

GET /api/1.2/deliveryservices

Retrieves all delivery services (if admin or ops) or all delivery services assigned to user. See also Using Traffic Ops - Delivery Service.

Authentication Required: Yes

Role(s) Required: None

Request Query Parameters

Name Required Description

cdn no Filter delivery services by CDN ID.

profile no Filter delivery services by Profile ID.

tenant no Filter delivery services by Tenant ID.

type no Filter delivery services by Type ID.

logsEnabled no Filter by logs enabled (true|false).

Response Properties

Parameter Type Description

active bool true if active, false if inactive.

anonymousBlockingEnabled bool

true: enable blocking clients with anonymous ips

false: disabled

cacheurl string Cache URL rule to apply to this delivery service.

ccrDnsTtl int The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.

cdnId int Id of the CDN to which the delivery service belongs to.

cdnName string Name of the CDN to which the delivery service belongs to.

checkPath string The path portion of the URL to check this deliveryservice for health.

deepCachingType string
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

displayName string The display name of the delivery service.

dnsBypassCname string

dnsBypassIp string The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassIp6 string The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassTtl int The TTL of the DNS bypass response.

dscp int The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.

edgeHeaderRewrite string The EDGE header rewrite actions to perform.

exampleURLs array Entry points into the CDN for this deliveryservice.

geoLimitRedirectUrl string

geoLimit int

0: None - no limitations

1: Only route on CZF file hit

2: Only route on CZF hit or when from USA

Note that this does not prevent access to content or makes content secure; it just prevents routing to the content by Traffic Router.

geoLimitCountries string

geoProvider int

globalMaxMbps int The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.

globalMaxTps int The maximum global transactions per second allowed on this deliveryservice. When this is exceeded traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices

fqPacingRate int The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, will be rate limited by the Linux kernel. A default value of 0 disables this feature

httpBypassFqdn string The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

id int The deliveryservice id (database row number).

infoUrl string Use this to add a URL that points to more information about that deliveryservice.

initialDispersion int

ipv6RoutingEnabled bool false: send IPv4 address of Traffic Router to client on HTTP type del.

lastUpdated string

logsEnabled bool

longDesc string Description field.

longDesc1 string Description field 1.

longDesc2 string Description field 2.

maxDnsAnswers int The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all available).

midHeaderRewrite string The MID header rewrite actions to perform.

missLat float The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. 39.7391500 or null

missLong float The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. -104.9847000 or null

multiSiteOrigin bool Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See Multi Site Origin

orgServerFqdn string The origin server base URL (FQDN when used in this instance, includes the protocol (http:// or https://) for use in retrieving content from the origin server.

originShield string

profileDescription string The description of the Traffic Router Profile with which this deliveryservice is associated.

profileId int The id of the Traffic Router Profile with which this deliveryservice is associated.

profileName string The name of the Traffic Router Profile with which this deliveryservice is associated.

protocol int

0: serve with http:// at EDGE

1: serve with https:// at EDGE

2: serve with both http:// and https:// at EDGE

qstringIgnore int

0: no special query string handling; it is for use in the cache-key and pass up to origin.

1: ignore query string in cache-key, but pass it up to parent and or origin.

2: drop query string at edge, and do not use it in the cache-key.

rangeRequestHandling int How to treat range requests: - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) - 1 Use the background_fetch 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.

routingName string The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.

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.

signingAlgorithm string

null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

“url_sig”: URL Sign token based auth is enabled for this deliveryservice.

“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.

sslKeyVersion int

tenant string Owning tenant name

tenantId int Owning tenant ID

trRequestHeaders string List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the “rh=” token.

trResponseHeaders string List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses.

typeId int The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).

xmlId string Unique string that describes this deliveryservice.

Response Example
{
  "response": [
    {
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": "3600",
        "cdnId": "2",
        "cdnName": "over-the-top",
        "checkPath": "",
        "deepCachingType": "NEVER",
        "displayName": "My Cool Delivery Service",
        "dnsBypassCname": "",
        "dnsBypassIp": "",
        "dnsBypassIp6": "",
        "dnsBypassTtl": "30",
        "dscp": "40",
        "edgeHeaderRewrite": null,
            "exampleURLs": [
            "http://foo.foo-ds.foo.bar.net"
        ],
        "geoLimit": "0",
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": "0",
        "globalMaxMbps": null,
        "globalMaxTps": "0",
        "fqPacingRate": "0",
        "httpBypassFqdn": "",
        "id": "442",
        "infoUrl": "",
        "initialDispersion": "1",
        "ipv6RoutingEnabled": true,
        "lastUpdated": "2016-01-26 08:49:35",
        "logsEnabled": false,
        "longDesc": "",
        "longDesc1": "",
        "longDesc2": "",
        "maxDnsAnswers": "0",
        "midHeaderRewrite": null,
        "missLat": "39.7391500",
        "missLong": "-104.9847000",
        "multiSiteOrigin": false,
        "orgServerFqdn": "http://baz.boo.net",
        "originShield": null,
        "profileDescription": "Content Router for over-the-top",
        "profileId": "5",
        "profileName": "ROUTER_TOP",
        "protocol": "0",
        "qstringIgnore": "1",
        "rangeRequestHandling": "0",
        "regexRemap": null,
        "regionalGeoBlocking": false,
        "remapText": null,
        "routingName": "foo",
        "signed": false,
        "signingAlgorithm": null,
        "sslKeyVersion": "0",
        "tenant": "root",
        "tenantId": 1,
        "trRequestHeaders": null,
        "trResponseHeaders": "Access-Control-Allow-Origin: *",
        "type": "HTTP",
        "typeId": "8",
        "xmlId": "foo-ds"
    }
    { .. },
    { .. }
  ]
}

GET /api/1.2/deliveryservices/:id

Retrieves a specific delivery service. If not admin / ops, delivery service must be assigned to user. See also Using Traffic Ops - Delivery Service.

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.

anonymousBlockingEnabled bool

true: enable blocking clients with anonymous ips

false: disabled

cacheurl string Cache URL rule to apply to this delivery service.

ccrDnsTtl int The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.

cdnId int Id of the CDN to which the delivery service belongs to.

cdnName string Name of the CDN to which the delivery service belongs to.

checkPath string The path portion of the URL to check this deliveryservice for health.

deepCachingType string
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

displayName string The display name of the delivery service.

dnsBypassCname string

dnsBypassIp string The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassIp6 string The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassTtl int The TTL of the DNS bypass response.

dscp int The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.

edgeHeaderRewrite string The EDGE header rewrite actions to perform.

exampleURLs array Entry points into the CDN for this deliveryservice.

fqPacingRate int The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, will be rate limited by the Linux kernel. A default value of 0 disables this feature

geoLimitRedirectUrl string

geoLimit int

0: None - no limitations

1: Only route on CZF file hit

2: Only route on CZF hit or when from USA

Note that this does not prevent access to content or makes content secure; it just prevents routing to the content by Traffic Router.

geoLimitCountries string

geoProvider int

globalMaxMbps int The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.

globalMaxTps int The maximum global transactions per second allowed on this deliveryservice. When this is exceeded traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices

httpBypassFqdn string The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

id int The deliveryservice id (database row number).

infoUrl string Use this to add a URL that points to more information about that deliveryservice.

initialDispersion int

ipv6RoutingEnabled bool false: send IPv4 address of Traffic Router to client on HTTP type del.

lastUpdated string

logsEnabled bool

longDesc string Description field.

longDesc1 string Description field 1.

longDesc2 string Description field 2.

matchList array Array of matchList hashes.

>>type string The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).

>>setNumber string The set Number of the matchList.

>>pattern string The regexp for the matchList.

maxDnsAnswers int The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all available).

midHeaderRewrite string The MID header rewrite actions to perform.

missLat float The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. 39.7391500 or null

missLong float The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. -104.9847000 or null

multiSiteOrigin bool Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See Multi Site Origin

orgServerFqdn string The origin server base URL (FQDN when used in this instance, includes the protocol (http:// or https://) for use in retrieving content from the origin server.

originShield string

profileDescription string The description of the Traffic Router Profile with which this deliveryservice is associated.

profileId int The id of the Traffic Router Profile with which this deliveryservice is associated.

profileName string The name of the Traffic Router Profile with which this deliveryservice is associated.

protocol int

0: serve with http:// at EDGE

1: serve with https:// at EDGE

2: serve with both http:// and https:// at EDGE

qstringIgnore int

0: no special query string handling; it is for use in the cache-key and pass up to origin.

1: ignore query string in cache-key, but pass it up to parent and or origin.

2: drop query string at edge, and do not use it in the cache-key.

rangeRequestHandling int How to treat range requests: - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) - 1 Use the background_fetch 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.

routingName string The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.

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.

signingAlgorithm string

null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

“url_sig”: URL Sign token based auth is enabled for this deliveryservice.

“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.

sslKeyVersion int

tenant string Owning tenant name

tenantId int Owning tenant ID

trRequestHeaders string

trResponseHeaders string

typeId int The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).

xmlId string Unique string that describes this deliveryservice.

Response Example
{
  "response": [
    {
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": "3600",
        "cdnId": "2",
        "cdnName": "over-the-top",
        "checkPath": "",
        "deepCachingType": "NEVER",
        "displayName": "My Cool Delivery Service",
        "dnsBypassCname": "",
        "dnsBypassIp": "",
        "dnsBypassIp6": "",
        "dnsBypassTtl": "30",
        "dscp": "40",
        "edgeHeaderRewrite": null,
        "exampleURLs": [
            "http://foo.foo-ds.foo.bar.net"
        ],
        "geoLimit": "0",
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": "0",
        "globalMaxMbps": null,
        "globalMaxTps": "0",
        "fqPacingRate": "0",
        "httpBypassFqdn": "",
        "id": "442",
        "infoUrl": "",
        "initialDispersion": "1",
        "ipv6RoutingEnabled": true,
        "lastUpdated": "2016-01-26 08:49:35",
        "logsEnabled": false,
        "longDesc": "",
        "longDesc1": "",
        "longDesc2": "",
        "matchList": [
            {
                "pattern": ".*\\.foo-ds\\..*",
                "setNumber": "0",
                "type": "HOST_REGEXP"
            }
        ],
        "maxDnsAnswers": "0",
        "midHeaderRewrite": null,
        "missLat": "39.7391500",
        "missLong": "-104.9847000",
        "multiSiteOrigin": false,
        "orgServerFqdn": "http://baz.boo.net",
        "originShield": null,
        "profileDescription": "Content Router for over-the-top",
        "profileId": "5",
        "profileName": "ROUTER_TOP",
        "protocol": "0",
        "qstringIgnore": "1",
        "rangeRequestHandling": "0",
        "regexRemap": null,
        "regionalGeoBlocking": false,
        "remapText": null,
        "routingName": "foo",
        "signed": false,
        "signingAlgorithm": null,
        "sslKeyVersion": "0",
        "tenant": "root",
        "tenantId": 1,
        "trRequestHeaders": null,
        "trResponseHeaders": "Access-Control-Allow-Origin: *",
        "type": "HTTP",
        "typeId": "8",
        "xmlId": "foo-ds"
    }
  ]
}

GET /api/1.2/deliveryservices/:id/servers

Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.

Authentication Required: Yes

Role(s) Required: Admin or Operations or delivery service must be assigned to user.

Request Route Parameters

Name Required Description

id yes Delivery service ID.

Response Properties

Parameter Type Description

cachegroup string The cache group name (see Cache Group).

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 Physical Location).

physLocationId string The physical location id (see Physical Location).

profile string The assigned profile name (see Profiles).

profileDesc string The assigned profile description (see Profiles).

profileId string The assigned profile Id (see Profiles).

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 Status).

statusId string The Status id (See 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 Types).

typeId string The id of the type of this server (see Types).

updPending bool

Response Example
{
   "response": [
       {
           "cachegroup": "us-il-chicago",
           "cachegroupId": "3",
           "cdnId": "3",
           "cdnName": "CDN-1",
           "domainName": "chi.kabletown.net",
           "guid": null,
           "hostName": "atsec-chi-00",
           "id": "19",
           "iloIpAddress": "172.16.2.6",
           "iloIpGateway": "172.16.2.1",
           "iloIpNetmask": "255.255.255.0",
           "iloPassword": "********",
           "iloUsername": "",
           "interfaceMtu": "9000",
           "interfaceName": "bond0",
           "ip6Address": "2033:D0D0:3300::2:2/64",
           "ip6Gateway": "2033:D0D0:3300::2:1",
           "ipAddress": "10.10.2.2",
           "ipGateway": "10.10.2.1",
           "ipNetmask": "255.255.255.0",
           "lastUpdated": "2015-03-08 15:57:32",
           "mgmtIpAddress": "",
           "mgmtIpGateway": "",
           "mgmtIpNetmask": "",
           "offlineReason": "N/A",
           "physLocation": "plocation-chi-1",
           "physLocationId": "9",
           "profile": "EDGE1_CDN1_421_SSL",
           "profileDesc": "EDGE1_CDN1_421_SSL profile",
           "profileId": "12",
           "rack": "RR 119.02",
           "routerHostName": "rtr-chi.kabletown.net",
           "routerPortName": "2",
           "status": "ONLINE",
           "statusId": "6",
           "tcpPort": "80",
           "httpsPort": "443",
           "type": "EDGE",
           "typeId": "3",
           "updPending": false
       },
       {
       ... more server data
       }
     ]
 }

GET /api/1.2/deliveryservices/:id/servers/unassigned

Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.

Authentication Required: Yes

Role(s) Required: Admin or Operations or delivery service must be assigned to user

Request Route Parameters

Name Required Description

id yes Delivery service ID.

Response Properties

Parameter Type Description

cachegroup string The cache group name (see Cache Group).

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 Physical Location).

physLocationId string The physical location id (see Physical Location).

profile string The assigned profile name (see Profiles).

profileDesc string The assigned profile description (see Profiles).

profileId string The assigned profile Id (see Profiles).

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 Status).

statusId string The Status id (See 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 Types).

typeId string The id of the type of this server (see Types).

updPending bool

Response Example
{
   "response": [
       {
           "cachegroup": "us-il-chicago",
           "cachegroupId": "3",
           "cdnId": "3",
           "cdnName": "CDN-1",
           "domainName": "chi.kabletown.net",
           "guid": null,
           "hostName": "atsec-chi-00",
           "id": "19",
           "iloIpAddress": "172.16.2.6",
           "iloIpGateway": "172.16.2.1",
           "iloIpNetmask": "255.255.255.0",
           "iloPassword": "********",
           "iloUsername": "",
           "interfaceMtu": "9000",
           "interfaceName": "bond0",
           "ip6Address": "2033:D0D0:3300::2:2/64",
           "ip6Gateway": "2033:D0D0:3300::2:1",
           "ipAddress": "10.10.2.2",
           "ipGateway": "10.10.2.1",
           "ipNetmask": "255.255.255.0",
           "lastUpdated": "2015-03-08 15:57:32",
           "mgmtIpAddress": "",
           "mgmtIpGateway": "",
           "mgmtIpNetmask": "",
           "offlineReason": "N/A",
           "physLocation": "plocation-chi-1",
           "physLocationId": "9",
           "profile": "EDGE1_CDN1_421_SSL",
           "profileDesc": "EDGE1_CDN1_421_SSL profile",
           "profileId": "12",
           "rack": "RR 119.02",
           "routerHostName": "rtr-chi.kabletown.net",
           "routerPortName": "2",
           "status": "ONLINE",
           "statusId": "6",
           "tcpPort": "80",
           "httpsPort": "443",
           "type": "EDGE",
           "typeId": "3",
           "updPending": false
       },
       {
       ... more server data
       }
     ]
 }

GET /api/1.2/deliveryservices/:id/servers/eligible

Retrieves properties of CDN EDGE or ORG servers not eligible for assignment to a delivery service.

Authentication Required: Yes

Role(s) Required: Admin or Operations or delivery service must be assigned to user

Request Route Parameters

Name Required Description

id yes Delivery service ID.

Response Properties

Parameter Type Description

cachegroup string The cache group name (see Cache Group).

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 Physical Location).

physLocationId string The physical location id (see Physical Location).

profile string The assigned profile name (see Profiles).

profileDesc string The assigned profile description (see Profiles).

profileId string The assigned profile Id (see Profiles).

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 Status).

statusId string The Status id (See 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 Types).

typeId string The id of the type of this server (see Types).

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
       }
     ]
 }

Health¶

GET /api/1.2/deliveryservices/:id/state

Retrieves the failover state for a delivery service. Delivery service must be assigned to user if user is not admin or operations.

Authentication Required: Yes

Role(s) Required: None

Response Properties

Parameter Type Description

failover hash

>locations array

>destination hash

>>location string

>>type string

>configured boolean

>enabled boolean

enabled boolean

Response Example
{
    "response": {
        "failover": {
            "locations": [ ],
            "destination": {
                "location": null,
                "type": "DNS",
            },
            "configured": false,
            "enabled": false
        },
        "enabled": true
    }
}

GET /api/1.2/deliveryservices/:id/health

Retrieves the health of all locations (cache groups) for a delivery service. Delivery service must be assigned to user if user is not admin or operations.

Authentication Required: Yes

Role(s) Required: None

Response Properties

Parameter Type Description

totalOnline int Total number of online caches across all CDNs.

totalOffline int Total number of offline caches across all CDNs.

cachegroups array A collection of cache groups.

>online int The number of online caches for the cache group

>offline int The number of offline caches for the cache group.

>name string Cache group name.

Response Example
{
 "response": {
    "totalOnline": 148,
    "totalOffline": 0,
    "cachegroups": [
       {
          "online": 8,
          "offline": 0,
          "name": "us-co-denver"
       },
       {
          "online": 7,
          "offline": 0,
          "name": "us-de-newcastle"
       }
    ]
 }
}

GET /api/1.2/deliveryservices/:id/capacity

Retrieves the capacity percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.

Authentication Required: Yes

Role(s) Required: None

Request Route Parameters

Name Required Description

id yes delivery service id.

Response Properties

Parameter Type Description

availablePercent number The percentage of server capacity assigned to the delivery service that is available.

unavailablePercent number The percentage of server capacity assigned to the delivery service that is unavailable.

utilizedPercent number The percentage of server capacity assigned to the delivery service being used.

maintenancePercent number The percentage of server capacity assigned to the delivery service that is down for maintenance.

Response Example
{
 "response": {
    "availablePercent": 89.0939840205533,
    "unavailablePercent": 0,
    "utilizedPercent": 10.9060020300395,
    "maintenancePercent": 0.0000139494071146245
 },
}

GET /api/1.2/deliveryservices/:id/routing

Retrieves the routing method percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.

Authentication Required: Yes

Role(s) Required: None

Request Route Parameters

Name Required Description

id yes delivery service id.

Response Properties

Parameter Type Description

staticRoute number The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries.

miss number The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP).

geo number The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping.

err number The percentage of Traffic Router requests for this deliveryservice resulting in an error.

cz number The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit.

dsr number The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the overflow CDN.

fed number The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN.

regionalAlternate number The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate regional geoblocking URL.

regionalDenied number The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy.

Response Example
{
 "response": {
    "staticRoute": 0,
    "miss": 0,
    "geo": 37.8855391018869,
    "err": 0,
    "cz": 62.1144608981131,
    "dsr": 0,
    "fed": 0,
    "regionalAlternate": 0,
    "regionalDenied": 0
 },
}

Delivery Service Server¶

GET /api/1.2/deliveryserviceserver

Retrieves delivery service / server assignments.

Authentication Required: Yes

Role(s) Required: None

Request Query Parameters

Name Required Description

page no The page number for use in pagination.

limit no For use in limiting the result set.

Response Properties

Parameter Type Description

lastUpdated array

server string

deliveryService string

Response Example
{
 "page": 2,
 "orderby": "deliveryservice",
 "response": [
    {
       "lastUpdated": "2014-09-26 17:53:43",
       "server": "20",
       "deliveryService": "1"
    },
    {
       "lastUpdated": "2014-09-26 17:53:44",
       "server": "21",
       "deliveryService": "1"
    },
 ],
 "limit": 2
}

POST /api/1.2/deliveryserviceserver

Create one or more delivery service / server assignments.

Authentication Required: Yes

Role(s) Required: Admin or Operations or the delivery service is assigned to the user.

Request Parameters

Name Required Description

dsId yes The ID of the delivery service.

servers yes An array of server IDs.

replace no Replace existing ds/server assignments? (true|false)

Request Example
{
    "dsId": 246,
    "servers": [ 2, 3, 4, 5, 6 ],
    "replace": true
}
Response Properties

Parameter Type Description

dsId int The ID of the delivery service.

servers array An array of server IDs.

replace array Existing ds/server assignments replaced? (true|false).

Response Example
{
    "alerts": [
              {
                      "level": "success",
                      "text": "Server assignments complete."
              }
      ],
    "response": {
        "dsId" : 246,
        "servers" : [ 2, 3, 4, 5, 6 ],
        "replace" : true
    }
}

DELETE /api/1.2/deliveryservice_server/:dsId/:serverId

Removes a server (cache) from a delivery service.

Authentication Required: Yes

Role(s) Required: Admin or Oper (if delivery service is not assigned to user)

Request Route Parameters

Name Required Description

dsId yes Delivery service ID.

serverId yes Server (cache) ID.
Response Example
{
       "alerts": [
                 {
                         "level": "success",
                         "text": "Server unlinked from delivery service."
                 }
         ],
}

Delivery Service User¶

POST /api/1.2/deliveryservice_user

Create one or more user / delivery service assignments.

Authentication Required: Yes

Role(s) Required: Admin or Operations

Request Parameters

Name Required Description

userId yes The ID of the user.

deliveryServices yes An array of delivery service IDs.

replace no Replace existing user/ds assignments? (true|false).

Request Example
{
    "userId": 50,
    "deliveryServices": [ 23, 34, 45, 56, 67 ],
    "replace": true
}
Response Properties

Parameter Type Description

userId int The ID of the user.

deliveryServices array An array of delivery service IDs.

replace array Existing user/ds assignments replaced? (true|false).

Response Example
{
    "alerts": [
              {
                      "level": "success",
                      "text": "Delivery service assignments complete."
              }
      ],
    "response": {
        "userId" : 50,
        "deliveryServices": [ 23, 34, 45, 56, 67 ],
        "replace": true
    }
}

DELETE /api/1.2/deliveryservice_user/:dsId/:userId

Removes a delivery service from a user.

Authentication Required: Yes

Role(s) Required: Admin or Operations

Request Route Parameters

Name Required Description

dsId yes Delivery service ID.

userId yes User ID.
Response Example
{
       "alerts": [
                 {
                         "level": "success",
                         "text": "User and delivery service were unlinked."
                 }
         ],
}

SSL Keys¶

GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys

Retrieves ssl keys for a delivery service.

Authentication Required: Yes

Role(s) Required: None

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

decode no a boolean value to decode the certs or not

Response Properties

Parameter Type Description

crt string base64 encoded (or not if decode=true) crt file for delivery service

csr string base64 encoded (or not if decode=true) csr file for delivery service

key string base64 encoded (or not if decode=true) private key file for delivery service

cdn string The CDN of the delivery service for which the certs were generated.

deliveryservice string The XML ID of the delivery service for which the cert was generated.

businessUnit string The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

city string The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

organization string The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

hostname string The hostname generated by Traffic Ops that is used as the common name when generating the certificate. This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.

country string The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

state string The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

version string The version of the certificate record in Riak

Response Example
{
  "response": {
    "certificate": {
      "crt": "crt",
      "key": "key",
      "csr": "csr"
    },
    "deliveryservice": "my-ds",
    "cdn": "qa",
    "businessUnit": "CDN_Eng",
    "city": "Denver",
    "organization": "KableTown",
    "hostname": "foober.com",
    "country": "US",
    "state": "Colorado",
    "version": "1"
  }
}

GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys

Authentication Required: Yes

Role(s) Required: Admin

Request Route Parameters

Name Required Description

hostname yes pristine hostname of the desired delivery service

Request Query Parameters

Name Required Description

version no The version number to retrieve

decode no a boolean value to decode the certs or not

Response Properties

Parameter Type Description

crt string base64 encoded (or not if decode=true) crt file for delivery service

csr string base64 encoded (or not if decode=true) csr file for delivery service

key string base64 encoded (or not if decode=true) private key file for delivery service

cdn string The CDN of the delivery service for which the certs were generated.

deliveryservice string The XML ID of the delivery service for which the cert was generated.

businessUnit string The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

city string The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

organization string The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

hostname string The hostname generated by Traffic Ops that is used as the common name when generating the certificate. This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.

country string The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

state string The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response

version string The version of the certificate record in Riak

Response Example
{
  "response": {
    "certificate": {
      "crt": "crt",
      "key": "key",
      "csr": "csr"
    },
    "deliveryservice": "my-ds",
    "cdn": "qa",
    "businessUnit": "CDN_Eng",
    "city": "Denver",
    "organization": "KableTown",
    "hostname": "foober.com",
    "country": "US",
    "state": "Colorado",
    "version": "1"
  }
}

GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete

Authentication Required: Yes

Role Required: Operations

Request Route Parameters

Name Required Description

xmlId yes xml_id of the desired delivery service

Request Query Parameters

Name Required Description

version no The version number to retrieve

Response Properties

Parameter Type Description

response string success response

Response Example
{
  "response": "Successfully deleted ssl keys for <xml_id>"
}

POST /api/1.2/deliveryservices/sslkeys/generate

Generates SSL crt, csr, and private key for a delivery service

Authentication Required: Yes

Role(s) Required: Operations

Request Properties

Parameter Type Description

key string xml_id of the delivery service

version string version of the keys being generated

hostname string the pristine hostname of the delivery service

country string Country

state string State

city string City

org string Organization

unit boolean Business Unit

deliveryservice string The deliveryservice xml-id for which you want to generate certs

cdn string The name of the CDN for which the deliveryservice belongs

Request Example
{
  "key": "ds-01",
  "businessUnit": "CDN Engineering",
  "version": "3",
  "hostname": "tr.ds-01.ott.kabletown.com",
  "certificate": {
    "key": "some_key",
    "csr": "some_csr",
    "crt": "some_crt"
  },
  "country": "US",
  "organization": "Kabletown",
  "city": "Denver",
  "state": "Colorado",
  "deliveryservice" : "ds-01",
  "cdn": "cdn1"
}

Response Properties

Parameter Type Description

response string response string

version string API version

Response Example
{
  "response": "Successfully created ssl keys for ds-01"
}

POST /api/1.2/deliveryservices/sslkeys/add

Allows user to add SSL crt, csr, and private key for a delivery service.

Authentication Required: Yes

Role(s) Required: Operations

Request Properties

Parameter Type Description

key string xml_id of the delivery service

version string version of the keys being generated

csr string

crt string

key string

deliveryservice string The deliveryservice xml-id for which you want to generate certs

cdn string The name of the CDN for which the deliveryservice belongs

hostname string the pristine hostname of the delivery service

Request Example
{
  "key": "ds-01",
  "version": "1",
  "certificate": {
    "key": "some_key",
    "csr": "some_csr",
    "crt": "some_crt"
  }
}

Response Properties

Parameter Type Description

response string response string

version string API version

Response Example
{
  "response": "Successfully added ssl keys for ds-01"
}

URL Sig Keys¶

GET /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys

Retrieves URL sig keys for a delivery service.

Authentication Required: Yes

Role(s) Required: None

Request Route Parameters

Name Required Description

xmlId yes xml_id of the desired delivery service

Response Properties

Parameter Type Description

key0 string base64 encoded key for delivery service

key2 string base64 encoded key for delivery service

keyn... string base64 encoded key for delivery service – repeats to 15 (16 total) and is currently unsorted.

Response Example
{
  "response": {
    key9":"ZvVQNYpPVQWQV8tjQnUl6osm4y7xK4zD",
    "key6":"JhGdpw5X9o8TqHfgezCm0bqb9SQPASWL",
    "key8":"ySXdp1T8IeDEE1OCMftzZb9EIw_20wwq",
    "key0":"D4AYzJ1AE2nYisA9MxMtY03TPDCHji9C",
    "key3":"W90YHlGc_kYlYw5_I0LrkpV9JOzSIneI",
    "key12":"ZbtMb3mrKqfS8hnx9_xWBIP_OPWlUpzc",
    "key2":"0qgEoDO7sUsugIQemZbwmMt0tNCwB1sf",
    "key4":"aFJ2Gb7atmxVB8uv7T9S6OaDml3ycpGf",
    "key1":"wnWNR1mCz1O4C7EFPtcqHd0xUMQyNFhA",
    "key11":"k6HMzlBH1x6htKkypRFfWQhAndQqe50e",
    "key10":"zYONfdD7fGYKj4kLvIj4U0918csuZO0d",
    "key15":"3360cGaIip_layZMc_0hI2teJbazxTQh",
    "key5":"SIwv3GOhWN7EE9wSwPFj18qE4M07sFxN",
    "key13":"SqQKBR6LqEOzp8AewZUCVtBcW_8YFc1g",
    "key14":"DtXsu8nsw04YhT0kNoKBhu2G3P9WRpQJ",
    "key7":"cmKoIIxXGAxUMdCsWvnGLoIMGmNiuT5I"
  }
}

POST /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys/generate

Generates Url sig keys for a delivery service

Authentication Required: Yes

Role(s) Required: Operations

Request Route Parameters

Name Required Description

xmlId yes xml_id of the desired delivery service

Response Properties

Parameter Type Description

response string response string

version string API version

Response Example
{
  "response": "Successfully generated and stored keys"
}

POST /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys/copyFromXmlId/:copyFromXmlId

Allows user to copy url sig keys from a specified delivery service to a delivery service.

Authentication Required: Yes

Role(s) Required: Operations

Request Route Parameters

Name Required Description

xmlId yes xml_id of the desired delivery service

copyFromXmlId yes xml_id of the delivery service to copy url sig keys from

Response Properties

Parameter Type Description

response string response string

version string API version

Response Example
{
  "response": "Successfully copied and stored keys"
}

POST /api/1.2/deliveryservices/request

Allows a user to send delivery service request details to a specified email address.

Authentication Required: Yes

Role(s) Required: None

Request Properties

Parameter Type Required Description

emailTo string yes The email to which the delivery service request will be sent.

details hash yes Parameters for the delivery service request.

>customer string yes Name of the customer to associated with the delivery service.

>deepCachingType string no
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

>deliveryProtocol string yes Eg. http or http/https

>routingType string yes Eg. DNS or HTTP Redirect

>routingName string no The routing name for the delivery service, e.g. <routingName>.<xmlId>.cdn.com

>serviceDesc string yes A description of the delivery service.

>peakBPSEstimate string yes Used to manage cache efficiency and plan for capacity.

>peakTPSEstimate string yes Used to manage cache efficiency and plan for capacity.

>maxLibrarySizeEstimate string yes Used to manage cache efficiency and plan for capacity.

>originURL string yes The URL path to the origin server.

>hasOriginDynamicRemap bool yes This is a feature which allows services to use multiple origin URLs for the same service.

>originTestFile string yes A URL path to a test file available on the origin server.

>hasOriginACLWhitelist bool yes Is access to your origin restricted using an access control list (ACL or whitelist) of Ips?

>originHeaders string no Header values that must be passed to requests to your origin.

>otherOriginSecurity string no Other origin security measures that need to be considered for access.

>queryStringHandling string yes How to handle query strings that come with the request.

>rangeRequestHandling string yes How to handle range requests.

>hasSignedURLs bool yes Are Urls signed?

>hasNegativeCachingCustomization bool yes Any customization required for negative caching?

>negativeCachingCustomizationNote string yes Negative caching customization instructions.

>serviceAliases array no Service aliases which will be used for this service.

>rateLimitingGBPS int no Rate Limiting - Bandwidth (Gbps)

>rateLimitingTPS int no Rate Limiting - Transactions/Second

>overflowService string no An overflow point (URL or IP address) used if rate limits are met.

>headerRewriteEdge string no Headers can be added or altered at each layer of the CDN.

>headerRewriteMid string no Headers can be added or altered at each layer of the CDN.

>headerRewriteRedirectRouter string no Headers can be added or altered at each layer of the CDN.

>notes string no Additional instructions to provide the delivery service provisioning team.

Request Example
{
   "emailTo": "foo@bar.com",
   "details": {
      "customer": "XYZ Corporation",
      "contentType": "video-on-demand",
      "deepCachingType": "NEVER",
      "deliveryProtocol": "http",
      "routingType": "dns",
      "routingName": "foo",
      "serviceDesc": "service description goes here",
      "peakBPSEstimate": "less-than-5-Gbps",
      "peakTPSEstimate": "less-than-1000-TPS",
      "maxLibrarySizeEstimate": "less-than-200-GB",
      "originURL": "http://myorigin.com",
      "hasOriginDynamicRemap": false,
      "originTestFile": "http://myorigin.com/crossdomain.xml",
      "hasOriginACLWhitelist": true,
      "originHeaders": "",
      "otherOriginSecurity": "",
      "queryStringHandling": "ignore-in-cache-key-and-pass-up",
      "rangeRequestHandling": "range-requests-not-used",
      "hasSignedURLs": true,
      "hasNegativeCachingCustomization": true,
      "negativeCachingCustomizationNote": "negative caching instructions",
      "serviceAliases": [
         "http://alias1.com",
         "http://alias2.com"
      ],
      "rateLimitingGBPS": 50,
      "rateLimitingTPS": 5000,
      "overflowService": "http://overflowcdn.com",
      "headerRewriteEdge": "",
      "headerRewriteMid": "",
      "headerRewriteRedirectRouter": "",
      "notes": ""
   }
}

Response Properties

Parameter Type Description

alerts array A collection of alert messages.

>level string Success, info, warning or error.

>text string Alert message.

version string

Response Example
{
  "alerts": [
        {
            "level": "success",
            "text": "Delivery Service request sent to foo@bar.com."
        }
    ]
}

POST /api/1.2/deliveryservices

Allows user to create a delivery service.

Authentication Required: Yes

Role(s) Required: Admin or Operations

Request Properties

Parameter Required Description

active yes true if active, false if inactive.

anonymousBlockingEnabled no

true: enable blocking clients with anonymous ips

false: disabled

cacheurl no Cache URL rule to apply to this delivery service.

ccrDnsTtl no The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host.

cdnId yes cdn id

checkPath no The path portion of the URL to check this deliveryservice for health.

deepCachingType no
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

displayName yes Display name

dnsBypassCname no Bypass CNAME

dnsBypassIp no The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassIp6 no The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassTtl no The TTL of the DNS bypass response.

dscp yes The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.

edgeHeaderRewrite no The EDGE header rewrite actions to perform.

fqPacingRate no The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, will be rate limited by the Linux kernel. A default value of 0 disables this feature

geoLimitRedirectURL no This is the URL Traffic Router will redirect to when Geo Limit Failure.

geoLimit yes

0: None - no limitations

1: Only route on CZF file hit

2: Only route on CZF hit or when from geo limit countries

Note that this does not prevent access to content or makes content secure; it just prevents routing to the content by Traffic Router.

geoLimitCountries no The geo limit countries.

geoProvider yes

0: Maxmind(default)

1: Neustar

globalMaxMbps no The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.

globalMaxTps no The maximum global transactions per second allowed on this deliveryservice. When this is exceeded traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices

httpBypassFqdn no The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

infoUrl no Use this to add a URL that points to more information about that deliveryservice.

initialDispersion yes|no Initial dispersion. Required for HTTP* delivery services.

ipv6RoutingEnabled yes|no false: send IPv4 address of Traffic Router to client on HTTP type del. Required for DNS*, HTTP* and STEERING* delivery services.

logsEnabled yes

false: No

true: Yes

longDesc no Description field.

longDesc1 no Description field 1.

longDesc2 no Description field 2.

maxDnsAnswers no The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all available).

midHeaderRewrite no The MID header rewrite actions to perform.

missLat yes|no The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services.

missLong yes|no The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services.

multiSiteOrigin yes|no true if enabled, false if disabled. Required for DNS* and HTTP* delivery services.

orgServerFqdn yes|no The origin server base URL (FQDN when used in this instance, includes the protocol (http:// or https://) for use in retrieving content from the origin server. This field is required if type is DNS* or HTTP*.

originShield no Origin shield

profileId no DS profile ID

protocol yes|no

0: serve with http:// at EDGE

1: serve with https:// at EDGE

2: serve with both http:// and https:// at EDGE

Required for DNS*, HTTP* or STEERING delivery services.

qstringIgnore yes|no

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.

Required for DNS* and HTTP* delivery services.

rangeRequestHandling yes|no How to treat range requests (required for DNS* and HTTP* delivery services): - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) - 1 Use the background_fetch plugin. - 2 Use the cache_range_requests plugin.

regexRemap no Regex Remap rule to apply to this delivery service at the Edge tier.

regionalGeoBlocking yes Is the Regional Geo Blocking feature enabled.

remapText no Additional raw remap line text.

routingName yes The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.

signed no

false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

true: token based auth is enabled for this deliveryservice.

signingAlgorithm no

null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

“url_sig”: URL Sign token based auth is enabled for this deliveryservice.

“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.

sslKeyVersion no SSL key version

tenantId No Owning tenant ID

trRequestHeaders no Traffic router log request headers

trResponseHeaders no Traffic router additional response headers

typeId yes The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).

xmlId yes Unique string that describes this deliveryservice.

Request Example
{
    "xmlId": "my_ds_1",
    "displayName": "my_ds_displayname_1",
    "tenantId": 1,
    "protocol": 1,
    "orgServerFqdn": "http://10.75.168.91",
    "cdnId": 2,
    "typeId": 42,
    "active": false,
    "dscp": 10,
    "geoLimit": 0,
    "geoProvider": 0,
    "initialDispersion": 1,
    "ipv6RoutingEnabled": false,
    "logsEnabled": false,
    "multiSiteOrigin": false,
    "missLat": 39.7391500,
    "missLong": -104.9847000,
    "qstringIgnore": 0,
    "rangeRequestHandling": 0,
    "regionalGeoBlocking": false,
    "anonymousBlockingEnabled": false,
    "signed": false,
    "signingAlgorithm": null
}
Response Properties

Parameter Type Description

active bool true if active, false if inactive.

anonymousBlockingEnabled bool

true: enable blocking clients with anonymous ips

false: disabled

cacheurl string Cache URL rule to apply to this delivery service.

ccrDnsTtl int The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.

cdnId int Id of the CDN to which the delivery service belongs to.

cdnName string Name of the CDN to which the delivery service belongs to.

checkPath string The path portion of the URL to check this deliveryservice for health.

deepCachingType string
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

displayName string The display name of the delivery service.

dnsBypassCname string

dnsBypassIp string The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassIp6 string The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassTtl int The TTL of the DNS bypass response.

dscp int The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.

edgeHeaderRewrite string The EDGE header rewrite actions to perform.

exampleURLs array Entry points into the CDN for this deliveryservice.

fqPacingRate int The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, will be rate limited by the Linux kernel. A default value of 0 disables this feature

geoLimitRedirectUrl string

geoLimit int

0: None - no limitations

1: Only route on CZF file hit

2: Only route on CZF hit or when from USA

Note that this does not prevent access to content or makes content secure; it just prevents routing to the content by Traffic Router.

geoLimitCountries string

geoProvider int

globalMaxMbps int The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.

globalMaxTps int The maximum global transactions per second allowed on this deliveryservice. When this is exceeded traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices

httpBypassFqdn string The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

id int The deliveryservice id (database row number).

infoUrl string Use this to add a URL that points to more information about that deliveryservice.

initialDispersion int

ipv6RoutingEnabled bool false: send IPv4 address of Traffic Router to client on HTTP type del.

lastUpdated string

logsEnabled bool

longDesc string Description field.

longDesc1 string Description field 1.

longDesc2 string Description field 2.

matchList array Array of matchList hashes.

>>type string The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).

>>setNumber string The set Number of the matchList.

>>pattern string The regexp for the matchList.

maxDnsAnswers int The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all available).

midHeaderRewrite string The MID header rewrite actions to perform.

missLat float The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. 39.7391500 or null

missLong float The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. -104.9847000 or null

multiSiteOrigin bool Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See Multi Site Origin

orgServerFqdn string The origin server base URL (FQDN when used in this instance, includes the protocol (http:// or https://) for use in retrieving content from the origin server.

originShield string

profileDescription string The description of the Traffic Router Profile with which this deliveryservice is associated.

profileId int The id of the Traffic Router Profile with which this deliveryservice is associated.

profileName string The name of the Traffic Router Profile with which this deliveryservice is associated.

protocol int

0: serve with http:// at EDGE

1: serve with https:// at EDGE

2: serve with both http:// and https:// at EDGE

qstringIgnore int

0: no special query string handling; it is for use in the cache-key and pass up to origin.

1: ignore query string in cache-key, but pass it up to parent and or origin.

2: drop query string at edge, and do not use it in the cache-key.

rangeRequestHandling int How to treat range requests: - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) - 1 Use the background_fetch 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.

routingName string The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.

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.

signingAlgorithm string

null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

“url_sig”: URL Sign token based auth is enabled for this deliveryservice.

“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.

sslKeyVersion int

trRequestHeaders string

trResponseHeaders string

typeId int The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).

xmlId string Unique string that describes this deliveryservice.

Response Example
{
  "response": [
    {
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": "3600",
        "cdnId": "2",
        "cdnName": "over-the-top",
        "checkPath": "",
        "deepCachingType": "NEVER",
        "displayName": "My Cool Delivery Service",
        "dnsBypassCname": "",
        "dnsBypassIp": "",
        "dnsBypassIp6": "",
        "dnsBypassTtl": "30",
        "dscp": "40",
        "edgeHeaderRewrite": null,
        "exampleURLs": [
            "http://foo.foo-ds.foo.bar.net"
        ],
        "geoLimit": "0",
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": "0",
        "globalMaxMbps": null,
        "globalMaxTps": "0",
        "fqPacingRate": "0",
        "httpBypassFqdn": "",
        "id": "442",
        "infoUrl": "",
        "initialDispersion": "1",
        "ipv6RoutingEnabled": true,
        "lastUpdated": "2016-01-26 08:49:35",
        "logsEnabled": false,
        "longDesc": "",
        "longDesc1": "",
        "longDesc2": "",
        "matchList": [
            {
                "pattern": ".*\\.foo-ds\\..*",
                "setNumber": "0",
                "type": "HOST_REGEXP"
            }
        ],
        "maxDnsAnswers": "0",
        "midHeaderRewrite": null,
        "missLat": "39.7391500",
        "missLong": "-104.9847000",
        "multiSiteOrigin": false,
        "orgServerFqdn": "http://baz.boo.net",
        "originShield": null,
        "profileDescription": "Content Router for over-the-top",
        "profileId": "5",
        "profileName": "ROUTER_TOP",
        "protocol": "0",
        "qstringIgnore": "1",
        "rangeRequestHandling": "0",
        "regexRemap": null,
        "regionalGeoBlocking": false,
        "remapText": null,
        "routingName": "foo",
        "signed": false,
        "signingAlgorithm": null,
        "sslKeyVersion": "0",
        "tenantId": 1,
        "trRequestHeaders": null,
        "trResponseHeaders": "Access-Control-Allow-Origin: *",
        "type": "HTTP",
        "typeId": "8",
        "xmlId": "foo-ds"
    }
  ]
}

PUT /api/1.2/deliveryservices/{:id}

Allows user to edit a delivery service.

Authentication Required: Yes

Role(s) Required: admin or oper

Request Route Parameters

Name Required Description

id yes delivery service id.

Request Properties

Parameter Required Description

active yes true if active, false if inactive.

anonymousBlockingEnabled no

true: enable blocking clients with anonymous ips

false: disabled

cacheurl no Cache URL rule to apply to this delivery service.

ccrDnsTtl no The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host.

cdnId yes cdn id

checkPath no The path portion of the URL to check this deliveryservice for health.

deepCachingType no
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

displayName yes Display name

dnsBypassCname no Bypass CNAME

dnsBypassIp no The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassIp6 no The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassTtl no The TTL of the DNS bypass response.

dscp yes The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.

edgeHeaderRewrite no The EDGE header rewrite actions to perform.

fqPacingRate no The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, will be rate limited by the Linux kernel. A default value of 0 disables this feature

geoLimitRedirectURL no This is the URL Traffic Router will redirect to when Geo Limit Failure.

geoLimit yes

0: None - no limitations

1: Only route on CZF file hit

2: Only route on CZF hit or when from geo limit countries

Note that this does not prevent access to content or makes content secure; it just prevents routing to the content by Traffic Router.

geoLimitCountries no The geo limit countries.

geoProvider yes

0: Maxmind(default)

1: Neustar

globalMaxMbps no The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.

globalMaxTps no The maximum global transactions per second allowed on this deliveryservice. When this is exceeded traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices

httpBypassFqdn no The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

infoUrl no Use this to add a URL that points to more information about that deliveryservice.

initialDispersion yes|no Initial dispersion. Required for HTTP* delivery services.

ipv6RoutingEnabled yes|no false: send IPv4 address of Traffic Router to client on HTTP type del. Required for DNS*, HTTP* and STEERING* delivery services.

logsEnabled yes

false: No

true: Yes

longDesc no Description field.

longDesc1 no Description field 1.

longDesc2 no Description field 2.

maxDnsAnswers no The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all available).

midHeaderRewrite no The MID header rewrite actions to perform.

missLat yes|no The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services.

missLong yes|no The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services.

multiSiteOrigin yes|no true if enabled, false if disabled. Required for DNS* and HTTP* delivery services.

orgServerFqdn yes|no The origin server base URL (FQDN when used in this instance, includes the protocol (http:// or https://) for use in retrieving content from the origin server. This field is required if type is DNS* or HTTP*.

originShield no Origin shield

profileId no DS profile ID

protocol yes|no

0: serve with http:// at EDGE

1: serve with https:// at EDGE

2: serve with both http:// and https:// at EDGE

Required for DNS*, HTTP* or STEERING delivery services.

qstringIgnore yes|no

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.

Required for DNS* and HTTP* delivery services.

rangeRequestHandling yes|no How to treat range requests (required for DNS* and HTTP* delivery services): - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) - 1 Use the background_fetch plugin. - 2 Use the cache_range_requests plugin.

regexRemap no Regex Remap rule to apply to this delivery service at the Edge tier.

regionalGeoBlocking yes Is the Regional Geo Blocking feature enabled.

remapText no Additional raw remap line text.

routingName yes The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.

signed no

false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

true: token based auth is enabled for this deliveryservice.

signingAlgorithm no

null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

“url_sig”: URL Sign token based auth is enabled for this deliveryservice.

“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.

sslKeyVersion no SSL key version

tenantId No Owning tenant ID

trRequestHeaders no Traffic router log request headers

trResponseHeaders no Traffic router additional response headers

typeId yes The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).

xmlId yes Unique string that describes this deliveryservice. This value cannot be changed on update.

Request Example
{
    "xmlId": "my_ds_1",
    "displayName": "my_ds_displayname_1",
    "tenantId": 1,
    "protocol": 1,
    "orgServerFqdn": "http://10.75.168.91",
    "cdnId": 2,
    "typeId": 42,
    "active": false,
    "dscp": 10,
    "geoLimit": 0,
    "geoProvider": 0,
    "initialDispersion": 1,
    "ipv6RoutingEnabled": false,
    "logsEnabled": false,
    "multiSiteOrigin": false,
    "missLat": 39.7391500,
    "missLong": -104.9847000,
    "qstringIgnore": 0,
    "rangeRequestHandling": 0,
    "regionalGeoBlocking": false,
    "anonymousBlockingEnabled": false,
    "signed": false,
    "signingAlgorithm": null
}
Response Properties

Parameter Type Description

active bool true if active, false if inactive.

anonymousBlockingEnabled bool

true: enable blocking clients with anonymous ips

false: disabled

cacheurl string Cache URL rule to apply to this delivery service.

ccrDnsTtl int The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.

cdnId int Id of the CDN to which the delivery service belongs to.

cdnName string Name of the CDN to which the delivery service belongs to.

checkPath string The path portion of the URL to check this deliveryservice for health.

deepCachingType string
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

displayName string The display name of the delivery service.

dnsBypassCname string

dnsBypassIp string The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassIp6 string The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassTtl int The TTL of the DNS bypass response.

dscp int The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.

edgeHeaderRewrite string The EDGE header rewrite actions to perform.

exampleURLs array Entry points into the CDN for this deliveryservice.

fqPacingRate int The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, will be rate limited by the Linux kernel. A default value of 0 disables this feature

geoLimitRedirectUrl string

geoLimit int

0: None - no limitations

1: Only route on CZF file hit

2: Only route on CZF hit or when from USA

Note that this does not prevent access to content or makes content secure; it just prevents routing to the content by Traffic Router.

geoLimitCountries string

geoProvider int

globalMaxMbps int The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.

globalMaxTps int The maximum global transactions per second allowed on this deliveryservice. When this is exceeded traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices

httpBypassFqdn string The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

id int The deliveryservice id (database row number).

infoUrl string Use this to add a URL that points to more information about that deliveryservice.

initialDispersion int

ipv6RoutingEnabled bool false: send IPv4 address of Traffic Router to client on HTTP type del.

lastUpdated string

logsEnabled bool

longDesc string Description field.

longDesc1 string Description field 1.

longDesc2 string Description field 2.

matchList array Array of matchList hashes.

>>type string The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).

>>setNumber string The set Number of the matchList.

>>pattern string The regexp for the matchList.

maxDnsAnswers int The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all available).

midHeaderRewrite string The MID header rewrite actions to perform.

missLat float The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. 39.7391500 or null

missLong float The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. -104.9847000 or null

multiSiteOrigin bool Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See Multi Site Origin

orgServerFqdn string The origin server base URL (FQDN when used in this instance, includes the protocol (http:// or https://) for use in retrieving content from the origin server.

originShield string

profileDescription string The description of the Traffic Router Profile with which this deliveryservice is associated.

profileId int The id of the Traffic Router Profile with which this deliveryservice is associated.

profileName string The name of the Traffic Router Profile with which this deliveryservice is associated.

protocol int

0: serve with http:// at EDGE

1: serve with https:// at EDGE

2: serve with both http:// and https:// at EDGE

qstringIgnore int

0: no special query string handling; it is for use in the cache-key and pass up to origin.

1: ignore query string in cache-key, but pass it up to parent and or origin.

2: drop query string at edge, and do not use it in the cache-key.

rangeRequestHandling int How to treat range requests: - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) - 1 Use the background_fetch 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.

routingName string The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.

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.

signingAlgorithm string

null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

“url_sig”: URL Sign token based auth is enabled for this deliveryservice.

“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.

sslKeyVersion int

trRequestHeaders string

trResponseHeaders string

typeId int The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).

xmlId string Unique string that describes this deliveryservice.

Response Example
{
  "response": [
    {
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": "3600",
        "cdnId": "2",
        "cdnName": "over-the-top",
        "checkPath": "",
        "deepCachingType": "NEVER",
        "displayName": "My Cool Delivery Service",
        "dnsBypassCname": "",
        "dnsBypassIp": "",
        "dnsBypassIp6": "",
        "dnsBypassTtl": "30",
        "dscp": "40",
        "edgeHeaderRewrite": null,
        "exampleURLs": [
            "http://foo.foo-ds.foo.bar.net"
        ],
        "geoLimit": "0",
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": "0",
        "globalMaxMbps": null,
        "globalMaxTps": "0",
        "fqPacingRate": "0",
        "httpBypassFqdn": "",
        "id": "442",
        "infoUrl": "",
        "initialDispersion": "1",
        "ipv6RoutingEnabled": true,
        "lastUpdated": "2016-01-26 08:49:35",
        "logsEnabled": false,
        "longDesc": "",
        "longDesc1": "",
        "longDesc2": "",
        "matchList": [
            {
                "pattern": ".*\\.foo-ds\\..*",
                "setNumber": "0",
                "type": "HOST_REGEXP"
            }
        ],
        "maxDnsAnswers": "0",
        "midHeaderRewrite": null,
        "missLat": "39.7391500",
        "missLong": "-104.9847000",
        "multiSiteOrigin": false,
        "orgServerFqdn": "http://baz.boo.net",
        "originShield": null,
        "profileDescription": "Content Router for over-the-top",
        "profileId": "5",
        "profileName": "ROUTER_TOP",
        "protocol": "0",
        "qstringIgnore": "1",
        "rangeRequestHandling": "0",
        "regexRemap": null,
        "regionalGeoBlocking": false,
        "remapText": null,
        "routingName": "foo",
        "signed": false,
        "signingAlgorithm": null,
        "sslKeyVersion": "0",
        "tenantId": 1,
        "trRequestHeaders": null,
        "trResponseHeaders": "Access-Control-Allow-Origin: *",
        "type": "HTTP",
        "typeId": "8",
        "xmlId": "foo-ds"
    }
  ]
}

PUT /api/1.2/deliveryservices/{:id}/safe

Allows a user to edit limited fields of an assigned delivery service.

Authentication Required: Yes

Role(s) Required: users with the delivery service assigned or ops and above

Request Route Parameters

Name Required Description

id yes delivery service id.

Request Properties

Parameter Required Description

displayName no Display name

infoUrl no Use this to add a URL that points to more information about that deliveryservice.

longDesc no Description field.

longDesc1 no Description field 1.

all other fields n/a All other fields will be silently ignored

Request Example
{
    "displayName": "My Cool Delivery Service",
    "infoUrl": "www.info.com",
    "longDesc": "some info about the service",
    "longDesc1": "the customer label"
}
Response Properties

Parameter Type Description

active bool true if active, false if inactive.

anonymousBlockingEnabled bool

true: enable blocking clients with anonymous ips

false: disabled

cacheurl string Cache URL rule to apply to this delivery service.

ccrDnsTtl int The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.

cdnId int Id of the CDN to which the delivery service belongs to.

cdnName string Name of the CDN to which the delivery service belongs to.

checkPath string The path portion of the URL to check this deliveryservice for health.

deepCachingType string
When to do Deep Caching for this Delivery Service:

NEVER (default)

ALWAYS

displayName string The display name of the delivery service.

dnsBypassCname string

dnsBypassIp string The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassIp6 string The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

dnsBypassTtl int The TTL of the DNS bypass response.

dscp int The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.

edgeHeaderRewrite string The EDGE header rewrite actions to perform.

exampleURLs array Entry points into the CDN for this deliveryservice.

fqPacingRate int The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, will be rate limited by the Linux kernel. A default value of 0 disables this feature

geoLimitRedirectUrl string

geoLimit int

0: None - no limitations

1: Only route on CZF file hit

2: Only route on CZF hit or when from USA

Note that this does not prevent access to content or makes content secure; it just prevents routing to the content by Traffic Router.

geoLimitCountries string

geoProvider int

globalMaxMbps int The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.

globalMaxTps int The maximum global transactions per second allowed on this deliveryservice. When this is exceeded traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices

httpBypassFqdn string The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the globalMaxMbps traffic on this deliveryservice.

id int The deliveryservice id (database row number).

infoUrl string Use this to add a URL that points to more information about that deliveryservice.

initialDispersion int

ipv6RoutingEnabled bool false: send IPv4 address of Traffic Router to client on HTTP type del.

lastUpdated string

logsEnabled bool

longDesc string Description field.

longDesc1 string Description field 1.

longDesc2 string Description field 2.

matchList array Array of matchList hashes.

>>type string The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).

>>setNumber string The set Number of the matchList.

>>pattern string The regexp for the matchList.

maxDnsAnswers int The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all available).

midHeaderRewrite string The MID header rewrite actions to perform.

missLat float The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. 39.7391500 or null

missLong float The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. - e.g. -104.9847000 or null

multiSiteOrigin bool Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See Multi Site Origin

orgServerFqdn string The origin server base URL (FQDN when used in this instance, includes the protocol (http:// or https://) for use in retrieving content from the origin server.

originShield string

profileDescription string The description of the Traffic Router Profile with which this deliveryservice is associated.

profileId int The id of the Traffic Router Profile with which this deliveryservice is associated.

profileName string The name of the Traffic Router Profile with which this deliveryservice is associated.

protocol int

0: serve with http:// at EDGE

1: serve with https:// at EDGE

2: serve with both http:// and https:// at EDGE

qstringIgnore int

0: no special query string handling; it is for use in the cache-key and pass up to origin.

1: ignore query string in cache-key, but pass it up to parent and or origin.

2: drop query string at edge, and do not use it in the cache-key.

rangeRequestHandling int How to treat range requests: - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) - 1 Use the background_fetch 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.

routingName string The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.

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.

signingAlgorithm string

null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.

“url_sig”: URL Sign token based auth is enabled for this deliveryservice.

“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.

sslKeyVersion int

trRequestHeaders string

trResponseHeaders string

typeId int The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).

xmlId string Unique string that describes this deliveryservice.

Response Example
{
  "response": [
    {
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": "3600",
        "cdnId": "2",
        "cdnName": "over-the-top",
        "checkPath": "",
        "deepCachingType": "NEVER",
        "displayName": "My Cool Delivery Service",
        "dnsBypassCname": "",
        "dnsBypassIp": "",
        "dnsBypassIp6": "",
        "dnsBypassTtl": "30",
        "dscp": "40",
        "edgeHeaderRewrite": null,
        "exampleURLs": [
            "http://foo.foo-ds.foo.bar.net"
        ],
        "geoLimit": "0",
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": "0",
        "globalMaxMbps": null,
        "globalMaxTps": "0",
        "fqPacingRate": "0",
        "httpBypassFqdn": "",
        "id": "442",
        "infoUrl": "www.info.com",
        "initialDispersion": "1",
        "ipv6RoutingEnabled": true,
        "lastUpdated": "2016-01-26 08:49:35",
        "logsEnabled": false,
        "longDesc": "some info about the service",
        "longDesc1": "the customer label",
        "longDesc2": "",
        "matchList": [
            {
                "pattern": ".*\\.foo-ds\\..*",
                "setNumber": "0",
                "type": "HOST_REGEXP"
            }
        ],
        "maxDnsAnswers": "0",
        "midHeaderRewrite": null,
        "missLat": "39.7391500",
        "missLong": "-104.9847000",
        "multiSiteOrigin": false,
        "orgServerFqdn": "http://baz.boo.net",
        "originShield": null,
        "profileDescription": "Content Router for over-the-top",
        "profileId": "5",
        "profileName": "ROUTER_TOP",
        "protocol": "0",
        "qstringIgnore": "1",
        "rangeRequestHandling": "0",
        "regexRemap": null,
        "regionalGeoBlocking": false,
        "remapText": null,
        "routingName": "foo",
        "signed": false,
        "signingAlgorithm": null,
        "sslKeyVersion": "0",
        "tenantId": 1,
        "trRequestHeaders": null,
        "trResponseHeaders": "Access-Control-Allow-Origin: *",
        "type": "HTTP",
        "typeId": "8",
        "xmlId": "foo-ds"
    }
  ]
}

DELETE /api/1.2/deliveryservices/{:id}

Allows user to delete a delivery service.

Authentication Required: Yes

Role(s) Required: admin or oper

Request Route Parameters

Name	Required	Description
id	yes	delivery service id.

Response Example

{
       "alerts": [
                 {
                         "level": "success",
                         "text": "Delivery service was deleted."
                 }
         ],
}

POST /api/1.2/deliveryservices/:xml_id/servers

Assign caches to a delivery service.

Authentication Required: Yes

Role(s) Required: admin or oper

Request Route Parameters

Name Required Description

xml_id yes the xml_id of the deliveryservice

Request Properties

Parameter Required Description

serverNames yes array of hostname of cache servers to assign to this deliveryservice, for example: [ “server1”, “server2” ]

Request Example
{
    "serverNames": [
        "tc1_ats1"
    ]
}
Response Properties

Parameter Type Description

xml_id string Unique string that describes this delivery service.

serverNames string array of hostname of cache servers to assign to this deliveryservice, for example: [ “server1”, “server2” ]
Response Example
{
    "response":{
        "serverNames":[
            "tc1_ats1"
        ],
        "xmlId":"my_ds_1"
    }
}

URI Signing Keys¶

DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys

Deletes URISigning objects for a delivery service.

Authentication Required: Yes

Role(s) Required: admin

Request Route Parameters

Name Required Description

xml_id yes xml_id of the desired delivery service

GET /api/1.2/deliveryservices/:xml_id/urisignkeys

Retrieves one or more URISigning objects for a delivery service.

Authentication Required: Yes

Role(s) Required: admin

Request Route Parameters

Name Required Description

xml_id yes xml_id of the desired delivery service

Response Properties

Parameter Type Description

Issuer string a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example

renewal_kid string a string naming the jwt key used for renewals.

keys string json array of jwt symmetric keys .

alg string this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.

kid string this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.

kty string this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.

k string this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.

Response Example
{
  "Kabletown URI Authority": {
    "renewal_kid": "Second Key",
    "keys": [
      {
        "alg": "HS256",
        "kid": "First Key",
        "kty": "oct",
        "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"
      },
      {
        "alg": "HS256",
        "kid": "Second Key",
        "kty": "oct",
        "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"
      }
    ]
  }
}

POST /api/1.2/deliveryservices/:xml_id/urisignkeys

Assigns URISigning objects to a delivery service.

Authentication Required: Yes

Role(s) Required: admin

Request Route Parameters

Name Required Description

xml_id yes xml_id of the desired delivery service

Request Properties

Parameter Type Description

Issuer string a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example

renewal_kid string a string naming the jwt key used for renewals.

keys string json array of jwt symmetric keys .

alg string this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.

kid string this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.

kty string this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.

k string this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.

Request Example
{
  "Kabletown URI Authority": {
    "renewal_kid": "Second Key",
    "keys": [
      {
        "alg": "HS256",
        "kid": "First Key",
        "kty": "oct",
        "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"
      },
      {
        "alg": "HS256",
        "kid": "Second Key",
        "kty": "oct",
        "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"
      }
    ]
  }
}

PUT /api/1.2/deliveryservices/:xml_id/urisignkeys

updates URISigning objects on a delivery service.

Authentication Required: Yes

Role(s) Required: admin

Request Route Parameters

Name Required Description

xml_id yes xml_id of the desired delivery service

Request Properties

Parameter Type Description

Issuer string a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example

renewal_kid string a string naming the jwt key used for renewals.

keys string json array of jwt symmetric keys .

alg string this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.

kid string this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.

kty string this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.

k string this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.

Request Example
{
  "Kabletown URI Authority": {
    "renewal_kid": "Second Key",
    "keys": [
      {
        "alg": "HS256",
        "kid": "First Key",
        "kty": "oct",
        "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"
      },
      {
        "alg": "HS256",
        "kid": "Second Key",
        "kty": "oct",
        "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"
      }
    ]
  }
}