Status Page Component Groups - OnlineOrNot API Documentation

GET/v1/status_pages/{status_page_id}/groups

List all component groups

Requires STATUS_PAGES:READ.

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

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

Responses

Status	Meaning	Description
200	OK	Returns a list of component groups for a status page. May also return a canonical failure envelope with success: false at HTTP200.
400	Bad Request	Invalid request
401	Unauthorized	Missing or invalid credentials
403	Forbidden	Insufficient permissions
500	Internal Server Error	Internal Server Error

Response Schema

success:boolean

false

result:null

errors:object[]

messages:[any]

Request

GET

/v1/status_pages/{status_page_id}/groups

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

Response

{
  "result": [
    {
      "id": "a1b2c3d4",
      "name": "Core Services",
      "description": "Our core infrastructure services",
      "sort_order": 1,
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-02-01T00:00:00.000Z"
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}

POST/v1/status_pages/{status_page_id}/groups

Create a component group

Requires STATUS_PAGES:EDIT.

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

Body parameters

name:string

Name of the component group

description:stringoptional

Description of the component group

Responses

Status	Meaning	Description
201	Created	Returns the newly created component group
400	Bad Request	Invalid request
401	Unauthorized	Missing or invalid credentials
403	Forbidden	Insufficient permissions
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}/groups

curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/groups \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Core Services","description":"Our core infrastructure services"}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "Core Services",
    "description": "Our core infrastructure services",
    "sort_order": 1,
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z"
  },
  "success": true,
  "errors": [],
  "messages": []
}

GET/v1/status_pages/{status_page_id}/groups/{group_id}

Retrieve a component group

Requires STATUS_PAGES:READ.

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

group_id:string

Status Page Component Group ID

Responses

Status	Meaning	Description
200	OK	Returns a component group
400	Bad Request	Invalid request
401	Unauthorized	Missing or invalid credentials
403	Forbidden	Insufficient permissions
404	Not Found	Resource not available or request rejected
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}/groups/{group_id}

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

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "Core Services",
    "description": "Our core infrastructure services",
    "sort_order": 1,
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z"
  },
  "success": true,
  "errors": [],
  "messages": []
}

PATCH/v1/status_pages/{status_page_id}/groups/{group_id}

Update a component group

Requires STATUS_PAGES:EDIT.

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

group_id:string

Status Page Component Group ID

Body parameters

name:stringoptional

Name of the component group

description:string | nulloptional

Description of the component group

Responses

Status	Meaning	Description
200	OK	Returns the updated component group
400	Bad Request	Invalid request
401	Unauthorized	Missing or invalid credentials
403	Forbidden	Insufficient permissions
404	Not Found	Resource not available or request rejected
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}/groups/{group_id}

curl --request PATCH \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/groups/a1b2c3d4 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Core Services","description":"Our core infrastructure services"}'

Response

{
  "result": {
    "id": "a1b2c3d4",
    "name": "Core Services",
    "description": "Our core infrastructure services",
    "sort_order": 1,
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-02-01T00:00:00.000Z"
  },
  "success": true,
  "errors": [],
  "messages": []
}

DELETE/v1/status_pages/{status_page_id}/groups/{group_id}

Delete a component group

Requires STATUS_PAGES:EDIT.

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

group_id:string

Status Page Component Group ID

Responses

Status	Meaning	Description
200	OK	Returns the deleted group's ID
400	Bad Request	Invalid request
401	Unauthorized	Missing or invalid credentials
403	Forbidden	Insufficient permissions
404	Not Found	Resource not available or request rejected
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}/groups/{group_id}

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

Response

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

PUT/v1/status_pages/{status_page_id}/groups/sort-order

Update the sort order of component groups

Requires STATUS_PAGES:EDIT.

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

Body parameters

group_ids:string[]

Ordered list of component group IDs

Responses

Status	Meaning	Description
200	OK	Sort order updated successfully
400	Bad Request	Invalid request
401	Unauthorized	Missing or invalid credentials
403	Forbidden	Insufficient permissions
404	Not Found	Resource not available or request rejected
500	Internal Server Error	Internal Server Error

Response Schema

result:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

Request

PUT

/v1/status_pages/{status_page_id}/groups/sort-order

curl --request PUT \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/groups/sort-order \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"group_ids":["a1b2c3d4","e5f6g7h8"]}'

Response

{
  "result": {
    "message": "Sort order updated successfully"
  },
  "success": true,
  "errors": [],
  "messages": []
}

PUT/v1/status_pages/{status_page_id}/groups/{group_id}/sort-order

Update the sort order of components within a group

Requires STATUS_PAGES:EDIT.

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

group_id:string

Status Page Component Group ID

Body parameters

component_ids:string[]

Ordered list of component IDs within the group

Responses

Status	Meaning	Description
200	OK	Sort order updated successfully
400	Bad Request	Invalid request
401	Unauthorized	Missing or invalid credentials
403	Forbidden	Insufficient permissions
404	Not Found	Resource not available or request rejected
500	Internal Server Error	Internal Server Error

Response Schema

result:object

success:boolean

Whether the API call was successful

errors:object[]

messages:object[]

Request

PUT

/v1/status_pages/{status_page_id}/groups/{group_id}/sort-order

curl --request PUT \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/groups/a1b2c3d4/sort-order \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --data '{"component_ids":["a1b2c3d4","e5f6g7h8"]}'

Response

{
  "result": {
    "message": "Sort order updated successfully"
  },
  "success": true,
  "errors": [],
  "messages": []
}