Skip to content
Site Qwality Site Qwality Site Qwality Docs

Rename a third-party component, change its description, or change which of the vendor's components it follows. Its place, group and visibility are part of the layout.

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
status_page_id
required
string format: uuid

Status page identifier

component_id
required
string format: uuid

Third-party component identifier

Request Body required

Section titled “Request Body required ”
Media type application/json

Fields left out keep their values.

object
friendly_name

Up to 256 characters.

string | null
description

Up to 200 characters. null clears it.

string | null
vendor_component_ids

Replaces the components it follows; empty follows the whole service.

array | null
Example generated
{
  "friendly_name": "example",
  "description": "example",
  "vendor_component_ids": [
    "example"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The updated 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:

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

string
Allowed values: operational degraded down maintenance
status_override
One of:

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
third_party
One of:

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>
Example 
{
  "kind": "http_job",
  "status": "operational",
  "status_override": {
    "status": "operational"
  }
}

400

Section titled “400 ”

Invalid request body, or an unknown vendor component

401

Section titled “401 ”

Missing or invalid authentication

404

Section titled “404 ”

Status page not found, or no third-party component with this id on it

502

Section titled “502 ”

The vendor could not be loaded; try again

Privacy Cookie preferences