servers_id_queue_update.rst

servers/{{ID}}/queue_update

Caution

In the vast majority of cases, it is advisable that the PUT method of the to-api-v3-servers-id endpoint be used instead.

POST

Queue or dequeue updates for a specific server.

Auth. Required

Yes

Roles Required

"admin" or "operations"

Response Type

Object

Request Structure

Request Path Parameters

Name	Description
ID	The integral, unique identifier of the server on which updates are being queued or dequeued

action

A string describing what action to take regarding server updates; one of:

queue

Queue Updates for the server, propagating configuration changes to the actual server

dequeue

Cancels any pending updates on the server

POST /api/3.0/servers/13/queue_update HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 22
Content-Type: application/json

{
    "action": "dequeue"
}

Response Structure

action

The action processed, one of:

queue

Queue Updates was performed on the server, propagating configuration changes to the actual server

dequeue

Canceled any pending updates on the server

serverId

The integral, unique identifier of the server on which action was taken

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Type: application/json
Date: Mon, 10 Dec 2018 18:20:04 GMT
X-Server-Name: traffic_ops_golang/
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
Whole-Content-Sha512: 9Mmo9hIFZyF5gAvfdJD//VH9eNgiHVLinXt88H0GlJSHhwND8gMxaFyC+f9XZfiNAoGd1MKi1934ZJGmaIR6qQ==
Content-Length: 49

{
    "response": {
        "serverId": "13",
        "action": "dequeue"
    }
}