Skip to main contentIBM Video Streaming Developers

Channel metadata values

Get all metadata values of a channel

Get all metadata values set for a selected channel.

GET https://api.video.ibm.com/channels/{channel_id}/custom-metadata.json

Parameters

This request has no parameters.

Success response

Upon success a response with HTTP status “200 OK” is returned with the following key-value pair.

KEYTYPEDESCRIPTION
metadataarrayArray of data for fields containing field_id and value

Example of a success response:

{
"metadata": [
{
"field_id": "7865",
"value": "some text"
},
{
"field_id": "7866",
"value": "false"

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
404 Not Foundnot_foundChannel not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Set channel metadata value

Set value of a custom field on a selected channel.

PUT https://api.video.ibm.com/channels/{channel_id}/custom-metadata/{field_id}.json

Parameters

The parameters for the PUT request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
value(mixed)*REQUIREDThe metadata field value

* Data type may vary based on selected field.

Success response

Upon success, a response with HTTP status “204 No Content” is returned.

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
403 Forbiddenlack_of_ownershipThe API user is not allowed to manage the given channel
404 Not Foundnot_foundChannel not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Remove channel metadata value

Remove value of a custom field on a selected channel.

DELETE https://api.video.ibm.com/channels/{channel_id}/custom-metadata/{field_id}.json

Parameters

This request has no parameters.

Success response

Upon success a response with HTTP status “200 OK” is returned.

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
403 Forbiddenlack_of_ownershipThe API user is not allowed to manage the given channel
404 Not Foundnot_foundChannel not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request