---
canonical_url: "https://docs.composio.dev/toolkits/instatus"
markdown_url: "https://docs.composio.dev/toolkits/instatus.md"
product: "platform"
version: null
last_updated: null
---

# Instatus

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

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

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notify` | boolean | No | 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") | Yes | Incident lifecycle status to set with this update. |
| `message` | string | No | Public progress message. |
| `page_id` | string | Yes | Status page ID containing the incident. |
| `started_at` | string | No | ISO 8601 time when this update occurred. Omit it to let Instatus use the current time. |
| `incident_id` | string | Yes | Incident ID receiving the update. |
| `component_ids` | array | Yes | IDs of components affected by this update. |
| `component_statuses` | array | Yes | Health states for affected components. Every item ID must also appear in component_ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_at` | string | No | ISO 8601 end time represented by this maintenance update. |
| `notify` | boolean | No | 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") | No | Maintenance lifecycle status represented by this update. |
| `message` | string | No | Public maintenance progress message. |
| `page_id` | string | Yes | Status page ID containing the maintenance. |
| `started_at` | string | Yes | Required ISO 8601 time when this maintenance update occurred. |
| `component_ids` | array | No | IDs of components affected by this maintenance update. |
| `maintenance_id` | string | Yes | Maintenance ID receiving the update. |
| `component_statuses` | array | No | Health states for affected components. Every item ID must also appear in component_ids. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Public component name. |
| `order` | integer | No | Display order on the status page. |
| `status` | string ("OPERATIONAL" | "UNDERMAINTENANCE" | "DEGRADEDPERFORMANCE" | "PARTIALOUTAGE" | "MAJOROUTAGE") | No | Initial component health status. Omit it to let Instatus apply its provider default. |
| `grouped` | boolean | No | Whether this component is a parent or group component. |
| `page_id` | string | Yes | Status page ID on which to create the component. |
| `group_id` | string | No | Parent component ID under which to group this component. |
| `description` | string | No | Optional public component description. |
| `show_uptime` | boolean | No | Whether to show the component's uptime percentage and bar. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Component

**Slug:** `INSTATUS_GET_COMPONENT`

Get the current health and configuration of one component on an Instatus status page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Status page ID containing the component. |
| `component_id` | string | Yes | Component ID from INSTATUS_LIST_COMPONENTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Incident

**Slug:** `INSTATUS_GET_INCIDENT`

Get one Instatus incident with its affected components and update history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Status page ID containing the incident. |
| `incident_id` | string | Yes | Incident ID from INSTATUS_LIST_INCIDENTS or INSTATUS_CREATE_INCIDENT. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Maintenance

**Slug:** `INSTATUS_GET_MAINTENANCE`

Get one Instatus maintenance with its schedule, affected components, automation settings, and update history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Status page ID containing the maintenance. |
| `maintenance_id` | string | Yes | Maintenance ID from INSTATUS_LIST_MAINTENANCES or INSTATUS_CREATE_MAINTENANCE. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Status page ID from INSTATUS_LIST_STATUS_PAGES. |
| `per_page` | integer | No | Maximum components to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page and pass the returned value unchanged to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Incidents

**Slug:** `INSTATUS_LIST_INCIDENTS`

List incidents for an Instatus status page, optionally including or excluding lifecycle statuses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Status page ID whose incidents to list. |
| `per_page` | integer | No | Maximum incidents to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `exclude_statuses` | string | No | Comma-separated statuses to exclude: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED. |
| `include_statuses` | string | No | Comma-separated statuses to include: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Maintenances

**Slug:** `INSTATUS_LIST_MAINTENANCES`

List scheduled and historical maintenances for an Instatus status page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_id` | string | Yes | Status page ID whose maintenances to list. |
| `per_page` | integer | No | Maximum maintenances to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per_page` | integer | No | Maximum status pages to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Component

**Slug:** `INSTATUS_UPDATE_COMPONENT`

Change a component's health or presentation on an Instatus status page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New public component name. |
| `order` | integer | No | New display order. |
| `status` | string ("OPERATIONAL" | "UNDERMAINTENANCE" | "DEGRADEDPERFORMANCE" | "PARTIALOUTAGE" | "MAJOROUTAGE") | No | New component health status. |
| `grouped` | boolean | No | Whether the component is a parent or group component. |
| `page_id` | string | Yes | Status page ID containing the component. |
| `description` | string | No | New public component description. |
| `show_uptime` | boolean | No | Whether to show uptime percentage and bar. |
| `component_id` | string | Yes | Component ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement public maintenance name. Omit it to preserve provider omission semantics. |
| `end_at` | string | Yes | Replacement maintenance end time in ISO 8601 format. |
| `notify` | boolean | Yes | Whether to notify page and affected-component subscribers about this update. |
| `status` | string ("NOTSTARTEDYET" | "INPROGRESS" | "COMPLETED") | Yes | Replacement maintenance lifecycle status. |
| `message` | string | Yes | Full replacement public maintenance message. |
| `page_id` | string | Yes | Status page ID containing the maintenance. |
| `auto_end` | boolean | Yes | Whether Instatus automatically completes the maintenance. |
| `start_at` | string | Yes | Replacement maintenance start time in ISO 8601 format. |
| `auto_start` | boolean | Yes | Whether Instatus automatically starts the maintenance. |
| `component_ids` | array | Yes | Full replacement list of affected component IDs. |
| `maintenance_id` | string | Yes | Maintenance ID to update. |
| `duration_minutes` | integer | Yes | Replacement maintenance duration in minutes. |
| `component_statuses` | array | Yes | Full replacement health states for affected components. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |