Skip to main content
POST
Replace an ingest key

Authorizations

X-API-Key
string
header
required

A Streamloop API key (sl_…). It carries no workspace: send X-Workspace-Id too (400 WORKSPACE_REQUIRED otherwise).

Headers

Idempotency-Key
string

Retry safely: the key (per caller, workspace, method and path) is taken before the request runs, and its first answer is replayed for 24 hours, with Idempotency-Replayed: true — a repeat sent while the first still runs waits for it. The same key with a different body is 422 IDEMPOTENCY_KEY_REUSED. A 5xx is not kept: the retry runs.

Maximum string length: 200
X-Workspace-Id
string

The workspace to act in. Required with an API key; otherwise the session's own.

Path Parameters

id
string
required

The scene's id (scn_…)

Pattern: ^scn_
key
string
required

The key's id (ingkey_…)

Response

The new key, with its secret once

id
string

ingkey_…, for these routes

sceneId
string
sourceId
string
key
string

Only when created or rotated

keyPrefix
string
status
enum<string>
Available options:
active,
revoked
live
boolean
rtmpUrl
string
rtmpsUrl
string
srtUrl
string

Only when created or rotated

ingestdId
string

The ingest service's id for the key (ingk_…, not the key's own ingkey_… id): what the draft's rtmp or srt source names as its ingest.key

createdAt
string<date-time>