Sign in
api-keys

Create an expiring API key

Issues an API key that expires at a caller-selected time. Exactly one of expires_at or ttl is required. The plaintext key is returned only for the first successful request. If that response is lost, repeating the same request and Idempotency-Key returns credential_already_created with the non-secret key ID; revoke that key and retry with a new Idempotency-Key.

post/api-keys/expiring

Headers

Idempotency-Keystring required

Unique key for this issuance attempt. Retained for 24 hours.

Request body

OR

Response

Expiring API key created

idstring uuid required

API key ID

namestring required

Name of the API key

descriptionstring

Description of the API key

keystring required

Plaintext API key. Returned only for the first successful request.

scopesIssuableApiKeyScope[] required

Scopes granted to this key

key_kind'personal' | 'service_account' required

Principal binding of the issued API key.

creation_timestring date-time required

API key creation time

expires_atstring date-time required

API key expiration time

Changes

Changed in 1 of the 76 revisions of this API.1

Of the 76 revisions, 20 have no diff computed.