Idempotency Keys

The API supports idempotency keys, which enables developers to retry requests without them occuring twice. This is especially important for creating resources via POST requests.

Idempotency keys can be provided in the request with the Idempotency-Key header. Any unique string is fine but we strongly recommend using a secure form of randomness, like UUID. They are only useful for POST requests, but they can be provided to our GET endpoints as well.

When an idempotency key is provided, the action will only happen once and any data or error will be stored and resent on any subsequent request with the same idempotency key. The HTTP verb, path, and parameters must all match for the same idempotency key; otherwise, an error will be returned.

Idempotency keys are scoped to projects, so requests within a single project cannot share the same idempotency key. At this time, idempotency keys are not purged on a consistent schedule.