Players

Operations related to players, which are created through the /live_streams resource. Players created through Wowza Video live streams can be embedded into your own web page or played through a web page hosted by Wowza Video.

Fetch all players

This operation shows limited details for all of your players. For detailed information, fetch a single player.

Request

query Parameters

page	integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see Get paginated query results with the Wowza Video REST API.
per_page	integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

200

Success

Response Schema: application/json

required

Array of objects (players)

Array

created_at	string <date-time> The date and time that the player was created.
id	string The unique alphanumeric string that identifies the player.
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
type	string The player you want to use. Wowza Video subscribers Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface. The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site. Other subscribers original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none.
updated_at	string <date-time> The date and time that the player was updated.

401

Unauthorized

get/players

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/players"

Response samples

application/json

{"players": [{"created_at": "2020-01-29T17:16:21.968Z",
"id": "e8dk5bf6",
"transcoder_id": "6Qbymbbq",
"type": "wowza_flowplayer",
"updated_at": "2020-01-31T07:42:03.968Z"
},
{"created_at": "2020-01-29T17:16:21.968Z",
"id": "s3jmdnbl",
"transcoder_id": "3kbb0hvf",
"type": "wowza_flowplayer",
"updated_at": "2020-01-31T02:22:29.968Z"
}
]
}

Fetch a player

This operation shows details of a specific player.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the player.

Responses

200

Success

Response Schema: application/json

required

object (player)

	object Configuration of the player customizations. If you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.
countdown	boolean A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.
countdown_at	string <date-time> The date and time that the event starts, used by the countdown clock. Enter YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.
created_at	string <date-time> The date and time that the player was created.
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
hls_playback_url	string The address that can be used to configure playback of the stream using the HLS protocol.
	object (hosted_page_response_object) Configuration of the hosted page.
id	string The unique alphanumeric string that identifies the player.
logo_image_url	string The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left.
	object Configuration of the plugins.
responsive	boolean A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a width.
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
type	string The player you want to use. Wowza Video subscribers Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface. The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site. Other subscribers original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none.
updated_at	string <date-time> The date and time that the player was updated.
video_poster_image_url	string The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/players/2adffc17"

Response samples

application/json

{"player": {"customizations": {"play_icon": "solid",
"thin_timeline": false,
"drag_handle": false,
"volume": true,
"mute": true,
"fullscreen": true,
"show_player_title": false,
"color": "4d4d4d"
},
"countdown": true,
"countdown_at": "2020-02-01T17:00:00.000Z",
"created_at": "2020-01-29T17:16:21.968Z",
"embed_code": null,
"hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8",
"hosted_page": {"enabled": true,
"description": "My Hosted Page Description",
"logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
"sharing_icons": false,
"title": "My Hosted Page",
"url": "https://player.video.wowza.com/hosted/e8dk5bf6/player.html"
},
"id": "e8dk5bf6",
"logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"logo_position": "top-right",
"plugins": {"airplay": false,
"chromecast": false
},
"responsive": false,
"transcoder_id": "6Qbymbbq",
"type": "wowza_flowplayer",
"updated_at": "2020-01-31T16:08:26.990Z",
"video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"width": 640
}
}

Update a player

This operation updates a player.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the player.

Request Body schema: application/json
required

Provide the details of the player to update in the body of the request.

required

object (player)

	object Configuration of the player customizations.
countdown	boolean A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false. Example: `"countdown": true`
countdown_at	string <date-time> The date and time that the event starts, used by the countdown clock. Enter YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. Example: `"countdown_at": "2020-02-01T17:00:00.000Z"`
	object (hosted_page_request_object) Configuration of the hosted page.
logo_image	string A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller. Example: `"logo_image": "[Base64-encoded string representation of an image]"`
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left. Example: `"logo_position": "top-left"`
	object Configuration of the plugins.
remove_logo_image	boolean If true, removes the logo file from the output. The default is false. Example: `"remove_logo_image": true`
remove_video_poster_image	boolean If true, removes the poster image from the output. The default is false. Example: `"remove_video_poster_image": true`
responsive	boolean A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a width. Example: `"responsive": true`
type	string The player you want to use. Wowza Video subscribers Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface. The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site. Note: If you update a live stream from original_html5 or wowza_player to wowza_flowplayer, it cannot be changed later. Other subscribers original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none. Example: `"type": "wowza_flowplayer"`
video_poster_image	string A Base64-encoded string representation of a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller. Example: `"video_poster_image": "[Base64-encoded string representation of an image]"`
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`

Responses

200

Success

Response Schema: application/json

required

object (player)

	object Configuration of the player customizations. If you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.
countdown	boolean A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.
countdown_at	string <date-time> The date and time that the event starts, used by the countdown clock. Enter YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.
created_at	string <date-time> The date and time that the player was created.
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
hls_playback_url	string The address that can be used to configure playback of the stream using the HLS protocol.
	object (hosted_page_response_object) Configuration of the hosted page.
id	string The unique alphanumeric string that identifies the player.
logo_image_url	string The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left.
	object Configuration of the plugins.
responsive	boolean A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a width.
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
type	string The player you want to use. Wowza Video subscribers Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface. The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site. Other subscribers original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none.
updated_at	string <date-time> The date and time that the player was updated.
video_poster_image_url	string The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/players/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"player": {"hosted_page": {"title": "My Updated Hosted Page"
},
"responsive": true
}
}

Response samples

application/json

{"player": {"customizations": {"play_icon": "solid",
"thin_timeline": false,
"drag_handle": false,
"volume": true,
"mute": true,
"fullscreen": true,
"show_player_title": false,
"color": "4d4d4d"
},
"countdown": true,
"countdown_at": "2020-02-01T17:00:00.000Z",
"created_at": "2020-01-29T17:16:21.968Z",
"embed_code": null,
"hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8",
"hosted_page": {"enabled": true,
"description": "My Hosted Page Description",
"logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
"sharing_icons": false,
"title": "My Hosted Page",
"url": "https://player.video.wowza.com/hosted/e8dk5bf6/player.html"
},
"id": "e8dk5bf6",
"logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"logo_position": "top-right",
"plugins": {"airplay": false,
"chromecast": false
},
"responsive": false,
"transcoder_id": "6Qbymbbq",
"type": "wowza_flowplayer",
"updated_at": "2020-01-31T16:08:26.990Z",
"video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"width": 640
}
}

Rebuild player code

This operation rebuilds the player with the current configuration.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the player.

Responses

200

Success

Response Schema: application/json

required

object (player)

state

string

The state of the player.

Enum: "requested" "already_requested" "activated"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

post/players/{id}/rebuild

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "POST" \
  "${WV_HOST}/api/v1.11/players/2adffc17/rebuild"

Response samples

application/json

{"player": {"state": "requested"
}
}

Fetch the state of a player

This operation shows the current state of a player.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the player.

Responses

200

Success

Response Schema: application/json

required

object (player)

state

string

The state of the player.

Enum: "requested" "activated"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{id}/state

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/players/2adffc17/state"

Response samples

application/json

{"player": {"state": "activated"
}
}

Create a player URL

This operation creates a new player URL.

Request

path Parameters

player_id

required

string

The unique alphanumeric string that identifies the player.

Request Body schema: application/json
required

Provide the details of the player URL to create in the body of the request.

required

object (url)

bitrate	integer <int32> The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than 0.
height	integer <int32> The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than 0.
label	string A descriptive name for the player URL. Maximum 255 characters.
url	string The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.
width	integer <int32> The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than 0.

Responses

200

Success

Response Schema: application/json

required

object (url)

bitrate	integer <int32> The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than 0.
created_at	string <date-time> The date and time that the player URL was created.
height	integer <int32> The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than 0.
id	string The unique alphanumeric string that identifies the player URL.
label	string A descriptive name for the player URL. Maximum 255 characters.
player_id	string The unique alphanumeric string that identifies the player.
updated_at	string <date-time> The date and time that the player URL was updated.
url	string The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.
width	integer <int32> The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than 0.

401

Unauthorized

422

Unprocessable Entity

post/players/{player_id}/urls

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"url": {"bitrate": 4128,
"height": 1080,
"label": "1920",
"url": "http://somedomain.com/path/to/stream.m3u8",
"width": 1920
}
}

Response samples

application/json

{"url": {"bitrate": 4138,
"height": 1080,
"id": "w9vJm3BJ",
"label": "1920",
"player_id": "Jm1tPblTJm1t",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
}
}

Fetch all player URLs

This operation shows the details of all player URLs.

Request

path Parameters

player_id

required

string

The unique alphanumeric string that identifies the player.

Responses

200

Success

Response Schema: application/json

required

Array of objects (url)

Array

bitrate	integer <int32> The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than 0.
created_at	string <date-time> The date and time that the player URL was created.
height	integer <int32> The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than 0.
id	string The unique alphanumeric string that identifies the player URL.
label	string A descriptive name for the player URL. Maximum 255 characters.
player_id	string The unique alphanumeric string that identifies the player.
updated_at	string <date-time> The date and time that the player URL was updated.
url	string The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.
width	integer <int32> The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than 0.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{player_id}/urls

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/players/2adffc17/urls"

Response samples

application/json

{"urls": [{"bitrate": 4138,
"height": 1080,
"id": "w9vJm3BJ",
"label": "1920",
"player_id": "Jm1tPblTJm1t",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
},
{"bitrate": 4138,
"height": 1080,
"id": "PPqV0kcm",
"label": "iPhone",
"player_id": "Jm1tPblTJm1t",
"transcoder_id": "yjCVYf5l",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
}
]
}

Fetch a player URL

This operation shows the details of a player URL.

Request

path Parameters

player_id required	string The unique alphanumeric string that identifies the player.
id required	string The unique alphanumeric string that identifies the player URL.

Responses

200

Success

Response Schema: application/json

required

object (url)

bitrate	integer <int32> The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than 0.
created_at	string <date-time> The date and time that the player URL was created.
height	integer <int32> The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than 0.
id	string The unique alphanumeric string that identifies the player URL.
label	string A descriptive name for the player URL. Maximum 255 characters.
player_id	string The unique alphanumeric string that identifies the player.
updated_at	string <date-time> The date and time that the player URL was updated.
url	string The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.
width	integer <int32> The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than 0.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/players/{player_id}/urls/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/players/2adffc17/urls/1acfg43d"

Response samples

application/json

{"url": {"bitrate": 4138,
"height": 1080,
"id": "w9vJm3BJ",
"label": "1920",
"player_id": "Jm1tPblTJm1t",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
}
}

Update a player URL

This operation updates a player URL.

Request

path Parameters

player_id required	string The unique alphanumeric string that identifies the player.
id required	string The unique alphanumeric string that identifies the player URL.

Request Body schema: application/json
required

Provide the details of the player URL to update in the body of the request.

required

object (url)

bitrate	integer <int32> The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than 0.
height	integer <int32> The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than 0.
label	string A descriptive name for the player URL. Maximum 255 characters.
url	string The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.
width	integer <int32> The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than 0.

Responses

200

Success

Response Schema: application/json

required

object (url)

bitrate	integer <int32> The video bitrate, in kilobits per second (Kbps), of the output rendition that will be played at the URL. May correspond to the bitrate of an output rendition being used by the live stream or transcoder. Must be greater than 0.
created_at	string <date-time> The date and time that the player URL was created.
height	integer <int32> The height, in pixels, of the output rendition that will be played at the URL. May correspond to the height of an output rendition being used by the live stream or transcoder. Must be greater than 0.
id	string The unique alphanumeric string that identifies the player URL.
label	string A descriptive name for the player URL. Maximum 255 characters.
player_id	string The unique alphanumeric string that identifies the player.
updated_at	string <date-time> The date and time that the player URL was updated.
url	string The URL of the player. If using a Wowza CDN target, the URL format is `http://wowzasubdomain-f.akamaihd.net/i/stream_name_angle@stream_id/master.m3u8` for HLS playback.
width	integer <int32> The width, in pixels, of the output rendition that will be played at the URL. May correspond to the width of an output rendition being used by the live stream or transcoder. Must be greater than 0.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/players/{player_id}/urls/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"url": {"bitrate": 4128,
"height": 1080,
"label": "1920",
"url": "http://somedomain.com/path/to/stream.m3u8",
"width": 1920
}
}

Response samples

application/json

{"url": {"bitrate": 4138,
"height": 1080,
"id": "w9vJm3BJ",
"label": "1920",
"player_id": "Jm1tPblTJm1t",
"url": "http://someurl.com/some/path/to/a/stream.m3u8",
"width": 1920
}
}

Delete a player URL

This operation deletes a player URL.

Request

path Parameters

player_id required	string The unique alphanumeric string that identifies the player.
id required	string The unique alphanumeric string that identifies the player URL.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/players/{player_id}/urls/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.11/players/2adffc17/urls/1acfg43d"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Players

Fetch all players

query Parameters

Response Schema: application/json

Fetch a player

path Parameters

Response Schema: application/json

Update a player

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Rebuild player code

path Parameters

Response Schema: application/json

Fetch the state of a player

path Parameters

Response Schema: application/json

Create a player URL

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetch all player URLs

path Parameters

Response Schema: application/json

Fetch a player URL

path Parameters

Response Schema: application/json

Update a player URL

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Delete a player URL

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required