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

List all updates for an incident

Requires STATUS_PAGES:READ; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_incident_id:string
Status Page Incident ID

Query parameters

page:integeroptional
Page number of paginated results, starting at 1.
Default: 1
per_page:integeroptional
Number of items per page. Defaults to 20. Continue requesting subsequent pages until the accumulated item count reaches result_info.total_count or a page is empty.
Default: 20
search:stringoptional
Search term to filter results.

Responses

StatusMeaningDescription
200OKReturns a list of updates for the incident. May also return a canonical failure envelope with success: false at HTTP200.
400Bad RequestInvalid request
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized
500Internal Server ErrorInternal Server Error

Response Schema

success:boolean
false
result:null
errors:object[]
messages:[any]

Request

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

Response

{
  "result": [
    {
      "id": "e5f6g7h8",
      "incident_id": "a1b2c3d4",
      "status": "INVESTIGATING",
      "description": "We are investigating reports of connectivity issues",
      "date_happened": "2021-01-01T00:00:00.000Z",
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-01-01T00:00:00.000Z",
      "components": [
        {
          "id": "comp123",
          "name": "API Server",
          "old_status": "OPERATIONAL",
          "new_status": "MAJOR_OUTAGE"
        }
      ]
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}
POST/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates

Create a new update for an incident

Requires STATUS_PAGES:EDIT; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_incident_id:string
Status Page Incident ID

Body parameters

status:string
Status for this update
Accepted values: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED" | "UPDATE" | "SCHEDULED" | "IN_PROGRESS" | "VERIFYING" | "COMPLETED"
description:string
Update message
notify_subscribers:booleanoptional
Whether to notify status page subscribers
Default: true
components_affected:object[]optional
Components affected by this update with their new status
date_happened:stringoptional
When this update occurred (defaults to now)

Responses

StatusMeaningDescription
201CreatedReturns the newly created incident update
400Bad RequestBad Request
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

POST
/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates
curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents/a1b2c3d4/updates \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --header 'X-OnlineOrNot-Organisation: string' \
  --data '{"status":"INVESTIGATING","description":"We are investigating reports of connectivity issues","notify_subscribers":true,"components_affected":[{"id":"a1b2c3d4","status":"MAJOR_OUTAGE"}],"date_happened":"2021-01-01T00:00:00.000Z"}'

Response

{
  "result": {
    "id": "e5f6g7h8",
    "incident_id": "a1b2c3d4",
    "status": "INVESTIGATING",
    "description": "We are investigating reports of connectivity issues",
    "date_happened": "2021-01-01T00:00:00.000Z",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-01-01T00:00:00.000Z",
    "components": [
      {
        "id": "comp123",
        "name": "API Server",
        "old_status": "OPERATIONAL",
        "new_status": "MAJOR_OUTAGE"
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}
GET/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates/{incident_update_id}

Retrieve a single incident update

Requires STATUS_PAGES:READ; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_incident_id:string
Status Page Incident ID
incident_update_id:string
Incident Update ID

Responses

StatusMeaningDescription
200OKReturns the incident update
400Bad RequestInvalid request
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized
404Not FoundNot Found
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

GET
/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates/{incident_update_id}
curl --request GET \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents/a1b2c3d4/updates/e5f6g7h8 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'X-OnlineOrNot-Organisation: string'

Response

{
  "result": {
    "id": "e5f6g7h8",
    "incident_id": "a1b2c3d4",
    "status": "INVESTIGATING",
    "description": "We are investigating reports of connectivity issues",
    "date_happened": "2021-01-01T00:00:00.000Z",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-01-01T00:00:00.000Z",
    "components": [
      {
        "id": "comp123",
        "name": "API Server",
        "old_status": "OPERATIONAL",
        "new_status": "MAJOR_OUTAGE"
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}
PATCH/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates/{incident_update_id}

Update an existing incident update

Requires STATUS_PAGES:EDIT; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_incident_id:string
Status Page Incident ID
incident_update_id:string
Incident Update ID

Body parameters

status:stringoptional
Updated status
Accepted values: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED" | "UPDATE" | "SCHEDULED" | "IN_PROGRESS" | "VERIFYING" | "COMPLETED"
description:stringoptional
Updated message
date_happened:stringoptional
Updated timestamp

Responses

StatusMeaningDescription
200OKReturns the updated incident update
400Bad RequestBad Request
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized
404Not FoundNot Found
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

PATCH
/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates/{incident_update_id}
curl --request PATCH \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents/a1b2c3d4/updates/e5f6g7h8 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --header 'X-OnlineOrNot-Organisation: string' \
  --data '{"status":"IDENTIFIED","description":"The issue has been identified","date_happened":"2021-01-01T00:00:00.000Z"}'

Response

{
  "result": {
    "id": "e5f6g7h8",
    "incident_id": "a1b2c3d4",
    "status": "INVESTIGATING",
    "description": "We are investigating reports of connectivity issues",
    "date_happened": "2021-01-01T00:00:00.000Z",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-01-01T00:00:00.000Z",
    "components": [
      {
        "id": "comp123",
        "name": "API Server",
        "old_status": "OPERATIONAL",
        "new_status": "MAJOR_OUTAGE"
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}
DELETE/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates/{incident_update_id}

Delete an incident update

Requires STATUS_PAGES:EDIT; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
status_page_incident_id:string
Status Page Incident ID
incident_update_id:string
Incident Update ID

Responses

StatusMeaningDescription
200OKReturns the deleted incident update's ID
400Bad RequestInvalid request
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized
404Not FoundNot Found
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

DELETE
/v1/status_pages/{status_page_id}/incidents/{status_page_incident_id}/updates/{incident_update_id}
curl --request DELETE \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/incidents/a1b2c3d4/updates/e5f6g7h8 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'X-OnlineOrNot-Organisation: string'

Response

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

Was this page helpful?