Create a new status override
curl --request POST \
--url https://statusstack.com/api/v1/status-overrides \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({component_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://statusstack.com/api/v1/status-overrides', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://statusstack.com/api/v1/status-overrides"
payload = { "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "operational",
"reason": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "operational",
"reason": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Overrides and advisories
Create a new status override
POST
/
v1
/
status-overrides
Create a new status override
curl --request POST \
--url https://statusstack.com/api/v1/status-overrides \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({component_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://statusstack.com/api/v1/status-overrides', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://statusstack.com/api/v1/status-overrides"
payload = { "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "operational",
"reason": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "operational",
"reason": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
StatusStack authenticates requests with API keys, created via the dashboard with granular permissions (read, write, delete, admin, *).
API keys support version compatibility:
- v1 keys: Can only access v1 endpoints
- v2 keys: Can access both v1 and v2 endpoints
Available permissions:
read: View resources (GET requests)write: Create and update resources (POST, PUT requests)delete: Delete resources (DELETE requests)admin: Administrative access to all resources*: Wildcard permission (all actions allowed)
Body
application/json
The four canonical values — operational, degraded_performance, under_maintenance, major_outage — are what the override is stored and returned as. Every other value listed is a legacy spelling, accepted on the wire and normalised onto one of those four.
Available options:
operational, degraded_performance, under_maintenance, major_outage, ok, up, online, clear, degraded, warning, partial, minor, partial_outage, outage, down, offline, alert, critical, major, maintenance, info Stack to scope the override to. Only stack-scoped overrides are honoured on public surfaces (status page, embed, badge, public API); omitting this creates a dashboard-only override that is never displayed. Must belong to the API key's team, and the component must be attached to it.
Maximum string length:
1000Response
An override already existed for this component/stack pair and was updated in place rather than duplicated.
Stack the override is scoped to. Null means dashboard-only; such an override is not shown on any public surface.
Available options:
operational, degraded_performance, under_maintenance, major_outage Was this page helpful?