Skip to main content

List Stacks belonging to a Project

GET/projects/{projectId}/stacks/
v2
GET
container-list-stacks

Request

  • projectIdstring (uuid)
    required

    ID of the Project to list Stacks for.

Responses

Response headers

  • X-Pagination-Limitinteger

    The limit used to select the resources for the response

  • X-Pagination-Skipinteger

    The number of skipped items

  • X-Pagination-Pagenumber

    The calculate page of the list response. Refer to parameters to learn more.

  • X-Pagination-TotalCountinteger

    The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

application/json

OK

  • Array[
  • *object
    • 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). To delete an existing container from a stack using a PUT request, simply omit it from the request body. Using a PATCH request, set it to an empty object {}.

      • 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.

      • imageDigeststring
      • 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
  • messagestring

    Message explaining the current state of the container. This may contain information about the current state of the container, or errors that occurred during deployment.

  • 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.

  • imageDigeststring
  • 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
    • ]
  • requiresRecreateboolean
    required
  • serviceNamestring
    required
  • shortIdstring
    required

    A short ID of the container. This is a unique identifier for the container within the project, and can be used to reference it in other API calls, or for SSH connections.

  • statusstring (one of: running, stopped, restarting, error, creating, starting)
    required
  • statusSetAtstring (date-time)
    required
  • ]
  • volumesarray of object
    • Array[
    • *object
      • idstring (uuid)
        required
      • linkedServicesarray of string (uuid)
        • Array[
        • *string (uuid)
        • ]
    • namestring
      required
    • orphanedboolean
      required

      Whether the Volume is attached to a Stack.

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

    Usage examples

    $ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/stacks?limit=50&page=1