Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Path Parameters

id
string
required

UUID of file to create

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

entry_id
string
required

UUID of the silo entry.

Body

application/json
name
string
required

Name of the file.

Example:

"invoice.pdf"

category
string

Category of the file.

Example:

"format"

data
string<byte>

Base64 encoded binary data. Optional - if not provided, sha256, size, and mime are required.

desc
string

Description of the file.

Example:

"Invoice for January 2021."

embeddable
boolean

When true, this file may be embedded inside other files, like PDFs. Default is false.

Example:

true

key
string

Key used to identify the file in the entry.

Example:

"pdf"

meta
Meta · object

Any additional meta data about the file.

mime
string

MIME type of the file. Required when data is not provided.

Example:

"application/pdf"

private
boolean

When true, this file is private and can only be accessed by the owner. Default is false.

Example:

true

sha256
string

SHA256 hex hash of the file. Required when data is not provided.

Example:

"27a0b656df99dc32124b4c49f2f3c35025f0a7453f289cbaa0701435cfcf4e28"

size
integer

Size of the file in bytes. Required when data is not provided.

Example:

12345

Response

200 - application/json

OK

category
string

Category of the file.

Example:

"version"

created_at
string

The date and time this file was created.

Example:

"2018-01-01T00:00:00.000Z"

desc
string

Description of the file.

Example:

"Invoice for January 2021."

embeddable
boolean

When true, the file can be embedded inside another file, like a PDF.

Example:

true

entry_id
string

The UUID of the entry this file belongs to.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

hash
string

SHA256 hash of the file.

Example:

"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6"

id
string

The UUID that identifies the file in the entry.

key
string

Key used to identify the file by the service or app that generated it.

Example:

"pdf"

meta
Meta · object

Any additional meta data about the file.

mime
string

MIME type of the file.

Example:

"application/pdf"

name
string

Name of the file.

Example:

"invoice.pdf"

previous
Previous · object[]

Set of previous versions of the file.

private
boolean

When true, the file will not have a public link.

size
integer

Size of the file in bytes.

Example:

12345

stored
boolean

When true, indicates that the file's contents have been uploaded successfully.

Example:

true

url
string

URL where the file's contents can be downloaded.