Schedules
List Schedules
API Documentation
Components
Component Groups
Incident Updates
Incident Templates
Schedules
List Schedules
GET
/
schedules
curl --request GET \
--url http://localhost/api/schedules
{
"data": [
{
"id": "<string>",
"type": "schedules",
"attributes": {
"id": "<string>",
"name": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"scheduled": {
"human": "<string>",
"string": "<string>"
},
"completed": {
"human": "<string>",
"string": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{
"id": "<string>",
"type": "components",
"attributes": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>",
"order": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"enabled": "<string>",
"meta": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"group": {
"data": {
"id": "<string>",
"type": "componentGroups",
"attributes": {
"id": "<string>",
"name": "<string>",
"order": "<string>",
"visible": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{}
]
}
}
}
},
"incidents": {
"data": [
{
"id": "<string>",
"type": "incidents",
"attributes": {
"id": "<string>",
"guid": "<string>",
"name": "<string>",
"message": "<string>",
"component_id": "<string>",
"visible": "<string>",
"stickied": "<string>",
"notifications": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"occurred": {
"human": "<string>",
"string": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{}
]
},
"updates": {
"data": [
{
"id": "<string>",
"type": "updates",
"attributes": {
"id": "<string>",
"updateable_id": "<string>",
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
},
"user": {
"data": {
"id": "<string>",
"type": "<string>",
"attributes": {
"id": "<string>"
}
}
}
}
}
]
}
}
}
]
},
"updates": {
"data": [
{
"id": "<string>",
"type": "updates",
"attributes": {
"id": "<string>",
"updateable_id": "<string>",
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
}
}
}
],
"meta": {
"current_page": 123,
"from": 123,
"path": "<string>",
"per_page": 123,
"to": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
}
}
Query Parameters
Available sorts are name
, id
, scheduled_at
, completed_at
. You can sort by multiple options by separating them with a comma. To sort in descending order, use -
sign in front of the sort, for example: -name
.
Available includes are components
, componentsCount
, componentsExists
, updates
, updatesCount
, updatesExists
, user
, userCount
, userExists
. You can include multiple options by separating them with a comma.
How many items to show per page.
Which page to show.
Filter the resources by name.
Filter the resources by status.
Available options:
0
, 1
, 2
Response
200 - application/json
Paginated set of `Schedule`
Available options:
schedules
curl --request GET \
--url http://localhost/api/schedules
{
"data": [
{
"id": "<string>",
"type": "schedules",
"attributes": {
"id": "<string>",
"name": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"scheduled": {
"human": "<string>",
"string": "<string>"
},
"completed": {
"human": "<string>",
"string": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{
"id": "<string>",
"type": "components",
"attributes": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>",
"order": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"enabled": "<string>",
"meta": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"group": {
"data": {
"id": "<string>",
"type": "componentGroups",
"attributes": {
"id": "<string>",
"name": "<string>",
"order": "<string>",
"visible": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{}
]
}
}
}
},
"incidents": {
"data": [
{
"id": "<string>",
"type": "incidents",
"attributes": {
"id": "<string>",
"guid": "<string>",
"name": "<string>",
"message": "<string>",
"component_id": "<string>",
"visible": "<string>",
"stickied": "<string>",
"notifications": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"occurred": {
"human": "<string>",
"string": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"components": {
"data": [
{}
]
},
"updates": {
"data": [
{
"id": "<string>",
"type": "updates",
"attributes": {
"id": "<string>",
"updateable_id": "<string>",
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
},
"user": {
"data": {
"id": "<string>",
"type": "<string>",
"attributes": {
"id": "<string>"
}
}
}
}
}
]
}
}
}
]
},
"updates": {
"data": [
{
"id": "<string>",
"type": "updates",
"attributes": {
"id": "<string>",
"updateable_id": "<string>",
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
}
}
}
],
"meta": {
"current_page": 123,
"from": 123,
"path": "<string>",
"per_page": 123,
"to": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
}
}