All URIs are relative to https://ws.api.video
| Method | HTTP request | Description |
|---|---|---|
| DeleteToken | Delete /upload-tokens/{uploadToken} | Delete an upload token |
| List | Get /upload-tokens | List all active upload tokens. |
| GetToken | Get /upload-tokens/{uploadToken} | Show upload token |
| CreateToken | Post /upload-tokens | Generate an upload token |
DeleteToken(uploadToken string) (error)
DeleteTokenWithContext(ctx context.Context, uploadToken string) (error)
Delete an upload token
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_TOKEN").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOU_SANDBOX_API_TOKEN").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\n", err)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| uploadToken | 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. |
| Name | Type | Description | Notes |
|---|
(empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List(r UploadTokensApiListRequest) (*TokenListResponse, error)
ListWithContext(ctx context.Context, r UploadTokensApiListRequest) (*TokenListResponse, error)
List all active upload tokens.
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_TOKEN").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOU_SANDBOX_API_TOKEN").Build()
req := apivideosdk.UploadTokensApiListRequest{}
req.SortBy("ttl") // string | 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 ISO-8601 format.
req.SortOrder("asc") // string | Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A.
req.CurrentPage(int32(2)) // int32 | Choose the number of search results to return per page. Minimum value: 1 (default to 1)
req.PageSize(int32(30)) // int32 | Results per page. Allowed values 1-100, default is 25. (default to 25)
res, err := client.UploadTokens.List(req)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UploadTokens.List``: %v\n", err)
}
// response from `List`: TokenListResponse
fmt.Fprintf(os.Stdout, "Response from `UploadTokens.List`: %v\n", res)
}| Name | Type | Description | Notes |
|---|---|---|---|
| sortBy | string | 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 ISO-8601 format. | |
| sortOrder | string | Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. | |
| currentPage | int32 | Choose the number of search results to return per page. Minimum value: 1 | [default to 1] |
| pageSize | int32 | Results per page. Allowed values 1-100, default is 25. | [default to 25] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetToken(uploadToken string) (*UploadToken, error)
GetTokenWithContext(ctx context.Context, uploadToken string) (*UploadToken, error)
Show upload token
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_TOKEN").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOU_SANDBOX_API_TOKEN").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\n", err)
}
// response from `GetToken`: UploadToken
fmt.Fprintf(os.Stdout, "Response from `UploadTokens.GetToken`: %v\n", res)
}| Name | Type | Description | Notes |
|---|---|---|---|
| uploadToken | string | The unique identifier for the token you want information about. |
| Name | Type | Description | Notes |
|---|
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateToken(tokenCreationPayload TokenCreationPayload) (*UploadToken, error)
CreateTokenWithContext(ctx context.Context, tokenCreationPayload TokenCreationPayload) (*UploadToken, error)
Generate an upload token
package main
import (
"context"
"fmt"
"os"
apivideosdk "github.com/apivideo/api.video-go-client"
)
func main() {
client := apivideosdk.ClientBuilder("YOUR_API_TOKEN").Build()
// if you rather like to use the sandbox environment:
// client := apivideosdk.SandboxClientBuilder("YOU_SANDBOX_API_TOKEN").Build()
tokenCreationPayload := *apivideosdk.NewTokenCreationPayload() // TokenCreationPayload |
res, err := client.UploadTokens.CreateToken(tokenCreationPayload)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UploadTokens.CreateToken``: %v\n", err)
}
// response from `CreateToken`: UploadToken
fmt.Fprintf(os.Stdout, "Response from `UploadTokens.CreateToken`: %v\n", res)
}| Name | Type | Description | Notes |
|---|---|---|---|
| tokenCreationPayload | TokenCreationPayload |
[Back to top] [Back to API list] [Back to Model list] [Back to README]