Overview
All API v2 endpoints share the /api/v2/ prefix.
Successful responses use a 2xx HTTP status code and contain resource-specific JSON. A 204 No Content response has no body.
Error responses use a common structure:
{
"code": "no_permission",
"message": "You have no permission to perform this action"
}Use the HTTP status to detect failure and message for display.
| HTTP status | Meaning |
|---|---|
| 200 / 201 / 202 / 204 | Success / Created / Accepted / No content |
| 400 | Malformed request, JSON, or authentication header |
| 401 | Missing, invalid, or expired authentication |
| 403 | Insufficient permissions |
| 404 | Resource not found |
| 405 | Method not allowed |
| 409 | Resource or revision conflict |
| 412 / 428 | Precondition failed / Required precondition missing |
| 413 / 415 | Request too large / Unsupported media type |
| 422 | Validation failed |
| 429 | Too many outstanding login tickets |
| 500 / 503 | Unexpected server error / Service unavailable |
Last updated on