List Volumes belonging to a Project

GET/projects/{projectId}/volumes/

API version

v2

Request method

GET

Operation ID

container-list-volumes

---

Request

• projectIdstring (uuid)

  required

  ID of the Project to list Volumes for.

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

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

Beispiel

[
  {
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "name": "string",
    "orphaned": true,
    "stackId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "storageUsageInBytes": 123,
    "storageUsageInBytesSetAt": "2024-12-19T00:33:14.805Z"
  }
]

JSON Schema

{
  "items": {
    "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"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/volumes?stackId=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.listVolumes({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "queryParameters": {
    "stackId": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListVolumesRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347"
))
  ->withStackId("f0f86186-0a5a-45b2-aa33-502777496347");
$response = $client->container()->listVolumes($request);

var_dump($response->getBody();