github.com/muxinc/mux-go@v1.1.1/docs/DirectUploadsApi.md (about)

     1  # \DirectUploadsApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CancelDirectUpload**](DirectUploadsApi.md#CancelDirectUpload) | **Put** /video/v1/uploads/{UPLOAD_ID}/cancel | Cancel a direct upload
     8  [**CreateDirectUpload**](DirectUploadsApi.md#CreateDirectUpload) | **Post** /video/v1/uploads | Create a new direct upload URL
     9  [**GetDirectUpload**](DirectUploadsApi.md#GetDirectUpload) | **Get** /video/v1/uploads/{UPLOAD_ID} | Retrieve a single direct upload's info
    10  [**ListDirectUploads**](DirectUploadsApi.md#ListDirectUploads) | **Get** /video/v1/uploads | List direct uploads
    11  
    12  
    13  # **CancelDirectUpload**
    14  > UploadResponse CancelDirectUpload(ctx, uPLOADID)
    15  Cancel a direct upload
    16  
    17  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. 
    18  
    19  ### Required Parameters
    20  
    21  Name | Type | Description  | Notes
    22  ------------- | ------------- | ------------- | -------------
    23   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    24    **uPLOADID** | **string**| ID of the Upload | 
    25  
    26  ### Return type
    27  
    28  [**UploadResponse**](UploadResponse.md)
    29  
    30  ### Authorization
    31  
    32  [accessToken](../README.md#accessToken)
    33  
    34  ### HTTP request headers
    35  
    36   - **Content-Type**: Not defined
    37   - **Accept**: application/json
    38  
    39  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    40  
    41  # **CreateDirectUpload**
    42  > UploadResponse CreateDirectUpload(ctx, createUploadRequest)
    43  Create a new direct upload URL
    44  
    45  ### Required Parameters
    46  
    47  Name | Type | Description  | Notes
    48  ------------- | ------------- | ------------- | -------------
    49   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    50    **createUploadRequest** | [**CreateUploadRequest**](CreateUploadRequest.md)|  | 
    51  
    52  ### Return type
    53  
    54  [**UploadResponse**](UploadResponse.md)
    55  
    56  ### Authorization
    57  
    58  [accessToken](../README.md#accessToken)
    59  
    60  ### HTTP request headers
    61  
    62   - **Content-Type**: application/json
    63   - **Accept**: application/json
    64  
    65  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    66  
    67  # **GetDirectUpload**
    68  > UploadResponse GetDirectUpload(ctx, uPLOADID)
    69  Retrieve a single direct upload's info
    70  
    71  ### Required Parameters
    72  
    73  Name | Type | Description  | Notes
    74  ------------- | ------------- | ------------- | -------------
    75   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    76    **uPLOADID** | **string**| ID of the Upload | 
    77  
    78  ### Return type
    79  
    80  [**UploadResponse**](UploadResponse.md)
    81  
    82  ### Authorization
    83  
    84  [accessToken](../README.md#accessToken)
    85  
    86  ### HTTP request headers
    87  
    88   - **Content-Type**: Not defined
    89   - **Accept**: application/json
    90  
    91  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    92  
    93  # **ListDirectUploads**
    94  > ListUploadsResponse ListDirectUploads(ctx, optional)
    95  List direct uploads
    96  
    97  ### Required Parameters
    98  
    99  Name | Type | Description  | Notes
   100  ------------- | ------------- | ------------- | -------------
   101   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   102   **optional** | ***ListDirectUploadsOpts** | optional parameters | nil if no parameters
   103  
   104  ### Optional Parameters
   105  Optional parameters are passed through a pointer to a ListDirectUploadsOpts struct
   106  
   107  Name | Type | Description  | Notes
   108  ------------- | ------------- | ------------- | -------------
   109   **limit** | **optional.Int32**| Number of items to include in the response | [default to 25]
   110   **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
   111  
   112  ### Return type
   113  
   114  [**ListUploadsResponse**](ListUploadsResponse.md)
   115  
   116  ### Authorization
   117  
   118  [accessToken](../README.md#accessToken)
   119  
   120  ### HTTP request headers
   121  
   122   - **Content-Type**: Not defined
   123   - **Accept**: application/json
   124  
   125  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   126