> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Instatus

> Instatus is a status page and incident communication platform for managing service health, incidents, maintenance, monitors, and subscribers.

![Instatus logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/instatus.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=f6304446f24e55bb8540bf29875d9c0c)

* **Category:** server monitoring
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 15
* **Triggers:** 0
* **Slug:** `INSTATUS`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Incident Update
>
> **Slug:** `INSTATUS_ADD_INCIDENT_UPDATE`
>
> Post 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
>
> **notify** `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.
>
> **status** `string ("INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED")` *required*
>
> Incident lifecycle status to set with this update.
>
> **message** `string`
>
> Public progress message.
>
> **page\_id** `string` *required*
>
> Status page ID containing the incident.
>
> **started\_at** `string`
>
> ISO 8601 time when this update occurred. Omit it to let Instatus use the current time.
>
> **incident\_id** `string` *required*
>
> Incident ID receiving the update.
>
> **component\_ids** `array` *required*
>
> IDs of components affected by this update.
>
> **component\_statuses** `array` *required*
>
> Health states for affected components. Every item ID must also appear in component\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Maintenance Update
>
> **Slug:** `INSTATUS_ADD_MAINTENANCE_UPDATE`
>
> Post 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
>
> **end\_at** `string`
>
> ISO 8601 end time represented by this maintenance update.
>
> **notify** `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.
>
> **status** `string ("NOTSTARTEDYET" | "INPROGRESS" | "COMPLETED")`
>
> Maintenance lifecycle status represented by this update.
>
> **message** `string`
>
> Public maintenance progress message.
>
> **page\_id** `string` *required*
>
> Status page ID containing the maintenance.
>
> **started\_at** `string` *required*
>
> Required ISO 8601 time when this maintenance update occurred.
>
> **component\_ids** `array`
>
> IDs of components affected by this maintenance update.
>
> **maintenance\_id** `string` *required*
>
> Maintenance ID receiving the update.
>
> **component\_statuses** `array`
>
> Health states for affected components. Every item ID must also appear in component\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Component
>
> **Slug:** `INSTATUS_CREATE_COMPONENT`
>
> Create 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
>
> **name** `string` *required*
>
> Public component name.
>
> **order** `integer`
>
> Display order on the status page.
>
> **status** `string ("OPERATIONAL" | "UNDERMAINTENANCE" | "DEGRADEDPERFORMANCE" | "PARTIALOUTAGE" | "MAJOROUTAGE")`
>
> Initial component health status. Omit it to let Instatus apply its provider default.
>
> **grouped** `boolean`
>
> Whether this component is a parent or group component.
>
> **page\_id** `string` *required*
>
> Status page ID on which to create the component.
>
> **group\_id** `string`
>
> Parent component ID under which to group this component.
>
> **description** `string`
>
> Optional public component description.
>
> **show\_uptime** `boolean`
>
> Whether to show the component's uptime percentage and bar.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Incident
>
> **Slug:** `INSTATUS_CREATE_INCIDENT`
>
> Create 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
>
> **name** `string` *required*
>
> Public incident name.
>
> **notify** `boolean`
>
> Whether Instatus should notify subscribers of the page and affected components when creating the incident.
>
> **status** `string ("INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED")` *required*
>
> Initial incident lifecycle status.
>
> **message** `string`
>
> Initial public incident message.
>
> **page\_id** `string` *required*
>
> Status page ID on which to create the incident.
>
> **started\_at** `string`
>
> Incident start time in ISO 8601 format. Omit it to let Instatus use the current time.
>
> **component\_ids** `array`
>
> IDs of components affected by the incident.
>
> **should\_publish** `boolean`
>
> Whether to publish the incident on the public status page. Defaults to true; set false explicitly to avoid publishing it.
>
> **component\_statuses** `array`
>
> States to apply to affected components. Every item ID must also appear in component\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Maintenance
>
> **Slug:** `INSTATUS_CREATE_MAINTENANCE`
>
> Schedule 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
>
> **name** `string` *required*
>
> Public maintenance name.
>
> **end\_at** `string` *required*
>
> Maintenance end as an ISO 8601 date-time in UTC. It must be later than start\_at.
>
> **notify** `boolean` *required*
>
> Whether creating this maintenance immediately notifies subscribers of the page and affected components.
>
> **status** `string ("NOTSTARTEDYET" | "INPROGRESS" | "COMPLETED")` *required*
>
> Initial maintenance lifecycle status.
>
> **message** `string`
>
> Initial public maintenance message.
>
> **page\_id** `string` *required*
>
> Status page ID on which to create the maintenance.
>
> **auto\_end** `boolean` *required*
>
> Whether Instatus automatically completes the maintenance at end\_at.
>
> **start\_at** `string` *required*
>
> Maintenance start as an ISO 8601 date-time in UTC.
>
> **expand\_at** `string`
>
> ISO 8601 UTC time when the collapsed maintenance expands on the page.
>
> **auto\_start** `boolean` *required*
>
> Whether Instatus automatically starts the maintenance at start\_at.
>
> **notify\_end** `boolean` *required*
>
> Whether Instatus notifies subscribers when the maintenance ends.
>
> **is\_collapsed** `boolean`
>
> Whether the maintenance is collapsed on the status page.
>
> **notify\_early** `boolean` *required*
>
> Whether Instatus sends an advance notification before the maintenance starts. Requires notify\_minutes when true.
>
> **notify\_start** `boolean` *required*
>
> Whether Instatus notifies subscribers when the maintenance starts.
>
> **component\_ids** `array` *required*
>
> IDs of components affected by the maintenance.
>
> **notify\_minutes** `integer`
>
> Minutes before start when the advance notification is sent.
>
> **duration\_minutes** `integer`
>
> Maintenance duration in minutes used when auto\_end is true.
>
> **component\_statuses** `array`
>
> States to apply to affected components. Every item ID must also appear in component\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Component
>
> **Slug:** `INSTATUS_GET_COMPONENT`
>
> Get the current health and configuration of one component on an Instatus status page.
>
> #### Input Parameters
>
> **page\_id** `string` *required*
>
> Status page ID containing the component.
>
> **component\_id** `string` *required*
>
> Component ID from INSTATUS\_LIST\_COMPONENTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Incident
>
> **Slug:** `INSTATUS_GET_INCIDENT`
>
> Get one Instatus incident with its affected components and update history.
>
> #### Input Parameters
>
> **page\_id** `string` *required*
>
> Status page ID containing the incident.
>
> **incident\_id** `string` *required*
>
> Incident ID from INSTATUS\_LIST\_INCIDENTS or INSTATUS\_CREATE\_INCIDENT.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Maintenance
>
> **Slug:** `INSTATUS_GET_MAINTENANCE`
>
> Get one Instatus maintenance with its schedule, affected components, automation settings, and update history.
>
> #### Input Parameters
>
> **page\_id** `string` *required*
>
> Status page ID containing the maintenance.
>
> **maintenance\_id** `string` *required*
>
> Maintenance ID from INSTATUS\_LIST\_MAINTENANCES or INSTATUS\_CREATE\_MAINTENANCE.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Components
>
> **Slug:** `INSTATUS_LIST_COMPONENTS`
>
> List 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
>
> **page\_id** `string` *required*
>
> Status page ID from INSTATUS\_LIST\_STATUS\_PAGES.
>
> **per\_page** `integer`
>
> Maximum components to return in this page (1-100).
>
> **next\_cursor** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Incidents
>
> **Slug:** `INSTATUS_LIST_INCIDENTS`
>
> List 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
>
> **page\_id** `string` *required*
>
> Status page ID whose incidents to list.
>
> **per\_page** `integer`
>
> Maximum incidents to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **exclude\_statuses** `string`
>
> Comma-separated statuses to exclude: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED.
>
> **include\_statuses** `string`
>
> Comma-separated statuses to include: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Maintenances
>
> **Slug:** `INSTATUS_LIST_MAINTENANCES`
>
> List scheduled and historical maintenances for an Instatus status page.
>
> #### Input Parameters
>
> **page\_id** `string` *required*
>
> Status page ID whose maintenances to list.
>
> **per\_page** `integer`
>
> Maximum maintenances to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Status Pages
>
> **Slug:** `INSTATUS_LIST_STATUS_PAGES`
>
> List status pages available to the connected Instatus account so an agent can discover page IDs for component, incident, and maintenance operations.
>
> #### Input Parameters
>
> **per\_page** `integer`
>
> Maximum status pages to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Component
>
> **Slug:** `INSTATUS_UPDATE_COMPONENT`
>
> Change a component's health or presentation on an Instatus status page.
>
> #### Input Parameters
>
> **name** `string`
>
> New public component name.
>
> **order** `integer`
>
> New display order.
>
> **status** `string ("OPERATIONAL" | "UNDERMAINTENANCE" | "DEGRADEDPERFORMANCE" | "PARTIALOUTAGE" | "MAJOROUTAGE")`
>
> New component health status.
>
> **grouped** `boolean`
>
> Whether the component is a parent or group component.
>
> **page\_id** `string` *required*
>
> Status page ID containing the component.
>
> **description** `string`
>
> New public component description.
>
> **show\_uptime** `boolean`
>
> Whether to show uptime percentage and bar.
>
> **component\_id** `string` *required*
>
> Component ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Incident
>
> **Slug:** `INSTATUS_UPDATE_INCIDENT`
>
> Edit 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
>
> **name** `string`
>
> New public incident name.
>
> **notify** `boolean`
>
> Whether to notify page and affected-component subscribers about this change.
>
> **status** `string ("INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED")`
>
> New incident lifecycle status.
>
> **page\_id** `string` *required*
>
> Status page ID containing the incident.
>
> **started\_at** `string` *required*
>
> Required incident start time in ISO 8601 format.
>
> **incident\_id** `string` *required*
>
> Incident ID to edit.
>
> **component\_ids** `array`
>
> Replacement list of affected component IDs.
>
> **component\_statuses** `array`
>
> Per-component health states for affected components.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Maintenance
>
> **Slug:** `INSTATUS_UPDATE_MAINTENANCE`
>
> Fully 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
>
> **name** `string`
>
> Replacement public maintenance name. Omit it to preserve provider omission semantics.
>
> **end\_at** `string` *required*
>
> Replacement maintenance end time in ISO 8601 format.
>
> **notify** `boolean` *required*
>
> Whether to notify page and affected-component subscribers about this update.
>
> **status** `string ("NOTSTARTEDYET" | "INPROGRESS" | "COMPLETED")` *required*
>
> Replacement maintenance lifecycle status.
>
> **message** `string` *required*
>
> Full replacement public maintenance message.
>
> **page\_id** `string` *required*
>
> Status page ID containing the maintenance.
>
> **auto\_end** `boolean` *required*
>
> Whether Instatus automatically completes the maintenance.
>
> **start\_at** `string` *required*
>
> Replacement maintenance start time in ISO 8601 format.
>
> **auto\_start** `boolean` *required*
>
> Whether Instatus automatically starts the maintenance.
>
> **component\_ids** `array` *required*
>
> Full replacement list of affected component IDs.
>
> **maintenance\_id** `string` *required*
>
> Maintenance ID to update.
>
> **duration\_minutes** `integer` *required*
>
> Replacement maintenance duration in minutes.
>
> **component\_statuses** `array` *required*
>
> Full replacement health states for affected components.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
