Skip to main content
GET
Read a source

Authorizations

Authorization
string
header
required

A platform API key, presented as Authorization: Bearer <API_KEY>. Each operation says which permission the key needs.

Path Parameters

source_id
string<uuid>
required

The source's id.

Response

The source.

A source's configuration, lifecycle state and what is currently arriving on it. Every source of this version is fed over SRT.

active_receiver
enum<string>
required

Which connection the stream is currently taken from.

Available options:
primary,
secondary,
unknown
description
string
required
engine_version
string
required

The engine version the source pins, as major.minor.patch; empty when it follows the current engine.

expected_properties
object
required

What the stream is expected to look like. Its shape is the expected properties schema of the source's engine version.

id
string<uuid>
required
kind
enum<string>
required

The protocol a source is fed over.

Available options:
srt
name
string
required
primary_connection_state
enum<string>
required

waiting has not been connected to yet; connected is receiving; disconnected was connected and is no longer.

Available options:
waiting,
connected,
disconnected
redundancy
boolean
required
read-only

Whether the source is received over two connections. Read-only; it follows the SRT settings, which are where the second connection is configured.

secondary_connection_state
enum<string>
required

waiting has not been connected to yet; connected is receiving; disconnected was connected and is no longer.

Available options:
waiting,
connected,
disconnected
srt_settings
object
required

How the source receives its stream. Its shape is the SRT settings schema of the source's engine version.

status
enum<string>
required

inactive accepts no stream; pending is being provisioned; active is ready to receive; stopping is still releasing its resources; error cannot be used until it is deactivated.

Available options:
inactive,
pending,
active,
stopping,
error
activated_at
string<date-time>
passthrough_url
string

Where the stream can be pulled from; present only while an active source offers passthrough.

primary_ingress_url
string

Where the stream is pushed to. Absent until the source is active, and for a source that connects out rather than listening.

recovery_location
string

The store holding buffered stream data for recovery, as a tmi:// URL.

recovery_max_size
integer

The recovery buffer's size limit in GB, per session.

region
string

Where the stream receiver is placed.

secondary_ingress_url
string

The second connection's ingress URL; present only for a redundantly received active source.

stream_metadata
object

What was detected in the incoming stream; absent until a stream arrives. Its shape is the metadata schema of the source's engine version.

tags
string[]
transport_statistics_passthrough
object[]

The passthrough output's sender statistics, one entry per connected consumer.

transport_statistics_primary
object

How the primary connection is performing. Its shape is the transport statistics schema of the source's engine version.

transport_statistics_secondary
object

How the secondary connection is performing; the same shape as the primary connection's.