M
API Matrix

Instatus API

Business / API Key Intermediate HTTPS
Varies by plan (check documentation)
72 Score
Grade B
Visit Official Site Compare Alternatives

Overview

Instatus API lets you programmatically create and update incidents and maintenance windows on your public status page. Use it to automate status updates directly from your monitoring systems.

💡

Beginner Tip

You need two IDs for most write operations: your page ID and the incident ID. Retrieve your page ID first with GET /v2/pages using your API key, then use it in all subsequent requests.

Available Data

Instatus data via REST API
JSON-formatted response data
Requires API key authentication

Example Response

JSON Response 
{
  "status": "success",
  "data": {
    "result": "Data from Instatus",
    "description": "Post to and update maintenance and incidents on your status page through an HTTP REST API",
    "timestamp": "2025-01-15T10:00:00Z"
  }
}

Field Reference

id Unique identifier for the status page or incident object.
name Display name of the status page or incident.
status Current incident status: "investigating", "identified", "monitoring", or "resolved".
components List of affected components (services) associated with the incident.
started_at ISO 8601 timestamp when the incident started.
resolved_at ISO 8601 timestamp when resolved, or null if still ongoing.

Implementation Example 

// ⚠️ Note: This URL may be a documentation page. Check official docs for actual API endpoint.
const url = "https://instatus.com/help/api";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "X-API-Key": "YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

401 Unauthorized The API key is missing or formatted incorrectly in the Authorization header
✓ Use the header format: Authorization: Bearer YOUR_API_KEY — not Basic auth or a query parameter.
404 Not Found on incident update The incident ID or page ID in the URL path does not match your account
✓ List your incidents first with GET /v2/{pageId}/incidents to get the correct IDs before attempting updates.
422 Unprocessable Entity A required field is missing in the request body
✓ Check the required fields in the docs — incident creation requires at minimum "name" and "status" (e.g. "investigating").

Matrix Score Breakdown

🌐 Reachability 30/30
⚡ Speed 5/20
🔒 Security 15/15
🛠 Developer XP 12/20
✓ Reliability 10/15

Partially tested on Apr 5, 2026

Technical Specifications

Auth API Key
HTTPS REQUIRED
CORS UNKNOWN
Category Business
Difficulty Intermediate
Verified: 2026-04-04

Similar APIs

View All →

Apache Superset

87

Apache Superset's REST API lets you programmatically manage dashboards, charts, datasets, and database connections in your Superset instance.

API Key Intermediate HTTPS

Charity Search

67

Charity Search lets you look up verified US non-profit organizations by name, EIN, or keyword.

API Key Intermediate

Clearbit Logo

⭐ Beginner's Pick
77

Clearbit Logo returns a company logo image by domain name — no scraping required.

API Key Intermediate HTTPS

Mailchimp

72

Mailchimp API lets you manage email lists, create campaigns, and track subscriber activity.

API Key Intermediate HTTPS

mailjet

72

Mailjet lets you send transactional and marketing emails via a simple REST API using MJML or HTML templates.

API Key Intermediate HTTPS