Services

Search Services

Method: GET

URL: https://zstatus.io/api/v0/services

Params

KeyDescriptionRequired
Headerasdf
ParagraphText

Example

const services = await api.getServices({
})

Example Response

{
"edges": [
{
"node": {
"id": "cl4wyeyi3008809mk4bvfhil1",
"name": "SMS Notifications",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": null,
"monitor": false,
"lastPingedAt": null,
"pagerDutyId": null,
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": "cl4wyedzy010609ladl92r18m",
"createdAt": "2022-06-27T16:28:17.835Z",
"updatedAt": "2022-06-27T16:28:17.835Z",
"serviceGroup": {
"id": "cl4wyedzy010609ladl92r18m",
"name": "Notification Delivery",
"pageId": "cl4ww9v04016509mjisnijiwe",
"createdAt": "2022-06-27T16:27:51.262Z",
"updatedAt": "2022-06-27T16:27:51.262Z"
},
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
},
"cursor": "cl4wyeyi3008809mk4bvfhil1"
},
{
"node": {
"id": "cl4wwa86t040409mj0y2n0tfq",
"name": "Frontend",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": "https://zstatus.io",
"monitor": true,
"lastPingedAt": "2022-06-27T17:27:46.538Z",
"pagerDutyId": null,
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": null,
"createdAt": "2022-06-27T15:28:37.877Z",
"updatedAt": "2022-06-27T17:27:46.539Z",
"serviceGroup": null,
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
},
"cursor": "cl4wwa86t040409mj0y2n0tfq"
},
{
"node": {
"id": "cl4ww9vfr025109mj6h9nl1f8",
"name": "Rest API",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": null,
"monitor": false,
"lastPingedAt": null,
"pagerDutyId": "P84GNFW",
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": null,
"createdAt": "2022-06-27T15:28:21.351Z",
"updatedAt": "2022-06-27T15:52:07.749Z",
"serviceGroup": null,
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
},
"cursor": "cl4ww9vfr025109mj6h9nl1f8"
},
{
"node": {
"id": "cl4ww9vem023909mjct7hvbob",
"name": "Email Notifications",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": null,
"monitor": false,
"lastPingedAt": null,
"pagerDutyId": "PYKW7WK",
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": "cl4wyedzy010609ladl92r18m",
"createdAt": "2022-06-27T15:28:21.310Z",
"updatedAt": "2022-06-27T16:27:51.262Z",
"serviceGroup": {
"id": "cl4wyedzy010609ladl92r18m",
"name": "Notification Delivery",
"pageId": "cl4ww9v04016509mjisnijiwe",
"createdAt": "2022-06-27T16:27:51.262Z",
"updatedAt": "2022-06-27T16:27:51.262Z"
},
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
},
"cursor": "cl4ww9vem023909mjct7hvbob"
}
],
"nodes": [
{
"id": "cl4wyeyi3008809mk4bvfhil1",
"name": "SMS Notifications",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": null,
"monitor": false,
"lastPingedAt": null,
"pagerDutyId": null,
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": "cl4wyedzy010609ladl92r18m",
"createdAt": "2022-06-27T16:28:17.835Z",
"updatedAt": "2022-06-27T16:28:17.835Z",
"serviceGroup": {
"id": "cl4wyedzy010609ladl92r18m",
"name": "Notification Delivery",
"pageId": "cl4ww9v04016509mjisnijiwe",
"createdAt": "2022-06-27T16:27:51.262Z",
"updatedAt": "2022-06-27T16:27:51.262Z"
},
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
},
{
"id": "cl4wwa86t040409mj0y2n0tfq",
"name": "Frontend",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": "https://zstatus.io",
"monitor": true,
"lastPingedAt": "2022-06-27T17:27:46.538Z",
"pagerDutyId": null,
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": null,
"createdAt": "2022-06-27T15:28:37.877Z",
"updatedAt": "2022-06-27T17:27:46.539Z",
"serviceGroup": null,
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
},
{
"id": "cl4ww9vfr025109mj6h9nl1f8",
"name": "Rest API",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": null,
"monitor": false,
"lastPingedAt": null,
"pagerDutyId": "P84GNFW",
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": null,
"createdAt": "2022-06-27T15:28:21.351Z",
"updatedAt": "2022-06-27T15:52:07.749Z",
"serviceGroup": null,
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
},
{
"id": "cl4ww9vem023909mjct7hvbob",
"name": "Email Notifications",
"description": null,
"statusId": "cl4ww9v04016809mjko8mcixd",
"url": null,
"monitor": false,
"lastPingedAt": null,
"pagerDutyId": "PYKW7WK",
"pageId": "cl4ww9v04016509mjisnijiwe",
"serviceGroupId": "cl4wyedzy010609ladl92r18m",
"createdAt": "2022-06-27T15:28:21.310Z",
"updatedAt": "2022-06-27T16:27:51.262Z",
"serviceGroup": {
"id": "cl4wyedzy010609ladl92r18m",
"name": "Notification Delivery",
"pageId": "cl4ww9v04016509mjisnijiwe",
"createdAt": "2022-06-27T16:27:51.262Z",
"updatedAt": "2022-06-27T16:27:51.262Z"
},
"status": {
"id": "cl4ww9v04016809mjko8mcixd",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Operational",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
}
],
"pageInfo": {
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "cl4wyeyi3008809mk4bvfhil1",
"endCursor": "cl4ww9vem023909mjct7hvbob"
},
"totalCount": 4
}

API Types

export interface CreateServiceProps {
pageId: string;
name: string;
statusId: string;
description?: string;
serviceGroupId?: string;
serviceGroupName?: string;
pagerDutyId?: string;
url?: string;
monitor?: boolean;
lastPingedAt?: string;
}
export interface UpdateServiceProps {
id: string;
statusId?: string;
name?: string;
description?: string;
serviceGroupId?: string;
serviceGroupName?: string;
pagerDutyId?: string;
url?: string;
monitor?: boolean;
lastPingedAt?: string;
}
export interface APIService extends CreateServiceProps {
id: string;
page?: APIPage;
status: APIStatusOption;
serviceGroup?: APIServiceGroup;
createdAt: string;
updatedAt: string;
}
export type APIServiceSearchArgs = APIOrderByArgs &
APIPaginationArgs & {
pageId: string;
};