Zum Hauptinhalt springen

List Volumes belonging to a Project

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

Request

  • projectIdstring (uuid)
    required

    ID of the Project to list Volumes for.

Responses

Response-Header

  • 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
    • 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/volumes?stackId=f0f86186-0a5a-45b2-aa33-502777496347&searchTerm=string&sortOrder=nameAsc&limit=50&page=1