Updating status of a component

[George Howitt]

I would like to be able to update the status of a component using the API. I need to know the set of acceptable status values. In the component edit screen I can set the component status to "Operational", "Degraded Performance", ...

But when I use the API as in:

curl -X PATCH https://api.statuspage.io/v1/pages/{page_id}/components/{comp_id}?api_key={my_key} -H "Content-Type: application/json" --data '{"component":{"status": "operational"}}'

it fails if I try to set status to anything other than "operational".

What is the list of acceptable status values?

[Dave Parrish [Atlassian] · Accepted solution]

Hi @George Howitt , the acceptable values for component status are shown here (expand the "request body schema"):

https://developer.statuspage.io/#operation/patchPagesPageIdComponentsComponentId

Here's the full list:

• "operational"
• "under_maintenance"
• "degraded_performance"
• "partial_outage"
• "major_outage"

[George Howitt]

Okay, they are documented under "request body schema", thanks alot.