Skip to main content
Instatus logo
  • Category: server monitoring
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 15
  • Triggers: 0
  • Slug: INSTATUS
  • Version: 20261101_00

Tools

Slug: INSTATUS_ADD_INCIDENT_UPDATEPost a public lifecycle update to an Instatus incident and change affected component states. This can send external notifications to page and affected-component subscribers when notify is true.

Input Parameters

boolean
Whether Instatus should notify subscribers of the page and affected components. Setting true can send external notifications; omit it to use the provider default.
string ("INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED")
required
Incident lifecycle status to set with this update.
string
Public progress message.
string
required
Status page ID containing the incident.
string
ISO 8601 time when this update occurred. Omit it to let Instatus use the current time.
string
required
Incident ID receiving the update.
array
required
IDs of components affected by this update.
array
required
Health states for affected components. Every item ID must also appear in component_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_ADD_MAINTENANCE_UPDATEPost a public progress update to an Instatus maintenance, optionally changing its lifecycle, timing, and affected component states. This can send external notifications to page and affected-component subscribers when notify is true.

Input Parameters

string
ISO 8601 end time represented by this maintenance update.
boolean
Whether Instatus should notify subscribers of the page and affected components. Setting true can send external notifications; omit it to use the provider default.
string ("NOTSTARTEDYET" | "INPROGRESS" | "COMPLETED")
Maintenance lifecycle status represented by this update.
string
Public maintenance progress message.
string
required
Status page ID containing the maintenance.
string
required
Required ISO 8601 time when this maintenance update occurred.
array
IDs of components affected by this maintenance update.
string
required
Maintenance ID receiving the update.
array
Health states for affected components. Every item ID must also appear in component_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_CREATE_COMPONENTCreate a component on an Instatus status page. This changes the page’s component configuration and can make the new component and its initial health status publicly visible.

Input Parameters

string
required
Public component name.
integer
Display order on the status page.
string ("OPERATIONAL" | "UNDERMAINTENANCE" | "DEGRADEDPERFORMANCE" | "PARTIALOUTAGE" | "MAJOROUTAGE")
Initial component health status. Omit it to let Instatus apply its provider default.
boolean
Whether this component is a parent or group component.
string
required
Status page ID on which to create the component.
string
Parent component ID under which to group this component.
string
Optional public component description.
boolean
Whether to show the component’s uptime percentage and bar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_CREATE_INCIDENTCreate an incident on an Instatus status page with optional affected component states. The incident is published publicly by default; notify=true can send notifications to page and affected-component subscribers.

Input Parameters

string
required
Public incident name.
boolean
Whether Instatus should notify subscribers of the page and affected components when creating the incident.
string ("INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED")
required
Initial incident lifecycle status.
string
Initial public incident message.
string
required
Status page ID on which to create the incident.
string
Incident start time in ISO 8601 format. Omit it to let Instatus use the current time.
array
IDs of components affected by the incident.
boolean
Whether to publish the incident on the public status page. Defaults to true; set false explicitly to avoid publishing it.
array
States to apply to affected components. Every item ID must also appear in component_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_CREATE_MAINTENANCESchedule or start a maintenance on an Instatus status page. The required notification controls are side-effecting: notify can contact subscribers immediately, while notify_start, notify_end, and notify_early schedule later subscriber notifications.

Input Parameters

string
required
Public maintenance name.
string
required
Maintenance end as an ISO 8601 date-time in UTC. It must be later than start_at.
boolean
required
Whether creating this maintenance immediately notifies subscribers of the page and affected components.
string ("NOTSTARTEDYET" | "INPROGRESS" | "COMPLETED")
required
Initial maintenance lifecycle status.
string
Initial public maintenance message.
string
required
Status page ID on which to create the maintenance.
boolean
required
Whether Instatus automatically completes the maintenance at end_at.
string
required
Maintenance start as an ISO 8601 date-time in UTC.
string
ISO 8601 UTC time when the collapsed maintenance expands on the page.
boolean
required
Whether Instatus automatically starts the maintenance at start_at.
boolean
required
Whether Instatus notifies subscribers when the maintenance ends.
boolean
Whether the maintenance is collapsed on the status page.
boolean
required
Whether Instatus sends an advance notification before the maintenance starts. Requires notify_minutes when true.
boolean
required
Whether Instatus notifies subscribers when the maintenance starts.
array
required
IDs of components affected by the maintenance.
integer
Minutes before start when the advance notification is sent.
integer
Maintenance duration in minutes used when auto_end is true.
array
States to apply to affected components. Every item ID must also appear in component_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_GET_COMPONENTGet the current health and configuration of one component on an Instatus status page.

Input Parameters

string
required
Status page ID containing the component.
string
required
Component ID from INSTATUS_LIST_COMPONENTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_GET_INCIDENTGet one Instatus incident with its affected components and update history.

Input Parameters

string
required
Status page ID containing the incident.
string
required
Incident ID from INSTATUS_LIST_INCIDENTS or INSTATUS_CREATE_INCIDENT.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_GET_MAINTENANCEGet one Instatus maintenance with its schedule, affected components, automation settings, and update history.

Input Parameters

string
required
Status page ID containing the maintenance.
string
required
Maintenance ID from INSTATUS_LIST_MAINTENANCES or INSTATUS_CREATE_MAINTENANCE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_LIST_COMPONENTSList components and their current health for one Instatus status page, including child components where present. Pass the response’s next_cursor back unchanged to fetch another page.

Input Parameters

string
required
Status page ID from INSTATUS_LIST_STATUS_PAGES.
integer
Maximum components to return in this page (1-100).
string
Continuation cursor returned by a previous call. Omit for the first page and pass the returned value unchanged to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_LIST_INCIDENTSList incidents for an Instatus status page, optionally including or excluding lifecycle statuses. Results are paginated, with up to 100 incidents per page and a cursor for retrieving the next page when more may be available.

Input Parameters

string
required
Status page ID whose incidents to list.
integer
Maximum incidents to return in this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.
string
Comma-separated statuses to exclude: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED.
string
Comma-separated statuses to include: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_LIST_MAINTENANCESList scheduled and historical maintenances for an Instatus status page.

Input Parameters

string
required
Status page ID whose maintenances to list.
integer
Maximum maintenances to return in this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_LIST_STATUS_PAGESList status pages available to the connected Instatus account so an agent can discover page IDs for component, incident, and maintenance operations.

Input Parameters

integer
Maximum status pages to return in this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_UPDATE_COMPONENTChange a component’s health or presentation on an Instatus status page.

Input Parameters

string
New public component name.
integer
New display order.
string ("OPERATIONAL" | "UNDERMAINTENANCE" | "DEGRADEDPERFORMANCE" | "PARTIALOUTAGE" | "MAJOROUTAGE")
New component health status.
boolean
Whether the component is a parent or group component.
string
required
Status page ID containing the component.
string
New public component description.
boolean
Whether to show uptime percentage and bar.
string
required
Component ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_UPDATE_INCIDENTEdit an existing Instatus incident’s name, timing, lifecycle status, affected components, or component states. Setting notify to true sends notifications to page and affected-component subscribers.

Input Parameters

string
New public incident name.
boolean
Whether to notify page and affected-component subscribers about this change.
string ("INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED")
New incident lifecycle status.
string
required
Status page ID containing the incident.
string
required
Required incident start time in ISO 8601 format.
string
required
Incident ID to edit.
array
Replacement list of affected component IDs.
array
Per-component health states for affected components.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INSTATUS_UPDATE_MAINTENANCEFully replace an Instatus maintenance’s public message, schedule, lifecycle state, affected components and states, and automation settings. Call INSTATUS_GET_MAINTENANCE first and preserve unchanged values; setting notify to true sends subscriber notifications.

Input Parameters

string
Replacement public maintenance name. Omit it to preserve provider omission semantics.
string
required
Replacement maintenance end time in ISO 8601 format.
boolean
required
Whether to notify page and affected-component subscribers about this update.
string ("NOTSTARTEDYET" | "INPROGRESS" | "COMPLETED")
required
Replacement maintenance lifecycle status.
string
required
Full replacement public maintenance message.
string
required
Status page ID containing the maintenance.
boolean
required
Whether Instatus automatically completes the maintenance.
string
required
Replacement maintenance start time in ISO 8601 format.
boolean
required
Whether Instatus automatically starts the maintenance.
array
required
Full replacement list of affected component IDs.
string
required
Maintenance ID to update.
integer
required
Replacement maintenance duration in minutes.
array
required
Full replacement health states for affected components.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not