Skip to main content
GET
List sources

Authorizations

Authorization
string
header
required

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

Query Parameters

page_token
string

An opaque token from a previous response. Omit it to read the first page.

max_results
integer
default:30

The maximum number of items to return.

Required range: 1 <= x <= 100
name
string

Returns only sources whose name contains this value.

status
enum<string>[]

Returns only sources in one of these states.

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
connection_state
enum<string>[]

Returns only sources one of whose connections is in one of these states.

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

Available options:
waiting,
connected,
disconnected
tag
string[]

Returns only sources carrying all of these tags.

order
enum<string>

Orders the page. Defaults to newest first.

Available options:
creation,
activation,
name_asc,
name_desc

Response

A page of sources.

next_page_token
string | null
required

Pass as page_token to read the next page. Null when no more results remain.

sources
object[]
required