Get a Volume belonging to a Stack

GET/stacks/{stackId}/volumes/{volumeId}/

API version

v2

Request method

GET

Operation ID

container-get-volume

---

Request

• stackIdstring (uuid)

  required

  ID of the Stack the Volume belongs too. ID of the default Stack equals the ID of the Project.

• volumeIdstring (uuid)

  required

  ID of the Volume to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• idstring (uuid)

  required
• namestring

  required
• orphanedboolean

  required

  Whether the Volume is attached to a Stack.

• stackIdstring (uuid)

  required
• storageUsageInBytesinteger

  required
• storageUsageInBytesSetAtstring (date-time)

  required

Example

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "name": "string",
  "orphaned": true,
  "stackId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "storageUsageInBytes": 123,
  "storageUsageInBytesSetAt": "2024-11-08T18:07:25.628Z"
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "orphaned": {
      "description": "Whether the Volume is attached to a Stack.",
      "type": "boolean"
    },
    "stackId": {
      "format": "uuid",
      "type": "string"
    },
    "storageUsageInBytes": {
      "type": "integer"
    },
    "storageUsageInBytesSetAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "stackId",
    "name",
    "orphaned",
    "storageUsageInBytes",
    "storageUsageInBytesSetAt"
  ],
  "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/volumes/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.getVolume({
  "stackId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "volumeId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetVolumeRequest(
  stackId: "f0f86186-0a5a-45b2-aa33-502777496347",
  volumeId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->container()->getVolume($request);

var_dump($response->getBody();