Compute

Update a Scalix Run service.

Updates a Scalix Run service (e.g. scaling) and returns the new state.

put/v1/run/services/{id}

Request

Base URL: https://api.scalix.world
URL: https://api.scalix.world/v1/run/services/{id}
Auth: HTTP bearer

Path parameters

idstring required

Service id

Request body

image_refstring nullable

envobject nullable

memory_mbinteger nullable

vcpusinteger nullable

min_instancesinteger nullable

max_instancesinteger nullable

target_concurrencyinteger nullable

scale_down_delay_secsinteger nullable

health_check_pathstring nullable

timeout_secsinteger nullable

rollout_strategystring nullable

Strategy for the rollout this update triggers.

rollout_stagesobject nullable

Canary stages, e.g. [{"pct":10,"soak_secs":60}].

ready_thresholdinteger nullable

Instances that must pass the probe before the revision is promoted.

gate_deadline_secsinteger nullable

Seconds the new revision has to pass its readiness gate before it is rolled back to the previous revision. Raise it for apps with a slow cold start (model loading, large runtimes) - a revision that boots fine but warms up slowly is otherwise reverted, leaving the older revision serving with its own resource settings.

Example request

{
  "memory_mb": 512,
  "rollout_strategy": "health_gated",
  "ready_threshold": 3,
  "gate_deadline_secs": 300
}

Response

Service updated

Changes

No recorded changes to this operation across all 1 revision of this API.