Skip to content

Device Upload API

Jim Lake edited this page Jul 9, 2025 · 2 revisions

Device Upload endpoints for API usage.

API Endpoint

All calls are made on the standard api endpoint:

https://api-prod.maxloapi.com

Post Upload

Get upload parameters for a list of files.

POST /device/1/media_grant/:media_grant_id/upload

Request Authentication

device_session_key - string - provided in query string or body

Request Path

media_grant_id - string - The media grant ID.

Request Body

file_list - array of object - Array of files to upload.

  • file_hash - string - The hash of the file.

  • file_size - number - The size of the file.

Responses

200 OK

upload_list - array of object - Array of upload information.

  • file_hash - string - The hash of the file.

  • file_size - number - The size of the file.

  • skip_upload - boolean - (optional) The file is already uploaded or not required.

  • signed_opts - object - (optional) Signed options to upload the file.

    • host - string - Host for the upload

    • method - string - Method for the upload

    • path - string - Path for the upload

    • url - string - Complete url for the upload

    • headers - object - Key value object of headers to include in the upload.

  • s3_bucket_id - number - (optional) Bucket ID for the upload.

upload_disabled - boolean - (optional) Uploads to this bucket are disabled by policy. upload_list will be empty if this is true.

Post S3 Object

Registers an S3 object with the system. This is typically called after a file has been successfully uploaded to S3.

POST /device/1/media_grant/:media_grant_id/s3_object

Request Authentication

device_session_key - string - provided in query string or body

Request Path

media_grant_id - string - The media grant ID.

Request Body

s3_bucket_id - number - The ID of the S3 bucket where the object was uploaded.

file_hash - string - The hash of the file.

file_size - number - The size of the file.

Responses

200 OK

Object registered successfully.

400 Bad Request

Missing or invalid parameters.

Clone this wiki locally