Get a Service belonging to a Stack

GET/stacks/{stackId}/services/{serviceId}/

API version

v2

Request method

GET

Operation ID

container-get-service

---

Request

• stackIdstring (uuid)

  required

  ID of the Stack the Service belongs to. ID of the default Stack equals the ID of the Project.

• serviceIdstring (uuid)

  required

  ID of the Service to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• 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

Example

{
  "deployedState": {
    "command": [
      "mysqld"
    ],
    "entrypoint": [
      "docker-entrypoint.sh"
    ],
    "envs": {
      "MYSQL_DATABASE": "my_db",
      "MYSQL_PASSWORD": "my_password",
      "MYSQL_ROOT_PASSWORD": "my_root_password",
      "MYSQL_USER": "my_user"
    },
    "image": "mysql:8.0",
    "ports": [
      "3306:3306/tcp"
    ],
    "volumes": [
      "data:/var/lib/mysql",
      "/home/p-XXXXX/html:/var/www"
    ]
  },
  "description": "MySQL DB",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "pendingState": {
    "command": [
      "mysqld"
    ],
    "entrypoint": [
      "docker-entrypoint.sh"
    ],
    "envs": {
      "MYSQL_DATABASE": "my_db",
      "MYSQL_PASSWORD": "my_password",
      "MYSQL_ROOT_PASSWORD": "my_root_password",
      "MYSQL_USER": "my_user"
    },
    "image": "mysql:8.0",
    "ports": [
      "3306:3306/tcp"
    ],
    "volumes": [
      "data:/var/lib/mysql",
      "/home/p-XXXXX/html:/var/www"
    ]
  },
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "serviceName": "mysql-db",
  "stackId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "status": "running"
}

JSON Schema

{
  "properties": {
    "deployedState": {
      "description": "The actual state of the container that is currently deployed.\n",
      "properties": {
        "command": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The container command (equivalent to the [Docker cmd](https://docs.docker.com/reference/dockerfile/#cmd)). When omitted, this defaults to the command defined in the image.\n",
          "example": [
            "mysqld"
          ]
        },
        "entrypoint": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The container entrypoint (equivalent to the [Docker entrypoint](https://docs.docker.com/reference/dockerfile/#entrypoint)). When omitted, this defaults to the entrypoint defined in the image.\n",
          "example": [
            "docker-entrypoint.sh"
          ]
        },
        "envs": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object",
          "description": "Key-value map of environment variables that should be passed into the container.\n",
          "example": {
            "MYSQL_DATABASE": "my_db",
            "MYSQL_PASSWORD": "my_password",
            "MYSQL_ROOT_PASSWORD": "my_root_password",
            "MYSQL_USER": "my_user"
          }
        },
        "image": {
          "type": "string",
          "description": "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.\n",
          "example": "mysql:8.0"
        },
        "ports": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "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.\n",
          "example": [
            "3306:3306/tcp"
          ]
        },
        "volumes": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "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).\n",
          "example": [
            "data:/var/lib/mysql",
            "/home/p-XXXXX/html:/var/www"
          ]
        }
      },
      "required": [
        "image"
      ],
      "type": "object"
    },
    "description": {
      "example": "MySQL DB",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "pendingState": {
      "description": "The desired state that is waiting to be reconciled.\n",
      "properties": {
        "command": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The container command (equivalent to the [Docker cmd](https://docs.docker.com/reference/dockerfile/#cmd)). When omitted, this defaults to the command defined in the image.\n",
          "example": [
            "mysqld"
          ]
        },
        "entrypoint": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The container entrypoint (equivalent to the [Docker entrypoint](https://docs.docker.com/reference/dockerfile/#entrypoint)). When omitted, this defaults to the entrypoint defined in the image.\n",
          "example": [
            "docker-entrypoint.sh"
          ]
        },
        "envs": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object",
          "description": "Key-value map of environment variables that should be passed into the container.\n",
          "example": {
            "MYSQL_DATABASE": "my_db",
            "MYSQL_PASSWORD": "my_password",
            "MYSQL_ROOT_PASSWORD": "my_root_password",
            "MYSQL_USER": "my_user"
          }
        },
        "image": {
          "type": "string",
          "description": "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.\n",
          "example": "mysql:8.0"
        },
        "ports": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "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.\n",
          "example": [
            "3306:3306/tcp"
          ]
        },
        "volumes": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "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).\n",
          "example": [
            "data:/var/lib/mysql",
            "/home/p-XXXXX/html:/var/www"
          ]
        }
      },
      "required": [
        "image"
      ],
      "type": "object"
    },
    "projectId": {
      "format": "uuid",
      "type": "string"
    },
    "serviceName": {
      "example": "mysql-db",
      "type": "string"
    },
    "stackId": {
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "enum": [
        "running",
        "stopped",
        "restarting",
        "error",
        "creating",
        "starting"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "stackId",
    "projectId",
    "description",
    "serviceName",
    "pendingState",
    "deployedState",
    "status"
  ],
  "type": "object"
}

Usage examples

cURL

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

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.container.getService({
  "stackId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "serviceId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Container\GetService\GetServiceRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetServiceRequest(
  stackId: "f0f86186-0a5a-45b2-aa33-502777496347",
  serviceId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->container()->getService($request);

var_dump($response->getBody();