Skip to content

deployment_service_list

List services within an environment.

Tool

deployment_service_list

List services within an environment.

List services within an environment. Each entry carries publicDomain — false for a service that holds no public auto-domain. 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/environments/:environmentId/services

Arguments

Name
Type
Required
Description
environmentId
string
•
No description in the catalog.

Try it

List services within an environment.

When to use

List services within an environment. Each entry carries publicDomain — false for a service that holds no public auto-domain. 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.

Example

Ask your agent something like this:

List services within an environment.

The agent will invoke deployment_service_list with these arguments:

{
  "environmentId": "<environmentId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select