Status Page Incidents - OnlineOrNot API Documentation

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

Path parameters

status_page_id:string

Status Page ID

Query parameters

page:stringoptional

Page number of paginated results.

Default: "1"

per_page:stringoptional

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

result:object[]

result_info:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

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",
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-02-01T00:00:00.000Z",
      "latest_update": {
        "id": "upd123",
        "status": "INVESTIGATING",
        "date_happened": "2021-01-01T00:00:00.000Z"
      },
      "scheduled_maintenance": {
        "id": "sm123",
        "start_date": "2021-01-01T00:00:00.000Z",
        "duration_minutes": 60,
        "notify_subscribers_at_start": true,
        "notify_subscribers_at_end": true
      }
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}

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

Path parameters

status_page_id:string

Status Page ID

Body parameters

title:string

a title for the incident

description:string

a description of the incident

status:string

The current status of the incident

Accepted values: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED" | "UPDATE"

components:object[]optional

Components affected by this incident with their status

notify_subscribers:booleanoptional

Whether to notify status page subscribers

Default: true

Responses

Status	Meaning	Description
201	Created	Returns the newly created status page incident
500	Internal Server Error	Internal 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

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","components":[{"id":"a1b2c3d4","status":"MAJOR_OUTAGE"}],"notify_subscribers":true}'

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",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z",
    "latest_update": {
      "id": "upd123",
      "status": "INVESTIGATING",
      "date_happened": "2021-01-01T00:00:00.000Z"
    },
    "scheduled_maintenance": {
      "id": "sm123",
      "start_date": "2021-01-01T00:00:00.000Z",
      "duration_minutes": 60,
      "notify_subscribers_at_start": true,
      "notify_subscribers_at_end": true
    },
    "components": [
      {
        "id": "comp123",
        "name": "API Server"
      }
    ],
    "updates": [
      {
        "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}

Retrieve an incident

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Path parameters

status_page_id:string

Status Page ID

status_page_incident_id:string

Status Page Incident ID

Responses

Status	Meaning	Description
200	OK	Returns a status page incident
500	Internal Server Error	Internal 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}

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",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z",
    "latest_update": {
      "id": "upd123",
      "status": "INVESTIGATING",
      "date_happened": "2021-01-01T00:00:00.000Z"
    },
    "scheduled_maintenance": {
      "id": "sm123",
      "start_date": "2021-01-01T00:00:00.000Z",
      "duration_minutes": 60,
      "notify_subscribers_at_start": true,
      "notify_subscribers_at_end": true
    },
    "components": [
      {
        "id": "comp123",
        "name": "API Server"
      }
    ],
    "updates": [
      {
        "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}

Update an incident

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Path parameters

status_page_id:string

Status Page ID

status_page_incident_id:string

Status Page Incident ID

Body parameters

title:string

a title for the incident

impact:stringnull

Impact of the incident

Accepted values: "MAJOR_OUTAGE" | "PARTIAL_OUTAGE" | "DEGRADED_PERFORMANCE" | "NO_IMPACT" | "MAINTENANCE"

Responses

Status	Meaning	Description
200	OK	Returns the updated status page incident
500	Internal Server Error	Internal 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}

curl --request PATCH \
  --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"}'

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",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z",
    "latest_update": {
      "id": "upd123",
      "status": "INVESTIGATING",
      "date_happened": "2021-01-01T00:00:00.000Z"
    },
    "scheduled_maintenance": {
      "id": "sm123",
      "start_date": "2021-01-01T00:00:00.000Z",
      "duration_minutes": 60,
      "notify_subscribers_at_start": true,
      "notify_subscribers_at_end": true
    },
    "components": [
      {
        "id": "comp123",
        "name": "API Server"
      }
    ],
    "updates": [
      {
        "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}

Delete an incident

Security: Bearer Auth

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

Example: Authorization: Bearer 123

Path parameters

status_page_id:string

Status Page ID

status_page_incident_id:string

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

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}

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": []
}