Activate a version

1 min

POST

{baseUrl}/idgen/templates/{name}/versions/{version}/activate

Activates the version now (empty body) or schedules it for effectiveAt (SCHEDULED). From then on IDs come from it and the previous version is RETIRED. Every node switches within about 5 seconds. Needs idgen.templates.write.

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

versioninteger<int32>The version number (from 1).

acceptstringGenerated from available response content types

bodyobjectWhen to activate: <code>{}</code> for now.

200The activated or scheduled version.

400INVALID_REQUEST: a malformed path or body value, or an invalid name.

401UNAUTHENTICATED: missing, expired or invalid credentials.

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

404NAMESPACE_NOT_FOUND or VERSION_NOT_FOUND: no such template or version.

409VERSION_NOT_MUTABLE: the version's state does not allow this change.

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/templates/{name}/versions/{version}/activate \
     --header 'accept: application/json'