Skip to content

Latest commit

 

History

History
91 lines (75 loc) · 3.6 KB

cachegroups_id_queue_update.rst

File metadata and controls

91 lines (75 loc) · 3.6 KB
Raw

cachegroups/{{ID}}/queue_update

POST

Queue or "dequeue" updates for all of a Cache Group's servers <cache-group-servers>, limited to a specific CDN.

Auth. Required

Yes

Roles Required

"admin" or "operations"

Response Type

Object

Request Structure

Request Path Parameters
Name Description
ID The cache-group-id of the Cache Group for which updates are being Queued/dequeued
action

The action to perform; one of "queue" or "dequeue"

cdn

The full name of the CDN in need of Queue Updates, or a "dequeue" thereof1

cdnId

The integral, unique identifier for the CDN in need of Queue Updates, or a "dequeue" thereof2

POST /api/2.0/cachegroups/8/queue_update HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 42
Content-Type: application/json

{"action": "queue", "cdn": "CDN-in-a-Box"}

Response Structure

action

The action processed, one of "queue" or "dequeue"

cachegroupId

An integer that is the cache-group-id of the Cache Group for which Queue Updates was performed or cleared

cachegroupName

The name of the Cache Group for which updates were queued/dequeued

cdn

The name of the CDN to which the queue/dequeue operation was restricted

serverNames

An array of the (short) hostnames of the Cache Group's servers <cache-group-servers> which are also assigned to the CDN specified in the "cdn" field

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: UAcP7LrflU1RnfR4UqbQrJczlk5rkrcLOtTXJTFvIUXxK1EklZkHkE4vewjDaVIhJJ6YQg8jmPGQpr+x1RHabw==
X-Server-Name: traffic_ops_golang/
Date: Wed, 14 Nov 2018 20:19:46 GMT
Content-Length: 115

{ "response": {
    "cachegroupName": "test",
    "action": "queue",
    "serverNames": [
        "foo"
    ],
    "cdn": "CDN-in-a-Box",
    "cachegroupID": 8
}}

  1. Either 'cdn' or 'cdnID' must be in the request data (but not both).↩

  2. Either 'cdn' or 'cdnID' must be in the request data (but not both).↩