STstudio-saelix
Stacks

List all stacks

Changed on

Returns an array of stack directory names on the target node.

get/api/stacks

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/stacks
  • Auth
    HTTP bearer

Query parameters

nodeIdinteger
Example:1

Target a specific node by ID (alternative to x-node-id header).

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 stack names.

string[] required

Example response

[
  "traefik",
  "portainer",
  "monitoring"
]

Changes

  • d58cf9d6195bRevision changes
    • info

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

    • info

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

  • 7464894ea582Revision changes
    • warning

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

    • warning

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

    • info

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

    • info

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