Delete File

POST

/api/v1/files/delete

curl --request POST \
  --url https://aura.strangeworks.com/api/v1/files/delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deployment_name": "example", "path": "example", "project_id": "example", "recursive": false, "snapshot_id": "example", "source": "deployment" }'

• Production

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

FileDeleteRequest

object

deployment_name

Any of:

string

string

null

null

path

required

Path

string

>= 1 characters

project_id

Any of:

string

string

null

null

recursive

Recursive

boolean

snapshot_id

Any of:

string

string

null

null

source

required

Source

string

Allowed values: deployment workspace snapshot

Responses

200

Successful Response

Media typeapplication/json

DeleteResponse

object

deleted

required

Deleted

integer

Example^generated

{
  "deleted": 1
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}