API Keys

Create an API key

Creates a scoped sat_live_ key. The plaintext key is returned ONCE in the response — store it immediately, it cannot be retrieved again. Requires a session token.

post/api-keys

Request

  • Base URL: https://saturnsql.com/api
  • URL: https://saturnsql.com/api/api-keys
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

namestring required

Display name for the key

expirystring required

One of 24h, 30d, 1y, never

scopesstring required

Subset of ["read", "execute", "write"], defaults to ["read"]

Request body

namestring required

Display name, e.g. the agent it is for

expiry'24h' | '30d' | '1y' | 'never' required
scopesstring[]

Defaults to ["read"]

Response

Created (secret shown once)

keystring

The plaintext secret — shown only here.

Changes

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