Stacks

List all stacks

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

get/api/stacks

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

Changed in 2 of the 36 revisions of this API.24

    • removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 401

      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

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

      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 401

      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