Skip to content
calternal docs

Move Files items

POST
/api/v1/files/move
curl --request POST \
  --url https://example.com/api/v1/files/move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "destination": "example", "paths": [ "example" ], "replace": true }'

Requires a signed-in User with the data scope, read access to each source and write access to the destination. It returns 400 for invalid input, 403 when access is denied, 404 when a source is missing, or 507 when storage is unavailable. Route: /api/v1/files/move. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
destination
required
string
paths
required
Array<string>
replace
boolean
Examplegenerated
{
  "destination": "example",
  "paths": [
    "example"
  ],
  "replace": true
}

Responses

Section titled “Responses”

204

Section titled “204”

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

507

Section titled “507”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}