deployment_service_scale

Tool

deployment_service_scale

Scale a service to N replicas without redeploy (min 0 = stop)

Behavior

HTTP: POST /deployment/services/:id/scale

Arguments

Name	Type	Required	Description
id	string	•	No description in the catalog.
replicas	integer	•	No description in the catalog.

Response

Field	Type	Always	Description
id	string	•
mode	string	—
name	string	•
slug	string	•
memory	object	—	Memory of the running version. Absent for static sites and when it could not be read.
probes	object	•
source	string	•
command	string	—
lastRun	object	—
tracing	string	—
replicas	integer	•
schedule	string	—
createdAt	string	•
dependsOn	array	•
nextRunAt	string	—
resources	object	—
updatedAt	string	•
autoDeploy	boolean	—
sleepState	string	•
idleMinutes	integer	•
scaleToZero	boolean	•
publicDomain	boolean	—
appliedProbes	object	—	Probes of the version running now: what the serving deployment rendered (the Active one, or the Crashed one while it crash-loops). null when no deployment runs, or when they could not be read (appliedProbesUnknown). A change to probes reaches it only through a deploy. To apply pendingProbes now, deploy the service, or roll back to its current Active deployment (same image, fresh render).
containerPort	integer	•
environmentId	string	•
jobTimeoutSec	integer	—
pendingProbes	object	—	Probes the next deploy of this service will apply, from its current settings and defaults. Absent for static and scheduled services.
jobConcurrency	string	—
buildMachineType	string	—
sourceConnection	object	—
startupAutomatic	boolean	—	True when appliedProbes.startup is the automatic startup probe (added for a liveness-only service), not the service's own probes.startup.
scheduleSuspended	boolean	—
suspendedByBilling	boolean	—
lastReplicasRunning	integer	•
appliedProbesUnknown	boolean	—	True when a deployment runs but its probes could not be read; appliedProbes is then null. The next deploy records them.
probesPendingRedeploy	boolean	—	True when pendingProbes differ from appliedProbes: the running version does not have them yet. To apply pendingProbes now, deploy the service, or roll back to its current Active deployment (same image, fresh render). False when no deployment runs or appliedProbes are unknown.
scaleToZeroEligibility	object	—
pendingStartupAutomatic	boolean	—	True when pendingProbes.startup is the automatic startup probe.

Try it

Scale a service to N replicas without redeploy (min 0 = stop).

When to use

Scale a service to N replicas without redeploy (min 0 = stop)

Example

Ask your agent something like this:

Scale a service to N replicas without redeploy (min 0 = stop).

The agent will invoke deployment_service_scale with these arguments:

{
  "id": "<id>",
  "replicas": "<replicas>"
}