Issue a run key for a launch dialog

POST

/v1/runs/keys

curl --request POST \
  --url https://beta-api.plune.ai/v1/runs/keys \
  --header 'Authorization: Bearer <token>'

• beta
• production
• local

A fresh run key (#1233): rk_ and ten lowercase hex, held by no live run of the project. The launch dialog asks for one when it opens, so the command it shows — PLUNE_RUN=<key> npx playwright test --grep "$(plune plan grep <plan-id>)" — is the real one; Save or Launch sends it as runKey (POST /v1/plans/{id}/launch) and the run keeps it as its externalKey, the key a reporter joins by. Nothing is stored: a dialog closed without Save or Launch just drops it. A reader is refused (403), as on every write.

Authorizations

• bearerAuth
• cookieAuth

Responses

200

The key

Media type application/json

object

key

required

string

/^rk_[0-9a-f]{10}$/

Example

{
  "key": "rk_4f7c2a9e1b"
}

401

No / invalid token or session

403

read-only member of the project — a reader launches nothing

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

429

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

Headers

Retry-After

integer

Seconds until the window rolls over