Status Options

Search Status Options

Method: GET

URL: https://zstatus.io/api/v0/status-options

Params

KeyDescriptionRequired

Example

const statusOptions = await api.getStatusOptions({
})

Example Response

{
"edges": [
{
"node": {
"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": "cl4ww9v04016809mjko8mcixd"
},
{
"node": {
"id": "cl4ww9v04016909mjt0gklxm2",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Degraded Performance",
"color": "yellow-600",
"description": "",
"icon": "MinusCircleIcon",
"severity": 1,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
"cursor": "cl4ww9v04016909mjt0gklxm2"
},
{
"node": {
"id": "cl4ww9v04017009mjx9i6llxc",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Partial Outage",
"color": "orange-600",
"description": "",
"icon": "ExclamationIcon",
"severity": 2,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
"cursor": "cl4ww9v04017009mjx9i6llxc"
},
{
"node": {
"id": "cl4ww9v04017109mj6c52spuk",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Major Outage",
"color": "red-600",
"description": "",
"icon": "XIcon",
"severity": 3,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
"cursor": "cl4ww9v04017109mj6c52spuk"
},
{
"node": {
"id": "cl4ww9v04017209mjf75dlmft",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Resolved",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
"cursor": "cl4ww9v04017209mjf75dlmft"
},
{
"node": {
"id": "cl4ww9v04017309mjtq22cdv5",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Identified",
"color": "blue-600",
"description": "",
"icon": "EyeIcon",
"severity": 1,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
"cursor": "cl4ww9v04017309mjtq22cdv5"
},
{
"node": {
"id": "cl4ww9v04017409mjsdl7nhp8",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Monitoring",
"color": "teal-600",
"description": "",
"icon": "ExclamationIcon",
"severity": 2,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
"cursor": "cl4ww9v04017409mjsdl7nhp8"
},
{
"node": {
"id": "cl4ww9v04017509mjt2jylba9",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Investigating",
"color": "yellow-600",
"description": "",
"icon": "QuestionMarkCircleIcon",
"severity": 3,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
"cursor": "cl4ww9v04017509mjt2jylba9"
}
],
"nodes": [
{
"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": "cl4ww9v04016909mjt0gklxm2",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Degraded Performance",
"color": "yellow-600",
"description": "",
"icon": "MinusCircleIcon",
"severity": 1,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
{
"id": "cl4ww9v04017009mjx9i6llxc",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Partial Outage",
"color": "orange-600",
"description": "",
"icon": "ExclamationIcon",
"severity": 2,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
{
"id": "cl4ww9v04017109mj6c52spuk",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Major Outage",
"color": "red-600",
"description": "",
"icon": "XIcon",
"severity": 3,
"type": "Service",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
{
"id": "cl4ww9v04017209mjf75dlmft",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Resolved",
"color": "green-600",
"description": "",
"icon": "CheckCircleIcon",
"severity": 0,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
{
"id": "cl4ww9v04017309mjtq22cdv5",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Identified",
"color": "blue-600",
"description": "",
"icon": "EyeIcon",
"severity": 1,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
{
"id": "cl4ww9v04017409mjsdl7nhp8",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Monitoring",
"color": "teal-600",
"description": "",
"icon": "ExclamationIcon",
"severity": 2,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
},
{
"id": "cl4ww9v04017509mjt2jylba9",
"pageId": "cl4ww9v04016509mjisnijiwe",
"name": "Investigating",
"color": "yellow-600",
"description": "",
"icon": "QuestionMarkCircleIcon",
"severity": 3,
"type": "Incident",
"createdAt": "2022-06-27T15:28:20.788Z",
"updatedAt": "2022-06-27T15:28:20.789Z"
}
],
"pageInfo": {
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "cl4ww9v04016809mjko8mcixd",
"endCursor": "cl4ww9v04017509mjt2jylba9"
},
"totalCount": 8
}

API Types

export enum APIStatusOptionType {
Service = 'Service',
Incident = 'Incident',
}
export type APIStatusOptionsResponse = APIStatusOption[];
export interface APIStatusOptionDeleteResponse {
success: boolean;
}
export interface CreateStatusOptionProps {
pageId: string;
name: string;
description: string;
color: string;
icon?: string | undefined;
severity: number;
type: APIStatusOptionType;
}
export interface UpdateStatusOptionProps {
id: string;
name: string;
description: string;
color: string;
icon?: string | undefined;
severity: number;
}
export interface APIStatusOption extends CreateStatusOptionProps {
id: string;
page?: APIPage;
createdAt: string;
updatedAt: string;
}
export type APIStatusOptionSearchArgs = APIOrderByArgs &
APIPaginationArgs & {
pageId: string;
type?: APIStatusOptionType;
};