Skip to content

Create Deployment

POST
/deployments

Accept the deployment and queue the plan (202). Poll GET /deployments/{id}: plan_summary fills in when the plan succeeds; a failed plan leaves the record “failed” with the tofu output in its logs.

The viewer gate resolves the tenant with the 404-no-leak rule; creating the deployment then requires deployment.request at that tenant (s12 D2), so a read-only user sees the tenant but cannot deploy into it (named 403). ADR-0023: the create is account-bound, an operator on the connection’s account (additive levels: an account grant, or a raised tenant viewer) creates without a tenant-wide permission; a connection outside the caller’s visibility does not exist.

st_session
Any of:
string
DeploymentCreateRequest

Template selection plus tenant/connection scope. params validates against the blueprint registry’s per-template schema (app/blueprints.py). links (D6: a list, a pipeline needs two) validate against the compatibility matrix in the same accept.

object
connection_id
required
Connection Id
string format: uuid
data_classification
Data Classification
string
default: none
Allowed values: phi pii confidential none
links
Any of:
Array<object>
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
template_name
required
Template Name
string
template_version
required
Template Version
string
tenant_id
required
Tenant Id
string format: uuid

Successful Response

DeploymentRecord
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
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