Files are uploaded, updated or deleted via the Records API.
The File API is usually used to fetch/download a file resource (with support for basic image manipulations, like generating thumbs).
Downloads a single file resource (aka. the URL address to the file). Example:
<img src="http://example.com/api/files/demo/1234abcd/test.png" alt="Test image" />
GET
/api/files/
collectionIdOrName/recordId/filenamePath parameters
| Param | Type | Description |
|---|---|---|
| collectionIdOrName | String | ID or name of the collection whose record model contains the file resource. |
| recordId | String | ID of the record model that contains the file resource. |
| filename | String | Name of the file resource. |
Query parameters
| Param | Type | Description |
|---|---|---|
| thumb | String | Get the thumb of the requested file.
The following thumb formats are currently supported:
|
| token | String | Optional file token for granting access to
protected file(s).
For an example, you can check "Files upload and handling". |
| download | Boolean | If it is set to a truthy value (1, t, true) the file will be
served with Content-Disposition: attachment header instructing the browser to
ignore the file preview for pdf, images, videos, etc. and to directly download the file.
|
Responses
[file resource]
{
"code": 400,
"message": "Filesystem initialization failure.",
"data": {}
}
{
"code": 404,
"message": "The requested resource wasn't found.",
"data": {}
}
Generates a short-lived file token for accessing protected file(s).
The client must be admin or auth record authenticated (aka. have regular authorization token sent with the request).
POST
/api/files/token
Requires Authorization: TOKENResponses
{
"token": "..."
}
{
"code": 400,
"message": "Failed to generate file token.",
"data": {}
}