INinth
API keys

Roll API key

Changed on

Replaces the secret of a key while keeping its name and ID in the key list. The previous secret stops working immediately. The new secret is minted with the current plan rate limit and is returned only once. Requires api-keys.write, a user token, and an admin or owner role; API keys cannot roll themselves.

post/v1/api-keys/{keyId}/roll

Request

  • Base URL
    https://api.inth.com
  • URL
    https://api.inth.com/v1/api-keys/{keyId}/roll
  • Auth
    HTTP bearer

Path parameters

keyIdstring required

API key ID.

Query parameters

organizationIdstring

Organization the key belongs to. Defaults to the active organization of the credential.

Response

The rolled key. The plaintext secret is returned only once.

successtrue required

Changes