v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

broadcast live

Get a secret

Retrieve the details of a specific secret

A secret represents a passphrase or key used for securing live streams.

get/v2/sites/{site_id}/live/broadcast/secrets/{secret_id}/

Path parameters

secret_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the secret

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Response

Success

schemastring

idstring

Unique identifier for a resource

createdstring

Date and time at which the resource was created

last_modifiedstring

Date and time at which the resource was most recently modified

typestring

Name of the type of resource.

relationshipsobject

Ancilliary resources associated to the primary resource being read

namestring

The friendly name for the secret

lifespan'persistent' | 'single_use'

The lifespan of the secret determining deletion behavior

Example response

{
  "schema": "https://schema.jwplayer.com/types/thumbnail.json",
  "id": "Ny05CEfj",
  "created": "2019-09-25T15:29:11.042095+00:00",
  "last_modified": "2019-09-25T15:29:11.042095+00:00"
}