Skip to main content
For Bring Your Own Infrastructure, each organization has one or more deployment targets — AWS accounts it deploys apps into. synthetiq infra provision registers a target here after provisioning the account; deploys resolve an app’s target to know which account, role, and domain to use. An organization can hold multiple targets (e.g. a shared target plus a dedicated BYOI one); one is the default. Each production app pins to a target. Node SDK: sdk.awsConfig.*. See Node SDK.

List deployment targets

GET /api/organizations/{id}/aws-config
Returns the organization’s deployment targets:
{ "configs": [ { "aws_account_id": "…", "domain": "…", "status": "ready", "is_default": true, "…": "…" } ] }
Authentication: Organization member.

Register / update a deployment target

PUT /api/organizations/{id}/aws-config
Upserts a target keyed on (organization, aws_account_id). Called by synthetiq infra provision once the AWS account is provisioned. Only the deploy key hash is sent — the raw key never leaves the customer account.
ParameterTypeDescription
aws_account_idbodyTarget AWS account id
deploy_role_arnbodyRole the deploy pipeline assumes
deploy_api_key_hashbodyHash of the in-account deploy key
domainbodyBase domain for apps (e.g. apps.acme.com)
cert_arnbodyCloudFront (CDN) ACM certificate ARN
api_cert_arnbodyALB (API) ACM certificate ARN
db_flavorbodyDatabase flavor for new apps (e.g. aws-serverless-rds)
provision_configbodySnapshot of the synthetiq.yaml used, for audit
statusbodyready once all required fields are present
A target becomes the org default when it first reaches ready and no default exists. Authentication: Organization member + infra:provision scope (token: platform:infra:write).

See also