status`

Sets the status of a Delivery Service Request.

`PUT`

Auth. Required:: Yes
Roles Required:: “admin”, “Federation”, “operations”, “Portal”, or “Steering”
Response Type:: Object

Request Structure

id:: The integral, unique identifier assigned to the DSR
status:: The status of the DSR <Delivery Service Request>. Can be “draft”, “submitted”, “rejected”, “pending”, or “complete”.

#295 Request Example

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

{
    "id": 1,
    "status": "rejected"
}

Response Structure

assignee:

The username of the user to whom the Delivery Service Request is assigned.

assigneeId:

The integral, unique identifier of the user to whom the Delivery Service Request is assigned.

author:

The author of the Delivery Service Request

authorId:

The integral, unique identifier assigned to the author

changeType:

The change type of the DSR. It can be create, update, or delete….

createdAt:

The date and time at which the DSR was created, in Traffic Ops’s Custom Date/Time Format.

deliveryService:

The delivery service that the DSR is requesting to update.

active:

A boolean that defines Active.

anonymousBlockingEnabled:

A boolean that defines Anonymous Blocking

cacheurl:

A Cache URL Expression

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

ccrDnsTtl:

The DNS TTL - named “ccrDnsTtl” for legacy reasons

cdnId:

The integral, unique identifier of the CDN to which the Delivery Service belongs

cdnName:

Name of the CDN to which the Delivery Service belongs

checkPath:

A Check Path

consistentHashQueryParams:

An array of Consistent Hashing Query Parameters

consistentHashRegex:

A Consistent Hashing Regular Expression

deepCachingType:

The Deep Caching setting for this Delivery Service

displayName:

The Display Name

dnsBypassCname:

A DNS Bypass CNAME

dnsBypassIp:

A DNS Bypass IP

dnsBypassIp6:

A DNS Bypass IPv6

dnsBypassTtl:

The DNS Bypass TTL

dscp:

A DSCP to be used within the Delivery Service

ecsEnabled:

A boolean that defines the EDNS0 Client Subnet Enabled setting on this Delivery Service

edgeHeaderRewrite:

A set of Edge Header Rewrite Rules

exampleURLs:

An array of Example URLs

firstHeaderRewrite:

A set of First Header Rewrite Rules

fqPacingRate:

The Fair-Queuing Pacing Rate Bps

geoLimit:

An integer that defines the Geo Limit

geoLimitCountries:

A string containing a comma-separated list defining the Geo Limit Countries [1]

geoLimitRedirectUrl:

A Geo Limit Redirect URL [1]

geoProvider:

The Geolocation Provider

globalMaxMbps:

The Global Max Mbps

globalMaxTps:

The Global Max TPS

httpBypassFqdn:

A HTTP Bypass FQDN

id:

An integral, unique identifier for this Delivery Service

infoUrl:

An Info URL

initialDispersion:

The Initial Dispersion

innerHeaderRewrite:

A set of Inner Header Rewrite Rules

ipv6RoutingEnabled:

A boolean that defines the IPv6 Routing Enabled setting on this Delivery Service

lastHeaderRewrite:

A set of Last Header Rewrite Rules

lastUpdated:

The date and time at which this Delivery Service was last updated, in Traffic Ops’s Custom Date/Time Format

logsEnabled:

A boolean that defines the Logs Enabled setting on this Delivery Service

longDesc:

The Long Description of this Delivery Service

longDesc1:

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 Match List

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

maxDnsAnswers:

The Max DNS Answers allowed for this Delivery Service

maxOriginConnections:

The Max Origin Connections

midHeaderRewrite:

A set of Mid Header Rewrite Rules

missLat:

The Geo Miss Default Latitude used by this Delivery Service

missLong:

The Geo Miss Default Longitude used by this Delivery Service

multiSiteOrigin:

A boolean that defines the use of Use Multi-Site Origin Feature by this Delivery Service

orgServerFqdn:

The Origin Server Base URL

originShield:

A Origin Shield string

profileDescription:

The Description of the Profile with which this Delivery Service is associated

profileId:

An optional ID of a Profile with which this Delivery Service shall be associated

profileName:

The Name of the Profile with which this Delivery Service is associated

protocol:

An integral, unique identifier that corresponds to the Protocol used by this Delivery Service

qstringIgnore:

An integral, unique identifier that corresponds to the Query String Handling setting on this Delivery Service

rangeRequestHandling:

An integral, unique identifier that corresponds to the Range Request Handling setting on this Delivery Service

regexRemap:

A Regex Remap Expression

regionalGeoBlocking:

A boolean defining the Regional Geoblocking setting on this Delivery Service

remapText:

Raw Remap Text

routingName:

The Routing Name of this Delivery Service

signed:

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

signingAlgorithm:

Either a Signing Algorithm or null to indicate URL/URI signing is not implemented on this Delivery Service

sslKeyVersion:

This integer indicates the SSL Key Version

tenant:

The name of the Tenant who owns this Origin

tenantId:

The integral, unique identifier of the Tenant who owns this Delivery Service

topology:

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

trRequestHeaders:

If defined, this defines the Traffic Router Log Request Headers used by Traffic Router for this Delivery Service

trResponseHeaders:

If defined, this defines the Traffic Router Additional Response Headers used by Traffic Router for this Delivery Service

type:

The Type of this Delivery Service

typeId:

The integral, unique identifier of the Type of this Delivery Service

xmlId:

This Delivery Service’s xml_id

id:

The integral, unique identifier assigned to the DSR

lastEditedBy:

The username of user who last edited this DSR

lastEditedById:

The integral, unique identifier assigned to the user who last edited this DSR

lastUpdated:

The date and time at which the DSR was last updated, in Traffic Ops’s Custom Date/Time Format.

status:

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

#296 Response Example

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=Sun, 23 Feb 2020 15:54:53 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: C8Nhciy1jv5X7CGgHwAnLp1qmLIzHq+4dvlAApb3cFSz5V2dABl7+N1Z4ndzB7GertB7rNLP31pVcat8vEz6rA==
X-Server-Name: traffic_ops_golang/
Date: Sun, 23 Feb 2020 14:54:53 GMT
Content-Length: 930

{
    "alerts": [
        {
            "text": "deliveryservice_request was updated.",
            "level": "success"
        }
    ],
    "response": {
        "assigneeId": 2,
        "assignee": "admin",
        "authorId": 2,
        "author": "admin",
        "changeType": "update",
        "createdAt": "2020-02-23 11:06:00+00",
        "id": 1,
        "lastEditedBy": "admin",
        "lastEditedById": 2,
        "lastUpdated": "2020-02-23 14:54:53+00",
        "deliveryService": {
            "active": true,
            "anonymousBlockingEnabled": false,
            "cacheurl": null,
            "ccrDnsTtl": null,
            "cdnId": 2,
            "cdnName": "CDN-in-a-Box",
            "checkPath": null,
            "displayName": "Demo 2",
            "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": null,
            "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": "rejected"
    }
}

deliveryservice_requests/{{ID}}/status

PUT

Request Structure

Response Structure

`deliveryservice_requests/{{ID}}/status`

`PUT`