deliveryservice_requests/{{ID}}/status

Get or set the status of a Delivery Service Request.

GET

Gets the status of a DSR.

New in version 4.0.

Auth. Required:

Yes

Roles Required:

“admin”, “Federation”, “operations”, “Portal”, or “Steering”

Permissions Required:

DS-REQUEST:READ

Response Type:

Object (string)

Request Structure

Table 309 Request Path Parameters

Name	Description
ID	The integral, unique identifier of the Delivery Service Request being inspected

#743 Request Example

GET /api/4.1/deliveryservice_requests/1/status HTTP/1.1
User-Agent: python-requests/2.24.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure

The response is the status of the requested DSR.

#744 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=Tue, 02 Feb 2021 22:56:47 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
X-Server-Name: traffic_ops_golang/
Date: Tue, 02 Feb 2021 21:56:47 GMT
Content-Length: 45

{ "response": "draft" }

PUT

Auth. Required:

Yes

Roles Required:

“admin”, “Federation”, “operations”, “Portal”, or “Steering”

Permissions Required:

DS-REQUEST:UPDATE, DS-REQUEST:READ

Response Type:

Object

Request Structure

Table 310 Request Path Parameters

Name	Description
ID	The integral, unique identifier of the Delivery Service Request being modified

status:

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

#745 Request Example

PUT /api/4.1/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

{
    "status": "rejected"
}

Response Structure

The response is a full representation of the modified DSR.

#746 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": "Changed status of 'demo1' Delivery Service Request from 'draft' to 'submitted'",
    "level": "success"
}],
"response": {
    "assignee": "admin",
    "author": "admin",
    "changeType": "update",
    "createdAt": "2020-09-25T06:52:23.758877Z",
    "id": 6,
    "lastEditedBy": "admin",
    "lastUpdated": "2020-09-25T07:13:28.753352Z",
    "original": {
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": null,
        "cdnId": 2,
        "cdnName": "CDN-in-a-Box",
        "checkPath": null,
        "displayName": "Demo 1",
        "dnsBypassCname": null,
        "dnsBypassIp": null,
        "dnsBypassIp6": null,
        "dnsBypassTtl": null,
        "dscp": 0,
        "edgeHeaderRewrite": null,
        "geoLimit": 0,
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": 0,
        "globalMaxMbps": null,
        "globalMaxTps": null,
        "httpBypassFqdn": null,
        "id": 1,
        "infoUrl": null,
        "initialDispersion": 1,
        "ipv6RoutingEnabled": true,
        "lastUpdated": "2020-09-25T02:09:54Z",
        "logsEnabled": true,
        "longDesc": "Apachecon North America 2018",
        "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,
        "regional": false,
        "regionalGeoBlocking": false,
        "remapText": null,
        "requiredCapabilities": [],
        "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",
        "trResponseHeaders": null,
        "trRequestHeaders": null,
        "consistentHashRegex": null,
        "consistentHashQueryParams": [
            "abc",
            "pdq",
            "xxx",
            "zyx"
        ],
        "maxOriginConnections": 0,
        "ecsEnabled": false,
        "rangeSliceBlockSize": null,
        "topology": "demo1-top",
        "firstHeaderRewrite": null,
        "innerHeaderRewrite": null,
        "lastHeaderRewrite": null,
        "serviceCategory": null,
        "tlsVersions": null
    },
    "requested": {
        "active": true,
        "anonymousBlockingEnabled": false,
        "cacheurl": null,
        "ccrDnsTtl": 30,
        "cdnId": 2,
        "cdnName": null,
        "checkPath": null,
        "displayName": "Demo 1 but modified by a DSR",
        "dnsBypassCname": null,
        "dnsBypassIp": null,
        "dnsBypassIp6": null,
        "dnsBypassTtl": null,
        "dscp": 0,
        "edgeHeaderRewrite": null,
        "geoLimit": 0,
        "geoLimitCountries": null,
        "geoLimitRedirectURL": null,
        "geoProvider": 0,
        "globalMaxMbps": null,
        "globalMaxTps": null,
        "httpBypassFqdn": null,
        "id": 1,
        "infoUrl": null,
        "initialDispersion": 3,
        "ipv6RoutingEnabled": null,
        "lastUpdated": null,
        "logsEnabled": false,
        "longDesc": "long desc",
        "matchList": null,
        "maxDnsAnswers": null,
        "midHeaderRewrite": null,
        "missLat": null,
        "missLong": null,
        "multiSiteOrigin": null,
        "originShield": null,
        "orgServerFqdn": null,
        "profileDescription": null,
        "profileId": null,
        "profileName": null,
        "protocol": null,
        "qstringIgnore": null,
        "rangeRequestHandling": null,
        "regexRemap": null,
        "regional": false,
        "regionalGeoBlocking": false,
        "remapText": null,
        "requiredCapabilities": [],
        "routingName": "cdn",
        "signed": false,
        "sslKeyVersion": null,
        "tenantId": 1,
        "type": null,
        "typeId": 8,
        "xmlId": "demo1",
        "exampleURLs": null,
        "deepCachingType": "NEVER",
        "fqPacingRate": null,
        "signingAlgorithm": null,
        "tenant": null,
        "trResponseHeaders": null,
        "trRequestHeaders": null,
        "consistentHashRegex": null,
        "consistentHashQueryParams": null,
        "maxOriginConnections": 0,
        "ecsEnabled": false,
        "rangeSliceBlockSize": null,
        "topology": null,
        "firstHeaderRewrite": null,
        "innerHeaderRewrite": null,
        "lastHeaderRewrite": null,
        "serviceCategory": null,
        "tlsVersions": null
    },
    "status": "submitted"
}}