List Volumes
Retrieve all volumes in a specific environment.
Endpoint
GET /environments/{envId}/volume
Authentication
Required: Yes (Session or Bearer Token with 2FA)
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
envId | string (UUID) | Yes | Environment ID |
Response
Success Response (200 OK)
Returns an array of volume objects.
[
{
"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-123",
"version": 1
},
{
"id": "vol-660e8400-e29b-41d4-a716-446655440001",
"name": "app-uploads",
"envIdRef": "660e8400-e29b-41d4-a716-446655440001",
"companyIdRef": "770e8400-e29b-41d4-a716-446655440002",
"size": 5120,
"mountPath": "/app/uploads",
"isDeleted": false,
"createdBy": "user-123",
"modifiedBy": "user-123",
"version": 1
}
]
Error Responses
| Status Code | Description |
|---|---|
| 401 | Unauthorized - Invalid or missing authentication |
| 403 | Forbidden - User doesn't have access to the environment |
| 404 | Not Found - Environment doesn't exist |
| 500 | Internal Server Error |
Examples
curl -X GET "https://api.thevenin.cloud/environments/{envId}/volume" \
-H "Authorization: Bearer tvn_your_api_token_here"
- Volumes marked as
isDeleted: trueare not included - Results are scoped to the specified environment
- Use this to check available volumes before attaching to applications