Skip to content

Latest commit

 

History

History
94 lines (79 loc) · 4.67 KB

servers_hostname_update.rst

File metadata and controls

94 lines (79 loc) · 4.67 KB
Raw

servers/{{HostName-Or-ID}}/update

POST

:term:`Queue` or dequeue updates and revalidation updates for a specific server.

Auth. Required:Yes
Roles Required:"admin" or "operations"
Permissions Required:SERVER:UPDATE, SERVER:READ
Response Type:undefined

Request Structure

Request Path Parameters
Name Description
HostName-OR-ID The hostName or integral, unique identifier of the server on which updates are being queued or dequeued
Request Query Parameters
Name Required Description
updated no The value to set for the queue update flag on this server. May be 'true' or 'false'.
reval_updated no The value to set for the reval update flag on this server. May be 'true' or 'false'.
config_apply_time no The value to set for when a queue update is applied for this server. Must be a valid RFC333Nano timestamp.
revalidate_apply_time no The value to set for when a reval update is applied for this server. Must be a valid RFC333Nano timestamp.

Note

While none of the timestamps is required individually, at least one must be sent to the API.

POST /api/4.0/servers/my-edge/update?config_apply_time=2022-01-31T12%3A00%3A00.123456-07%3A00&revalidate_apply_time=2022-01-31T12%3A00%3A00.123456-07%3A00 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

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

{
        "alerts" :
                [
                        {
                                "text" : "successfully set server 'my-edge' config_apply_time=2022-01-31T12:00:00.123456-07:00 revalidate_apply_time=2022-01-31T12:00:00.123456-07:00",
                                "level" : "success"
                        }
                ]
}