API Reference

OpsPilot365 provides a REST API for programmatic access to your managed tenants and data.

The API is currently in beta. Endpoints may change without notice.

Base URL

All API requests should be made to:


https://api.opspilot365.com/v1

The API uses API keys for authentication. Include your API key in the Authorization header:


curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.opspilot365.com/v1/tenants

See Authentication for details on obtaining and managing API keys.

Rate limit headers are included in all responses:


X-RateLimit-Limit: 60
X-RateLimit-Remaining: 55
X-RateLimit-Reset: 1640000000

All responses are returned as JSON:


{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 25,
    "total": 100
  }
}


{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request was invalid",
    "details": { ... }
  }
}

List endpoints support pagination:


GET /v1/tenants?page=2&limit=50

Parameters:

Method	Endpoint	Description
GET	`/tenants/:id/licenses`	List available licenses
GET	`/tenants/:id/licenses/assignments`	List assignments
POST	`/tenants/:id/licenses/assign`	Assign license
POST	`/tenants/:id/licenses/remove`	Remove license

Coming soon:

For API support, contact us at api-support@opspilot365.com