Skip to main content

Get Volume

Retrieve detailed information about a specific volume.

Endpoint

GET /{envId}/volume/{id}

Authentication

Required: Yes (Session or Bearer Token with 2FA)

Path Parameters

ParameterTypeRequiredDescription
envIdstring (UUID)YesEnvironment ID containing the volume
idstring (UUID)YesVolume ID

Response

Success Response (200 OK)

{
"id": "vol-550e8400-e29b-41d4-a716-446655440000",
"name": "postgres-data",
"envIdRef": "660e8400-e29b-41d4-a716-446655440001",
"companyIdRef": "770e8400-e29b-41d4-a716-446655440002",
"size": 10240,
"mountPath": "/var/lib/postgresql/data",
"isDeleted": false,
"createdBy": "user-123",
"modifiedBy": "user-456",
"version": 2
}

Error Responses

Status CodeDescription
400Bad Request - Invalid UUID format
401Unauthorized - Invalid or missing authentication
403Forbidden - User doesn't have access to this volume
404Not Found - Volume or environment doesn't exist
500Internal Server Error

Examples

curl -X GET "https://api.thevenin.cloud/environments/{envId}/volume/{volumeId}" \
-H "Authorization: Bearer tvn_your_api_token_here"
  • Both environment ID and volume ID must be valid UUIDs