You can use the applications endpoint to:
- Get a list of your company’s applications.
- See information about a specific application, including deployment details and processes.
- Delete an application.
- Send a
PUTrequest to update details within the application settings, such as the build path, display name, default branch, and more.
Get list of applications by Company ID
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
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 404
- 500
{- "company": {
- "apps": {
- "items": [
- {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "name": "unique-name",
- "display_name": "firstsite",
- "status": "deploymentSuccess"
}
]
}
}
}Get application by id
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
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 404
- 500
{- "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"
}
]
}
}Delete application by id
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
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 400
- 401
- 500
{- "message": "Application \"54fb80af-576c-4fdc-ba4f-b596c83f15a1\" is being deleted"
}Update application basic details
Application updated successfully
No or invalid API key provided to the request
Error occurred while updating application
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "build_path": "dist",
- "build_type": "dockerfile",
- "docker_file_path": "Dockerfile",
- "docker_context": ".",
- "display_name": "My App",
- "auto_deploy": true,
- "default_branch": "main"
}- 200
- 401
- 500
{- "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"
}
}Get application by nameDeprecated
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
- curl
- Node.js
- Browser JavaScript
- PHP
- 200
- 401
- 404
- 500
{- "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"
}
]
}
}