Skip to main content

List Applications

Retrieve all applications within a specific environment or across all environments.

Endpoints

List Applications by Environment

GET /environments/{envId}/app

Lists all applications within a specific environment.

List All Applications

GET /apps

Lists all applications across all environments that the authenticated user has access to.

Authentication

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

Path Parameters

ParameterTypeRequiredDescription
envIdstring (UUID)Yes*Environment ID (*only for environment-specific endpoint)

Response

Success Response (200 OK)

Returns an array of application objects.

[
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "my-web-app",
"envIdRef": "660e8400-e29b-41d4-a716-446655440001",
"companyIdRef": "770e8400-e29b-41d4-a716-446655440002",
"source": {
"image": {
"name": "nginx",
"tag": "latest"
}
},
"resources": {
"cpu": 1000,
"memory": 512,
"storage": 10240
},
"hostname": "my-web-app-abc123",
"port": 80,
"isDeleted": false,
"createdBy": "user-123",
"modifiedBy": "user-123",
"version": 1
}
]

Error Responses

Status CodeDescription
401Unauthorized - Invalid or missing authentication
403Forbidden - User doesn't have access to the environment
404Not Found - Environment doesn't exist
500Internal Server Error

Examples

List by environment:

curl -X GET "https://api.thevenin.cloud/environments/{envId}/app" \
-H "Authorization: Bearer tvn_your_api_token_here"

List all applications:

curl -X GET "https://api.thevenin.cloud/apps" \
-H "Authorization: Bearer tvn_your_api_token_here"