Applications

You can use the applications endpoint to:

Get list of applications by Company ID

SecuritybearerAuth
Request
query Parameters
company
required
string
Example: company=54fb80af-576c-4fdc-ba4f-b596c83f15a1
limit
number
Default: 10
Example: limit=10
offset
number
Default: 0
Example: offset=3
Responses
200

Response object of applications requests

401

No or invalid API key provided to the request

404

Could not find the company or the user does not have permissions to retrieve data

500

Error occurred while retrieving applications

get/applications
Request samples
Response samples
application/json
{
  • "company": {
    }
}

Get application by id

SecuritybearerAuth
Request
path Parameters
id
required
string
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses
200

Response object of applications requests

401

No or invalid API key provided to the request

404

Could not find the application or the user does not have permissions to retrieve data

500

Error occurred while retrieving application

get/applications/{id}
Request samples
Response samples
application/json
{
  • "app": {
    }
}

Delete application by id

SecuritybearerAuth
Request
path Parameters
id
required
string
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses
200

Response object of applications requests

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

500

Error occurred while deleting application

delete/applications/{id}
Request samples
Response samples
application/json
{
  • "message": "Application \"54fb80af-576c-4fdc-ba4f-b596c83f15a1\" is being deleted"
}

Update application basic details

SecuritybearerAuth
Request
path Parameters
id
required
string
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Request Body schema: application/json
required
build_path
string
build_type
string
Enum: "dockerfile" "pack" "nixpacks"
docker_file_path
string
docker_context
string
display_name
string
auto_deploy
boolean
default_branch
string
Responses
200

Application updated successfully

401

No or invalid API key provided to the request

500

Error occurred while updating application

put/applications/{id}
Request samples
application/json
{
  • "build_path": "dist",
  • "build_type": "dockerfile",
  • "docker_file_path": "Dockerfile",
  • "docker_context": ".",
  • "display_name": "My App",
  • "auto_deploy": true,
  • "default_branch": "main"
}
Response samples
application/json
{
  • "app": {
    }
}

Get application by nameDeprecated

SecuritybearerAuth
Request
path Parameters
name
required
string
Example: unique-name
Responses
200

Response object of applications requests

401

No or invalid API key provided to the request

404

Could not find the application or the user does not have permissions to retrieve data

500

Error occurred while retrieving application

get/applications/{name}
Request samples
Response samples
application/json
{
  • "app": {
    }
}