You can use the applications
endpoint to:
Response object of applications requests
No or invalid API key provided to the request
Could not find the company or the user does not have permissions to retrieve data
Error occurred while retrieving applications
{- "company": {
- "apps": {
- "items": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "unique-name",
- "display_name": "firstsite",
- "status": "deploymentSuccess"
}
]
}
}
}
Response object of applications requests
No or invalid API key provided to the request
Could not find the application or the user does not have permissions to retrieve data
Error occurred while retrieving application
{- "app": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "unique-name",
- "display_name": "firstsite",
- "status": "deploymentSuccess",
- "deployments": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "branch": "main",
- "commit_message": "docs: example",
- "created_at": 1667489138845
}
], - "processes": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "key": "web"
}
]
}
}
Response object of applications requests
One or more of the required parameters were not provided to the request
No or invalid API key provided to the request
Error occurred while deleting application
{- "message": "Application \"54fb80af-576c-4fdc-ba4f-b596c83f15a1\" is being deleted"
}
Application updated successfully
No or invalid API key provided to the request
Error occurred while updating application
{- "build_path": "dist",
- "build_type": "dockerfile",
- "docker_file_path": "Dockerfile",
- "docker_context": ".",
- "display_name": "My App",
- "auto_deploy": true,
- "default_branch": "main"
}
{- "app": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "my-app",
- "status": "deploymentInProgress",
- "updated_at": 1695300630620,
- "build_path": "dist",
- "build_type": "dockerfile",
- "docker_file_path": "Dockerfile",
- "docker_context": ".",
- "display_name": "My App",
- "auto_deploy": true,
- "default_branch": "main"
}
}
Response object of applications requests
No or invalid API key provided to the request
Could not find the application or the user does not have permissions to retrieve data
Error occurred while retrieving application
{- "app": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "unique-name",
- "display_name": "firstsite",
- "status": "deploymentSuccess",
- "deployments": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "branch": "main",
- "commit_message": "docs: example",
- "created_at": 1667489138845
}
], - "processes": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "key": "web"
}
]
}
}