Skip to documentation content
Clario360DOCS
DocumentationBuildAPI conventions
BUILD

API conventions

Versioning, pagination, filtering, errors and idempotent operations.

Last updated July 18, 2026 · 6 min read

#Requests and responses

  • JSON request and response bodies use application/json
  • Timestamps use RFC 3339 in UTC
  • Unknown fields may be added without a major version change
  • Every response carries or returns a request identifier for support tracing

#Pagination

bash
curl "$CLARIO360_API_URL/api/v1/cyber/alerts?per_page=50&page=2" \
  -H "X-API-Key: $CLARIO360_API_KEY"

#Errors

json
{
  "error": {
    "code": "validation_failed",
    "message": "The request could not be processed.",
    "details": [{ "field": "name", "reason": "required" }]
  },
  "request_id": "req_01J..."
}

#Idempotency

For supported create and action endpoints, send a unique Idempotency-Key. Reusing the key with the same payload returns the original result; reusing it with a different payload is rejected.

Was this page helpful?
API conventions — Clario360 Documentation