Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For an API key, a valid value would be : api_0197c8f2-5a6b-7cde-8f12-3456789abcde

Optional unique key for best-effort duplicate suppression of this one-time response. The original successful response is returned to the caller but never retained in API log bodies or Redis replay results. Only an unresolved reservation is retained for 24 hours by default; a matching retry returns 409 idempotency_outcome_unknown without repeating the operation or revealing its secret. A concurrent request returns 409 idempotency_key_in_use; a changed request returns 422 idempotency_key_mismatch. An unavailable reservation store returns 503 before execution. A 4xx rejection releases its reservation; interruption after execution or loss of the success response requires inspection and a deliberate new operation. Redis expiry/eviction or explicit server-side disabling removes protection; this is not durable exactly-once execution. Use the target GET to inspect current metadata and obtain its validator, then a new key only when intentionally rotating again.

Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.

Generated from available response content types