Skip to main content
POST
Move project file

Authorizations

Authorization
string
header
required

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

Path Parameters

project_reference
string
required

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

Query Parameters

ref
string

Mutable content to address: main or branch:. Omit for main. Release and environment selectors return 400. Supplied aliases must name the same content.

Example:

"branch:feature-x"

branch
string

Branch name or ID; legacy alias for ref=branch:. Supplied aliases must agree.

branch_id
string<uuid>

Branch UUID; legacy alias for ref=branch:. Supplied aliases must agree.

Body

application/json
source_path
string
required

Current file path

destination_path
string
required

New file path

expected_version_id
string

Expected current source file version ID. Omission disables this guard; a stale version returns 409.

Response

File moved successfully

source_path
string
required

Original source path supplied by the caller.

destination_path
string
required

Destination path supplied by the caller.

success
boolean
required

True after completing the move.

file_id
string

Destination file ID when supplied by the store; IDs depend on project and normalized path.