Sign in
Stacks

List stack services

Returns the service names defined in the stack's compose file.

get/api/stacks/{stackName}/services

Path parameters

stackNamestring required
Example:my-stack

Stack directory name. Must match ^[a-zA-Z0-9_-]+$ (alphanumeric characters, hyphens, and underscores only). Returns 400 Invalid stack name if the name contains path separators, dots, spaces, or other special characters.

Headers

x-node-idinteger
Example:1

Target a specific node by ID. If omitted, the default node is used. Can also be passed as ?nodeId= query parameter.

Response

Array of service names.

string[] required

Example response

[
  "web",
  "db",
  "redis"
]

Changes

Changed in 3 of the 36 revisions of this API.124

  • d58cf9d6195b2See the full diff
    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • 7464894ea58222See the full diff
    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • c62bbceae8241See the full diff
    • ▲

      added the pattern ^[a-zA-Z0-9_-]+$ to the path request parameter stackName

      request-parameter-pattern-added