xpna

Appearance

Errors ​

Notes:

Public API v1 is currently in feature preview and as such documentation for this feature is still work in progress

Public API v1 errors are returned using RFC 9457 problem details.

Response format ​

  • The response content type is application/problem+json.
  • Standard problem detail fields are included, plus xpna metadata fields.
json
{
  "type": "https://help.xpna.app/api-reference/errors#bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request payload is invalid.",
  "instance": "/api/public/v1/dataloader/upload",
  "requestId": "00-6b2f90b3a92445f792a2b2a6b4d8e6d0-0a8a7d9b9d8c4e2f-00",
  "correlationId": "3f3cb61b8f5342b4b4f0a3e2e1d0d5b1",
  "timestamp": "2026-02-03T05:16:02.000Z",
  "errors": {
    "entityId": ["The EntityId field is required."]
  }
}

Problem types ​

Common status codes ​

  • 400 is returned for validation or known request errors.
  • 401 is returned when authentication is missing or invalid.
  • 404 is returned when a resource is not found.
  • 429 is returned when the rate limit is exceeded.
  • 500 is returned for unexpected server errors.

bad-request ​

  • The request is rejected due to a known error.
  • A 400 status code is returned.

client-closed-request ​

  • The request is cancelled by the client.
  • A 499 status code is returned.

internal-error ​

  • An unexpected server error is raised.
  • A 500 status code is returned.

not-found ​

  • The requested resource does not exist.
  • A 404 status code is returned.

not-implemented ​

  • The feature is not available.
  • A 501 status code is returned.

rate-limit-exceeded ​

  • The request exceeds the current rate limit.
  • A 429 status code is returned.

unauthorized ​

  • Authentication is missing or invalid.
  • A 401 status code is returned.

validation-error ​

  • The request payload fails validation.
  • A 400 status code is returned with errors.

Copyright © 2025 xpna