API ReferenceEnvironments

Create Aws environment

Creates an environment and queues provisioning. HTTP 201 does not mean infrastructure is ready. Inspect the environment and jobs for completion.

Requires every scope: environments:write.

Authentication

AuthorizationBearer

JWT returned by POST /api/auth/token-exchange. Amazon and authorization invitations require API-key-derived tokens.

Request

This endpoint expects an object.
environmentNamestringRequired>=3 characters
awsRegionstringRequired>=3 characters
awsAccessKeyIdstringRequired>=16 characters
awsSecretAccessKeystringRequired>=16 characters
templateIdstringOptionalDefaults to aws-environment-base
deploymentPatternenumOptionalDefaults to aws-ecs-express
awsAccountIdstringOptionalformat: "^\d{12}$"

Optional 12-digit account ID; whitespace is trimmed.

customDomainstringOptional
tlsCertificateArnstringOptional
enableWafbooleanOptional
enableCloudFrontbooleanOptional
parametersmap from strings to strings or doubles or booleansOptional

Response

Success
environmentIdinteger
jobIdinteger
messagestringOptional
resourceGroupstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error