servers/{{hostname}}/update_status
Note
This endpoint only truly has meaning for cache servers, though it will return a valid response for any server configured in Traffic Ops.
GET
Retrieves information regarding pending updates and Content Invalidation Jobs for a given server
- Auth. Required
Yes
- Roles Required
None
- Permissions Required
SERVER:READ
- Response Type
Array
Changed in version 4.0: Prior to API version 4.0, the response was a top-level array rather than the normal response
object.
Request Structure
Name |
Description |
---|---|
hostname |
The (short) hostname of the server being inspected |
GET /api/4.0/servers/edge/update_status HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Response Structure
Each object in the returned array1 will contain the following fields:
- host_id
The integral, unique identifier for the server for which the other fields in this object represent the pending updates and revalidation status
- host_name
The (short) hostname of the server for which the other fields in this object represent the pending updates and revalidation status
- parent_pending
A boolean telling whether or not any Topology ancestor or parent of this server has pending updates
- parent_reval_pending
A boolean telling whether or not any Topology ancestor or parent of this server has pending Content Invalidation Jobs
- reval_pending
true
if the server has pending Content Invalidation Jobs,false
otherwise- status
The name of the status of this server
See also
Health Protocol gives more information on how these statuses are used, and the
GET
method of the statuses endpoint can be used to retrieve information about all server statuses configured in Traffic Ops.- upd_pending
true
if the server has pending updates,false
otherwise- use_reval_pending
A boolean which tells ORT whether or not this version of Traffic Ops should use pending Content Invalidation Jobs
Note
This field was introduced to give ORT the ability to work with Traffic Control versions 1.x and 2.x seamlessly - as of Traffic Control v3.0 there is no reason for this field to ever be
false
.
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: R6BjNVrcecHGn3eGDqQ1yDiBnEDGQe7QtOMIsRwlpck9SZR8chRQznrkTF3YdROAZ1l8BxR3fXTIvKHIzK2/dA==
X-Server-Name: traffic_ops_golang/
Date: Mon, 04 Feb 2019 16:24:01 GMT
Content-Length: 174
{ "response": [{
"host_name": "edge",
"upd_pending": false,
"reval_pending": false,
"use_reval_pending": true,
"host_id": 10,
"status": "REPORTED",
"parent_pending": false,
"parent_reval_pending": false
}]}
- 1
The returned object is an array, and there is no guarantee that one server exists for a given hostname. However, for each server in the array, that server’s update status will be accurate for the server with that particular server ID.