Skip to main content

Get a Stack

GET/stacks/{stackId}/
v2
GET
container-get-stack

Request

  • stackIdstring (uuid)
    required

    ID of the Stack to be retrieved.

Responses

application/json

OK

  • descriptionstring
    required
  • disabledboolean
    required
  • idstring (uuid)
    required
  • prefixstring
    required

    Prefix for all service-names in this stack.

  • projectIdstring (uuid)
    required
  • servicesarray of object

    A set of containers that should be started in this stack. The key is relevant for network connectivity between containers, because you can use it as DNS name to resolve this containers from other containers running in the same project (or from managed apps running in the same project).

    • Array[
    • *object
      • deployedStateobject
        required

        The actual state of the container that is currently deployed.

        • commandarray of string

          The container command (equivalent to the Docker cmd). When omitted, this defaults to the command defined in the image.

          • Array[
          • *string
          • ]
        • entrypointarray of string

          The container entrypoint (equivalent to the Docker entrypoint). When omitted, this defaults to the entrypoint defined in the image.

          • Array[
          • *string
          • ]
        • envsobject

          Key-value map of environment variables that should be passed into the container.

          • *string
        • imagestring
          required

          The image to run, in the usual format also used by docker run and docker compose. When the image is pulled from a private registry, make sure to create it first, using the container-create-registry endpoint. The appropriate registry is matched by hostname.

        • portsarray of string

          Exposed ports. Follows the format <public-port>:<container-port>/<protocol>. Exposed ports can be accessed from other containers (or managed apps) within the same project. To expose a port publicly, connect it with an ingress resource.

          • Array[
          • *string
          • ]
        • volumesarray of string

          Volume mounts for this container. These items always follow the format <volume>:<mountpoint>. The <volume> may either be a named volume, or a file path in the (always present) project file system (which is shared among containers and managed apps within a project).

          • Array[
          • *string
          • ]
      • descriptionstring
        required
      • idstring (uuid)
        required
      • pendingStateobject
        required

        The desired state that is waiting to be reconciled.

        • commandarray of string

          The container command (equivalent to the Docker cmd). When omitted, this defaults to the command defined in the image.

          • Array[
          • *string
          • ]
        • entrypointarray of string

          The container entrypoint (equivalent to the Docker entrypoint). When omitted, this defaults to the entrypoint defined in the image.

          • Array[
          • *string
          • ]
        • envsobject

          Key-value map of environment variables that should be passed into the container.

          • *string
        • imagestring
          required

          The image to run, in the usual format also used by docker run and docker compose. When the image is pulled from a private registry, make sure to create it first, using the container-create-registry endpoint. The appropriate registry is matched by hostname.

        • portsarray of string

          Exposed ports. Follows the format <public-port>:<container-port>/<protocol>. Exposed ports can be accessed from other containers (or managed apps) within the same project. To expose a port publicly, connect it with an ingress resource.

          • Array[
          • *string
          • ]
        • volumesarray of string

          Volume mounts for this container. These items always follow the format <volume>:<mountpoint>. The <volume> may either be a named volume, or a file path in the (always present) project file system (which is shared among containers and managed apps within a project).

          • Array[
          • *string
          • ]
      • projectIdstring (uuid)
        required
      • serviceNamestring
        required
      • stackIdstring (uuid)
        required
      • statusstring (one of: running, stopped, restarting, error, creating, starting)
        required
    • ]
  • volumesarray of object
    • Array[
    • *object
      • idstring (uuid)
        required
      • namestring
        required
      • orphanedboolean
        required

        Whether the Volume is attached to a Stack.

      • stackIdstring (uuid)
        required
      • storageUsageInBytesinteger
        required
      • storageUsageInBytesSetAtstring (date-time)
        required
    • ]

Usage examples

$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/stacks/f0f86186-0a5a-45b2-aa33-502777496347