Skip to main contentIBM Video Streaming Developers

Broadcasting devices

List all broadcasting devices

Returns information on devices that have access to broadcast to your channels.

GET https://api.video.ibm.com/users/self/device-passwords.json

Parameters

The query parameters for the GET request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
pageintegerOPTIONALRequested page number (value is 1 by default)
pagesizeintegerOPTIONALRequested page size (value is 50 by default, max. 50)

Success response

Upon success a response with HTTP status “200 OK” is returned with the following key-value pairs under a device_passwords object.

KEYTYPEDESCRIPTION
device_namestringName of the device
user_namestringUsername of the device
created_atnumberThe date and time when the device password was created (Unix timestamp)
valid_fromnumberThe date and time after which the device password can be used for logging in (Unix timestamp).
valid_untilnumberThe date and time until the device password can be used for logging in (Unix timestamp).

Example of a success response:

{
"device_passwords": [
{
"device_name": "Sample Device 1",
"user_name": "xnwj3mseuka",
"created_at": 1497441340,
"valid_from": 1497443340,
"valid_until": null
},

The paging information can be found under the paging key. Example:

{
"paging": {
"previous": "https://api.video.ibm.com/users/self/device-passwords.json?pagesize=PAGE_SIZE&page=PREVIOUS_PAGE",
"next": "https://api.video.ibm.com/users/self/device-passwords.json?pagesize=PAGE_SIZE&page=NEXT_PAGE"
}
}

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 was not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Create access for device

Generate username and password for a new device to broadcast on your channels.

POST https://api.video.ibm.com/users/self/device-passwords.json

Parameters

The parameters for the POST request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
device_namestringREQUIREDName of the device
valid_fromtimestampREQUIREDThe date and time after which the device password can be used for logging in (Unix timestamp).
valid_untiltimestampOPTIONALThe date and time until the device password can be used for logging in (Unix timestamp).

Success response

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

KEYTYPEDESCRIPTION
device_namestringName of the device
user_namestringGenerated username of device
passwordstringGenerated password
valid_fromnumberThe date and time after which the device password can be used for logging in (Unix timestamp).
valid_untilnumberThe date and time until the device password can be used for logging in (Unix timestamp).

Example of a success response:

{
"device_name": "Sample Device 4",
"user_name": "jgun36pdc79",
"password": "jgcxathqhyqcdxp",
"valid_from": 1497571200,
"valid_until": 1500249600
}

Error responses

Possible error responses:

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

Revoke access from device

Revoke access to your channels from a broadcasting device.

DELETE https://api.video.ibm.com/users/self/device-passwords/{user_name}.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 UnauthorizedunauthorizedThe provided access token is missing, revoked, expired or malformed
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request