← Tools Reference

Instatus

Instatus integration (Developer Tools, Productivity). Imported from open-connector.

API key15 toolshttps://api.instatus.com
GET
instatus_list_status_pages
List Instatus status pages in the authenticated account.

/v2/pages

2 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page number for pagination.
perPageintegeroptionalThe number of items per page, up to 100.
GET
instatus_list_components
List components on an Instatus status page.

/v2/pages/{pageId}/components

3 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
pageintegeroptionalThe page number for pagination.
perPageintegeroptionalThe number of items per page, up to 100.
GET
instatus_get_component
Get one Instatus component by ID.

/v2/pages/{pageId}/components/{componentId}

2 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
componentIdstringrequiredThe ID of the Instatus component.
POST
instatus_create_component
Create one component on an Instatus status page.

/v1/{pageId}/components

10 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
namestringrequiredThe name of the component.
descriptionstringoptionalThe component description.
statusstringoptionalThe status of an Instatus component.
orderintegeroptionalThe order of the component on the status page.
showUptimebooleanoptionalWhether to show uptime for the component.
groupedbooleanoptionalWhether the component is a parent or grouped component.
groupstringoptional
archivedbooleanoptionalWhether the component should be archived.
translationsobjectoptionalTranslations keyed by field name and then language code.
PUT
instatus_update_component
Update one Instatus component by ID.

/v2/pages/{pageId}/components/{componentId}

10 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
componentIdstringrequiredThe ID of the Instatus component.
namestringoptionalThe name of the component.
descriptionstringoptionalThe component description.
statusstringoptionalThe status of an Instatus component.
orderintegeroptionalThe order of the component on the status page.
showUptimebooleanoptionalWhether to show uptime for the component.
groupedbooleanoptionalWhether the component is a parent or grouped component.
archivedbooleanoptionalWhether the component should be archived.
translationsobjectoptionalTranslations keyed by field name and then language code.
DELETE
instatus_delete_component
Delete one Instatus component by ID.

/v1/{pageId}/components/{componentId}

2 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
componentIdstringrequiredThe ID of the Instatus component.
GET
instatus_list_incidents
List incidents on an Instatus status page.

/v1/{pageId}/incidents

5 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
pageintegeroptionalThe page number for pagination.
perPageintegeroptionalThe number of items per page, up to 100.
statusesarrayoptionalIncident statuses to include.
excludedStatusesarrayoptionalIncident statuses to exclude.
GET
instatus_get_incident
Get one Instatus incident by ID.

/v1/{pageId}/incidents/{incidentId}

2 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
incidentIdstringrequiredThe ID of the Instatus incident.
POST
instatus_create_incident
Create one incident on an Instatus status page.

/v1/{pageId}/incidents

10 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
namestringrequiredThe name of the incident.
messagestringoptionalThe initial incident message.
componentsarrayoptionalThe IDs of components affected by the incident.
startedstringoptionalThe date and time when the incident started.
statusstringrequiredThe status of an Instatus incident.
notifybooleanoptionalWhether to notify subscribers of the incident.
shouldPublishbooleanoptionalWhether to publish the incident to the page.
statusesarrayoptionalThe statuses to apply to affected components.
translationsobjectoptionalTranslations keyed by field name and then language code.
PUT
instatus_update_incident
Update one Instatus incident by ID.

/v1/{pageId}/incidents/{incidentId}

9 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
incidentIdstringrequiredThe ID of the Instatus incident.
namestringoptionalThe name of the incident.
componentsarrayoptionalThe IDs of components affected by the incident.
startedstringoptionalThe date and time when the incident started.
statusstringoptionalThe status of an Instatus incident.
notifybooleanoptionalWhether to notify subscribers of the incident.
statusesarrayoptionalThe statuses to apply to affected components.
translationsobjectoptionalTranslations keyed by field name and then language code.
DELETE
instatus_delete_incident
Delete one Instatus incident by ID.

/v1/{pageId}/incidents/{incidentId}

2 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
incidentIdstringrequiredThe ID of the Instatus incident.
GET
instatus_get_incident_update
Get one Instatus incident update by ID.

/v1/{pageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}

3 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
incidentIdstringrequiredThe ID of the Instatus incident.
incidentUpdateIdstringrequiredThe ID of the Instatus incident update.
POST
instatus_create_incident_update
Create one update on an Instatus incident.

/v1/{pageId}/incidents/{incidentId}/incident-updates

9 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
incidentIdstringrequiredThe ID of the Instatus incident.
messagestringoptionalThe incident update message.
componentsarrayrequiredThe IDs of components affected by the incident update.
startedstringoptionalThe date and time when the incident update happened.
statusstringrequiredThe status of an Instatus incident.
notifybooleanoptionalWhether to notify subscribers of the incident update.
statusesarrayrequiredThe statuses to apply to affected components.
translationsobjectoptionalTranslations keyed by field name and then language code.
PUT
instatus_update_incident_update
Update one Instatus incident update by ID.

/v1/{pageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}

10 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
incidentIdstringrequiredThe ID of the Instatus incident.
incidentUpdateIdstringrequiredThe ID of the Instatus incident update.
messagestringoptionalThe incident update message.
componentsarrayoptionalThe IDs of components affected by the incident update.
startedstringoptionalThe date and time when the incident update happened.
statusstringoptionalThe status of an Instatus incident.
notifybooleanoptionalWhether to notify subscribers of the incident update.
statusesarrayoptionalThe statuses to apply to affected components.
translationsobjectoptionalTranslations keyed by field name and then language code.
DELETE
instatus_delete_incident_update
Delete one Instatus incident update by ID.

/v1/{pageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}

3 parameters
ParamTypeRequiredDescription
pageIdstringrequiredThe ID of the Instatus status page.
incidentIdstringrequiredThe ID of the Instatus incident.
incidentUpdateIdstringrequiredThe ID of the Instatus incident update.