Get a Service belonging to a Stack

GET /v2/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
  • commandarray of string
    • Array[
    • *string
    ]
• entrypointarray of string
  • Array[
  • *string
  ]

envsobject

• *string

imagestring

required

portsarray of string

• Array[
• *string
]

volumesarray of string

• Array[
• *string
]

descriptionstring

required

idstring (uuid)

required

pendingStateobject

required

• commandarray of string
  • Array[
  • *string
  ]

entrypointarray of string

• Array[
• *string
]

envsobject

• *string

imagestring

required

portsarray of string

• Array[
• *string
]

volumesarray of string

• Array[
• *string
]

projectIdstring (uuid)

required

serviceNamestring

required

stackIdstring (uuid)

required

statusstring (one of: running, stopped, restarting, error, creating, starting)

required

Example

{
  "deployedState": {
    "command": [
      "string"
    ],
    "entrypoint": [
      "string"
    ],
    "envs": {
      "string": "string"
    },
    "image": "string",
    "ports": [
      "string"
    ],
    "volumes": [
      "string"
    ]
  },
  "description": "MySQL DB",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "pendingState": {
    "command": [
      "string"
    ],
    "entrypoint": [
      "string"
    ],
    "envs": {
      "string": "string"
    },
    "image": "string",
    "ports": [
      "string"
    ],
    "volumes": [
      "string"
    ]
  },
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "serviceName": "mysql-db",
  "stackId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "status": "running"
}

JSON Schema

{
  "properties": {
    "deployedState": {
      "properties": {
        "command": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "entrypoint": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "envs": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "image": {
          "type": "string"
        },
        "ports": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "volumes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "image"
      ],
      "type": "object"
    },
    "description": {
      "example": "MySQL DB",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "pendingState": {
      "properties": {
        "command": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "entrypoint": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "envs": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "image": {
          "type": "string"
        },
        "ports": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "volumes": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "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();