All URIs are relative to https://ws.api.video
Method | Description | HTTP request |
---|---|---|
createToken() | Generate an upload token | POST /upload-tokens |
getToken() | Retrieve upload token | GET /upload-tokens/{uploadToken} |
deleteToken() | Delete an upload token | DELETE /upload-tokens/{uploadToken} |
list() | List all active upload tokens | GET /upload-tokens |
Generates an upload token that can be used to replace the API Key. More information can be found here
Name | Type | Required | Description |
---|---|---|---|
tokenCreationPayload | TokenCreationPayload | yes |
Promise<UploadToken>.
Retrieve details about a specific upload token by id.
Name | Type | Required | Description |
---|---|---|---|
uploadToken | string | yes | The unique identifier for the token you want information about. |
Promise<UploadToken>.
Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.
Name | Type | Required | Description |
---|---|---|---|
uploadToken | string | yes | The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication. |
Promise<void>.
Retrieve a list of all currently active delegated tokens.
Name | Type | Required | Description |
---|---|---|---|
sortBy | 'createdAt' | 'ttl' | no | Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ATOM UTC format. |
sortOrder | 'asc' | 'desc' | no | Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. |
currentPage | number | no | Choose the number of search results to return per page. Minimum value: 1 |
pageSize | number | no | Results per page. Allowed values 1-100, default is 25. |
Promise<TokenListResponse>.