Skip to main content
POST
Create a managed deployment

Authorizations

x-api-key
string
header
required

Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.

Body

application/json
name
string
required
Required string length: 1 - 80
domainName
string
required
Maximum string length: 200
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
ownerEmail
string<email>
required
Maximum string length: 254
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
provider
string
required
Allowed value: "aws"
target
object
required
size
string
default:small
Allowed value: "small"

Response

Create a managed deployment

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
provider
enum<string>
required
Available options:
aws,
azure,
gcp
target
object
required
domainName
string
required
ownerEmail
string
required
size
string
required
Allowed value: "small"
updateMode
string
required
Allowed value: "approval"
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
webUrl
string<uri>
required
consoleUrl
string<uri>
required
installedVersion
string | null
required
Maximum string length: 80
Pattern: ^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$
availableVersion
string | null
required
Maximum string length: 80
Pattern: ^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$
updateAvailable
boolean
required
health
object
required
run
object | null
required