Control Panel — API documentation

SEVU Token

SEVU Token object

ScaleEngine Virtual Usher system provides security on your streams and Video on Demand files.

Descriptions

id Integer Autogenerated

Unique identifier for this object.

Sample value:N/A

cdn_id Integer Autogenerated

The CDN ID that owns this object.

Sample value:8123

key String Autogenerated

SEVU token used for Playback Authentication.

Sample value:mystream.53ffc996dd39d5.39102367

pass String Immutable Required

Password used for Playback Authentication. This field can be used to store an identifier of the user this ticket is for, to allow matching logs and tracking abuse.

String

Sample value:user123|randomdata

ip String Immutable Required

A pipe (|) separated list of IP Restrictions: Single IP (1.1.1.1), IP range using CIDR notation (1.1.1.1/24), IP Detection (auto or auto/24) will use the first IP address to make a playback request, or 0.0.0.0/0 to allow any IP. Multiple IPs can be separated by a |, to allow only the first 2 subnets or similar.

String

Default:

Sample value:auto/24|auto/24

video String Immutable Required

A pipe (|) separated list of videos to allow with optional wildcards (*)

String

Default:

Sample value:my_video.mp4|my_folder/*

app String Immutable Required

A pipe (|) separated list of Application names to allow with optional wildcards (*)

The application name must begin with "username-"

Sample value:username-*

uses Integer Immutable Required

Number of times the token is allowed to be used

Integer

Sample value:999

active Boolean Normal

Sets the token to be active or inactive

Boolean

Default:1

Sample value:1

created_date String Autogenerated

Date and time the token was created

Sample value:2019-12-23 23:59:59

expire_date String Normal

Date and time the token will expire

String

Default:+1 week

Sample value:2019-12-24 23:59:59

used_date String Autogenerated

Date and time the token was last used

Sample value:2019-12-23 13:59:59

option:children String

Include child object in results

Default:none

Sample value:sevu_attempt

pass String Immutable

Password used for Playback Authentication. This field can be used to store an identifier of the user this ticket is for, to allow matching logs and tracking abuse.

Sample value:user123|randomdata

ip String Immutable

A pipe (|) separated list of IP Restrictions: Single IP (1.1.1.1), IP range using CIDR notation (1.1.1.1/24), IP Detection (auto or auto/24) will use the first IP address to make a playback request, or 0.0.0.0/0 to allow any IP. Multiple IPs can be separated by a |, to allow only the first 2 subnets or similar.

Sample value:auto/24|auto/24

video String Immutable

A pipe (|) separated list of videos to allow with optional wildcards (*)

Sample value:my_video.mp4|my_folder/*

app String Immutable

A pipe (|) separated list of Application names to allow with optional wildcards (*)

Sample value:username-*

active Boolean Normal

Sets the token to be active or inactive

Sample value:1

created_date String Autogenerated

Date and time the token was created

Sample value:2019-12-23 23:59:59

expire_date String Normal

Date and time the token will expire

Sample value:2019-12-24 23:59:59

used_date String Autogenerated

Date and time the token was last used

Sample value:2019-12-23 13:59:59

None

Child endpoints

Sevu attempt

Attempt log entries for SEVU tickets

Examples

Get the SEVU Token object with id mystream.53ffc996dd39d5.39102367.

Example URL

https://api.scaleengine.net/v2/sevu_token/mystream.53ffc996dd39d5.39102367

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/sevu_token/mystream.53ffc996dd39d5.39102367

Example request body

None

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "key": "mystream.53ffc996dd39d5.39102367",
    "pass": "user123|randomdata",
    "ip": "auto/24|auto/24",
    "video": "my_video.mp4|my_folder/*",
    "app": "username-*",
    "uses": 999,
    "active": true,
    "created_date": "2019-12-23 23:59:59",
    "expire_date": "2019-12-24 23:59:59",
    "used_date": "2019-12-23 13:59:59"
}

Create a new SEVU Token object.

Example URL

https://api.scaleengine.net/v2/sevu_token

Example cURL

curl -X PUT --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/sevu_token

Example request body

{
    "pass": "user123|randomdata",
    "ip": "auto/24|auto/24",
    "video": "my_video.mp4|my_folder/*",
    "app": "username-*",
    "uses": 999,
    "active": true,
    "expire_date": "2019-12-24 23:59:59"
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "key": "mystream.53ffc996dd39d5.39102367",
    "pass": "user123|randomdata",
    "ip": "auto/24|auto/24",
    "video": "my_video.mp4|my_folder/*",
    "app": "username-*",
    "uses": 999,
    "active": true,
    "created_date": "2019-12-23 23:59:59",
    "expire_date": "2019-12-24 23:59:59",
    "used_date": "2019-12-23 13:59:59"
}

Update the SEVU Token object with id mystream.53ffc996dd39d5.39102367.

Example URL

https://api.scaleengine.net/v2/sevu_token/mystream.53ffc996dd39d5.39102367

Example cURL

curl -X POST --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/sevu_token/mystream.53ffc996dd39d5.39102367

Example request body

{
    "active": true,
    "expire_date": "2019-12-24 23:59:59"
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "key": "mystream.53ffc996dd39d5.39102367",
    "pass": "user123|randomdata",
    "ip": "auto/24|auto/24",
    "video": "my_video.mp4|my_folder/*",
    "app": "username-*",
    "uses": 999,
    "active": true,
    "created_date": "2019-12-23 23:59:59",
    "expire_date": "2019-12-24 23:59:59",
    "used_date": "2019-12-23 13:59:59"
}

Delete the SEVU Token object with id mystream.53ffc996dd39d5.39102367.

Example URL

https://api.scaleengine.net/v2/sevu_token/mystream.53ffc996dd39d5.39102367

Example cURL

curl -X DELETE --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/sevu_token/mystream.53ffc996dd39d5.39102367

Example request body


			
			
Example response data


None


			
				


	








	
Errors





	

			

			
				ACCESS_VIOLATION
			
			
You do not have access to modify this field

		

			

			
				REQUIRED_FIELD
			
			
Missing one or more required fields

		

			

			
				TYPE_MISMATCH
			
			
Data type does not conform to required field type

		

			

			
				APP_INVALID
			
			
The application name must begin with "username-"