Skip to content
Console
On this page

Remove file on a lease

Removes one file or directory tree in the lease.

Removes one file or directory tree in the lease.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:removeFile
  • Scope sandboxes:exec
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection leases

Request

FieldTypeWhat it is
namestringThe name of the lease. Required.
pathstringThe absolute path in the guest. Required.

Response

The call answers with an empty object.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:removeFile" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"…"}'