Remove - Byteport

POST

remove

curl -X POST https://api.byteport.com/remove \
  -H "Authorization: Bearer bp_xxxxxxxxx" \
  -H "User-Agent: my-app/1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "Dropbox/tmp/*"
  }'

{
  "id": "trf_01HZ...",
  "status": "queued"
}

Remove a file or folder. Removed paths are unrecoverable — preview first with Preview if you want to dry-run the request.

Body parameters

path

string | string[]

required

Source location path.A valid file or folder path begins with the location, followed by a path relative to the root directory. To remove multiple files, submit a string array. Regex supported.Examples

"Production Bucket/archives/2026-04-21"
"Dropbox/*"

Example

curl -X POST https://api.byteport.com/remove \
  -H "Authorization: Bearer bp_xxxxxxxxx" \
  -H "User-Agent: my-app/1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "Dropbox/tmp/*"
  }'

{
  "id": "trf_01HZ...",
  "status": "queued"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

path

required

Source location path. Regex supported.

Response

Remove accepted

string

Identifier for the transfer.

status

enum<string>

Available options:

queued,

running,

complete

Pull

List Objects

curl -X POST https://api.byteport.com/remove \
  -H "Authorization: Bearer bp_xxxxxxxxx" \
  -H "User-Agent: my-app/1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "Dropbox/tmp/*"
  }'

{
  "id": "trf_01HZ...",
  "status": "queued"
}

​Body parameters

​Example

Authorizations

Body

Response

Body parameters

Example