Show a live channel's stream key

GET

/v1/live/channels/{id}/stream-key

curl --request GET \
  --url https://api.iomza.com/v1/live/channels/example/stream-key \
  --header 'Authorization: Bearer <token>'

• Production

Whoever has the key can stream to the channel: if it leaks, rotate it. A key from before it could be shown answers 409: rotate it once.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

Responses

200

The stream key.

Media typeapplication/json

A channel’s stream key.

object

object

required

string

Allowed value: live_stream_key

stream_key

required

OBS’s “Stream Key”. Keep it secret: whoever has it can stream to the channel.

string

Example

{
  "object": "live_stream_key"
}

401

The API key is missing, invalid or revoked.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

403

Valid credentials that may not do this (forbidden), your plan doesn’t include the module the route belongs to (module_not_in_plan), or your organization is suspended (organization_suspended).

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

404

It doesn’t exist in your organization.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

409

Its state doesn’t allow it (a finished job, an Idempotency-Key reused with another body…).

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

429

Too many requests: wait and retry. Answered by the gateway, so the body may differ.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

500

Ours: retry, and tell us if it persists.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

503

Momentarily unavailable: retry in a few seconds.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}