statuses/{{ID}}

GET

Retrieves a list of all server Statuses.

Auth. Required:

Yes

Roles Required:

None

Permissions Required:

STATUS:READ

Response Type:

Array

Request Structure

Table 425 Request Query Parameters

Name

Required

Description

description

no

Return only Statuses with this exact description

id

no

Return only the Status with this integral, unique identifier

name

no

Return only Statuses with this name

orderby

no

Choose the ordering of the results - must be the name of one of the fields of the objects in the response array

sortOrder

no

Changes the order of sorting. Either ascending (default or “asc”) or descending (“desc”)

limit

no

Choose the maximum number of results to return

offset

no

The number of results to skip before beginning to return results. Must use in conjunction with limit

page

no

Return the nth page of results, where “n” is the value of this parameter, pages are limit long and the first page is 1. If offset was defined, this query parameter has no effect. limit must be defined to make use of page.

#1032 Request Example
GET /api/4.0/statuses/3 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

description:

A short description of the status

id:

The integral, unique identifier of this status

lastUpdated:

The date and time at which this status was last modified, in Traffic Ops’s Custom Date/Time Format

name:

The name of the status

#1033 Response Example
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: dHNip9kpTGGS1w39/fWcFehNktgmXZus8XaufnmDpv0PyG/3fK/KfoCO3ZOj9V74/CCffps7doEygWeL/xRtKA==
X-Server-Name: traffic_ops_golang/
Date: Mon, 10 Dec 2018 20:56:59 GMT
Content-Length: 150

{ "response": [
    {
        "description": "Server is online and reported in the health protocol.",
        "id": 3,
        "lastUpdated": "2018-12-10 19:11:17+00",
        "name": "REPORTED"
    }
]}

PUT

Updates a Status.

Auth. Required:

Yes

Roles Required:

None

Permissions Required:

STATUS:UPDATE, STATUS:READ

Response Type:

Array

Request Structure

description:

The description of the updated Status

name:

The name of the updated Status

#1034 Request Example
PUT /api/4.0/statuses/3 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

{ "description": "test", "name": "example" }

Response Structure

description:

A short description of the status

id:

The integral, unique identifier of this status

lastUpdated:

The date and time at which this status was last modified, in Traffic Ops’s Custom Date/Time Format

name:

The name of the status

#1035 Response Example
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: dHNip9kpTGGS1w39/fWcFehNktgmXZus8XaufnmDpv0PyG/3fK/KfoCO3ZOj9V74/CCffps7doEygWeL/xRtKA==
X-Server-Name: traffic_ops_golang/
Date: Mon, 10 Dec 2018 20:56:59 GMT
Content-Length: 167

{ "alerts": [
    {
        "text": "status was created.",
        "level": "success"
    }
],"response": [
    {
        "description": "test",
        "name": "example"
        "id": 3,
        "lastUpdated": "2018-12-10 19:11:17+00",
    }
]}

DELETE

Deletes a Status.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

STATUS:DELETE, STATUS:READ

Response Type:

Object

Request Structure

Table 426 Request Path Parameters

Name

Required

Description

id

yes

The integral, unique identifier of the desired Status-to-Server association

#1036 Request Example
DELETE /api/4.0/statuses/18 HTTP/1.1
User-Agent: curl/8.1.2
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 0

Response Structure

#1037 Response Example
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=Thu, 15 Jun 2023 22:37:37 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: T8wtKKwyOKKVwDwoNCNvETllsByDiEe4CrpeS7Zdox+rXMgPb3FBlKmmgu4CpxbWdhpiODKqKn+gsSq5K4yvIQ==
X-Server-Name: traffic_ops_golang/
Date: Thu, 15 Jun 2023 21:41:18 GMT
Content-Length: 62

{
    "alerts": [
        {
            "text": "status was deleted.",
            "level": "success"
        }
    ]
}