View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.

API reference Models

RotateApiKeyDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

What a caller may choose about a rotation. Everything here is optional: a rotation with an empty body is the common case and takes the configured defaults.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
overlapHours required integer (int32) How many hours the replaced key should keep authenticating, or `null` for the configured default (24 hours). nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
expireAt required string (date-time) When the replacement should expire, or `null` to give it the same term the replaced key was originally granted, measured from now. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
reason required string A reason recorded against the replaced key, used only when the rotation cuts over immediately and therefore revokes it in the same operation. nullablemax length 256
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.