API Documentation

Integrate AntOps with your existing tools and workflows using our comprehensive REST API

Contents

ANTOPS API Documentation

Welcome to the ANTOPS API! This RESTful API allows you to programmatically interact with your ITSM (IT Service Management) platform for managing incidents, problems, changes, and infrastructure components.

Authentication

ANTOPS API supports API tokens for authentication.

API Tokens

Generate API tokens through the Settings page in your ANTOPS dashboard. Include the token in the Authorization header:

Authorization: Bearer antops_sk_live_[your_token_here]

Rate Limiting

AI Endpoints

AI-powered endpoints have a rate limiting per user per day:

  • 5 AI scans per user per day
  • Resets daily at midnight
  • Rate limit status available via /api/ai/token-status

General API Endpoints

Standard rate limiting applies to prevent abuse. Contact support if you need higher limits.

Response Format

All responses follow this structure:

{
  "data": { ... },         // Success responses
  "error": "string",       // Error message (if applicable)
  "status": "success|error"
}

Error Codes

  • 200 - Success
  • 201 - Created
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 429 - Rate Limited
  • 500 - Internal Server Error

Authentication Endpoints

Get Current User

Get information about the authenticated user.

GET /api/auth/me

Response:

{
  "user": {
    "id": "user-uuid",
    "email": "user@example.com",
    "name": "John Doe",
    "organizationId": "org-uuid",
    "role": "owner",
    "isApiTokenAuth": true,
    "tokenPermissions": ["read", "write"],
    "tokenScope": "full"
  },
  "authMethod": "api_token"
}

Create API Token

POST /api/auth/tokens 
{
  "name": "My Integration Token",
  "permissions": ["read", "write"],
  "scope": "full",
  "expiresAt": "2024-12-31T23:59:59Z"
}

Response:

{
  "token": "antops_sk_live_[full_token_here]",
  "tokenData": {
    "id": "token-uuid",
    "name": "My Integration Token",
    "tokenPrefix": "antops_sk_li...",
    "permissions": ["read", "write"],
    "scope": "full",
    "expiresAt": "2024-12-31T23:59:59Z",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

Incident Management

List Incidents

Retrieve all incidents for your organization.

GET /api/incidents

Response:

[
  {
    "id": "incident-uuid",
    "title": "Database Connection Issues",
    "description": "Users unable to connect to primary database",
    "status": "open",
    "priority": "high",
    "criticality": "major",
    "urgency": "high",
    "assignedTo": "user-uuid",
    "assignedToName": "John Doe",
    "affectedServices": ["web-app", "api"],
    "tags": ["database", "connectivity"],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T11:45:00Z"
  }
]

Create Incident

POST /api/incidents 
{
  "title": "API Response Time Degradation",
  "description": "API endpoints showing increased response times",
  "priority": "medium",
  "criticality": "minor", 
  "urgency": "medium",
  "assignedTo": "user-uuid",
  "affectedServices": ["api", "web-app"],
  "tags": ["performance", "api"]
}

AI-Powered Features

Get AI Token Status

Check your AI scan token usage and limits.

GET /api/ai/token-status

Response:

{
  "tokensUsed": 2,
  "tokensRemaining": 3,
  "tokensLimit": 5,
  "canScan": true,
  "resetTime": "2024-01-16T00:00:00Z",
  "resetTimeFormatted": "13h 24m"
}

AI Component Analysis

POST /api/ai/component-insights 
{
  "componentId": "component-uuid",
  "analysisDepth": "basic",
  "includeFailurePaths": true,
  "includeDependencyAnalysis": true
}

Examples

Complete Incident Workflow

# 1. Create an incident
curl -X POST "https://app.antopshq.com/api/incidents" \
  -H "Authorization: Bearer antops_sk_live_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Database Connection Issues",
    "description": "Primary database showing connection timeouts",
    "priority": "high",
    "criticality": "major",
    "urgency": "high",
    "affectedServices": ["web-app", "api"]
  }'

# 2. Update the incident  
curl -X PUT "https://app.antopshq.com/api/incidents/{incident-id}" \
  -H "Authorization: Bearer antops_sk_live_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "investigating",
    "description": "Updated: Found connection pool exhaustion"
  }'

Support

Getting Help

  • Email: support@antopshq.com

Last updated: 27th of August, 2025