Skip to content

Destroy Deployment

POST
/deployments/{deployment_id}/destroy

Accept the destroy and queue it (202), the failure-path recovery and the demo teardown. Destroying carries the same approval gate as apply (deployment.approve + requester != approver, s12 D2). Emits deployment.destroy.started with the accept and deployment.destroy.completed when the run finishes.

deployment_id
required
Deployment Id
string format: uuid
st_session
Any of:
string

Successful Response

DeploymentDetail
object
active_job
Any of:
string
approved_by
required
Any of:
string
connection_id
required
Connection Id
string format: uuid
created_at
required
Created At
string format: date-time
data_classification
required
Data Classification
string
id
required
Id
string format: uuid
job_progress
Any of:
object
key
additional properties
string
links
Links
Array<object>
default:
DeploymentLinkRecord

One blueprint link as seen from THIS deployment: role is the side this deployment plays; other_* describe the deployment at the other end.

object
id
required
Id
string format: uuid
kind
required
Kind
string
other_deployment_id
required
Other Deployment Id
string format: uuid
other_name
required
Other Name
string
other_template_name
required
Other Template Name
string
role
required
Role
string
Allowed values: source target
wired
required
Wired
boolean
logs
required
Logs
string
params
required
Params
object
key
additional properties
any
plan_summary
required
Any of:
PlanSummary
object
counts
required
Counts
object
key
additional properties
integer
resources
required
Resources
Array<object>
PlanResource
object
action
required
Action
string
address
required
Address
string
name
required
Name
string
type
required
Type
string
status
required
Status
string
template_name
required
Template Name
string
template_version
required
Template Version
string
tenant_aws_account_id
Any of:
string format: uuid
tenant_id
required
Tenant Id
string format: uuid
updated_at
required
Updated At
string format: date-time

Validation Error

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