Skip to main content
POST
Create a scoped API key

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Body

application/json
name
string
ttl
string

Duration such as 90d, 24h, or seconds. Max 365d.

Example:

"90d"

preset
enum<string>
Available options:
read-only,
full-sandbox,
ci,
admin
actions
string[]
sandboxIds
string[]
environmentIds
string[]

Response

Created key metadata plus the one-time secret.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

apiKey
object
required
secret
string
required

Raw secret returned once. Store it before closing the response.

apiKeys
object[]
required