Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

Updating status of a component

George Howitt November 4, 2020

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?

1 answer

1 accepted

1 vote
Answer accepted
Dave Parrish _Atlassian_
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 4, 2020

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 November 4, 2020

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

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
TAGS
AUG Leaders

Atlassian Community Events