Unkey · Schema

ServiceUnavailableErrorResponse

Error response when a required service is temporarily unavailable. This indicates that the service exists but cannot be reached or is not responding. When you encounter this error: - The service is likely experiencing temporary issues - Retrying the request after a short delay may succeed - If the error persists, the service may be undergoing maintenance - Contact Unkey support if the issue continues

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
meta object
error object
View JSON Schema on GitHub

JSON Schema

unkey-serviceunavailableerrorresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServiceUnavailableErrorResponse",
  "title": "ServiceUnavailableErrorResponse",
  "type": "object",
  "required": [
    "meta",
    "error"
  ],
  "properties": {
    "meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "error": {
      "$ref": "#/components/schemas/BaseError"
    }
  },
  "description": "Error response when a required service is temporarily unavailable. This indicates that the service exists but cannot be reached or is not responding.\n\nWhen you encounter this error:\n- The service is likely experiencing temporary issues\n- Retrying the request after a short delay may succeed\n- If the error persists, the service may be undergoing maintenance\n- Contact Unkey support if the issue continues"
}