API Overview¶
The Mayo ASPM REST API provides programmatic access to all platform features.
Base URL¶
Interactive Documentation¶
- Swagger UI: docs.api.mayoaspm.com/docs
- ReDoc: docs.api.mayoaspm.com/redoc
- OpenAPI Schema: docs.api.mayoaspm.com/openapi.json
Response Format¶
All responses are JSON. Paginated endpoints return:
Error Responses¶
Common status codes:
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request |
| 401 | Unauthorized (missing/invalid auth) |
| 403 | Forbidden (insufficient permissions) |
| 404 | Not found |
| 409 | Conflict (duplicate) |
| 429 | Rate limited (queue full) |
| 502 | Upstream service unavailable |