Skip to main content
POST
Deploy a container image as a public HTTPS service (ECS Express Mode: AWS provisions the load balancer, TLS, autoscaling and a *.on.aws URL)

Authorizations

Authorization
string
header
required

A management token: minted by the OAuth flow (aireserve login, or an MCP client's Authenticate step) or on the portal Keys page under Management Keys. Inference API keys are refused.

Body

application/json
image
string
required

Image reference, e.g. ghcr.io/acme/api:1.4 or 123456789012.dkr.ecr.us-east-1.amazonaws.com/api:1.4

Required string length: 1 - 500
clientId
string<uuid>

Target organization id — platform admins only; omit otherwise

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)$
region
string

AWS region (default us-east-1)

name
string

Service name (becomes https://.ecs..on.aws). Default: derived from the image

Required string length: 1 - 32
cluster
string

Existing cluster; omit for the default cluster

Required string length: 1 - 255
containerPort
integer

Port the container listens on (default 8080)

Required range: 1 <= x <= 65535
healthCheckPath
string

HTTP health check path (default /)

Required string length: 1 - 255
Pattern: ^\/[^\s]*$
cpu
enum<string>

Fargate CPU units (default 1024)

Available options:
256,
512,
1024,
2048,
4096
memory
enum<string>

Fargate memory MiB; must pair with cpu (default 2048)

Available options:
512,
1024,
2048,
4096,
8192,
16384
cpuArchitecture
enum<string>

Default X86_64

Available options:
X86_64,
ARM64
command
string[]
Maximum array length: 64
Required string length: 1 - 1024
environment
object[]

Plain environment variables

Maximum array length: 64
secrets
object[]

Secrets Manager / Parameter Store ARNs the container reads at start

Maximum array length: 64
minTasks
integer

Default 1

Required range: 0 <= x <= 100
maxTasks
integer

Default 4

Required range: 1 <= x <= 1000
scalingMetric
enum<string>

Default AVERAGE_CPU

Available options:
AVERAGE_CPU,
AVERAGE_MEMORY,
REQUEST_COUNT_PER_TARGET
scalingTarget
number

Default 60

Required range: 1 <= x <= 100000
repositoryCredentials
string

Secrets Manager ARN with {username,password} for a private registry

Maximum string length: 2048

Response

Executed successfully (ok: true).

status
enum<string>
required
Available options:
executed
ok
boolean
required

Whether the operation succeeded.

summary
string
required

The consent line describing what was done, built from resolved labels.

message
string
required

Human-readable result line.

data
any

Operation payload (reads) or detail worth relaying (writes).

secret
string

A one-time secret the operation minted (API key, credential). Shown once; store it now.

sensitive
enum<boolean>

Present exactly when secret is: redact this response from logs.

Available options:
true