statuses/{{ID}}

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

#1502 Request Example

PUT /api/5.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 RFC 3339 format

Changed in version 5.0: Prior to version 5.0 of the API, this field was in Traffic Ops’s Custom Date/Time Format.

name:

The name of the status

#1503 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-10T19:11:17Z",
    }
]}

DELETE

Deletes a Status.

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

STATUS:DELETE, STATUS:READ

Response Type:

Object

Request Structure

Table 605 Request Path Parameters

Name	Required	Description
id	yes	The integral, unique identifier of the desired Status-to-Server association

#1504 Request Example

DELETE /api/5.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

#1505 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"
        }
    ]
}