Files

Generate Presigned Url

Create a presigned url for uploading a file.

The presigned url is valid for a limited time period, after which it will expire. Be careful on accidental exposure of the presigned url, as it may allow unauthorized access to the file before the expiration.

put/api/v1/files

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

expires_at_secondsinteger nullable
project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

namestring required

Name that will be used for created file. If possible, always include the file extension in the name.

external_file_idstring nullable

The ID of the file in the external system

file_sizeinteger nullable

Size of the file in bytes

last_modified_atstring date-time nullable

The last modified time of the file

resource_infoobject nullable

Resource information for the file

permission_infoobject nullable

Permission information for the file

data_source_idstring uuid nullable

The ID of the data source that the file belongs to

Response

Successful Response

urlstring uri required

A presigned URL for IO operations against a private file

expires_atstring date-time required

The time at which the presigned URL expires

form_fieldsobject nullable

Form fields for a presigned POST request

file_idstring uuid required

The ID of the file associated with the presigned URL

Changes

No recorded changes to this operation across all 6 revisions of this API.