cdns/{{ID}}/queue_update

POST

Queue or “dequeue” updates for all servers assigned to a specific CDN.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

SERVER:QUEUE, CDN:READ

Response Type:

Object

Request Structure

Table 282 Request Path Parameters

Name

Description

ID

The integral, unique identifier for the CDN on which to (de)queue updates

Table 283 Request Query Parameters

Name

Required

Description

type

no

The name of the type of servers, for which the updates need to be queued or dequeued.

profile

no

The name of the profile of servers, for which the updates need to be queued or dequeued.

action:

One of “queue” or “dequeue” as appropriate

#688 Request Example
POST /api/4.0/cdns/2/queue_update?type=EDGE HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 19
Content-Type: application/json

{"action": "queue"}

Response Structure

action:

The action processed, either "queue" or "dequeue"

cdnId:

The integral, unique identifier for the CDN on which Queue Updates was performed or cleared

#689 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-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: rBpFfrrP+9IFkwsRloEM+v+I8MuBZDXqFu+WUTGtRGypnAn2gHooPoNQRyVvJGjyIQrLXLvqjEtve+lH2Tj4uw==
X-Server-Name: traffic_ops_golang/
Date: Wed, 14 Nov 2018 21:02:07 GMT
Content-Length: 41

{ "response": {
    "action": "queue",
    "cdnId": 2
}}