Use this file to discover all available pages before exploring further.
All POST, PATCH, and DELETE requests accept an Idempotency-Key header. Retry with the same key and Deck returns the original response instead of performing the operation again. GET requests are naturally idempotent and do not require a key.
When Deck receives a request with an idempotency key and the request succeeds, it caches the response and associates it with that key. Only successful responses are cached. If the original request returned an error, retrying with the same key will execute the request again. Keys are scoped to your organization, so different organizations can use the same key independently.If the same key is sent again:
Same parameters: Deck returns the cached response. The operation is not repeated.
Different parameters: Deck returns a 409 Conflict with an idempotency_error to prevent accidental misuse.
After 24 hours: the key expires and can be reused.
The key stays the same across retries. If the first request succeeded but the response was lost, the second request returns the cached result. If the first request failed or never reached the server, the second one executes normally since only successful responses are cached.
Key reuse with different parameters returns HTTP 409:
{ "errors": [ { "type": "idempotency", "code": "idempotency_error", "message": "Idempotency key has already been used with different parameters." } ], "request_id": "req_a1b2c3d4..."}
If you see this error, use a new key for the new request.Key exceeds 256 characters returns HTTP 400:
{ "errors": [ { "type": "idempotency", "code": "idempotency_key_error", "message": "Idempotency key must be at most 256 characters" } ], "request_id": "req_a1b2c3d4..."}