Skip to content

Latest commit

 

History

History
132 lines (82 loc) · 4.61 KB

DirectUploadsApi.md

File metadata and controls

132 lines (82 loc) · 4.61 KB

\DirectUploadsApi

All URIs are relative to https://api.mux.com

Method HTTP request Description
CancelDirectUpload Put /video/v1/uploads/{UPLOAD_ID}/cancel Cancel a direct upload
CreateDirectUpload Post /video/v1/uploads Create a new direct upload URL
GetDirectUpload Get /video/v1/uploads/{UPLOAD_ID} Retrieve a single direct upload's info
ListDirectUploads Get /video/v1/uploads List direct uploads

CancelDirectUpload

UploadResponse CancelDirectUpload(ctx, uPLOADID) Cancel a direct upload

Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this request, no asset will be created. This request will only succeed if the upload is still in the waiting state.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uPLOADID string ID of the Upload

Return type

UploadResponse

Authorization

accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateDirectUpload

UploadResponse CreateDirectUpload(ctx, createUploadRequest) Create a new direct upload URL

Creates a new direct upload, through which video content can be uploaded for ingest to Mux.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createUploadRequest CreateUploadRequest

Return type

UploadResponse

Authorization

accessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDirectUpload

UploadResponse GetDirectUpload(ctx, uPLOADID) Retrieve a single direct upload's info

Fetches information about a single direct upload in the current environment.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uPLOADID string ID of the Upload

Return type

UploadResponse

Authorization

accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListDirectUploads

ListUploadsResponse ListDirectUploads(ctx, optional) List direct uploads

Lists direct uploads in the current environment.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListDirectUploadsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListDirectUploadsOpts struct

Name Type Description Notes
limit optional.Int32 Number of items to include in the response [default to 25]
page optional.Int32 Offset by this many pages, of the size of `limit` [default to 1]

Return type

ListUploadsResponse

Authorization

accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]