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
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | • | No description in the catalog. |
| mode | string | — | No description in the catalog. |
| name | string | — | No description in the catalog. |
| probes | object | — | No description in the catalog. |
| source | object | — | No description in the catalog. |
| command | string | — | Shell 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. |
| tracing | string | — | OTel 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. |
| replicas | integer | — | No description in the catalog. |
| schedule | string | — | Five-field UTC cron expression (minute hour day-of-month month day-of-week), or null for a scheduled service with no schedule yet. |
| resources | object | — | No description in the catalog. |
| autoDeploy | boolean | — | Whether 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. |
| idleMinutes | integer | — | No description in the catalog. |
| scaleToZero | boolean | — | No description in the catalog. |
| containerPort | integer | — | No description in the catalog. |
| jobTimeoutSec | integer | — | Wall-clock budget for one run, in seconds (60..86400). Becomes the Job activeDeadlineSeconds — an overrunning run is killed, not left going. |
| jobConcurrency | string | — | What 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). |
| buildMachineType | string | — | No description in the catalog. |
| scheduleSuspended | boolean | — | Pause or resume a scheduled service without losing its schedule. |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| id | string | • | |
| mode | string | — | |
| name | string | • | |
| slug | string | • | |
| probes | object | • | |
| source | object | • | |
| 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 | • | |
| containerPort | integer | • | |
| environmentId | string | • | |
| jobTimeoutSec | integer | — | |
| jobConcurrency | string | — | |
| buildMachineType | string | — | |
| scheduleSuspended | boolean | — | |
| suspendedByBilling | boolean | — | |
| lastReplicasRunning | integer | • | |
| scaleToZeroEligibility | object | — |
Try it
Update service fields.