Skip to content

Latest commit

 

History

History
1189 lines (1108 loc) · 60.6 KB

deliveryservice_requests.rst

File metadata and controls

1189 lines (1108 loc) · 60.6 KB
Raw

deliveryservice_requests

GET

Retrieves ds_requests.

Auth. Required

Yes

Roles Required

None

Response Type

Array

Request Structure

Request Query Parameters
Name Required Description
assignee no Filter for ds_requests that are assigned to the user identified by this username.
assigneeId no Filter for ds_requests that are assigned to the user identified by this integral, unique identifier
author no Filter for ds_requests submitted by the user identified by this username
authorId no Filter for ds_requests submitted by the user identified by this integral, unique identifier
changeType no Filter for ds_requests of the change type specified. Can be create, update, or delete.
createdAt no Filter for ds_requests created on a certain date/time. Value must be 3339 compliant. Eg. 2019-09-19T19:35:38.828535Z
id no Filter for the Delivery Service Request <ds_requests> identified by this integral, unique identifier.
status no Filter for ds_requests whose status is the status specified. The status can be draft, submitted, pending, rejected, or complete.
xmlId no Filter for ds_requests that have the given ds-xmlid.
orderby no Choose the ordering of the results - must be the name of one of the fields of the objects in the response array
sortOrder no Changes the order of sorting. Either ascending (default or "asc") or descending ("desc")
limit no Choose the maximum number of results to return
offset no The number of results to skip before beginning to return results. Must use in conjunction with limit
page no Return the nth page of results, where "n" is the value of this parameter, pages are limit long and the first page is 1. If offset was defined, this query parameter has no effect. limit must be defined to make use of page.

ATCv6 The createdAt query parameter was added to this in endpoint across all API versions in ATC (Apache Traffic Control) version 6.0.0.

GET /api/3.0/deliveryservice_requests?status=draft HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure

author

The username of the user who created the Delivery Service Request.

authorId

The integral, unique identifier assigned to the author

changeType

The change type of the DSR <Delivery Service Request>. It can be create, update, or delete....

createdAt

The date and time at which the DSR <Delivery Service Request> was created, in non-rfc-datetime.

deliveryService

The delivery service that the DSR <Delivery Service Request> is requesting to update.

active

A boolean that defines ds-active.

anonymousBlockingEnabled

A boolean that defines ds-anonymous-blocking

cacheurl

A ds-cacheurl

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

ccrDnsTtl

The ds-dns-ttl - named "ccrDnsTtl" for legacy reasons

cdnId

The integral, unique identifier of the ds-cdn to which the Delivery Service belongs

cdnName

Name of the ds-cdn to which the Delivery Service belongs

checkPath

A ds-check-path

consistentHashQueryParams

An array of ds-consistent-hashing-qparams

consistentHashRegex

A ds-consistent-hashing-regex

deepCachingType

The ds-deep-caching setting for this Delivery Service

displayName

The ds-display-name

dnsBypassCname

A ds-dns-bypass-cname

dnsBypassIp

A ds-dns-bypass-ip

dnsBypassIp6

A ds-dns-bypass-ipv6

dnsBypassTtl

The ds-dns-bypass-ttl

dscp

A ds-dscp to be used within the Delivery Service

ecsEnabled

A boolean that defines the ds-ecs setting on this Delivery Service

edgeHeaderRewrite

A set of ds-edge-header-rw-rules

exampleURLs

An array of ds-example-urls

firstHeaderRewrite

A set of ds-first-header-rw-rules

fqPacingRate

The ds-fqpr

geoLimit

An integer that defines the ds-geo-limit

geoLimitCountries

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

geoLimitRedirectUrl

A ds-geo-limit-redirect-url

geoProvider

The ds-geo-provider

globalMaxMbps

The ds-global-max-mbps

globalMaxTps

The ds-global-max-tps

httpBypassFqdn

A ds-http-bypass-fqdn

id

An integral, unique identifier for this Delivery Service

infoUrl

An ds-info-url

initialDispersion

The ds-initial-dispersion

innerHeaderRewrite

A set of ds-inner-header-rw-rules

ipv6RoutingEnabled

A boolean that defines the ds-ipv6-routing setting on this Delivery Service

lastHeaderRewrite

A set of ds-last-header-rw-rules

lastUpdated

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

logsEnabled

A boolean that defines the ds-logs-enabled setting on this Delivery Service

longDesc

The ds-longdesc of this Delivery Service

longDesc1

An optional field containing the 2nd long description of this Delivery Service

longDesc2

An optional field containing the 3rd long description of this Delivery Service

matchList

The Delivery Service's ds-matchlist

pattern

A regular expression - the use of this pattern is dependent on the type field (backslashes are escaped)

setNumber

An integer that provides explicit ordering of ds-matchlist items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.

type

The type of match performed using pattern.

maxDnsAnswers

The ds-max-dns-answers allowed for this Delivery Service

maxOriginConnections

The ds-max-origin-connections

midHeaderRewrite

A set of ds-mid-header-rw-rules

missLat

The ds-geo-miss-default-latitude used by this Delivery Service

missLong

The ds-geo-miss-default-longitude used by this Delivery Service

multiSiteOrigin

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

orgServerFqdn

The ds-origin-url

originShield

A ds-origin-shield string

profileDescription

The profile-description of the ds-profile with which this Delivery Service is associated

profileId

An optional profile-id of a ds-profile with which this Delivery Service shall be associated

profileName

The profile-name of the ds-profile with which this Delivery Service is associated

protocol

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

qstringIgnore

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

rangeRequestHandling

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

regexRemap

A ds-regex-remap

regionalGeoBlocking

A boolean defining the ds-regionalgeo setting on this Delivery Service

remapText

ds-raw-remap

routingName

The ds-routing-name of this Delivery Service

signed

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

signingAlgorithm

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

sslKeyVersion

This integer indicates the ds-ssl-key-version

tenant

The name of the Tenant who owns this Origin

tenantId

The integral, unique identifier of the ds-tenant who owns this Delivery Service

topology

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

trRequestHeaders

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

trResponseHeaders

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

type

The ds-types of this Delivery Service

typeId

The integral, unique identifier of the ds-types of this Delivery Service

xmlId

This Delivery Service's ds-xmlid

id

The integral, unique identifier assigned to the DSR <Delivery Service Request>

lastEditedBy

The username of user who last edited this DSR <Delivery Service Request>

lastEditedById

The integral, unique identifier assigned to the user who last edited this DSR <Delivery Service Request>

lastUpdated

The date and time at which the DSR <Delivery Service Request> was last updated, in non-rfc-datetime.

status

The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
X-Server-Name: traffic_ops_golang/
Date: Mon, 24 Feb 2020 19:14:07 GMT
Content-Length: 872

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

POST

Note

This route does NOT do the same thing as POST deliveryservices/request <to-api-v3-deliveryservices-request>.

Creates a new Delivery Service Request.

Auth. Required

Yes

Roles Required

"admin", "Federation", "operations", "Portal", or "Steering"

Response Type

Object

Request Structure

changeType

The action that you want to perform on the delivery service. It can be "create", "update", or "delete".

status

The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".

deliveryService

The Delivery Service that you have submitted for review as part of this request.

active

A boolean that defines ds-active.

anonymousBlockingEnabled

A boolean that defines ds-anonymous-blocking

cacheurl

A ds-cacheurl

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

ccrDnsTtl

The ds-dns-ttl - named "ccrDnsTtl" for legacy reasons

cdnId

The integral, unique identifier of the ds-cdn to which the Delivery Service belongs

cdnName

Name of the ds-cdn to which the Delivery Service belongs

checkPath

A ds-check-path

consistentHashQueryParams

An array of ds-consistent-hashing-qparams

consistentHashRegex

A ds-consistent-hashing-regex

deepCachingType

The ds-deep-caching setting for this Delivery Service

displayName

The ds-display-name

dnsBypassCname

A ds-dns-bypass-cname

dnsBypassIp

A ds-dns-bypass-ip

dnsBypassIp6

A ds-dns-bypass-ipv6

dnsBypassTtl

The ds-dns-bypass-ttl

dscp

A ds-dscp to be used within the Delivery Service

ecsEnabled

A boolean that defines the ds-ecs setting on this Delivery Service

edgeHeaderRewrite

A set of ds-edge-header-rw-rules

exampleURLs

An array of ds-example-urls

firstHeaderRewrite

A set of ds-first-header-rw-rules

fqPacingRate

The ds-fqpr

geoLimit

An integer that defines the ds-geo-limit

geoLimitCountries

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

geoLimitRedirectUrl

A ds-geo-limit-redirect-url

geoProvider

The ds-geo-provider

globalMaxMbps

The ds-global-max-mbps

globalMaxTps

The ds-global-max-tps

httpBypassFqdn

A ds-http-bypass-fqdn

id

An integral, unique identifier for this Delivery Service

infoUrl

An ds-info-url

initialDispersion

The ds-initial-dispersion

innerHeaderRewrite

A set of ds-inner-header-rw-rules

ipv6RoutingEnabled

A boolean that defines the ds-ipv6-routing setting on this Delivery Service

lastHeaderRewrite

A set of ds-last-header-rw-rules

lastUpdated

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

logsEnabled

A boolean that defines the ds-logs-enabled setting on this Delivery Service

longDesc

The ds-longdesc of this Delivery Service

longDesc1

An optional field containing the 2nd long description of this Delivery Service

longDesc2

An optional field containing the 3rd long description of this Delivery Service

matchList

The Delivery Service's ds-matchlist

pattern

A regular expression - the use of this pattern is dependent on the type field (backslashes are escaped)

setNumber

An integer that provides explicit ordering of ds-matchlist items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.

type

The type of match performed using pattern.

maxDnsAnswers

The ds-max-dns-answers allowed for this Delivery Service

maxOriginConnections

The ds-max-origin-connections

midHeaderRewrite

A set of ds-mid-header-rw-rules

missLat

The ds-geo-miss-default-latitude used by this Delivery Service

missLong

The ds-geo-miss-default-longitude used by this Delivery Service

multiSiteOrigin

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

orgServerFqdn

The ds-origin-url

originShield

A ds-origin-shield string

profileDescription

The profile-description of the ds-profile with which this Delivery Service is associated

profileId

An optional profile-id of a ds-profile with which this Delivery Service shall be associated

profileName

The profile-name of the ds-profile with which this Delivery Service is associated

protocol

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

qstringIgnore

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

rangeRequestHandling

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

regexRemap

A ds-regex-remap

regionalGeoBlocking

A boolean defining the ds-regionalgeo setting on this Delivery Service

remapText

ds-raw-remap

routingName

The ds-routing-name of this Delivery Service

signed

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

signingAlgorithm

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

sslKeyVersion

This integer indicates the ds-ssl-key-version

tenant

The name of the Tenant who owns this Origin

tenantId

The integral, unique identifier of the ds-tenant who owns this Delivery Service

topology

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

trRequestHeaders

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

trResponseHeaders

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

type

The ds-types of this Delivery Service

typeId

The integral, unique identifier of the ds-types of this Delivery Service

xmlId

This Delivery Service's ds-xmlid

POST /api/3.0/deliveryservice_requests HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 1979

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

Response Structure

author

The username of the user who created the Delivery Service Request.

authorId

The integral, unique identifier assigned to the author

changeType

The change type of the DSR <Delivery Service Request>. It can be create, update, or delete....

createdAt

The date and time at which the DSR <Delivery Service Request> was created, in non-rfc-datetime.

deliveryService

The delivery service that the DSR <Delivery Service Request> is requesting to update.

active

A boolean that defines ds-active.

anonymousBlockingEnabled

A boolean that defines ds-anonymous-blocking

cacheurl

A ds-cacheurl

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

ccrDnsTtl

The ds-dns-ttl - named "ccrDnsTtl" for legacy reasons

cdnId

The integral, unique identifier of the ds-cdn to which the Delivery Service belongs

cdnName

Name of the ds-cdn to which the Delivery Service belongs

checkPath

A ds-check-path

consistentHashQueryParams

An array of ds-consistent-hashing-qparams

consistentHashRegex

A ds-consistent-hashing-regex

deepCachingType

The ds-deep-caching setting for this Delivery Service

displayName

The ds-display-name

dnsBypassCname

A ds-dns-bypass-cname

dnsBypassIp

A ds-dns-bypass-ip

dnsBypassIp6

A ds-dns-bypass-ipv6

dnsBypassTtl

The ds-dns-bypass-ttl

dscp

A ds-dscp to be used within the Delivery Service

ecsEnabled

A boolean that defines the ds-ecs setting on this Delivery Service

edgeHeaderRewrite

A set of ds-edge-header-rw-rules

exampleURLs

An array of ds-example-urls

firstHeaderRewrite

A set of ds-first-header-rw-rules

fqPacingRate

The ds-fqpr

geoLimit

An integer that defines the ds-geo-limit

geoLimitCountries

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

geoLimitRedirectUrl

A ds-geo-limit-redirect-url

geoProvider

The ds-geo-provider

globalMaxMbps

The ds-global-max-mbps

globalMaxTps

The ds-global-max-tps

httpBypassFqdn

A ds-http-bypass-fqdn

id

An integral, unique identifier for this Delivery Service

infoUrl

An ds-info-url

initialDispersion

The ds-initial-dispersion

innerHeaderRewrite

A set of ds-inner-header-rw-rules

ipv6RoutingEnabled

A boolean that defines the ds-ipv6-routing setting on this Delivery Service

lastHeaderRewrite

A set of ds-last-header-rw-rules

lastUpdated

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

logsEnabled

A boolean that defines the ds-logs-enabled setting on this Delivery Service

longDesc

The ds-longdesc of this Delivery Service

longDesc1

An optional field containing the 2nd long description of this Delivery Service

longDesc2

An optional field containing the 3rd long description of this Delivery Service

matchList

The Delivery Service's ds-matchlist

pattern

A regular expression - the use of this pattern is dependent on the type field (backslashes are escaped)

setNumber

An integer that provides explicit ordering of ds-matchlist items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.

type

The type of match performed using pattern.

maxDnsAnswers

The ds-max-dns-answers allowed for this Delivery Service

maxOriginConnections

The ds-max-origin-connections

midHeaderRewrite

A set of ds-mid-header-rw-rules

missLat

The ds-geo-miss-default-latitude used by this Delivery Service

missLong

The ds-geo-miss-default-longitude used by this Delivery Service

multiSiteOrigin

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

orgServerFqdn

The ds-origin-url

originShield

A ds-origin-shield string

profileDescription

The profile-description of the ds-profile with which this Delivery Service is associated

profileId

An optional profile-id of a ds-profile with which this Delivery Service shall be associated

profileName

The profile-name of the ds-profile with which this Delivery Service is associated

protocol

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

qstringIgnore

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

rangeRequestHandling

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

regexRemap

A ds-regex-remap

regionalGeoBlocking

A boolean defining the ds-regionalgeo setting on this Delivery Service

remapText

ds-raw-remap

routingName

The ds-routing-name of this Delivery Service

signed

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

signingAlgorithm

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

sslKeyVersion

This integer indicates the ds-ssl-key-version

tenant

The name of the Tenant who owns this Origin

tenantId

The integral, unique identifier of the ds-tenant who owns this Delivery Service

topology

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

trRequestHeaders

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

trResponseHeaders

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

type

The ds-types of this Delivery Service

typeId

The integral, unique identifier of the ds-types of this Delivery Service

xmlId

This Delivery Service's ds-xmlid

id

The integral, unique identifier assigned to the DSR <Delivery Service Request>

lastEditedBy

The username of user who last edited this DSR <Delivery Service Request>

lastEditedById

The integral, unique identifier assigned to the user who last edited this DSR <Delivery Service Request>

lastUpdated

The date and time at which the DSR <Delivery Service Request> was last updated, in non-rfc-datetime.

status

The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
X-Server-Name: traffic_ops_golang/
Date: Mon, 24 Feb 2020 19:11:12 GMT
Content-Length: 901

{
    "alerts": [
        {
            "text": "deliveryservice_request was created.",
            "level": "success"
        }
    ],
    "response": {
        "authorId": 2,
        "author": null,
        "changeType": "update",
        "createdAt": null,
        "id": 1,
        "lastEditedBy": null,
        "lastEditedById": 2,
        "lastUpdated": "2020-02-24 19:11:12+00",
        "deliveryService": {
            "active": false,
            "anonymousBlockingEnabled": false,
            "cacheurl": null,
            "ccrDnsTtl": null,
            "cdnId": 2,
            "cdnName": "CDN-in-a-Box",
            "checkPath": null,
            "displayName": "Demo 1",
            "dnsBypassCname": null,
            "dnsBypassIp": null,
            "dnsBypassIp6": null,
            "dnsBypassTtl": null,
            "dscp": 0,
            "edgeHeaderRewrite": null,
            "firstHeaderRewrite": null,
            "geoLimit": 0,
            "geoLimitCountries": null,
            "geoLimitRedirectURL": null,
            "geoProvider": 0,
            "globalMaxMbps": null,
            "globalMaxTps": null,
            "httpBypassFqdn": null,
            "id": 1,
            "infoUrl": null,
            "initialDispersion": 1,
            "innerHeaderRewrite": null,
            "ipv6RoutingEnabled": true,
            "lastHeaderRewrite": null,
            "lastUpdated": "0001-01-01 00:00:00+00",
            "logsEnabled": true,
            "longDesc": "Apachecon North America 2018",
            "longDesc1": null,
            "longDesc2": null,
            "matchList": [
                {
                    "type": "HOST_REGEXP",
                    "setNumber": 0,
                    "pattern": ".*\\.demo1\\..*"
                }
            ],
            "maxDnsAnswers": null,
            "midHeaderRewrite": null,
            "missLat": 42,
            "missLong": -88,
            "multiSiteOrigin": false,
            "originShield": null,
            "orgServerFqdn": "http://origin.infra.ciab.test",
            "profileDescription": null,
            "profileId": null,
            "profileName": null,
            "protocol": 2,
            "qstringIgnore": 0,
            "rangeRequestHandling": 0,
            "regexRemap": null,
            "regionalGeoBlocking": false,
            "remapText": null,
            "routingName": "video",
            "signed": false,
            "sslKeyVersion": 1,
            "tenantId": 1,
            "topology": null,
            "type": "HTTP",
            "typeId": 1,
            "xmlId": "demo1",
            "exampleURLs": [
                "http://video.demo1.mycdn.ciab.test",
                "https://video.demo1.mycdn.ciab.test"
            ],
            "deepCachingType": "NEVER",
            "fqPacingRate": null,
            "signingAlgorithm": null,
            "tenant": "root",
            "trResponseHeaders": null,
            "trRequestHeaders": null,
            "consistentHashRegex": null,
            "consistentHashQueryParams": [
                "abc",
                "pdq",
                "xxx",
                "zyx"
            ],
            "maxOriginConnections": 0,
            "ecsEnabled": false
        },
        "status": "draft"
    }
}

PUT

Updates an existing Delivery Service Request <ds_requests>.

Auth. Required

Yes

Roles Required

"admin", "Federation", "operations", "Portal", or "Steering"

Response Type

Object

Request Structure

changeType

The change type of the DSR <Delivery Service Request>. It can be create, update, or delete....

deliveryService

The delivery service that the DSR <Delivery Service Request> is requesting to update.

active

A boolean that defines ds-active.

anonymousBlockingEnabled

A boolean that defines ds-anonymous-blocking

cacheurl

A ds-cacheurl

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

ccrDnsTtl

The ds-dns-ttl - named "ccrDnsTtl" for legacy reasons

cdnId

The integral, unique identifier of the ds-cdn to which the Delivery Service belongs

cdnName

Name of the ds-cdn to which the Delivery Service belongs

checkPath

A ds-check-path

consistentHashQueryParams

An array of ds-consistent-hashing-qparams

consistentHashRegex

A ds-consistent-hashing-regex

deepCachingType

The ds-deep-caching setting for this Delivery Service

displayName

The ds-display-name

dnsBypassCname

A ds-dns-bypass-cname

dnsBypassIp

A ds-dns-bypass-ip

dnsBypassIp6

A ds-dns-bypass-ipv6

dnsBypassTtl

The ds-dns-bypass-ttl

dscp

A ds-dscp to be used within the Delivery Service

ecsEnabled

A boolean that defines the ds-ecs setting on this Delivery Service

edgeHeaderRewrite

A set of ds-edge-header-rw-rules

exampleURLs

An array of ds-example-urls

firstHeaderRewrite

A set of ds-first-header-rw-rules

fqPacingRate

The ds-fqpr

geoLimit

An integer that defines the ds-geo-limit

geoLimitCountries

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

geoLimitRedirectUrl

A ds-geo-limit-redirect-url

geoProvider

The ds-geo-provider

globalMaxMbps

The ds-global-max-mbps

globalMaxTps

The ds-global-max-tps

httpBypassFqdn

A ds-http-bypass-fqdn

id

An integral, unique identifier for this Delivery Service

infoUrl

An ds-info-url

initialDispersion

The ds-initial-dispersion

innerHeaderRewrite

A set of ds-inner-header-rw-rules

ipv6RoutingEnabled

A boolean that defines the ds-ipv6-routing setting on this Delivery Service

lastHeaderRewrite

A set of ds-last-header-rw-rules

lastUpdated

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

logsEnabled

A boolean that defines the ds-logs-enabled setting on this Delivery Service

longDesc

The ds-longdesc of this Delivery Service

longDesc1

An optional field containing the 2nd long description of this Delivery Service

longDesc2

An optional field containing the 3rd long description of this Delivery Service

matchList

The Delivery Service's ds-matchlist

pattern

A regular expression - the use of this pattern is dependent on the type field (backslashes are escaped)

setNumber

An integer that provides explicit ordering of ds-matchlist items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.

type

The type of match performed using pattern.

maxDnsAnswers

The ds-max-dns-answers allowed for this Delivery Service

maxOriginConnections

The ds-max-origin-connections

midHeaderRewrite

A set of ds-mid-header-rw-rules

missLat

The ds-geo-miss-default-latitude used by this Delivery Service

missLong

The ds-geo-miss-default-longitude used by this Delivery Service

multiSiteOrigin

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

orgServerFqdn

The ds-origin-url

originShield

A ds-origin-shield string

profileDescription

The profile-description of the ds-profile with which this Delivery Service is associated

profileId

An optional profile-id of a ds-profile with which this Delivery Service shall be associated

profileName

The profile-name of the ds-profile with which this Delivery Service is associated

protocol

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

qstringIgnore

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

rangeRequestHandling

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

regexRemap

A ds-regex-remap

regionalGeoBlocking

A boolean defining the ds-regionalgeo setting on this Delivery Service

remapText

ds-raw-remap

routingName

The ds-routing-name of this Delivery Service

signed

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

signingAlgorithm

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

sslKeyVersion

This integer indicates the ds-ssl-key-version

tenant

The name of the Tenant who owns this Origin

tenantId

The integral, unique identifier of the ds-tenant who owns this Delivery Service

topology

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

trRequestHeaders

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

trResponseHeaders

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

type

The ds-types of this Delivery Service

typeId

The integral, unique identifier of the ds-types of this Delivery Service

xmlId

This Delivery Service's ds-xmlid

id

The integral, unique identifier assigned to the DSR <Delivery Service Request>

status

The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".

Request Query Parameters
Name Required Description
id yes The integral, unique identifier of the Delivery Service Request <ds_requests> that you want to update. 
PUT /api/3.0/deliveryservice_requests?id=1 HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 2256

{
    "authorId": 2,
    "author": "admin",
    "changeType": "update",
    "createdAt": "2020-02-24 19:11:12+00",
    "id": 1,
    "lastEditedBy": "admin",
    "lastEditedById": 2,
    "lastUpdated": "2020-02-24 19:33:26+00",
    "deliveryService": {
        "active": false,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": null,
        "cdnId": 2,
        "cdnName": "CDN-in-a-Box",
        "checkPath": null,
        "displayName": "Demo 1",
        "dnsBypassCname": null,
        "dnsBypassIp": null,
        "dnsBypassIp6": null,
        "dnsBypassTtl": null,
        "dscp": 0,
        "edgeHeaderRewrite": null,
        "firstHeaderRewrite": null,
        "geoLimit": 0,
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": 0,
        "globalMaxMbps": null,
        "globalMaxTps": null,
        "httpBypassFqdn": null,
        "id": 1,
        "infoUrl": null,
        "initialDispersion": 1,
        "innerHeaderRewrite": null,
        "ipv6RoutingEnabled": true,
        "lastHeaderRewrite": null,
        "lastUpdated": "0001-01-01 00:00:00+00",
        "logsEnabled": true,
        "longDesc": "Apachecon North America 2018",
        "longDesc1": null,
        "longDesc2": null,
        "matchList": [
            {
                "type": "HOST_REGEXP",
                "setNumber": 0,
                "pattern": ".*\\.demo1\\..*"
            }
        ],
        "maxDnsAnswers": null,
        "midHeaderRewrite": null,
        "missLat": 42,
        "missLong": -88,
        "multiSiteOrigin": false,
        "originShield": null,
        "orgServerFqdn": "http://origin.infra.ciab.test",
        "profileDescription": null,
        "profileId": null,
        "profileName": null,
        "protocol": 2,
        "qstringIgnore": 0,
        "rangeRequestHandling": 0,
        "regexRemap": null,
        "regionalGeoBlocking": false,
        "remapText": null,
        "routingName": "video",
        "signed": false,
        "sslKeyVersion": 1,
        "tenantId": 1,
        "topology": null,
        "type": "HTTP",
        "typeId": 1,
        "xmlId": "demo1",
        "exampleURLs": [
            "http://video.demo1.mycdn.ciab.test",
            "https://video.demo1.mycdn.ciab.test"
        ],
        "deepCachingType": "NEVER",
        "fqPacingRate": null,
        "signingAlgorithm": null,
        "tenant": "root",
        "trResponseHeaders": "",
        "trRequestHeaders": null,
        "consistentHashRegex": null,
        "consistentHashQueryParams": [
            "abc",
            "pdq",
            "xxx",
            "zyx"
        ],
        "maxOriginConnections": 0,
        "ecsEnabled": false
    },
    "status": "submitted"
}

Response Structure

changeType

The change type of the DSR <Delivery Service Request>. It can be create, update, or delete....

deliveryService

The delivery service that the DSR <Delivery Service Request> is requesting to update.

active

A boolean that defines ds-active.

anonymousBlockingEnabled

A boolean that defines ds-anonymous-blocking

cacheurl

A ds-cacheurl

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

ccrDnsTtl

The ds-dns-ttl - named "ccrDnsTtl" for legacy reasons

cdnId

The integral, unique identifier of the ds-cdn to which the Delivery Service belongs

cdnName

Name of the ds-cdn to which the Delivery Service belongs

checkPath

A ds-check-path

consistentHashQueryParams

An array of ds-consistent-hashing-qparams

consistentHashRegex

A ds-consistent-hashing-regex

deepCachingType

The ds-deep-caching setting for this Delivery Service

displayName

The ds-display-name

dnsBypassCname

A ds-dns-bypass-cname

dnsBypassIp

A ds-dns-bypass-ip

dnsBypassIp6

A ds-dns-bypass-ipv6

dnsBypassTtl

The ds-dns-bypass-ttl

dscp

A ds-dscp to be used within the Delivery Service

ecsEnabled

A boolean that defines the ds-ecs setting on this Delivery Service

edgeHeaderRewrite

A set of ds-edge-header-rw-rules

exampleURLs

An array of ds-example-urls

firstHeaderRewrite

A set of ds-first-header-rw-rules

fqPacingRate

The ds-fqpr

geoLimit

An integer that defines the ds-geo-limit

geoLimitCountries

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

geoLimitRedirectUrl

A ds-geo-limit-redirect-url

geoProvider

The ds-geo-provider

globalMaxMbps

The ds-global-max-mbps

globalMaxTps

The ds-global-max-tps

httpBypassFqdn

A ds-http-bypass-fqdn

id

An integral, unique identifier for this Delivery Service

infoUrl

An ds-info-url

initialDispersion

The ds-initial-dispersion

innerHeaderRewrite

A set of ds-inner-header-rw-rules

ipv6RoutingEnabled

A boolean that defines the ds-ipv6-routing setting on this Delivery Service

lastHeaderRewrite

A set of ds-last-header-rw-rules

lastUpdated

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

logsEnabled

A boolean that defines the ds-logs-enabled setting on this Delivery Service

longDesc

The ds-longdesc of this Delivery Service

longDesc1

An optional field containing the 2nd long description of this Delivery Service

longDesc2

An optional field containing the 3rd long description of this Delivery Service

matchList

The Delivery Service's ds-matchlist

pattern

A regular expression - the use of this pattern is dependent on the type field (backslashes are escaped)

setNumber

An integer that provides explicit ordering of ds-matchlist items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.

type

The type of match performed using pattern.

maxDnsAnswers

The ds-max-dns-answers allowed for this Delivery Service

maxOriginConnections

The ds-max-origin-connections

midHeaderRewrite

A set of ds-mid-header-rw-rules

missLat

The ds-geo-miss-default-latitude used by this Delivery Service

missLong

The ds-geo-miss-default-longitude used by this Delivery Service

multiSiteOrigin

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

orgServerFqdn

The ds-origin-url

originShield

A ds-origin-shield string

profileDescription

The profile-description of the ds-profile with which this Delivery Service is associated

profileId

An optional profile-id of a ds-profile with which this Delivery Service shall be associated

profileName

The profile-name of the ds-profile with which this Delivery Service is associated

protocol

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

qstringIgnore

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

rangeRequestHandling

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

regexRemap

A ds-regex-remap

regionalGeoBlocking

A boolean defining the ds-regionalgeo setting on this Delivery Service

remapText

ds-raw-remap

routingName

The ds-routing-name of this Delivery Service

signed

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

signingAlgorithm

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

sslKeyVersion

This integer indicates the ds-ssl-key-version

tenant

The name of the Tenant who owns this Origin

tenantId

The integral, unique identifier of the ds-tenant who owns this Delivery Service

topology

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

trRequestHeaders

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

trResponseHeaders

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

type

The ds-types of this Delivery Service

typeId

The integral, unique identifier of the ds-types of this Delivery Service

xmlId

This Delivery Service's ds-xmlid

id

The integral, unique identifier assigned to the DSR <Delivery Service Request>

lastEditedBy

The username of user who last edited this DSR <Delivery Service Request>

lastEditedById

The integral, unique identifier assigned to the user who last edited this DSR <Delivery Service Request>

lastUpdated

The date and time at which the DSR <Delivery Service Request> was last updated, in non-rfc-datetime.

status

The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:36:16 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: +W0vFm96yFkZUJqa0GAX7uzIpRKh/ohyBm0uH3egpiERTcxy5OfVVtoP3h8Ee2teLu8KFooDYXJ6rpQg6UhbNQ==
X-Server-Name: traffic_ops_golang/
Date: Mon, 24 Feb 2020 19:36:16 GMT
Content-Length: 913

{
    "alerts": [
        {
            "text": "deliveryservice_request was updated.",
            "level": "success"
        }
    ],
    "response": {
        "authorId": 0,
        "author": "admin",
        "changeType": "update",
        "createdAt": "0001-01-01 00:00:00+00",
        "id": 1,
        "lastEditedBy": "admin",
        "lastEditedById": 2,
        "lastUpdated": "2020-02-24 19:36:16+00",
        "deliveryService": {
            "active": false,
            "anonymousBlockingEnabled": false,
            "cacheurl": null,
            "ccrDnsTtl": null,
            "cdnId": 2,
            "cdnName": "CDN-in-a-Box",
            "checkPath": null,
            "displayName": "Demo 1",
            "dnsBypassCname": null,
            "dnsBypassIp": null,
            "dnsBypassIp6": null,
            "dnsBypassTtl": null,
            "dscp": 0,
            "edgeHeaderRewrite": null,
            "firstHeaderRewrite": null,
            "geoLimit": 0,
            "geoLimitCountries": null,
            "geoLimitRedirectURL": null,
            "geoProvider": 0,
            "globalMaxMbps": null,
            "globalMaxTps": null,
            "httpBypassFqdn": null,
            "id": 1,
            "infoUrl": null,
            "initialDispersion": 1,
            "innerHeaderRewrite": null,
            "ipv6RoutingEnabled": true,
            "lastHeaderRewrite": null,
            "lastUpdated": "0001-01-01 00:00:00+00",
            "logsEnabled": true,
            "longDesc": "Apachecon North America 2018",
            "longDesc1": null,
            "longDesc2": null,
            "matchList": [
                {
                    "type": "HOST_REGEXP",
                    "setNumber": 0,
                    "pattern": ".*\\.demo1\\..*"
                }
            ],
            "maxDnsAnswers": null,
            "midHeaderRewrite": null,
            "missLat": 42,
            "missLong": -88,
            "multiSiteOrigin": false,
            "originShield": null,
            "orgServerFqdn": "http://origin.infra.ciab.test",
            "profileDescription": null,
            "profileId": null,
            "profileName": null,
            "protocol": 2,
            "qstringIgnore": 0,
            "rangeRequestHandling": 0,
            "regexRemap": null,
            "regionalGeoBlocking": false,
            "remapText": null,
            "routingName": "video",
            "signed": false,
            "sslKeyVersion": 1,
            "tenantId": 1,
            "topology": null,
            "type": "HTTP",
            "typeId": 1,
            "xmlId": "demo1",
            "exampleURLs": [
                "http://video.demo1.mycdn.ciab.test",
                "https://video.demo1.mycdn.ciab.test"
            ],
            "deepCachingType": "NEVER",
            "fqPacingRate": null,
            "signingAlgorithm": null,
            "tenant": "root",
            "trResponseHeaders": "",
            "trRequestHeaders": null,
            "consistentHashRegex": null,
            "consistentHashQueryParams": [
                "abc",
                "pdq",
                "xxx",
                "zyx"
            ],
            "maxOriginConnections": 0,
            "ecsEnabled": false
        },
        "status": "submitted"
    }
}

DELETE

Deletes a Delivery Service Request.

Auth. Required

Yes

Roles Required

"admin", "Federation", "operations", "Portal", or "Steering"

Response Type

undefined

Request Structure

Request Query Parameters
Name Required Description
id yes The integral, unique identifier of the Delivery Service Request <ds_requests> that you want to delete. 
DELETE /api/3.0/deliveryservice_requests?id=1 HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 0

Response Structure

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:48:55 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: jNCbNo8Tw+JMMaWpAYQgntSXPq2Xuj+n2zSEVRaDQFWMV1SYbT9djes6SPdwiBoKq6W0lNE04hOE92jBVcjtEw==
X-Server-Name: traffic_ops_golang/
Date: Mon, 24 Feb 2020 19:48:55 GMT
Content-Length: 96

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