deployment_service_get

Tool

deployment_service_get

Get a single service by id.

Get a single service by id. A scheduled service (mode:'scheduled') also reports nextRunAt and lastRun — when it fires next and how its most recent run ended. publicDomain says whether this service holds its public auto-domain; false means it is reachable only through a custom domain or from inside the environment. A git or static source with a GitHub connector also carries sourceConnection.state: 'connected' (the connection is working), 'unavailable' (removed, detached, replaced by a reconnect, or not working — call deployment_vcs_connection_list with repoFullName to see which connections can read the repo, then deployment_service_update with the new connectorId) or 'unknown' (the connection list could not be fetched; the read still succeeds). Reading never contacts GitHub and never changes the source; source.autoDeploy sits next to it. A git source may report source.build.secrets: names only; variable values are never returned. appliedProbes are the probes of the version running now; pendingProbes are what the next deploy applies; probesPendingRedeploy is true when they differ. To apply them now, deploy the service, or roll back to its current Active deployment (same image, fresh render). appliedProbes is null when nothing runs, or with appliedProbesUnknown when they could not be read.

Behavior

HTTP: GET /deployment/services/:id

Arguments

Name	Type	Required	Description
id	string	•	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

Get a single service by id.

When to use

Example

Ask your agent something like this:

Get a single service by id.

The agent will invoke deployment_service_get with these arguments:

{
  "id": "<id>"
}