Skip to content

Latest commit

 

History

History
158 lines (136 loc) · 6.7 KB

statuses.rst

File metadata and controls

158 lines (136 loc) · 6.7 KB
Raw

statuses

GET

Retrieves a list of all server :term:`Statuses`.

Auth. Required:Yes
Roles Required:None
Permissions Required:STATUS:READ
Response Type:Array

Request Structure

Request Query Parameters
Name Required Description
description no Return only :term:`Statuses` with this exact description
id no Return only the :term:`Status` with this integral, unique identifier
name no Return only :term:`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. 
GET /api/4.0/statuses?name=REPORTED 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 :ref:`non-rfc-datetime`
name:The name of the status 
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"
        }
]}

POST

Creates a Server :term:`Status`.

Auth. Required:Yes
Roles Required:None
Permissions Required:STATUS:CREATE, STATUS:READ
Response Type:Array

Request Structure

description:Create a :term:`Status` with this description
name:Create a :term:`Status` with this name 
POST /api/4.0/statuses 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 :ref:`non-rfc-datetime`
name:The name of the status 
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",
        }
]}