Skip to main content
API docs by Redocly

Management API (1.0.0)

Download OpenAPI specification:Download

Test the API with Swagger at https://api.cdn.vindral.com/api-docs

Packager Endpoints

The /v1/packagers endpoints additionally require the packager control plane to be enabled for your organization.,

API Keys and Permissions

The API key used for authentication is tied to a user and shares the permissions of that user which is configured in the Vindral Portal. In addition to the user level permissions each API key has a scope of either read-only or read-write.

Read more about permissions here

Channels

List channels

Get a list of channels that the provided api key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "channelId" "name" "streamKey"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create channel

Create a new channel. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string [ 2 .. 50 ] characters

Name of the channel.

authRequired
boolean
Default: false

true if the channel should be protected and require a valid token to watch it.

notes
string <= 500 characters
Default: ""

Notes for the channel.

transcodingProfileId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Transcoding profile to use for this channel.

object
object

Recording configuration.

Array of objects

Restreaming configuration.

object

Browser overlay configuration. A web page rendered on top of the video. Only the source's primary video and audio track are used. Changes take effect when transcoding restarts, such as on the next ingest. A page larger than the source, or faster than its frame rate, is rendered at the source's size and rate. Always send enabled; other fields left out keep their stored value, or take the default when the overlay is created. When enabled, url, width, height and frameRate are required. Requires the browser overlay feature on the organization and a transcoding profile on the channel.

organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization that the channel should be added to.

channelId
string

ChannelId (public id) for the channel, required as: ${normalizedOrganizationName}_${normalizedName}_ci_${uuid}. If not provided, this will be generated.

streamKey
string

Stream key (private id) for the channel, required as: ${normalizedOrganizationName}_${normalizedName}_sk_${uuid}. If not provided, this will be generated.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "authRequired": false,
  • "notes": "",
  • "transcodingProfileId": "837bdf0e-3944-423b-9940-32e2c71da88b",
  • "viewerCountryLimitation": {
    },
  • "recording": {
    },
  • "restreaming": [
    ],
  • "browserOverlay": {
    },
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "channelId": "string",
  • "streamKey": "string"
}

Response samples

Content type
application/json
{
  • "authRequired": true,
  • "channelId": "string",
  • "name": "string",
  • "notes": "string",
  • "streamKey": "string",
  • "suspended": true,
  • "isLive": true,
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "transcodingProfileId": "string",
  • "viewerCountryLimitation": {
    },
  • "restreaming": [
    ],
  • "recording": {
    },
  • "browserOverlay": {
    }
}

List channels by channel group

Get a list of channels belonging to a specific channel group.

Authorizations:
Authorization
path Parameters
channelGroupId
required
string

The channel group id to get channels for.

query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "channelId" "name" "streamKey"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

List channels by transcoding profile

Get a list of channels with a specific transcoding profile.

Authorizations:
Authorization
path Parameters
transcodingProfileId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

The transcoding profile id to get channels for.

query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "channelId" "name" "streamKey"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get channel

Get a channel by channel id.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel to get.

Responses

Response samples

Content type
application/json
{
  • "authRequired": true,
  • "channelId": "string",
  • "name": "string",
  • "notes": "string",
  • "streamKey": "string",
  • "suspended": true,
  • "isLive": true,
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "transcodingProfileId": "string",
  • "viewerCountryLimitation": {
    },
  • "restreaming": [
    ],
  • "recording": {
    },
  • "browserOverlay": {
    }
}

Update channel

Update a channel by channel id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel to update.

Request Body schema: application/json
required
name
string [ 2 .. 50 ] characters

Name of the channel.

authRequired
boolean

true if the channel should be protected and require a valid token to watch it.

notes
string <= 500 characters

Notes for the channel.

transcodingProfileId
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Transcoding profile to use for this channel.

object
object

Recording configuration.

Array of objects

Restreaming configuration.

object

Browser overlay configuration. A web page rendered on top of the video. Only the source's primary video and audio track are used. Changes take effect when transcoding restarts, such as on the next ingest. A page larger than the source, or faster than its frame rate, is rendered at the source's size and rate. Always send enabled; other fields left out keep their stored value, or take the default when the overlay is created. When enabled, url, width, height and frameRate are required. Requires the browser overlay feature on the organization and a transcoding profile on the channel.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "authRequired": true,
  • "notes": "string",
  • "transcodingProfileId": "837bdf0e-3944-423b-9940-32e2c71da88b",
  • "viewerCountryLimitation": {
    },
  • "recording": {
    },
  • "restreaming": [
    ],
  • "browserOverlay": {
    }
}

Response samples

Content type
application/json
{
  • "authRequired": true,
  • "channelId": "string",
  • "name": "string",
  • "notes": "string",
  • "streamKey": "string",
  • "suspended": true,
  • "isLive": true,
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "transcodingProfileId": "string",
  • "viewerCountryLimitation": {
    },
  • "restreaming": [
    ],
  • "recording": {
    },
  • "browserOverlay": {
    }
}

Create or update channel

Creates or updates a channel by channelId.

If the channelId exists, it will be updated - otherwise created.

channelId, streamKey or organizationId will not be changed on an existing channel, but are required to match.

Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
channelId
required
string

ChannelId (public id) for the channel, required as: ${normalizedOrganizationName}_${normalizedName}_ci_${uuid}.

Request Body schema: application/json
required
name
required
string [ 2 .. 50 ] characters

Name of the channel.

transcodingProfileId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Transcoding profile to use for this channel.

authRequired
boolean
Default: false

true if the channel should be protected and require a valid token to watch it.

notes
string <= 500 characters
Default: ""

Notes for the channel.

organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization that the channel should be added to. Will not update on existing channel.

required
object
required
object or null

Recording configuration, passing null will remove saved configuration.

required
Array of objects

Restreaming configuration.

object

Browser overlay configuration. Omitting it leaves the stored overlay unchanged; pass enabled: false to turn it off.

streamKey
required
string

Stream key (private id) for the channel, required as: ${normalizedOrganizationName}_${normalizedName}_sk_${uuid}.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "transcodingProfileId": "837bdf0e-3944-423b-9940-32e2c71da88b",
  • "authRequired": false,
  • "notes": "",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "viewerCountryLimitation": {
    },
  • "recording": {
    },
  • "restreaming": [
    ],
  • "browserOverlay": {
    },
  • "streamKey": "string"
}

Response samples

Content type
application/json
{
  • "authRequired": true,
  • "channelId": "string",
  • "name": "string",
  • "notes": "string",
  • "streamKey": "string",
  • "suspended": true,
  • "isLive": true,
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "transcodingProfileId": "string",
  • "viewerCountryLimitation": {
    },
  • "restreaming": [
    ],
  • "recording": {
    },
  • "browserOverlay": {
    }
}

Delete channel

Delete a channel by channel id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel to delete.

Responses

Response samples

Content type
application/json
null

Channel Groups

Get channel group

Get one channel group by id.

Authorizations:
Authorization
path Parameters
channelGroupId
required
string

ID of the channel group to get.

Responses

Response samples

Content type
application/json
{
  • "channelGroupId": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}

Update channel group

Update a channel group with by channel group id. If the channel array is passed in the whole array will be updated with the new array. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
channelGroupId
required
string

ID of the channel group to update.

Request Body schema: application/json
required
name
string <= 50 characters

Name of the channel group.

channelIds
Array of strings

List of channel IDs that should be part of the group.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "channelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "channelGroupId": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}

Delete channel group

Delete channel group by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
channelGroupId
required
string

ID of the channel group to remove.

Responses

Response samples

Content type
application/json
null

List channel groups

Get a list of channel groups that the provided api key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "name" "channelGroupId"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create channel group

Create a new channel group for a specified name and organization. Optionally add a list of channel ids that should belong to the new channel group. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string <= 50 characters

Name of the channel group.

organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization that the channel group should be added to.

channelIds
Array of strings

List of channel IDs that should be part of the group.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "channelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "channelGroupId": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}

Add channel to channel group

Add one channel to a channel group. Specify a channelGroupId and a channelId you wish to add to the channel group. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
channelGroupId
required
string

ID of the channel group to add channel to.

channelId
required
string

ID of the channel that should be added to the channel group.

Responses

Response samples

Content type
application/json
null

Remove channel from channel group

Remove one channel from a channel group. Specify a channelGroupId and a channelId you wish to remove from the channel group. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
channelGroupId
required
string

ID of the channel group to remove channel from.

channelId
required
string

ID of the channel to remove from the channel group.

Responses

Response samples

Content type
application/json
null

Transcoding Profiles

List transcoding profiles

Get a list of transcoding profiles that the provided api key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Value: "name"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create transcoding profile

Create a new transcoding profile. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string
notes
required
string
organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...
required
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notes": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "notes": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    }
}

Get transcoding profile

Get a transcoding profile by id.

Authorizations:
Authorization
path Parameters
transcodingProfileId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

ID of the transcoding profile to get.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "notes": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    }
}

Update transcoding profile

Update a transcoding profile by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
transcodingProfileId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...
Request Body schema: application/json
required
id
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...
name
string
notes
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "notes": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "notes": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    }
}

Delete transcoding profile

Delete a transcoding profile by id. Channels that referenced the deleted transcoding profile will be unusable until assigned a new transcoding profile. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
transcodingProfileId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Responses

Response samples

Content type
application/json
null

Get transcoding profile by channel

Get the transcoding profile configured for the specific channel.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel to get the transcoding profile for.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "notes": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    }
}

Profile

Get profile

Get profile info based on the api token used to make the request.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json
{
  • "apiKey": {
    },
  • "user": {
    },
  • "organizations": [
    ]
}

Ingest

Get ingest information

Get ingest information for a channel.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel to get.

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "playUrl": {
    }
}

Drop ingest

Drop ingest for a channel.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel to drop.

Responses

Response samples

Content type
application/json
{
  • "status": "Drop requested"
}

Status

Get channel status

Get live status and viewers for all channels in an organization.

Authorizations:
Authorization
query Parameters
organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

ID of the organization to get analytics data for.

Responses

Response samples

Content type
application/json
{
  • "viewersTotal": 0,
  • "ingressBps": 0,
  • "egressBps": 0,
  • "channels": [
    ]
}

Get ingest status

Get the current ingest of every channel in an organization that has one: protocol, ingress bitrate, keyframe delta, packet arrival delta and the tracks reported by the encoder. A channel that is not listed has nothing being ingested. Use the optional query parameters channelId and channelGroupId to filter the channels. Values are at most 15 seconds old.

Authorizations:
Authorization
query Parameters
organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

ID of the organization to get ingest status for.

channelId
string

Comma separated list of channel IDs to limit the response to.

channelGroupId
string

Only return channels in this channel group.

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ]
}

Analytics

Get current viewers

Get current number of viewers for an organization. Use the optional query parameters channelId, countryCode and continent to filter the results. Use the optional query parameter groupBy to group the results by country or channel.

Authorizations:
Authorization
query Parameters
organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

ID of the organization to get analytics data for.

channelId
string

Filters for the specific channel.

countryCode
string

Country code (ISO 3166-1 alpha-2) to filter the data on a specific country. Special code unknown is used when a lookup was not possible.

Example: SE to filter for Sweden.

continent
string

Continent code to filter the data for a specific continent. Valid continent codes:

  • AF: Africa
  • AN: Antarctica
  • AS: Asia
  • EU: Europe
  • NA: North America
  • OC: Oceania
  • SA: South America
  • unknown: Unknown continent. Special code unknown is used when a lookup was not possible.

Example: EU to filter for Europe.

groupBy
string
Enum: "channel" "country"

Optionally group by channel or country. Default is no grouping. Valid values: channel, country.

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ]
}

Get metrics

Get metrics. Use the optional query parameters channelId, countryCode and continent to filter the results. Metrics are calculated for the time range between from and to. By default all available metrics are returned, to limit the response use the optional query parameter fields to specify which metrics to return.

Note that viewerBitrateAverage, totalIngressBytes, restartCount, hlsEgressBytes, clippingBytes, rtmpEgressBytes and restreamBytes disregards country and continent filters!

Authorizations:
Authorization
query Parameters
organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

ID of the organization to get analytics data for.

channelId
string

Filters for the specific channel.

countryCode
string

Country code (ISO 3166-1 alpha-2) to filter the data on a specific country. Special code unknown is used when a lookup was not possible.

Example: SE to filter for Sweden.

continent
string

Continent code to filter the data for a specific continent. Valid continent codes:

  • AF: Africa
  • AN: Antarctica
  • AS: Asia
  • EU: Europe
  • NA: North America
  • OC: Oceania
  • SA: South America
  • unknown: Unknown continent. Special code unknown is used when a lookup was not possible.

Example: EU to filter for Europe.

fields
string

Limit the response by selecting specific fields as a comma separated list. Available fields are:

  • viewerSessions
  • viewerSeconds
  • viewerSessionsAvgDurationSeconds
  • viewerBitrateAverage
  • totalEgressBytes
  • totalIngressBytes
  • timeToFirstFrameMedianMs
  • roundTripTimeMedianMs
  • browsers
  • os
  • devices
  • restartCount
  • hlsEgressBytes
  • clippingBytes
  • rtmpEgressBytes
  • restreamBytes

Example: viewerSessions,viewerBitrateAverage to only get viewer sessions and average bitrate.

groupBy
string
Enum: "channel" "country"

Optionally group by channel or country. Default is no grouping. Valid values: channel, country.

from
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

to
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

Responses

Response samples

Content type
application/json
{
  • "viewerSessions": 0,
  • "viewerSeconds": 0,
  • "viewerSessionsAvgDurationSeconds": 0,
  • "viewerBitrateAverage": 0,
  • "totalEgressBytes": 0,
  • "totalIngressBytes": 0,
  • "restartCount": 0,
  • "hlsEgressBytes": 0,
  • "clippingBytes": 0,
  • "rtmpEgressBytes": 0,
  • "restreamBytes": 0,
  • "timeToFirstFrameMedianMs": 0,
  • "roundTripTimeMedianMs": 0,
  • "browserDistribution": [
    ],
  • "osDistribution": [
    ],
  • "deviceDistribution": [
    ]
}

Get time series

Get time series. Use the optional query parameters channelId, countryCode and continent to filter the results. Time series are calculated for the time range between from and to (rounded to the nearest minute). By default all available time series are returned, to limit the response use the optional query parameter fields to specify which metrics to return.

Note that ingressBps, keyframeDelta, averagePacketArrivalTime and highestPacketArrivalTime disregards country and continent filters and is not returned when grouped by country!

Authorizations:
Authorization
query Parameters
organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

ID of the organization to get analytics data for.

channelId
string

Filters for the specific channel.

countryCode
string

Country code (ISO 3166-1 alpha-2) to filter the data on a specific country. Special code unknown is used when a lookup was not possible.

Example: SE to filter for Sweden.

continent
string

Continent code to filter the data for a specific continent. Valid continent codes:

  • AF: Africa
  • AN: Antarctica
  • AS: Asia
  • EU: Europe
  • NA: North America
  • OC: Oceania
  • SA: South America
  • unknown: Unknown continent. Special code unknown is used when a lookup was not possible.

Example: EU to filter for Europe.

fields
string

Limit the response by selecting specific fields as a comma separated list. Available fields are:

  • viewers
  • egressBps
  • ingressBps
  • keyframeDeltaVideo
  • averagePacketArrivalTimeVideo
  • highestPacketArrivalTimeVideo
  • keyframeDeltaAudio
  • averagePacketArrivalTimeAudio
  • highestPacketArrivalTimeAudio

Example: viewers,egressBps to only get time series for viewers and egress.

from
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

to
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

Responses

Response samples

Content type
application/json
{
  • "viewers": [
    ],
  • "egressBps": [
    ],
  • "ingressBps": [
    ],
  • "keyframeDeltaVideo": [
    ],
  • "averagePacketArrivalTimeVideo": [
    ],
  • "highestPacketArrivalTimeVideo": [
    ],
  • "keyframeDeltaAudio": [
    ],
  • "averagePacketArrivalTimeAudio": [
    ],
  • "highestPacketArrivalTimeAudio": [
    ]
}

Clipping

Generate a clip from a recording

Creates a custom clip of a recorded live stream.

This endpoint will return a m3u8 playlist which can be used in any HLS-compatible video player.

Please note that the response will be a 302 redirect, with the Location header set to the URL of your clip.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel

query Parameters
from
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

to
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

Responses

Response samples

Content type
application/json
null

Generate a clip from a recording

Creates a custom clip of a recorded live stream.

This endpoint will return a mp4 which can be used in any compatible video player.

Please note that the response will be a 302 redirect, with the Location header set to the URL of your clip.

Authorizations:
Authorization
path Parameters
channelId
required
string

ID of the channel

query Parameters
from
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

to
required
string

Date in ISO 8601 format.

Example: 2024-01-01T00:00:00Z.

Responses

Response samples

Content type
application/json
null

Packagers / Workspaces

List workspaces

Get a list of workspaces that the provided API key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "id" "name"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

organizationId
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create workspace

Create a new workspace. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string [ 1 .. 256 ] characters

Name of the workspace.

organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization to create the workspace in.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerImage": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Get workspace

Get a workspace by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the workspace to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerImage": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Update workspace

Update a workspace by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the workspace to update.

Request Body schema: application/json
required
name
string [ 1 .. 256 ] characters

Name of the workspace.

string or null

Docker image used for the packager in this workspace. Set to null to clear.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "packagerImage": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerImage": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Delete workspace

Delete a workspace by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the workspace to delete.

Responses

Response samples

Content type
application/json
null

Packagers / Workspace Connect Keys

List connect keys

Get a list of connect keys that the provided API key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "id" "name"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

workspaceId
string <nanoid> ^[a-zA-Z0-9_-]{21}$

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create connect key

Create a new connect key. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string [ 1 .. 256 ] characters

Name of the connect key.

workspaceId
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

Workspace the connect key belongs to.

organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization to create the connect key in.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "workspaceId": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "workspaceId": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "lastUsedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "key": "string"
}

Get connect key

Get a connect key by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the connect key to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "workspaceId": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "lastUsedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Update connect key

Update a connect key by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the connect key to update.

Request Body schema: application/json
required
name
string [ 1 .. 256 ] characters

Name of the connect key.

active
boolean

Whether the connect key is active.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "workspaceId": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "lastUsedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Delete connect key

Delete a connect key by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the connect key to delete.

Responses

Response samples

Content type
application/json
null

Packagers / Transcoders

List transcoder instances

Get a list of transcoder instances that the provided API key has access to. A transcoder instance is a transcoder task running on a packager; they are read-only here.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "createdAt"
Enum: "createdAt" "taskId"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

packagerId
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get transcoder instance

Get a transcoder instance by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the transcoder instance to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerId": "string",
  • "resourceId": "string",
  • "transcoderConfigId": "string",
  • "taskId": "string",
  • "info": {
    }
}

Packagers / Compositors

List compositor instances

Get a list of compositor instances that the provided api key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "createdAt"
Enum: "createdAt" "taskId"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

packagerId
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get compositor instance

Get a compositor instance by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the compositor instance to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerId": "string",
  • "resourceId": "string",
  • "compositorConfigId": "string",
  • "taskId": "string",
  • "info": {
    }
}

Packagers / Sources

List source instances

Get a list of source instances that the provided API key has access to. A source instance is a source task running on a packager; they are read-only here.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "createdAt"
Enum: "createdAt" "taskId"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

packagerId
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get source instance

Get a source instance by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the source instance to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerId": "string",
  • "resourceId": "string",
  • "sourceConfigId": "string",
  • "taskId": "string",
  • "info": {
    }
}

Packagers / Configs

List packager configs

Get a list of packager configs that the provided API key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "id" "name"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

workspaceId
string <nanoid> ^[a-zA-Z0-9_-]{21}$

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create packager config

Create a new packager config. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string [ 1 .. 256 ] characters

Name of the packager config.

organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization to create the packager config in.

workspaceId
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

Workspace the packager config belongs to.

description
string <= 512 characters
Default: ""

Description of the packager config.

Array of objects

Source task configurations.

Array of objects
Default: []

Transcoder task configurations.

Array of objects
Default: []

Compositor task configurations.

Array of objects

Sink task configurations.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "workspaceId": "string",
  • "description": "",
  • "sources": [
    ],
  • "transcoders": [ ],
  • "compositors": [ ],
  • "sinks": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "workspaceId": "string",
  • "revision": 0,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "sources": [
    ],
  • "transcoders": [
    ],
  • "compositors": [
    ],
  • "sinks": [
    ]
}

Get packager config

Get a packager config by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the packager config to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "workspaceId": "string",
  • "revision": 0,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "sources": [
    ],
  • "transcoders": [
    ],
  • "compositors": [
    ],
  • "sinks": [
    ]
}

Replace packager config

Fully replaces a packager config. The request body must include all sources, transcoders, compositors, and sinks you want to keep — any tasks omitted from the payload will be permanently deleted. Fetch the current config first, apply your changes, then submit the complete config. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the packager config to update.

Request Body schema: application/json
required
name
required
string [ 1 .. 256 ] characters

Name of the packager config.

description
required
string <= 512 characters

Description of the packager config.

required
Array of objects

Source task configurations.

required
Array of objects

Transcoder task configurations.

required
Array of objects

Compositor task configurations.

required
Array of objects

Sink task configurations.

changeReason
string <= 512 characters

Reason for this update.

restoredFromRevision
integer ( 0 .. 9007199254740991 ]

Revision this update restores, when it replays an earlier revision's contents.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "sources": [
    ],
  • "transcoders": [
    ],
  • "compositors": [
    ],
  • "sinks": [
    ],
  • "changeReason": "string",
  • "restoredFromRevision": 9007199254740991
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "workspaceId": "string",
  • "revision": 0,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "sources": [
    ],
  • "transcoders": [
    ],
  • "compositors": [
    ],
  • "sinks": [
    ]
}

Delete packager config

Delete a packager config by id, together with its sources, transcoders, compositors and sinks. Refused while the config has deployments. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the packager config to delete.

Responses

Response samples

Content type
application/json
null

Packagers / Sinks

List sink instances

Get a list of sink instances that the provided API key has access to. A sink instance is a sink task running on a packager; they are read-only here.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "createdAt"
Enum: "createdAt" "taskId"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

packagerId
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get sink instance

Get a sink instance by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the sink instance to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerId": "string",
  • "resourceId": "string",
  • "sinkConfigId": "string",
  • "taskId": "string",
  • "info": {
    }
}

Packagers / Deployment Adapters

List deployment adapters

Get a list of deployment adapters that the provided API key has access to.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "id" "name"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

organizationId
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create deployment adapter

Create a new deployment adapter. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization to create the deployment adapter in.

name
required
string [ 1 .. 256 ] characters

Name of the deployment adapter.

required
object or object

Configuration for the deployment adapter.

Responses

Request samples

Content type
application/json
{
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

Get deployment adapter

Get a deployment adapter by id.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the deployment adapter to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

Update deployment adapter

Update a deployment adapter by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the deployment adapter

Request Body schema: application/json
required
name
string [ 1 .. 256 ] characters

Name of the deployment adapter.

object or object

Configuration for the deployment adapter.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "config": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

Delete deployment adapter

Delete a deployment adapter by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

ID of the deployment adapter to delete.

Responses

Response samples

Content type
application/json
null

Packagers

List packagers

Get a list of packagers that the provided API key has access to. A packager created in the portal or through this API is listed as pending until it registers; a connect-key packager is listed once it first registers.

Authorizations:
Authorization
query Parameters
skip
number
Default: 0

Omits the specified number of returned records. This is useful, for example, to paginate responses.

take
number
Default: 100

Specifies how many records to include in the response.

orderBy
string
Default: "name"
Enum: "id" "name" "hostname" "status"

Specifies which column to sort the response by.

"asc" (string) or "desc" (string)
Default: "asc"

How to sort the response records, either in ascending or descending order.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0
}

Create packager

Create a packager that runs a packager config. The adapter must be manual. The response carries the registration token once; it cannot be retrieved again. It also carries command, which starts the packager with that token; to start it another way, pass the token to the packager yourself. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
Request Body schema: application/json
required
name
required
string [ 2 .. 256 ] characters

Name of the packager. Chosen when it is created in the portal; a connect-key packager is named after its id.

organizationId
required
string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Organization to create the packager in.

packagerConfigId
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

Packager config the packager runs.

deploymentAdapterId
required
string <nanoid> ^[a-zA-Z0-9_-]{21}$

Deployment adapter used to start the packager.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "packagerConfigId": "string",
  • "deploymentAdapterId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "workspaceId": "string",
  • "hostname": "string",
  • "packagerConfigId": "string",
  • "packagerConfigRevision": -9007199254740991,
  • "deploymentAdapterId": "string",
  • "version": "string",
  • "status": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "token": "string",
  • "command": "string"
}

Get packager

Get a packager by id.

Authorizations:
Authorization
path Parameters
id
required
string

ID of the packager to get.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "workspaceId": "string",
  • "hostname": "string",
  • "packagerConfigId": "string",
  • "packagerConfigRevision": -9007199254740991,
  • "deploymentAdapterId": "string",
  • "version": "string",
  • "status": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Delete packager

Delete a packager by id. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string

ID of the packager to delete.

Responses

Response samples

Content type
application/json
null

Apply latest packager config

Pushes the newest revision of the packager's config to it. Packager configs are versioned; each edit produces a new revision. A connected packager also picks up the newest revision whenever it reconnects. Requires a read-write scoped API key with sufficient permissions.

Authorizations:
Authorization
path Parameters
id
required
string^[A-Za-z0-9_-]{1,100}$

ID of the packager to update.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "workspaceId": "string",
  • "hostname": "string",
  • "packagerConfigId": "string",
  • "packagerConfigRevision": -9007199254740991,
  • "deploymentAdapterId": "string",
  • "version": "string",
  • "status": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Kill packager

Asks a packager to stop itself. The packager shuts down cleanly and exits; whether it starts again is decided by however it is being run, for example a container restart policy. Requires a read-write scoped API key with sufficient permissions. Fails if the packager is not currently connected.

Authorizations:
Authorization
path Parameters
id
required
string^[A-Za-z0-9_-]{1,100}$
Request Body schema: application/json
required
force
boolean
Default: false

Best-effort fast stop. The packager still shuts down cleanly, but does not wait for running tasks to confirm they stopped.

Responses

Request samples

Content type
application/json
{
  • "force": false
}

Response samples

Content type
application/json
{
  • "status": "Kill requested"
}