Sign in
V3 > Share

Creates a new token.

Creates a new token associated with the provided share based on the provided parameters..

post/2/vod/shares/{share}/token

Path parameters

sharestring required

The Share unique identifier

Headers

X-Ik-Token-Enforce-Ipboolean

Extra header to pass if ip_address should be used, if this header isn't passed, the ip_address field will be ignored.

Request body

allowed_domainsstring[] nullable

List of allowed domains for the Token

expires_atstring nullable

a simple string

ip_addressstring nullable

Valid ipv4 or ipv6 address address

payloadstring nullable

a simple string

restricted_domainsstring[] nullable

List of restricted domain names for the Token

saltstring nullable

a simple string

sessionstring nullable

a simple string

starts_atstring nullable

a simple string

strategystring required

the playback strategy to enforce protection for<note><strong>hls</strong>: Apple HTTP Live Streaming</note><note><strong>dash</strong>: Dynamic Adaptive Streaming over HTTP</note><note><strong>single</strong>: Single bitrate</note><note><strong>best</strong>: Playback strategy selecting the best available quality dynamically</note>

windowinteger nullable

The Token validity duration (in seconds)

Example request

{
  "expires_at": "\"toto\"",
  "ip_address": "192.168.31.1",
  "payload": "\"toto\"",
  "salt": "\"toto\"",
  "session": "\"toto\"",
  "starts_at": "\"toto\"",
  "strategy": "hls"
}

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

datastring

Example response

{
  "result": "success"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.