File
File Storage Management API.
The File Storage Management API provides a way to store and retrieve files for devices and apps.
Get
Get a file.
Endpoint
HTTP
POST /file/getAuthorized User Role
viewRequest Body
| Field | Type | Required | Notes |
|---|---|---|---|
| filename | string | yes | Desired file pathname. |
| accountId | string | App Account ID. |
Response
File data.
GetSignedUrl
Get a signed URL to upload or download a file for the device.
Endpoint
HTTP
POST /file/getSignedUrlAuthorized User Role
viewRequest Body
| Field | Type | Notes |
|---|---|---|
| accountId | string | App Account ID. |
| command | string | File command to execute (get/put/delete). |
| filename | string | File name. |
| mimeType | string | MIME type. |
| size | number | File size in bytes. |
Response
A signed URL string.
List
Get a list of matching files filtered by matching properties.
Endpoint
HTTP
POST /file/listAuthorized User Role
viewRequest Body
| Field | Type |
|---|---|
| * | any |
Response
TBD.
Put
Put a file to storage.
Endpoint
HTTP
POST /file/putAuthorized User Role
editRequest Body
| Field | Type | Notes |
|---|---|---|
| filename | string | File name. |
| mimeType | string | MIME type. |
| data | string | File data in base64 format. |
Response
TBD.
Remove
Remove a file.
Endpoint
HTTP
POST /file/removeAuthorized User Role
viewRequest Body
| Field | Type |
|---|---|
| * | any |