Skip to main content
POST
Issue an ingest key

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

Body

application/json
name
string
required
Required string length: 1 - 80
dataset_default
string
default:default

Dataset used when an ingest request does not name one. A non-string value falls back to default.

Pattern: ^[A-Za-z][A-Za-z0-9_]{0,62}$
require_signature
boolean
default:false

Only the literal true enables it. When enabled a signing secret is generated and returned once.

Response

Created. key is the full ik_live_ token and signing_secret the whsec_ value - both are shown exactly once and only the key hash / encrypted secret are stored.

id
string
required
key
string
required

ik_live_ followed by 48 hex characters.

signing_secret
string | null
required

Present only when require_signature was true; otherwise null.