Skip to content
Aura

Delete Deployment

DELETE
/api/v1/deployments/{name}
curl --request DELETE \
  --url https://aura.strangeworks.com/api/v1/deployments/example \
  --header 'Authorization: Bearer <token>'

Delete a deployment: purge its files, tombstone the row, free the name.

Irreversible — see deployment_service.delete_deployment. Projects seeded from it keep their workspace and their recorded origin; the response reports how many there are rather than refusing on their behalf.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
Name
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
DeploymentDeleteResponse

What the delete removed, and how many projects were seeded from it.

seeded_project_count is reported, not enforced: deletion proceeds regardless, since those projects own their copy of the workspace and only record the handle as frozen provenance.

object
files_deleted
required
Files Deleted
integer
handle
required
Handle
string
seeded_project_count
required
Seeded Project Count
integer
Examplegenerated
{
  "files_deleted": 1,
  "handle": "example",
  "seeded_project_count": 1
}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}