Skip to content

deployment_service_update

Update service fields.

Tool

deployment_service_update

Update service fields.

Update service fields. mode is immutable. On a scheduled service (mode:'scheduled') you may change schedule (five-field UTC cron, or null to leave it on demand only), command, jobTimeoutSec, jobConcurrency ('forbid' | 'allow' | 'replace'), and scheduleSuspended, which pauses or resumes the schedule without losing it.

Behavior

HTTP
PATCH /deployment/services/:id

Arguments

NameTypeRequiredDescription
idstringNo description in the catalog.
modestringNo description in the catalog.
namestringNo description in the catalog.
probesobjectNo description in the catalog.
sourceobjectNo description in the catalog.
commandstringShell command a scheduled run executes (`/bin/sh -c <command>`). Scheduled services only; omit it to run the image entrypoint. `null` clears a command that was set and returns the run to the image entrypoint.
tracingstringOTel SDK to inject into this service's pods: 'off' (none), 'node' or 'python'. Read when a deploy builds the workload — takes effect on the next deploy, running pods are untouched.
replicasintegerNo description in the catalog.
schedulestringFive-field UTC cron expression (minute hour day-of-month month day-of-week), or null for a scheduled service with no schedule yet.
resourcesobjectNo description in the catalog.
autoDeploybooleanWhether a push to this service's repo+branch queues a deploy. Default true. Turning it off suppresses push-triggered deploys only — manual and API-triggered deploys still work. Applies to git and static sources alike; the UI toggle is currently git-only, so a static service is switched through this field.
idleMinutesintegerNo description in the catalog.
scaleToZerobooleanNo description in the catalog.
containerPortintegerNo description in the catalog.
jobTimeoutSecintegerWall-clock budget for one run, in seconds (60..86400). Becomes the Job activeDeadlineSeconds — an overrunning run is killed, not left going.
jobConcurrencystringWhat happens when a run is still going at the next tick: 'forbid' (skip the tick), 'allow' (run in parallel) or 'replace' (kill the running one).
buildMachineTypestringNo description in the catalog.
scheduleSuspendedbooleanPause or resume a scheduled service without losing its schedule.

Response

FieldTypeAlwaysDescription
idstring
modestring
namestring
slugstring
probesobject
sourceobject
commandstring
lastRunobject
tracingstring
replicasinteger
schedulestring
createdAtstring
dependsOnarray
nextRunAtstring
resourcesobject
updatedAtstring
autoDeployboolean
sleepStatestring
idleMinutesinteger
scaleToZeroboolean
containerPortinteger
environmentIdstring
jobTimeoutSecinteger
jobConcurrencystring
buildMachineTypestring
scheduleSuspendedboolean
suspendedByBillingboolean
lastReplicasRunninginteger
scaleToZeroEligibilityobject

Try it

Update service fields.

When to use

Update service fields. mode is immutable. On a scheduled service (mode:'scheduled') you may change schedule (five-field UTC cron, or null to leave it on demand only), command, jobTimeoutSec, jobConcurrency ('forbid' | 'allow' | 'replace'), and scheduleSuspended, which pauses or resumes the schedule without losing it.

Example

Ask your agent something like this:

Update service fields.

The agent will invoke deployment_service_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect