API keys

Create an API key

Issues a new API key in this workspace. The key is shown only in this response, and only its hash is stored. expiresAt makes it stop working at a set time, useful for a contractor or a one-off script. An expired key stays in the list until you revoke it.

post/v1/api-keys

Request

Base URL: https://api.rumoro.dev
URL: https://api.rumoro.dev/v1/api-keys
Auth: HTTP bearer

Request body

namestring

A name for the key. Defaults to "default".

scope'read' | 'write'

write can do everything. read is limited to GET.

expiresAtstring date-time

Expiry time in ISO 8601 or epoch ms, later than now. Set it for keys you hand to a script or contractor. Omit it or send null and the key never expires.

Response

The created key, visible only now

idstring required

The key's id (key_...).

namestring required

prefixstring required

The start of the key, so you can tell keys apart.

scope'read' | 'write' required

write can do everything. read is limited to GET.

createdAtstring required

UTC time in ISO 8601.

lastUsedAtstring nullable required

UTC time in ISO 8601.

expiresAtstring nullable required

When the key expires. Null for a key without expiry. Expired keys stay in the list until revoked.

keystring required

The complete key. It is only shown here, so save it now.

Changes

No recorded changes to this operation across all 1 revision of this API.