Sign In

API Overview

Access Upstat programmatically to integrate with your existing tools and workflows.

Getting Started

The API uses standard REST conventions:

Base URL: https://api.upstat.io/v1

Authentication: Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

![Placeholder: API Keys Settings Page with Generate Key Button]

Available Resources

The API provides access to core Upstat features:

Monitors - Create and manage monitors programmatically

Incidents - Create incidents, update status, add comments

Status Pages - Update your public status page

Runbooks - Execute runbooks via API

Catalog - Manage services and dependencies

![Placeholder: API Documentation Page Showing Available Endpoints]

Response Format

All API responses use consistent JSON formatting:

{
  "status": "success",
  "data": { ... }
}

Errors include a message:

{
  "status": "error",
  "message": "Monitor not found"
}

Rate Limits

To ensure fair usage:

  • Limit: 1000 requests per hour per API key
  • Headers: Check X-RateLimit-Remaining in responses
  • Exceeded: Returns 429 status code

Learn more