topologies_name_queue_update.rst

topologies/{{name}}/queue_update

POST

:term:`Queue` or "dequeue" updates for all servers assigned to the :term:`Cache Groups` in a specific :term:`Topology`.

Auth. Required:	Yes
Roles Required:	"admin" or "operations"
Permissions Required:	SERVER:QUEUE, TOPOLOGY:READ, SERVER:READ, CACHE-GROUP:READ
Response Type:	Object

Request Structure

Request Path Parameters

Name	Description
name	The name of the :term:`Topology` on which to queue or dequeue updates.

action:	One of "queue" or "dequeue" as appropriate
cdnId:	The integral, unique identifier for the CDN on which to (de)queue updates

POST /api/4.0/topologies/demo1-top/queue_update HTTP/1.1
User-Agent: python-requests/2.24.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 28

{
        "action": "queue",
        "cdnId": 1
}

Response Structure

action:	The action processed, either "queue" or "dequeue"
cdnId:	The CDN ID on which :term:`Queue Updates` was performed or cleared
topology:	The name of the :term:`Topology` on which :term:`Queue Updates` was performed or cleared

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, 08 Sep 2020 17:35:42 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
Whole-Content-Sha512: nmu3TMVmllcHeEstLuiqPsEpypNV2jcs5PyrqsqJKkexxxb8N7qk84AWzTJWUpsfdVWrj/JzRiCPGJS4hw0phQ==
X-Server-Name: traffic_ops_golang/
Date: Tue, 08 Sep 2020 16:35:42 GMT
Content-Length: 79

{
        "response": {
                "action": "queue",
                "cdnId": 1,
                "topology": "demo1-top"
        }
}