Skip to main content
POST
Import external file

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Headers

idempotency-key
string

Key of 1-128 characters without whitespace. A retry with the same key and request within 24 hours returns the first result instead of creating another item; the same key with a different request returns 409 conflict.

Required string length: 1 - 128
Pattern: ^\S+$

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

provider
enum<string>
required

External file provider: onedrive, sharepoint or drive (Google Drive).

Available options:
onedrive,
sharepoint,
drive
file_id
string
required

Provider item ID from listExternalFiles. Opaque; percent-encode it. Missing or inaccessible items return not_found.

Required string length: 1 - 1024

Body

application/json
folder_path
string

Destination folder inside project Uploads, relative (no leading /). The Uploads root when omitted.

Minimum string length: 1
timestamp_prefix
boolean

Prefix the stored name with a timestamp to avoid a name conflict. Defaults to false.

visibility
enum<string>

Visibility of the new upload: project, public or private. Omitted, the upload inherits the destination's visibility. Setting it needs upload admin access on the destination, and public a paid plan; a refusal imports nothing.

Available options:
project,
public,
private

Response

The created upload and its source.

upload
object
required
source
object
required