deliveryservices/{{ID}}/urlkeys

GET

Retrieves URL signing keys for a Delivery Service.

Caution

This method will return the Delivery Service’s PRIVATE URL signing keys! Be wary of using this endpoint and NEVER share the output with anyone who would be unable to see it on their own.

Auth. Required

Yes

Roles Required

None

Permissions Required

DS-SECURITY-KEY:READ, DELIVERY-SERVICE:READ

Response Type

Object

Request Structure

Table 322 Request Path Parameters

Name

Description

id

Filter for the Delivery Service identified by this integral, unique identifier

#763 Request Example
GET /api/4.0/deliveryservices/1/urlkeys HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure

key<N>

The private URL signing key for this Delivery Service as a base-64-encoded string, where <N> is the “generation” of the key e.g. the first key will always be named "key0". Up to 16 concurrent generations are retained at any time (<N> is always on the interval [0,15])

#764 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 16:34:56 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: cTc5OPE3hM+CiyQPCy36zD2tsQcfkvIqQ7/D82WGMWHm+ACW3YbcKhgPnSQU6+Tuj4jya52Kx9+nw5+OonFvPQ==
X-Server-Name: traffic_ops_golang/
Date: Sun, 23 Feb 2020 15:34:56 GMT
Content-Length: 533

{
    "response": {
        "key0": "...",
        "key1": "...",
        "key2": "...",
        "key3": "...",
        "key4": "...",
        "key5": "...",
        "key6": "...",
        "key7": "...",
        "key8": "...",
        "key9": "...",
        "key10": "...",
        "key11": "...",
        "key12": "...",
        "key13": "...",
        "key14": "...",
        "key15": "..."
    }
}

DELETE

Deletes URL signing keys for a Delivery Service.

Auth. Required

Yes

Roles Required

“admin” or “operations”

Permissions Required

DS-SECURITY-KEY:DELETE, DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE

Response Type

Object

Request Structure

Table 323 Request Path Parameters

Name

Description

id

Filter for the Delivery Service identified by this integral, unique identifier

Response Structure

#765 Response Example
{
    "alerts": [{
        "level": "success",
        "text": "Successfully deleted URL Sig keys from Traffic Vault"
    }]
}