Generate IDs

1 min

POST

{baseUrl}/idgen/namespaces/{name}/ids

Issues count IDs from the namespace's active version, in sequence order. A tenant's first request for a name it does not have copies the _default template of that name, if there is one. IDs are never issued twice; gaps are normal. Needs idgen.ids.generate.

namestringThe namespace name (<code>^[a-z][a-z0-9._-]{0,63}$</code>).

acceptstringGenerated from available response content types

Idempotency-KeystringMakes retries safe: a repeat with the same key within 24 hours returns the first response byte for byte. 5xx responses are not stored, so retrying after one really retries.

bodyobjectHow many IDs to generate.

201The new IDs.

400INVALID_REQUEST: a malformed path or body value, or <code>count</code> outside 1-1000.

401UNAUTHENTICATED: missing, expired or invalid credentials.

403FORBIDDEN: the caller lacks the <code>idgen.ids.generate</code> permission, or its tenant or site scope does not match.

404NAMESPACE_NOT_FOUND: no such namespace and no template of that name.

409NAMESPACE_DISABLED, NO_ACTIVE_VERSION or SEQUENCE_EXHAUSTED (configuration problems), or IDEMPOTENCY_KEY_IN_USE (retryable: the first request with this key is still running).

422IDEMPOTENCY_KEY_REUSED: the key was used with a different request.

500INTERNAL_ERROR: an unexpected failure. Retry once, then report it with the <code>x-request-id</code>.

503AUTH_UNAVAILABLE or BACKEND_UNAVAILABLE (both retryable): retry with backoff.

curl --request POST \
     --url http://localhost:8080/idgen/namespaces/{name}/ids \
     --header 'accept: application/json'