Upload Tokens
get
/upload-tokensList all active upload tokens
Retrieve a list of all currently active delegated tokens.
sortBystringAllowed: 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 ISO-8601 format.
- Enum
- createdAt
- ttl
- Example
- "ttl"
sortOrderstringAllowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A.
- Enum
- asc
- desc
- Example
- "asc"
currentPageintChoose the number of search results to return per page. Minimum value: 1
- Default
- 1
- Example
- 2
pageSizeintResults per page. Allowed values 1-100, default is 25.
- Default
- 25
- Example
- 30
apiKey
Responses
Too Many Requests
Response BodyHeaders
typestringA link to the error documentation.
titlestringA description of the error that occurred.
statusintThe HTTP status code.
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Success
Response BodyHeaders
dataarray[object (UploadToken)]required
UploadTokenobject (UploadToken)tokenstringThe unique identifier for the token you will use to authenticate an upload.
- Example
- "to1tcmSFHeYY5KzyhOqVKMKb"
ttlintTime-to-live - how long the upload token is valid for.
- Min
- 0
- Max
- 2147483647
createdAtstringWhen the token was created, displayed in ISO-8601 format.
- Format
- date-time
- Example
- "2019-12-16T08:25:51.000Z"
expiresAtstring or nullWhen the token expires, displayed in ISO-8601 format.
- Format
- date-time
- Example
- "2019-12-16T09:25:51.000Z"
paginationobject (pagination)required
- Example
- { "itemsTotal": 123, "pagesTotal": 7, "pageSize": 20, "currentPage": 3, "currentPageItems": 20, "links": { "first": { "rel": "first", "uri": "/videos/search?currentPage=1&pageSize=20" }, "previous": { "rel": "previous", "uri": "/videos/search?currentPage=2&pageSize=20" }, "next": { "rel": "next", "uri": "/videos/search?currentPage=4&pageSize=20" }, "last": { "rel": "last", "uri": "/videos/search?currentPage=6&pageSize=20" } } }
itemsTotalintTotal number of items that exist.
pagesTotalintNumber of items listed in the current page.
pageSizeintMaximum number of item per page.
currentPageintThe current page index.
currentPageItemsintThe number of items on the current page.
linksarray[object (PaginationLink)]required
PaginationLinkobject (PaginationLink)relstringuristring- Format
- uri
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Request examples
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokensApi.md#list
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_KEY").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOUR_SANDBOX_API_KEY").Build()
uploadToken := "to1tcmSFHeYY5KzyhOqVKMKb" // string | The unique identifier for the token you want information about.
res, err := client.UploadTokens.GetToken(uploadToken)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UploadTokens.GetToken``: %v\
", err)
}
// response from `GetToken`: UploadToken
fmt.Fprintf(os.Stdout, "Response from `UploadTokens.GetToken`: %v\
", res)
}
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#list
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const uploadTokens = await client.uploadTokens.list();
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/UploadTokensApi.md#list
import apivideo
from apivideo.api import upload_tokens_api
from apivideo.model.not_found import NotFound
from apivideo.model.upload_token import UploadToken
from pprint import pprint
# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
# Create an instance of the API class
api_instance = upload_tokens_api.UploadTokensApi(api_client)
upload_token = "to1tcmSFHeYY5KzyhOqVKMKb" # str | The unique identifier for the token you want information about.
# example passing only required values which don't have defaults set
try:
# Show upload token
api_response = api_instance.get_token(upload_token)
pprint(api_response)
except apivideo.ApiException as e:
print("Exception when calling UploadTokensApi->get_token: %s\n" % e)
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#list
import video.api.client.ApiVideoClient;
import video.api.client.api.ApiException;
import video.api.client.api.models.*;
import video.api.client.api.clients.UploadTokensApi;
import java.util.*;
public class Example {
public static void main(String[] args) {
ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
// if you rather like to use the sandbox environment:
// ApiVideoClient client = new ApiVideoClient("YOUR_SANDBOX_API_KEY", ApiVideoClient.Environment.SANDBOX);
UploadTokensApi apiInstance = client.uploadTokens();
String uploadToken = "to1tcmSFHeYY5KzyhOqVKMKb"; // The unique identifier for the token you want information about.
try {
UploadToken result = apiInstance.getToken(uploadToken);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UploadTokensApi#getToken");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getMessage());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#list
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class getTokenExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var uploadToken = to1tcmSFHeYY5KzyhOqVKMKb; // string | The unique identifier for the token you want information about.
var apiUploadTokensInstance = apiInstance.UploadTokens();
try
{
// Show upload token
UploadToken result = apiUploadTokensInstance.getToken(uploadToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling UploadTokensApi.getToken: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
<?php
// First install the api client: "composer require api-video/php-api-client"
// Documentation: https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#list
require __DIR__ . '/vendor/autoload.php';
$client = new \ApiVideo\Client\Client(
'https://ws.api.video',
'YOUR_API_KEY',
new \Symfony\Component\HttpClient\Psr18Client()
);
$uploadTokens = $client->uploadTokens()->list(); // First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#list
Response examples
Success
{
"data": [
{
"token": "to37YfoPDRR2pcDKa6LsUE0M",
"ttl": 3600,
"createdAt": "2020-12-02T10:26:46.000Z",
"expiresAt": "2020-12-02T11:26:46.000Z"
},
{
"token": "to1W3ZS9PdUBZWzzTEZr1B79",
"ttl": 0,
"createdAt": "2020-12-02T10:26:28.000Z"
}
],
"pagination": {
"currentPage": 1,
"currentPageItems": 2,
"pageSize": 25,
"pagesTotal": 1,
"itemsTotal": 2,
"links": [
{
"rel": "self",
"uri": "/upload-tokens?currentPage=1&pageSize=25"
},
{
"rel": "first",
"uri": "/upload-tokens?currentPage=1&pageSize=25"
},
{
"rel": "last",
"uri": "/upload-tokens?currentPage=1&pageSize=25"
}
]
}
}Too Many Requests
{
"type": "https://docs.api.video/reference/too-many-requests",
"title": "Too many requests.",
"status": 429
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
post
/upload-tokensGenerate an upload token
Generates an upload token that can be used to replace the API Key. More information can be found here
ttlintTime in seconds that the token will be active. A value of 0 means that the token has no exipration date. The default is to have no expiration.
- Default
- 0
- Min
- 0
- Max
- 2147483647
apiKey
Responses
Too Many Requests
Response BodyHeaders
typestringA link to the error documentation.
titlestringA description of the error that occurred.
statusintThe HTTP status code.
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Success
Response BodyHeaders
tokenstringThe unique identifier for the token you will use to authenticate an upload.
- Example
- "to1tcmSFHeYY5KzyhOqVKMKb"
ttlintTime-to-live - how long the upload token is valid for.
- Min
- 0
- Max
- 2147483647
createdAtstringWhen the token was created, displayed in ISO-8601 format.
- Format
- date-time
- Example
- "2019-12-16T08:25:51.000Z"
expiresAtstring or nullWhen the token expires, displayed in ISO-8601 format.
- Format
- date-time
- Example
- "2019-12-16T09:25:51.000Z"
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Bad Request
Response BodyHeaders
typestringA link to the error documentation.
titlestringA description of the error that occurred.
namestringThe name of the parameter that caused the error.
statusintThe HTTP status code.
problemsarray[object (BadRequest)]Returns any additional problems in the request in an array of objects.
BadRequestobject (BadRequest)typestringA link to the error documentation.
titlestringA description of the error that occurred.
namestringThe name of the parameter that caused the error.
statusintThe HTTP status code.
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Request examples
{
"ttl": 3600
}// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokensApi.md#createToken
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_KEY").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOUR_SANDBOX_API_KEY").Build()
tokenCreationPayload := *apivideosdk.NewTokenCreationPayload() // TokenCreationPayload |
res, err := client.UploadTokens.CreateToken(tokenCreationPayload)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UploadTokens.CreateToken``: %v\
", err)
}
// response from `CreateToken`: UploadToken
fmt.Fprintf(os.Stdout, "Response from `UploadTokens.CreateToken`: %v\
", res)
}
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#createToken
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const tokenCreationPayload = {
ttl: 56, // Time in seconds that the token will be active. A value of 0 means that the token has no expiration date. The default is to have no expiration.
};
const uploadToken = await client.uploadTokens.createToken(tokenCreationPayload);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/UploadTokensApi.md#createToken
import apivideo
from apivideo.api import upload_tokens_api
from apivideo.model.bad_request import BadRequest
from apivideo.model.upload_token import UploadToken
from apivideo.model.token_creation_payload import TokenCreationPayload
from pprint import pprint
# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
# Create an instance of the API class
api_instance = upload_tokens_api.UploadTokensApi(api_client)
token_creation_payload = TokenCreationPayload(
ttl=0,
) # TokenCreationPayload |
# example passing only required values which don't have defaults set
try:
# Generate an upload token
api_response = api_instance.create_token(token_creation_payload)
pprint(api_response)
except apivideo.ApiException as e:
print("Exception when calling UploadTokensApi->create_token: %s\
" % e)
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#createToken
import video.api.client.ApiVideoClient;
import video.api.client.api.ApiException;
import video.api.client.api.models.*;
import video.api.client.api.clients.UploadTokensApi;
import java.util.*;
public class Example {
public static void main(String[] args) {
ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
// if you rather like to use the sandbox environment:
// ApiVideoClient client = new ApiVideoClient("YOUR_SANDBOX_API_KEY", ApiVideoClient.Environment.SANDBOX);
UploadTokensApi apiInstance = client.uploadTokens();
TokenCreationPayload tokenCreationPayload = new TokenCreationPayload(); //
tokenCreationPayload.setTtl(); // Time in seconds that the token will be active. A value of 0 means that the token has no expiration date. The default is to have no expiration.
try {
UploadToken result = apiInstance.createToken(tokenCreationPayload);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UploadTokensApi#createToken");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getMessage());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#createToken
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class createTokenExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var tokenCreationPayload = new TokenCreationPayload(); // TokenCreationPayload |
var apiUploadTokensInstance = apiInstance.UploadTokens();
try
{
// Generate an upload token
UploadToken result = apiUploadTokensInstance.createToken(tokenCreationPayload);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling UploadTokensApi.createToken: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
<?php
// First install the api client: "composer require api-video/php-api-client"
// Documentation: https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#deleteToken
require __DIR__ . '/vendor/autoload.php';
$client = new \ApiVideo\Client\Client(
'https://ws.api.video',
'YOUR_API_KEY',
new \Symfony\Component\HttpClient\Psr18Client()
);
$uploadToken = 'to1tcmSFHeYY5KzyhOqVKMKb'; // 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.
$client->uploadTokens()->deleteToken($uploadToken); // First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#createToken
Response examples
Success
{
"token": "to1tcmSFHeYY5KzyhOqVKMKb",
"ttl": 3600,
"createdAt": "2020-12-02T10:13:19.000Z",
"expiresAt": "2020-12-02T11:13:19.000Z"
}Bad Request
{
"type": "string",
"title": "string",
"name": "string",
"status": 123,
"problems": [
{
"type": "string",
"title": "string",
"name": "string",
"status": 123
}
]
}Too Many Requests
{
"type": "https://docs.api.video/reference/too-many-requests",
"title": "Too many requests.",
"status": 429
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
get
/upload-tokens/{uploadToken}Retrieve upload token
Retrieve details about a specific upload token by id.
uploadTokenstringrequired
The unique identifier for the token you want information about.
- Example
- "to1tcmSFHeYY5KzyhOqVKMKb"
apiKey
Responses
Not Found
Response BodyHeaders
typestringtitlestringnamestringstatusintX-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Too Many Requests
Response BodyHeaders
typestringA link to the error documentation.
titlestringA description of the error that occurred.
statusintThe HTTP status code.
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Success
Response BodyHeaders
tokenstringThe unique identifier for the token you will use to authenticate an upload.
- Example
- "to1tcmSFHeYY5KzyhOqVKMKb"
ttlintTime-to-live - how long the upload token is valid for.
- Min
- 0
- Max
- 2147483647
createdAtstringWhen the token was created, displayed in ISO-8601 format.
- Format
- date-time
- Example
- "2019-12-16T08:25:51.000Z"
expiresAtstring or nullWhen the token expires, displayed in ISO-8601 format.
- Format
- date-time
- Example
- "2019-12-16T09:25:51.000Z"
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Request examples
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokensApi.md#getToken
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_KEY").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOUR_SANDBOX_API_KEY").Build()
uploadToken := "to1tcmSFHeYY5KzyhOqVKMKb" // string | The unique identifier for the token you want information about.
res, err := client.UploadTokens.GetToken(uploadToken)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UploadTokens.GetToken``: %v\
", err)
}
// response from `GetToken`: UploadToken
fmt.Fprintf(os.Stdout, "Response from `UploadTokens.GetToken`: %v\
", res)
}
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#getToken
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const uploadTokenId = 'to1tcmSFHeYY5KzyhOqVKMKb'; // The unique identifier for the token you want information about.
const uploadToken = await client.uploadTokens.getToken(uploadTokenId);
# First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/UploadTokensApi.md#getToken
import apivideo
from apivideo.api import upload_tokens_api
from apivideo.model.not_found import NotFound
from apivideo.model.upload_token import UploadToken
from pprint import pprint
# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
# Create an instance of the API class
api_instance = upload_tokens_api.UploadTokensApi(api_client)
upload_token = "to1tcmSFHeYY5KzyhOqVKMKb" # str | The unique identifier for the token you want information about.
# example passing only required values which don't have defaults set
try:
# Show upload token
api_response = api_instance.get_token(upload_token)
pprint(api_response)
except apivideo.ApiException as e:
print("Exception when calling UploadTokensApi->get_token: %s\n" % e)
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#getToken
import video.api.client.ApiVideoClient;
import video.api.client.api.ApiException;
import video.api.client.api.models.*;
import video.api.client.api.clients.UploadTokensApi;
import java.util.*;
public class Example {
public static void main(String[] args) {
ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
// if you rather like to use the sandbox environment:
// ApiVideoClient client = new ApiVideoClient("YOUR_SANDBOX_API_KEY", ApiVideoClient.Environment.SANDBOX);
UploadTokensApi apiInstance = client.uploadTokens();
String uploadToken = "to1tcmSFHeYY5KzyhOqVKMKb"; // The unique identifier for the token you want information about.
try {
UploadToken result = apiInstance.getToken(uploadToken);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UploadTokensApi#getToken");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getMessage());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#getToken
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class getTokenExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var uploadToken = to1tcmSFHeYY5KzyhOqVKMKb; // string | The unique identifier for the token you want information about.
var apiUploadTokensInstance = apiInstance.UploadTokens();
try
{
// Show upload token
UploadToken result = apiUploadTokensInstance.getToken(uploadToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling UploadTokensApi.getToken: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
<?php
// First install the api client: "composer require api-video/php-api-client"
// Documentation: https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#getToken
require __DIR__ . '/vendor/autoload.php';
$client = new \ApiVideo\Client\Client(
'https://ws.api.video',
'YOUR_API_KEY',
new \Symfony\Component\HttpClient\Psr18Client()
);
$uploadTokenId = 'to1tcmSFHeYY5KzyhOqVKMKb'; // The unique identifier for the token you want information about.
$uploadToken = $client->uploadTokens()->getToken($uploadTokenId); // First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#getToken
Response examples
Success
{
"token": "to1tcmSFHeYY5KzyhOqVKMKb",
"ttl": 0,
"createdAt": "2020-12-02T10:13:19.000Z"
}Not Found
{
"type": "string",
"title": "string",
"name": "string",
"status": 123
}Too Many Requests
{
"type": "https://docs.api.video/reference/too-many-requests",
"title": "Too many requests.",
"status": 429
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
delete
/upload-tokens/{uploadToken}Delete an upload token
Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.
uploadTokenstringrequired
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.
- Example
- "to1tcmSFHeYY5KzyhOqVKMKb"
apiKey
Responses
No Content
Response BodyHeaders
This response is empty
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Not Found
Response BodyHeaders
typestringtitlestringnamestringstatusintX-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Too Many Requests
Response BodyHeaders
typestringA link to the error documentation.
titlestringA description of the error that occurred.
statusintThe HTTP status code.
X-RateLimit-LimitintThe request limit per minute.
X-RateLimit-RemainingintThe number of available requests left for the current time window.
X-RateLimit-Retry-AfterintThe number of seconds left until the current rate limit window resets.
Request examples
// First install the go client with "go get github.com/apivideo/api.video-go-client"
// Documentation: https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokensApi.md#deleteToken
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_KEY").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOUR_SANDBOX_API_KEY").Build()
uploadToken := "to1tcmSFHeYY5KzyhOqVKMKb" // string | 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.
err := client.UploadTokens.DeleteToken(uploadToken)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UploadTokens.DeleteToken``: %v\
", err)
}
}
// First install the "@api.video/nodejs-client" npm package
// Documentation: https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#deleteToken
const client = new ApiVideoClient({ apiKey: "YOUR_API_KEY" });
const uploadToken = 'to1tcmSFHeYY5KzyhOqVKMKb'; // 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.
await client.uploadTokens.deleteToken(uploadToken); # First install the api client with "pip install api.video"
# Documentation: https://github.com/apivideo/api.video-python-client/blob/main/docs/UploadTokensApi.md#deleteToken
import apivideo
from apivideo.api import upload_tokens_api
from apivideo.model.not_found import NotFound
from pprint import pprint
# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
# Create an instance of the API class
api_instance = upload_tokens_api.UploadTokensApi(api_client)
upload_token = "to1tcmSFHeYY5KzyhOqVKMKb" # str | 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.
# example passing only required values which don't have defaults set
try:
# Delete an upload token
api_instance.delete_token(upload_token)
except apivideo.ApiException as e:
print("Exception when calling UploadTokensApi->delete_token: %s\n" % e)
// First add the "video.api:java-api-client" maven dependency to your project
// Documentation: https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#deleteToken
import video.api.client.ApiVideoClient;
import video.api.client.api.ApiException;
import video.api.client.api.models.*;
import video.api.client.api.clients.UploadTokensApi;
import java.util.*;
public class Example {
public static void main(String[] args) {
ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
// if you rather like to use the sandbox environment:
// ApiVideoClient client = new ApiVideoClient("YOUR_SANDBOX_API_KEY", ApiVideoClient.Environment.SANDBOX);
UploadTokensApi apiInstance = client.uploadTokens();
String uploadToken = "to1tcmSFHeYY5KzyhOqVKMKb"; // 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.
try {
apiInstance.deleteToken(uploadToken);
} catch (ApiException e) {
System.err.println("Exception when calling UploadTokensApi#deleteToken");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getMessage());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// First add the "ApiVideo" NuGet package to your project
// Documentation: https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#deleteToken
using System.Diagnostics;
using ApiVideo.Client;
namespace Example
{
public class deleteTokenExample
{
public static void Main()
{
var basePath = ApiVideoClient.Client.Environment.SANDBOX;
var apiKey = "YOUR_API_KEY";
var apiInstance = new ApiVideoClient(apiKey,basePath);
var uploadToken = to1tcmSFHeYY5KzyhOqVKMKb; // string | 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.
var apiUploadTokensInstance = apiInstance.UploadTokens();
try
{
// Delete an upload token
apiUploadTokensInstance.deleteToken(uploadToken);
}
catch (ApiException e)
{
Debug.Print("Exception when calling UploadTokensApi.deleteToken: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
<?php
// First install the api client: "composer require api-video/php-api-client"
// Documentation: https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#getToken
require __DIR__ . '/vendor/autoload.php';
$client = new \ApiVideo\Client\Client(
'https://ws.api.video',
'YOUR_API_KEY',
new \Symfony\Component\HttpClient\Psr18Client()
);
$uploadTokenId = 'to1tcmSFHeYY5KzyhOqVKMKb'; // The unique identifier for the token you want information about.
$uploadToken = $client->uploadTokens()->getToken($uploadTokenId); // First install the api client: https://github.com/apivideo/api.video-swift-client#getting-started
// Documentation: https://github.com/apivideo/api.video-swift-client/blob/main/docs/UploadTokensAPI.md#deleteToken
Response examples
No Content
Empty response
Not Found
{
"type": "string",
"title": "string",
"name": "string",
"status": 123
}Too Many Requests
{
"type": "https://docs.api.video/reference/too-many-requests",
"title": "Too many requests.",
"status": 429
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Was this page helpful?