API Overview

The Ops Atlas REST API allows you to programmatically manage your infrastructure.

Base URL

https://your-instance.com/api/v1

Authentication

All requests require authentication via API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://your-instance.com/api/v1/services

See Authentication for details.

Request Format

• Content-Type: application/json
• Accept: application/json

Response Format

Successful responses:

{
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}

Error responses:

{
  "error": {
    "code": "not_found",
    "message": "Service not found",
    "details": { ... }
  }
}

Pagination

Use query parameters:

GET /api/v1/services?page=2&per_page=50

Rate Limiting

Default limits:

• 100 requests per minute per API key
• 1000 requests per hour per API key

See Rate Limits for details.

SDKs

Official SDKs:

• JavaScript/TypeScript
• Python
• Go

Quick Examples

List Services

curl -H "Authorization: Bearer $API_KEY" \
  https://ops.example.com/api/v1/services

Trigger Deployment

curl -X POST \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service": "api", "version": "v1.2.3"}' \
  https://ops.example.com/api/v1/deployments

Get Metrics

curl -H "Authorization: Bearer $API_KEY" \
  "https://ops.example.com/api/v1/metrics?service=api&from=-1h"