api-keys

Create Api Key

Create a new API key. The raw key is returned only once.

post/api/v1/keys

Request

  • Base URL
    https://api.maritime.sh (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maritime.sh/api/v1/keys
  • Auth
    HTTP bearer

Request body

namestring required

Human-readable name for this key

scopesstring[]

Scopes: provision (create), deploy (lifecycle/chat), secrets (env vars), manage (delete + everything, wildcard). Defaults to full access; pass a narrower set to restrict a key.

expires_in_daysinteger nullable

Key expiry in days from now. Null = never expires

project_idstring nullable

Restrict this key to one project (plan 22 §3). Scoped keys only work on the /api/v1 partner surface (front door, usage) for that project; every other endpoint rejects them.

Response

Successful Response

idstring required
namestring required
key_prefixstring required
scopesstring[] required
is_activeboolean required
project_idstring nullable
last_used_atstring date-time nullable required
expires_atstring date-time nullable required
created_atstring date-time required
computer_sessions_30dinteger
raw_keystring required

Full API key. Store securely, shown only once

Changes

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