Skip to content

API Errors

Error Response Format

json
{
  "error": {
    "code": "error_code",
    "message": "Human readable message",
    "details": {
      "field": "Additional context"
    }
  }
}

HTTP Status Codes

CodeDescription
200Success
201Created
204No Content
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Unprocessable Entity
429Rate Limit Exceeded
500Internal Server Error

Common Errors

authentication_failed

json
{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid or expired API key"
  }
}

validation_error

json
{
  "error": {
    "code": "validation_error",
    "message": "Validation failed",
    "details": {
      "name": "Name is required",
      "url": "Invalid URL format"
    }
  }
}

not_found

json
{
  "error": {
    "code": "not_found",
    "message": "Service 'xyz' not found"
  }
}

conflict

json
{
  "error": {
    "code": "conflict",
    "message": "Service with this name already exists"
  }
}

Released under the MIT License.