Reference

Errors.

All errors follow the same envelope. Always read the type field, not just the HTTP status.

Envelope

{
  "error": {
    "type": "forbidden",
    "message": "You do not have access to wind farm wf_xyz.",
    "requestId": "req_8f12",
    "details": []
  }
}

HTTP status codes

StatusTypeWhen
400invalid_requestThe request is malformed or fails validation.
401unauthorizedMissing or invalid access token.
403forbiddenToken does not grant access to this asset or scope.
404not_foundThe resource does not exist or is hidden from this tenant.
409conflictState conflict, for example a duplicate external id.
422validation_errorField level validation failed. See details.
429rate_limitedToo many requests, see Retry-After header.
500server_errorUnexpected server side error. Retry with backoff.