Sign in
Files

Upload File From Url

Changed on

Upload a file to the project from a URL.

If name is ommitted in the request payload, the file name will be extracted from the response Content-Disposition header if available or otherwise it will be derived from the URL path.

If providing the name in the request payload, always suffix the file extension in the name if available.

put/api/v1/files/upload_from_url

Request

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

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

namestring nullable

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

urlstring uri required

URL of the file to download

proxy_urlstring uri nullable

URL of the proxy server to use for downloading the file

request_headersobject nullable

Headers to include in the request when downloading the file

verify_sslboolean

Whether to verify the SSL certificate when downloading the file

follow_redirectsboolean

Whether to follow redirects when downloading the file

resource_infoobject nullable

Resource information for the file

Response

Successful Response

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring required
external_file_idstring nullable

The ID of the file in the external system

file_sizeinteger nullable

Size of the file in bytes

file_typestring nullable

File type (e.g. pdf, docx, etc.)

project_idstring uuid required

The ID of the project that the file belongs to

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

Changes

  • 07b7155e4e0eRevision changes
    • ▲

      the response property became optional for the status

    • ▲

      response property external_file_id list-of-types was widened by adding types null to media type application/json of response 200