Skip to main contentIBM Video Streaming Developers

Hide channel page

If page lock is enabled, your channel and videos will not be found anywhere on video.ibm.com. Viewers will only be able to watch embedded players on external websites.

If you want the channel to appear only on your own website, make sure to restrict embeds to your site as well.

Get page lock setting

Get the status of the page lock.

GET https://api.video.ibm.com/channels/{channel_id}/locks/page.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
lockedstringReturns TRUE if the page lock is enabled on the channel, otherwise FALSE.

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
402 Payment Requiredinvalid_requestThe user does not have the embed_restriction benefit
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

Modify page lock

Enable or disable page lock on a channel.

PUT https://api.video.ibm.com/channels/{channel_id}/locks/page.json

Parameters

The parameters for the PUT request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
lockedstringREQUIREDSets page lock on channel when value is TRUE. Removes page lock when value is FALSE.

Success response

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

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
400 Bad Requestinvalid_requestThe request parameter is missing or invalid
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
402 Payment Requiredinvalid_requestThe user does not have the benefit
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