Viewing and Editing Channel Information

You can change information about a channel at any time.

Note: For more information about Backlot REST API commands, see the Backlot API Reference.

To view or edit channel information:

  1. To view the channel's information, use the GET /v2assets route with the asset ID of the channel. The following example performs a get to obtain the current settings for channel dvNTVxMjrRktSlb5v.
    [GET]/v2/assets/dvNTVxMjrRktSlb5v

    Backlot returns a response similar to the following.

    {
       "asset_type": "channel",
       "duration": 0,
       "name": "My Channel",
       "preview_image_url": null,
       "created_at": "2011-08-10T17:45:24+00:00",
       "embed_code": "dvNTVxMjrRktSlb5v",
       "time_restrictions": null,
       "updated_at": "2011-08-10T17:45:24+00:00",
       "external_id": null,
       "hosted_at": null,
       "original_file_name": null,
       "description": null,
       "status": "live" 
    }
    Note:

    Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

  2. To change a channel's information, use PATCH with /v2/assets, the asset ID, and the updated properties in the request body. The following example changes the name, "hosted at" URL, and description.
    [PATCH]/v2/assets/dvNTVxMjrRktSlb5v{
       "name": "My Awesome Channel",
       "hosted_at": "http://www.mydomain.com",
       "description": "This channel is awesome, really." 
    }

    Backlot returns a response similar to the following.

    {
       "asset_type": "channel",
       "duration": 0,
       "name": "My Awesome Channel",
       "preview_image_url": null,
       "created_at": "2011-08-10T17:45:24+00:00",
       "embed_code": "dvNTVxMjrRktSlb5v",
       "time_restrictions": null,
       "updated_at": "2011-08-10T17:48:25+00:00",
       "external_id": null,
       "hosted_at": "http://www.mydomain.com",
       "original_file_name": null,
       "description": "This channel is awesome, really.",
       "status": "live" 
    }

The channel is successfully edited.

Was this article helpful?