> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/instatus.md).

# Instatus

Manage status pages, incidents, and components in Instatus.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Instatus  | API key        |

#### Instatus

Manage Instatus incidents and status page components.

**Set up in Instatus**

1. Sign in to Instatus and open User settings, then Developer settings.
2. Copy your API key.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Instatus**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                               |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| API key       | Yes      | Copy your API key from Instatus developer settings. [Provider instructions](https://instatus.com/help/api). |

**Provider documentation:** [Setup reference](https://instatus.com/help/api).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Instatus** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Status Pages

List accessible status pages and their IDs.

**Inputs**

| Field           | Type    | Required | Description                                                              |
| --------------- | ------- | -------- | ------------------------------------------------------------------------ |
| Maximum results | integer | No       | Fetch complete pages until this many results are collected. Default: 50. |
| Starting page   | integer | No       | Use the next page from a previous result to continue. Default: 1.        |

**Outputs**

| Field     | Type          | Description                                                     |
| --------- | ------------- | --------------------------------------------------------------- |
| Pages     | object\_array | Accessible status pages and their IDs.                          |
| Next page | integer       | Next page to fetch, or empty when all pages have been returned. |

#### List Components

List component names, IDs, and current statuses on a status page.

**Inputs**

| Field           | Type            | Required | Description                                                         |
| --------------- | --------------- | -------- | ------------------------------------------------------------------- |
| Status page     | select (string) | Yes      | Choose a status page. Options load from the selected connection.    |
| Maximum results | integer         | No       | Fetch complete pages until this soft limit is reached. Default: 50. |
| Starting page   | integer         | No       | Use Next page from a previous result to continue. Default: 1.       |

**Outputs**

| Field      | Type          | Description                                                   |
| ---------- | ------------- | ------------------------------------------------------------- |
| Components | object\_array | Component IDs, names, and current statuses.                   |
| Next Page  | integer       | Next starting page; empty when all results have been fetched. |

#### List Incidents

List incidents on a status page, optionally filtered by status.

**Inputs**

| Field           | Type            | Required | Description                                                                                              |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| Status page     | select (string) | Yes      | Choose a status page. Options load from the selected connection.                                         |
| Incident status | select (string) | No       | Optionally filter by incident status. Available values: Investigating, Identified, Monitoring, Resolved. |
| Maximum results | integer         | No       | Fetch complete pages until this soft limit is reached. Default: 50.                                      |
| Starting page   | integer         | No       | Use the next page from a previous result to continue. Default: 1.                                        |

**Outputs**

| Field     | Type          | Description                                                         |
| --------- | ------------- | ------------------------------------------------------------------- |
| Incidents | object\_array | Incidents with their IDs, titles, statuses, and timeline summaries. |
| Next page | integer       | Next starting page; empty when all results have been fetched.       |

#### Get Incident

Get an incident with its update history and affected components.

**Inputs**

| Field       | Type            | Required | Description                                                                   |
| ----------- | --------------- | -------- | ----------------------------------------------------------------------------- |
| Status page | select (string) | Yes      | Choose the incident's status page. Options load from the selected connection. |
| Incident    | select (string) | Yes      | Choose an incident on this page. Options load from the selected connection.   |

**Outputs**

| Field    | Type   | Description                                         |
| -------- | ------ | --------------------------------------------------- |
| Incident | object | Incident details, affected components, and updates. |

#### Create Incident

Create a draft incident, or publish it with an initial message and affected components.

**Inputs**

| Field               | Type                      | Required | Description                                                                                                                          |
| ------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Status page         | select (string)           | Yes      | Choose a status page. Options load from the selected connection.                                                                     |
| Title               | string                    | Yes      | Brief description of the incident.                                                                                                   |
| Message             | textarea                  | Yes      | Explain the incident and its impact.                                                                                                 |
| Incident status     | select (string)           | No       | Choose the current stage of the incident. Available values: Investigating, Identified, Monitoring, Resolved. Default: INVESTIGATING. |
| Affected components | multiple\_select (string) | No       | Select affected components on this page. Options load from the selected connection.                                                  |
| Publish immediately | boolean                   | No       | Publish the incident on the status page. Leave off to create a draft. Default: false.                                                |
| Notify subscribers  | boolean                   | No       | Send a notification to subscribers. Requires Publish immediately. Default: false.                                                    |
| Advanced options    | boolean                   | No       | Set when the incident occurred. Default: false.                                                                                      |
| Occurred at         | datetime                  | No       | Optional incident time, including timezone.                                                                                          |

**Outputs**

| Field    | Type   | Description           |
| -------- | ------ | --------------------- |
| Incident | object | The created incident. |

#### Update Incident

Edit incident title, status, or affected components without posting a timeline message.

**Inputs**

| Field               | Type                      | Required | Description                                                                                                                     |
| ------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Status page         | select (string)           | Yes      | Choose a status page. Options load from the selected connection.                                                                |
| Incident            | select (string)           | Yes      | Choose the incident to edit. Options load from the selected connection.                                                         |
| Title               | string                    | No       | New incident title; omit to keep it unchanged.                                                                                  |
| Incident status     | select (string)           | No       | New status; omit to keep it unchanged. Available values: Investigating, Identified, Monitoring, Resolved.                       |
| Affected components | multiple\_select (string) | No       | Select affected components, or omit to keep them. Remove all components in Instatus. Options load from the selected connection. |
| Notify subscribers  | boolean                   | No       | Enable to notify subscribers about this edit. Default: false.                                                                   |
| Occurred at         | string                    | No       | Optional corrected incident start time, including timezone.                                                                     |

**Outputs**

| Field    | Type   | Description           |
| -------- | ------ | --------------------- |
| Incident | object | The updated incident. |

#### Create Component

Create a service component on a status page.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                                                                   |
| ---------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Status page      | select (string) | Yes      | Choose a status page. Options load from the selected connection.                                                                                                              |
| Name             | string          | Yes      | Name of the service shown on your status page.                                                                                                                                |
| Description      | textarea        | No       | Optional explanation of the service.                                                                                                                                          |
| Component status | select (string) | No       | Choose the current availability of the component. Available values: Operational, Under maintenance, Degraded performance, Partial outage, Major outage. Default: OPERATIONAL. |
| Show uptime      | boolean         | No       | Display the uptime percentage and history. Default: true.                                                                                                                     |

**Outputs**

| Field     | Type   | Description                    |
| --------- | ------ | ------------------------------ |
| Component | object | The created service component. |

#### Update Component Status

Change a component's availability while preserving its other settings.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                                     |
| ---------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Status page      | select (string) | Yes      | Choose a status page. Options load from the selected connection.                                                                                |
| Component        | select (string) | Yes      | Choose a component on the selected status page. Options load from the selected connection.                                                      |
| Component status | select (string) | Yes      | Choose the availability of the component. Available values: Operational, Under maintenance, Degraded performance, Partial outage, Major outage. |

**Outputs**

| Field     | Type   | Description            |
| --------- | ------ | ---------------------- |
| Component | object | The updated component. |

#### Add Incident Update

Publish a progress or resolution message for an incident.

**Inputs**

| Field                     | Type                      | Required | Description                                                                                                                                                  |
| ------------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status page               | select (string)           | Yes      | Choose the incident's status page. Options load from the selected connection.                                                                                |
| Incident                  | select (string)           | Yes      | Choose the incident to update. Options load from the selected connection.                                                                                    |
| Message                   | textarea                  | Yes      | Explain progress or resolution to customers.                                                                                                                 |
| Incident status           | select (string)           | No       | Leave blank to keep the current incident status. Available values: Investigating, Identified, Monitoring, Resolved.                                          |
| Affected components       | multiple\_select (string) | No       | Omit to keep affected components; an explicit empty list clears them. Options load from the selected connection.                                             |
| Notify subscribers        | boolean                   | No       | Send subscribers a notification about this update. Default: false.                                                                                           |
| Advanced options          | boolean                   | No       | Set component statuses or a custom event time. Default: false.                                                                                               |
| Affected component status | select (string)           | No       | Optionally set the status of every affected component. Available values: Operational, Degraded performance, Partial outage, Major outage, Under maintenance. |
| Occurred at               | string                    | No       | Optional date and time, including timezone.                                                                                                                  |

**Outputs**

| Field           | Type   | Description                    |
| --------------- | ------ | ------------------------------ |
| Incident update | object | The published incident update. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/instatus.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
