Skip to content

Revise Deployment

POST
/deployments/{deployment_id}/revise

Accept a revision of an applied sftp/v1 deployment and queue a fresh plan (202), the deployment-revision lifecycle (ADR-0027, revised). Add transfer partners (sftp_users, each optionally routed to a destination), add allowed CIDRs, and add ADDITIONAL wired S3 destination buckets; the primary bucket, endpoint_name, and vpc_id are immutable, so a revision is never destructive. The revision re-plans the same deployment; poll GET /deployments/{id} for the plan, then approve to apply the exact reviewed artifact.

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

Revise an existing sftp/v1 deployment (ADR-0027, revised): the full new params (additive edits, add SFTP users each optionally routed to a destination, add allowed CIDRs) and an optional ADDITIONAL wired S3 destination to add (feeds_into an applied Secure Bucket). Adding a destination is purely additive, the PRIMARY bucket, endpoint_name, and vpc_id are immutable. params validate against the deployment’s template schema; the service enforces the immutable-primary-bucket and additive-only rules and re-plans the same deployment.

object
link
Any of:
DeploymentLinkRequest

One blueprint link created with the deployment (ruling R4). direction “feeds_into”: the NEW deployment is the source feeding the named existing deployment; “fed_by”: the named existing deployment feeds the new one.

object
deployment_id
required
Deployment Id
string format: uuid
direction
required
Direction
string
Allowed values: feeds_into fed_by
params
required
Params
object
key
additional properties
any

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