Add a third-party component: a vendor shown with the status its own status page publishes, for the whole service or chosen components. It never shows uptime and never changes the page's overall status. It goes last in its group.

POST

/status_page/{status_page_id}/component/third_party

curl --request POST \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/component/third_party \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "vendor_slug": "example", "vendor_component_ids": [ "example" ], "friendly_name": "example", "description": "example", "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "hidden": true }'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

Request Body ^required

Media type application/json

object

vendor_slug

required

From GET /status_page/third_party/vendors.

string

vendor_component_ids

Component ids from GET /status_page/third_party/vendors/{slug}. Leave out or empty to follow the whole service. At most 50.

Array<string>

friendly_name

Up to 256 characters. Defaults to the vendor’s name.

string | null

description

One line under the name. Up to 200 characters.

string | null

group_id

A group on this page. Leave out for the ungrouped list.

string | null format: uuid

hidden

Keep it off the public page for now.

boolean

Example ^generated

{
  "vendor_slug": "example",
  "vendor_component_ids": [
    "example"
  ],
  "friendly_name": "example",
  "description": "example",
  "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "hidden": true
}

Responses

201

The new component

Media type application/json

A component on the page, as the page shows it.

object

id

required

What the layout and the component routes call it: the HTTP job, browser check or cron job id, or the manual component’s own id.

string format: uuid

monitor_id

required

The same value as id, kept for clients that predate manual components.

string format: uuid

kind

required

string

Allowed values: http_job browser_check cron_job manual third_party

friendly_name

required

string

description

One line shown under the name, or null.

string | null

hidden

required

A hidden component stays on the page’s list but is left off the public page.

boolean

show_uptime

required

False shows the status only, with no uptime bars or percentage. Heartbeats, manual and third-party components never show uptime.

boolean

status

One of:

string

The status the owner set on a manual component; null for every other kind.

string

Allowed values: operational degraded down maintenance

null

null

status_override

One of:

object

The override in force, or null. One past its expiry reads as null.

object

status

required

What the owner says a component is doing: a manual component’s status, or an override on any component. Stored as text (status_page_components.manual_status, *.override_status).

string

Allowed values: operational degraded down maintenance

note

string | null

expires_at

When it lapses on its own, or null to keep it until cleared.

string | null format: date-time

set_at

string | null format: date-time

null

null

third_party

One of:

object

The vendor a third-party component follows; null for every other kind.

object

vendor_slug

required

The vendor’s slug, from GET /status_page/third_party/vendors.

string

component_ids

required

The vendor components it follows; empty follows the whole service.

Array<string>

null

null

Example

{
  "kind": "http_job",
  "status": "operational",
  "status_override": {
    "status": "operational"
  }
}

400

An unknown vendor or component, components of a vendor that can only be followed as a whole, a group that is not on this page, or the page already shows 100 components

401

Missing or invalid authentication

404

Status page not found

502

The vendor could not be loaded; try again