Skip to content
Nexa Platform Docs

Delete workspace objects

POST
/api/v1/workspace/delete
curl --request POST \
  --url https://example.com/api/v1/workspace/delete \
  --header 'Content-Type: application/json' \
  --data '{ "path": "example", "recursive": true }'

Delete workspace objects.

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceDeleteRequest

Request model for deleting workspace objects.

object
path
required
Path

Path to delete

string
recursive
Recursive

Delete recursively

boolean
default: true

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceOperationResponse

Response model for workspace operations.

object
success
required
Success

Operation success status

boolean
message
required
Message

Operation result message

string
path
required
Path

Path that was operated on

string
Examplegenerated
{
  "success": true,
  "message": "example",
  "path": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}