🎉 Cmdop v1.0 is here! Download now →
Skip to Content
DocsAPI ReferenceOverview

API Reference

RESTful API for programmatic access to Cmdop.

Base URL

https://api.cmdop.com/v1

Authentication

All requests require authentication via API token:

curl https://api.cmdop.com/v1/machines \ -H "Authorization: Bearer YOUR_API_TOKEN"

Get your API token from dashboard settings .

Response Format

All responses are JSON:

{ "data": { ... }, "meta": { "request_id": "req_abc123" } }

Error Responses

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

HTTP Status Codes

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

Rate Limiting

  • 1000 requests per minute per API token
  • Rate limit headers included in responses:
    • X-RateLimit-Limit
    • X-RateLimit-Remaining
    • X-RateLimit-Reset

Pagination

List endpoints support pagination:

curl "https://api.cmdop.com/v1/machines?limit=10&offset=0"

Response includes pagination metadata:

{ "data": [...], "meta": { "total": 45, "limit": 10, "offset": 0 } }

Endpoints

EndpointDescription
GET /machinesList machines
GET /machines/:idGet machine
POST /commandsExecute command
GET /filesList files
POST /schedulesCreate schedule

SDKs

We recommend using official SDKs:

Next Steps


API Reference | Cmdop