Skip to main content
POST
Change a deployed container service: new image (rolling deploy), size, environment, or scaling bounds

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
cluster
string
required

Cluster name

Required string length: 1 - 255
service
string
required

Service name

Required string length: 1 - 255
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)

image
string
Required string length: 1 - 500
cpu
enum<string>
Available options:
256,
512,
1024,
2048,
4096
memory
enum<string>

Change together with cpu

Available options:
512,
1024,
2048,
4096,
8192,
16384
healthCheckPath
string
Required string length: 1 - 255
Pattern: ^\/[^\s]*$
environment
object[]

Replaces the current variables

Maximum array length: 64
command
string[]
Maximum array length: 64
Required string length: 1 - 1024
minTasks
integer
Required range: 0 <= x <= 100
maxTasks
integer
Required range: 1 <= x <= 1000
scalingMetric
enum<string>
Available options:
AVERAGE_CPU,
AVERAGE_MEMORY,
REQUEST_COUNT_PER_TARGET
scalingTarget
number
Required range: 1 <= x <= 100000

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