SPspectate
Status page components

List components

Returns the page's components by position, lowest first. position is one order for the whole page. The page shows a named group once, where its first component falls, so components of a group that are not next to each other in this list still show together.

get/status-pages/{statusPage}/components

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

statusPagestring uuid required

Status page ID.

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Components per page, 1 to 100.

Response

Paginated set of StatusPageComponent

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "API",
      "description": "Our public REST API.",
      "group": "Backend",
      "monitor": {
        "label": "Website"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.