API

invalid_parameter

HTTP 400. Invalid parameter

What it means

A query or path parameter is unknown or has the wrong form.

What to do

Unknown query parameters are rejected on purpose so that typos fail loudly. Check the spelling against the operation reference and the parameter's type and range.

Retrying

Do not retry the same request. Change it first.

Extra members

errors: The offending parameters, each with a pointer, a code and a message.

Example

json

{
  "type": "https://reuseforge.com/docs/api/errors/invalid_parameter",
  "title": "Invalid parameter",
  "status": 400,
  "detail": "Query parameter `limit` must be between 1 and 100.",
  "instance": "/api/v1/items/acme/invoice-extractor",
  "code": "invalid_parameter",
  "request_id": "req_c4v8n2m6x1z3",
  "errors": [
    {
      "pointer": "#/limit",
      "code": "maximum",
      "message": "limit must be at most 100."
    }
  ]
}

Every error is application/problem+json (RFC 9457). Branch on code, show detail to people and quote request_id when you ask for help. See the error catalogue.