{
  "schemas": {
    "catalogue": "https://apiguide.dev/schemas/errors/v1/catalogue.schema.json",
    "type": "https://apiguide.dev/schemas/errors/v1/problem-type.schema.json"
  },
  "catalogue": {
    "schema": "v1",
    "base_url": "https://apiguide.dev/errors/"
  },
  "registered": {
    "date-not-acceptable": "https://iana.org/assignments/http-problem-types#date",
    "digest-invalid-values": "https://iana.org/assignments/http-problem-types#digest-invalid-values",
    "digest-mismatched-values": "https://iana.org/assignments/http-problem-types#digest-mismatched-values",
    "digest-unsupported-algorithms": "https://iana.org/assignments/http-problem-types#digest-unsupported-algorithms",
    "ohttp-key-not-acceptable": "https://iana.org/assignments/http-problem-types#ohttp-key"
  },
  "types": [
    {
      "type": "account-frozen",
      "title": "Account Frozen",
      "status": 403,
      "summary": "Use 403 with an Account Frozen error when credentials are valid but the account itself has been suspended, locked, or placed under review, so no action can proceed regardless of the caller's permissions.",
      "extensions": {
        "reason": {
          "type": "string"
        },
        "frozenAt": {
          "type": "string"
        },
        "contact": {
          "type": "string"
        }
      }
    },
    {
      "type": "bad-gateway",
      "title": "Bad Gateway",
      "status": 502,
      "summary": "Use 502 Bad Gateway when your server, acting as a gateway or proxy, got a response from the server behind it and that response was unusable.",
      "extensions": {
        "upstream": {
          "type": "string"
        }
      }
    },
    {
      "type": "date-not-acceptable",
      "title": "Date Not Acceptable",
      "status": 400,
      "summary": "Use 400 with Date Not Acceptable when you reject a request because the value of its `Date` header falls outside the window of time you accept requests in.",
      "registered_type": "https://iana.org/assignments/http-problem-types#date"
    },
    {
      "type": "digest-invalid-values",
      "title": "Invalid Digest Values",
      "status": 400,
      "summary": "Use 400 with an Invalid Digest Values error when a `Content-Digest` or `Repr-Digest` field parses, names an algorithm you support, but carries a value that algorithm could never produce.",
      "registered_type": "https://iana.org/assignments/http-problem-types#digest-invalid-values",
      "extensions": {
        "invalid_digests": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    {
      "type": "digest-mismatched-values",
      "title": "Mismatched Digest Values",
      "status": 400,
      "summary": "Use 400 with a Mismatched Digest Values error when a request carries a `Content-Digest` or `Repr-Digest` field, the digest uses an algorithm you support, and the value you compute over the content does not match the one the client sent.",
      "registered_type": "https://iana.org/assignments/http-problem-types#digest-mismatched-values",
      "extensions": {
        "mismatched_digests": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    {
      "type": "digest-unsupported-algorithms",
      "title": "Unsupported Hashing Algorithms",
      "status": 400,
      "summary": "Use 400 with an Unsupported Hashing Algorithms error when the only digests a request carries, in `Content-Digest` or `Repr-Digest`, use algorithms you do not support.",
      "registered_type": "https://iana.org/assignments/http-problem-types#digest-unsupported-algorithms",
      "extensions": {
        "unsupported_algorithms": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    {
      "type": "endpoint-sunset",
      "title": "Endpoint Sunset",
      "status": 410,
      "summary": "Use `410 Gone` with an Endpoint Sunset error when a client calls a piece of API surface you have retired on purpose: an endpoint, an operation, or a path-versioned API such as everything under `/v1/`.",
      "extensions": {
        "deprecatedAt": {
          "type": "string"
        },
        "sunsetAt": {
          "type": "string"
        },
        "successor": {
          "type": "string"
        },
        "migrationGuide": {
          "type": "string"
        }
      }
    },
    {
      "type": "expired-authentication-token",
      "title": "Expired Authentication Token",
      "status": 401,
      "summary": "Use 401 with an expired authentication token error when the client presents a token (such as a JWT, OAuth token, or API token) that is structurally valid and was previously recognized by the server, but has since passed its expiration timestamp."
    },
    {
      "type": "failed-dependency",
      "title": "Failed Dependency",
      "status": 424,
      "summary": "Use `424 Failed Dependency` for an operation that was not performed because it depended on another operation in the same request, and that other operation failed.",
      "extensions": {
        "results": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    {
      "type": "feature-disabled",
      "title": "Feature Disabled",
      "status": 403,
      "summary": "Use `403 Forbidden` with a Feature Disabled error when the caller is authenticated, the request is valid, and the feature it uses is turned off for this account, organization or plan.",
      "extensions": {
        "feature": {
          "type": "string"
        },
        "enableUrl": {
          "type": "string"
        }
      }
    },
    {
      "type": "forbidden",
      "title": "Forbidden",
      "status": 403,
      "summary": "Use 403 Forbidden when the server knows who the caller is, the credentials are valid, and your authorization rules still refuse this action.",
      "extensions": {
        "requiredRole": {
          "type": "string"
        },
        "currentRole": {
          "type": "string"
        }
      }
    },
    {
      "type": "gateway-timeout",
      "title": "Gateway Timeout",
      "status": 504,
      "summary": "Use 504 Gateway Timeout when an upstream server (such as Nginx, Apache, an API Gateway, or Cloudflare) acting as a gateway or proxy fails to receive a timely response from the backend application server (like Node.js, Python, or Go) to complete the request."
    },
    {
      "type": "gone",
      "title": "Gone",
      "status": 410,
      "summary": "Use 410 Gone when a resource has been removed on purpose and will not come back.",
      "extensions": {
        "sunsetAt": {
          "type": "string"
        },
        "successor": {
          "type": "string"
        },
        "migrationGuide": {
          "type": "string"
        }
      }
    },
    {
      "type": "idempotency-key-conflict",
      "title": "Idempotency Key Conflict",
      "status": 422,
      "summary": "Use 422 with an Idempotency Key Conflict error when a client sends an `Idempotency-Key` that it has already used, but with a different request payload."
    },
    {
      "type": "idempotency-key-missing",
      "title": "Idempotency Key Missing",
      "status": 400,
      "summary": "Use `400 Bad Request` with an Idempotency Key Missing error when an operation is documented as requiring an `Idempotency-Key` header and the request arrives without one."
    },
    {
      "type": "insufficient-funds",
      "title": "Insufficient Funds",
      "status": 402,
      "summary": "Use 402 with an Insufficient Funds error when the client is authenticated and authorized to perform the action, but the account backing the request cannot cover its cost.",
      "extensions": {
        "balance": {
          "type": "string"
        },
        "required": {
          "type": "string"
        },
        "currency": {
          "type": "string"
        },
        "topUpUrl": {
          "type": "string"
        }
      }
    },
    {
      "type": "insufficient-scope",
      "title": "Insufficient Scope",
      "status": 403,
      "summary": "Use 403 with an Insufficient Scope error when the client's credentials (like an API token or OAuth access token) are valid and authenticated, but the token lacks the specific permissions or scopes needed to access the requested resource or perform the HTTP action."
    },
    {
      "type": "internal-server-error",
      "title": "Internal Server Error",
      "status": 500,
      "summary": "Use 500 Internal Server Error when the application encounters an unexpected, unhandled exception or system failure that prevents it from fulfilling the request."
    },
    {
      "type": "invalid-credentials",
      "title": "Invalid Credentials",
      "status": 401,
      "summary": "Use `401 Unauthorized` with an Invalid Credentials error when the client presents a credential pair to authenticate and the pair does not check out: a username and password that do not match, an API key ID with the wrong secret, or HTTP Basic credentials for an account that does not exist."
    },
    {
      "type": "invalid-pagination-cursor",
      "title": "Invalid Pagination Cursor",
      "status": 400,
      "summary": "Use 400 when the client sent a value that fails structural validation before any business logic runs."
    },
    {
      "type": "invalid-query-parameter",
      "title": "Invalid Query Parameter",
      "status": 400,
      "summary": "Use 400 Invalid Query Parameter when the query string is the problem.",
      "extensions": {
        "parameter": {
          "type": "string"
        }
      }
    },
    {
      "type": "invalid-signature",
      "title": "Invalid Signature",
      "status": 401,
      "summary": "Use `401 Unauthorized` with an Invalid Signature error when a request carries the signature your endpoint requires, and that signature fails verification.",
      "extensions": {
        "signatureLabel": {
          "type": "string"
        },
        "reason": {
          "type": "string"
        }
      }
    },
    {
      "type": "length-required",
      "title": "Length Required",
      "status": 411,
      "summary": "Use 411 Length Required when the server refuses a request with content that does not declare its size in `Content-Length`."
    },
    {
      "type": "maintenance-mode",
      "title": "Maintenance Mode",
      "status": 503,
      "summary": "Use `503 Service Unavailable` with a Maintenance Mode error when you have taken the API, or part of it, out of service on purpose for planned work: a database migration, a data center move, a version upgrade that needs writes stopped."
    },
    {
      "type": "malformed-request-body",
      "title": "Malformed Request Body",
      "status": 400,
      "summary": "Use 400 with a Malformed Request Body error when the server cannot parse the payload sent in the HTTP request body."
    },
    {
      "type": "method-not-allowed",
      "title": "Method Not Allowed",
      "status": 405,
      "summary": "Use 405 Method Not Allowed when the HTTP request URI matches a valid path in your routing table, but the specific HTTP method used (e.g. `POST`, `PUT`, `DELETE`) is not supported by that endpoint."
    },
    {
      "type": "mfa-required",
      "title": "MFA Required",
      "status": 401,
      "summary": "Use `401 Unauthorized` with an MFA Required error when the caller is authenticated, but not strongly or recently enough for this operation, and must complete multi-factor authentication before it can proceed."
    },
    {
      "type": "misdirected-request",
      "title": "Misdirected Request",
      "status": 421,
      "summary": "Use `421 Misdirected Request` when a request reached a server that cannot give an authoritative response for its target URI."
    },
    {
      "type": "missing-signature",
      "title": "Missing Signature",
      "status": 401,
      "summary": "Use `401 Unauthorized` with a Missing Signature error when an endpoint requires signed requests and the request does not carry the signature it needs."
    },
    {
      "type": "not-acceptable",
      "title": "Not Acceptable",
      "status": 406,
      "summary": "Use 406 Not Acceptable when the client asks, through proactive content negotiation, for a representation the server is unable to produce."
    },
    {
      "type": "not-implemented",
      "title": "Not Implemented",
      "status": 501,
      "summary": "Use 501 Not Implemented when the server does not recognize the request method and cannot support it on any resource."
    },
    {
      "type": "ohttp-key-not-acceptable",
      "title": "Oblivious HTTP Key Configuration Not Acceptable",
      "status": 400,
      "summary": "Use 400 with this type when you run an Oblivious Gateway Resource under RFC 9458, Oblivious HTTP, and an Encapsulated Request was made with a key configuration you no longer accept or never issued: an unknown key identifier, a rotated-out key, or an unsupported HPKE suite.",
      "registered_type": "https://iana.org/assignments/http-problem-types#ohttp-key"
    },
    {
      "type": "payload-too-large",
      "title": "Payload Too Large",
      "status": 413,
      "summary": "Use 413 Content Too Large (formerly \"Payload Too Large\") when the client sends a request body (often a file upload or bulk records batch) that exceeds the maximum size limit configured on the server or application."
    },
    {
      "type": "precondition-failed",
      "title": "Precondition Failed",
      "status": 412,
      "summary": "Use 412 Precondition Failed when the client attaches a conditional header such as `If-Match` or `If-Unmodified-Since`, and the condition evaluates to false because the resource changed on the server since the client last saw it."
    },
    {
      "type": "precondition-required",
      "title": "Precondition Required",
      "status": 428,
      "summary": "Use 428 Precondition Required, defined in RFC 6585, when the server requires a state-changing request to be conditional and the client sent it without any precondition."
    },
    {
      "type": "quota-exceeded",
      "title": "Quota Exceeded",
      "status": 429,
      "summary": "Use 429 with a Quota Exceeded error when the client has used up the allowance on its plan for the current billing period, such as 100,000 requests a month or 50 GB of exports per cycle, and further requests are refused until the period resets or the plan changes.",
      "extensions": {
        "violatedPolicies": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "resetsAt": {
          "type": "string"
        },
        "upgradeUrl": {
          "type": "string"
        }
      }
    },
    {
      "type": "range-not-satisfiable",
      "title": "Range Not Satisfiable",
      "status": 416,
      "summary": "Use 416 Range Not Satisfiable when a client sends a `Range` header for part of a representation and none of the ranges it asked for can be served."
    },
    {
      "type": "rate-limit-exceeded",
      "title": "Rate Limit Exceeded",
      "status": 429,
      "summary": "Use 429 when the client has sent more requests than your rate limiting policy allows within a given window."
    },
    {
      "type": "request-header-fields-too-large",
      "title": "Request Header Fields Too Large",
      "status": 431,
      "summary": "Use 431 Request Header Fields Too Large, defined in RFC 6585, when the server will not process the request because its header fields are too large.",
      "extensions": {
        "field": {
          "type": "string"
        },
        "maxFieldSize": {
          "type": "integer"
        }
      }
    },
    {
      "type": "request-timeout",
      "title": "Request Timeout",
      "status": 408,
      "summary": "Use 408 Request Timeout when the server was prepared to receive a request but the client did not produce a complete one within the time the server was willing to wait."
    },
    {
      "type": "resource-conflict",
      "title": "Resource Conflict",
      "status": 409,
      "summary": "Use 409 Resource Conflict when the request cannot be completed due to a conflict with the current state of the target resource."
    },
    {
      "type": "resource-locked",
      "title": "Resource Locked",
      "status": 423,
      "summary": "Use `423 Locked` when the client tries to change a resource that is locked, and the lock is an explicit state of that resource rather than a permission rule.",
      "extensions": {
        "lockedBy": {
          "type": "string"
        },
        "lockedAt": {
          "type": "string"
        },
        "expectedReleaseAt": {
          "type": "string"
        }
      }
    },
    {
      "type": "resource-not-found",
      "title": "Resource Not Found",
      "status": 404,
      "summary": "Use 404 Resource Not Found when the requested URI does not match any route in the application routing table, or when a dynamic segment of the URI (such as an ID or UUID) refers to a resource database record that does not exist or has been deleted."
    },
    {
      "type": "service-unavailable",
      "title": "Service Unavailable",
      "status": 503,
      "summary": "Use 503 Service Unavailable when the server is temporarily unable to process the request because it is overloaded or down for planned maintenance."
    },
    {
      "type": "stale-resource-version",
      "title": "Stale Resource Version",
      "status": 409,
      "summary": "Use 409 Stale Resource Version when implementing optimistic concurrency control (OCC) and the client attempts to update or delete a resource using an outdated version indicator (such as an `ETag`, `version` integer, or `updated_at` timestamp)."
    },
    {
      "type": "tenant-suspended",
      "title": "Tenant Suspended",
      "status": 403,
      "summary": "Use `403 Forbidden` with a Tenant Suspended error when the caller's own credentials and account are fine, but the tenant the request targets, such as an organization, workspace or team, has been suspended.",
      "extensions": {
        "tenant": {
          "type": "string"
        },
        "reason": {
          "type": "string"
        },
        "suspendedAt": {
          "type": "string"
        }
      }
    },
    {
      "type": "token-revoked",
      "title": "Token Revoked",
      "status": 401,
      "summary": "Use `401 Unauthorized` with a Token Revoked error when the client presents an access token or API key that was valid, has not expired, and has since been revoked: the user signed out, an admin disabled the integration, the key was rotated after a leak, or the authorization server revoked the grant it belonged to."
    },
    {
      "type": "too-early",
      "title": "Too Early",
      "status": 425,
      "summary": "Use `425 Too Early` when a request arrived in TLS 1.3 early data (0-RTT), or was forwarded by an intermediary with `Early-Data: 1`, and processing a replayed copy of it would cause a side effect you are not prepared to repeat."
    },
    {
      "type": "unauthorized",
      "title": "Unauthorized",
      "status": 401,
      "summary": "Use 401 Unauthorized when the request lacks valid authentication credentials."
    },
    {
      "type": "unavailable-for-legal-reasons",
      "title": "Unavailable For Legal Reasons",
      "status": 451,
      "summary": "Use `451 Unavailable For Legal Reasons` when you are denying access to a resource because of a legal demand: a court order, a takedown notice, a sanctions rule, or a regulator's instruction that this data may not be served to this caller or in this jurisdiction."
    },
    {
      "type": "unprocessable-query",
      "title": "Unprocessable Query",
      "status": 422,
      "summary": "Use 422 when the request is syntactically valid but semantically wrong."
    },
    {
      "type": "unsupported-api-version",
      "title": "Unsupported API Version",
      "status": 400,
      "summary": "Use 400 with an Unsupported API Version error when the client selects an API version through a request header or query parameter, and the server does not serve that version.",
      "extensions": {
        "requestedVersion": {
          "type": "string"
        },
        "supportedVersions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    {
      "type": "unsupported-media-type",
      "title": "Unsupported Media Type",
      "status": 415,
      "summary": "Use 415 Unsupported Media Type when the server rejects a request because the request's payload format is not supported."
    },
    {
      "type": "uri-too-long",
      "title": "URI Too Long",
      "status": 414,
      "summary": "Use 414 URI Too Long when the target URI is longer than the server is willing to interpret.",
      "extensions": {
        "maxLength": {
          "type": "integer"
        }
      }
    },
    {
      "type": "validation-failed",
      "title": "Validation Failed",
      "status": 422,
      "summary": "Use 422 Validation Failed when the request payload is syntactically correct and readable (like valid JSON), but fails to meet the server's business constraints or data validation rules.",
      "extensions": {
        "errors": {
          "type": "object"
        }
      }
    }
  ]
}
