Statuses API
Events have a status which describes the current state of a services
Attributes
- id
- The unique identifier by which to identify the status
- name
- The name of the status, defined by the user
- description
- The description of the status
- url
- The URL of the specific status resource
- level
- The level of this status. Can be any value listed in the Levels List resource
- image
- The URL of the image for this status
- default
- Defines the status as default
List all statuses
GET /api/v1/statuses
{
"statuses": [
{
"name": "Available",
"id": "available",
"description": "An explanation of what this status represents",
"level": "NORMAL",
"image": "/images/status/tick-circle.png",
"url": "api/v1/statuses/up",
"default": true,
},
{
"name": "Down",
"id": "down",
"description": "An explanation of what this status represents",
"level": "ERROR",
"image": "/images/status/cross-circle.png",
"url": "api/v1/statuses/down",
"default": false,
},
]
}
Get an individual status
GET /api/v1/statuses/{status-id}
{
"name": "Down",
"id": "down",
"description": "A new status",
"level": "ERROR",
"image": "/images/status/cross-circle.png",
"url": "/api/v1/statuses/down",
"default": false,
}