Status Page Incidents - OnlineOrNot API Documentation

POST/v1/status_pages/{status_page_id}/incidents

Create an incident

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
» title
Type
string
Description
a title for the incident
Name
» description
Type
string
Description
a description of the incident
Name
» status
Type
string
Description
The current status of the incident
Name
» impact
Type
string,null
Description
Impact of the incident
Name
» components
Type
object
Description
undefined

Optional parameters

Name
body
Type
object
Description
undefined
Name
»» **additionalProperties**
Type
string - enum
Description
Impact of the incident on the component
Enum: "MAJOR_OUTAGE" "PARTIAL_OUTAGE" "DEGRADED_PERFORMANCE" "NO_IMPACT" "MAINTENANCE"

Body parameter

{
  "title": "API is inaccessible",
  "description": "We are currently investigating the issue",
  "status": "INVESTIGATING",
  "impact": "MAJOR_OUTAGE",
  "components": {
    "property1": "MAJOR_OUTAGE",
    "property2": "MAJOR_OUTAGE"
  }
}

Responses

Status	Meaning	Description
200	OK	Returns the newly created status page component
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Incident ID
»» title	string	true	a title for the incident
»» impact	string,null	true	Impact of the incident
»» started	string	true	When the incident started
»» ended	string	false	When the incident was resolved
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
impact	MAJOR_OUTAGE
impact	PARTIAL_OUTAGE
impact	DEGRADED_PERFORMANCE
impact	NO_IMPACT
impact	MAINTENANCE

Request

POST

/v1/status_pages/{status_page_id}/incidents

curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"title":"API is inaccessible","description":"We are currently investigating the issue","status":"INVESTIGATING","impact":"MAJOR_OUTAGE","components":{"property1":"MAJOR_OUTAGE","property2":"MAJOR_OUTAGE"}}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "title": "API is inaccessible",
    "impact": "MAJOR_OUTAGE",
    "started": "2021-01-01T00:00:00.000Z",
    "ended": "2021-02-01T00:00:00.000Z"
  },
  "success": true,
  "errors": [],
  "messages": []
}

GET/v1/status_pages/{status_page_id}/incidents

List all incidents

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID

Optional parameters

Name
page
Type
string
Description
Page number of paginated results.
Default: "1"
Name
per_page
Type
string
Description
Number of items per page.
Default: "20"

Responses

Status	Meaning	Description
200	OK	Returns a list of incidents for a status page
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	[object]	true	none
»» id	string	true	Status Page Incident ID
»» title	string	true	a title for the incident
»» impact	string,null	true	Impact of the incident
»» started	string	true	When the incident started
»» ended	string	false	When the incident was resolved
» result_info	object	true	none
»» page	number	true	Page number of paginated results.
»» per_page	number	true	Number of items per page.
»» count	number	true	Number of items on the current page.
»» total_count	number	true	Total number of items.
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
impact	MAJOR_OUTAGE
impact	PARTIAL_OUTAGE
impact	DEGRADED_PERFORMANCE
impact	NO_IMPACT
impact	MAINTENANCE

Request

GET

/v1/status_pages/{status_page_id}/incidents

curl --request GET \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

Response

{
  "result": [
    {
      "id": "a1b2c3d4",
      "title": "API is inaccessible",
      "impact": "MAJOR_OUTAGE",
      "started": "2021-01-01T00:00:00.000Z",
      "ended": "2021-02-01T00:00:00.000Z"
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}

GET/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}

Retrieve an incident

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
status_page_incident_id
Type
string
Description
Status Page Incident ID

Responses

Status	Meaning	Description
200	OK	Returns a status page incident
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Incident ID
»» title	string	true	a title for the incident
»» impact	string,null	true	Impact of the incident
»» started	string	true	When the incident started
»» ended	string	false	When the incident was resolved
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
impact	MAJOR_OUTAGE
impact	PARTIAL_OUTAGE
impact	DEGRADED_PERFORMANCE
impact	NO_IMPACT
impact	MAINTENANCE

Request

GET

/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}

curl --request GET \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "title": "API is inaccessible",
    "impact": "MAJOR_OUTAGE",
    "started": "2021-01-01T00:00:00.000Z",
    "ended": "2021-02-01T00:00:00.000Z"
  },
  "success": true,
  "errors": [],
  "messages": []
}

POST/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}

Update an incident

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
status_page_incident_id
Type
string
Description
Status Page Incident ID
Name
» title
Type
string
Description
a title for the incident
Name
» impact
Type
string,null
Description
Impact of the incident
Name
» components
Type
object
Description
undefined

Optional parameters

Name
body
Type
object
Description
undefined
Name
»» **additionalProperties**
Type
string - enum
Description
Impact of the incident on the component
Enum: "MAJOR_OUTAGE" "PARTIAL_OUTAGE" "DEGRADED_PERFORMANCE" "NO_IMPACT" "MAINTENANCE"

Body parameter

{
  "title": "API is inaccessible",
  "impact": "MAJOR_OUTAGE",
  "components": {
    "property1": "MAJOR_OUTAGE",
    "property2": "MAJOR_OUTAGE"
  }
}

Responses

Status	Meaning	Description
200	OK	Returns the updated status page incident
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Incident ID
»» title	string	true	a title for the incident
»» impact	string,null	true	Impact of the incident
»» started	string	true	When the incident started
»» ended	string	false	When the incident was resolved
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Enumerated Values

Property	Value
impact	MAJOR_OUTAGE
impact	PARTIAL_OUTAGE
impact	DEGRADED_PERFORMANCE
impact	NO_IMPACT
impact	MAINTENANCE

Request

POST

/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}

curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"title":"API is inaccessible","impact":"MAJOR_OUTAGE","components":{"property1":"MAJOR_OUTAGE","property2":"MAJOR_OUTAGE"}}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "title": "API is inaccessible",
    "impact": "MAJOR_OUTAGE",
    "started": "2021-01-01T00:00:00.000Z",
    "ended": "2021-02-01T00:00:00.000Z"
  },
  "success": true,
  "errors": [],
  "messages": []
}

DELETE/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}

Delete an incident

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Required parameters

Name
status_page_id
Type
string
Description
Status Page ID
Name
status_page_incident_id
Type
string
Description
Status Page Incident ID

Responses

Status	Meaning	Description
200	OK	Returns the deleted incident's ID
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Description
» result	object	true	none
»» id	string	true	Status Page Incident ID
» success	boolean	true	Whether the API call was successful
» errors	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none
» messages	[object]	true	none
»» code	number	true	none
»» message	string	true	none
»» type	string	false	none

Request

DELETE

/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}

curl --request DELETE \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

Response

{
  "result": {
    "id": "a1b2c3d4"
  },
  "success": true,
  "errors": [],
  "messages": []
}