Installer Requests

This is the description of the commonly used installer API requests. If you need more information, you can access Swagger documentation by contacting our team.

Credentials

baseUrl: https://installer.a1apps.io

Authorization Type: Header

key	value
x-api-key	apiKeyValue

Installer Requests

Get Application

Path: {{baseUrl}}/environments/:environment_id/customers/:customer_id/:app

Method: GET

Description: Get the application information. Replace :environment_id with the environment id, :customer_id with the customer id, and :app with the application name.

Query Parameters:

• addUpdateInstallInfo - boolean, if true, the response will include information about the application dependencies that will be installed or updated.
• fullUpdate - boolean, if true, the response will include information about the application dependencies for all the dependencies that have newer versions available.

Response:

• 200 - application information
• 404 - application not found

Response Body Keys:

• status - application status, string, e.g, “SUCCEEDED”, “FAILED”, “IN_PROGRESS”
• task - application task, string, e.g, “INSTALL”, “UPDATE”, “DELETE”
• applied_config - application outputs, object, e.g, {“UpdatedTime”: “2024-02-02T17:04:14.272000+00:00”}
• environment_id - environment id, string, e.g, “env-123”
• awsAccountId - AWS account id, string, e.g, “123456789012”
• last_updated - last updated time, string, e.g, “2024-02-02T17:04:14+00:00”
• last_version - indicates whether the application has the latest version, boolean, e.g, true
• versionNumberCurrent - current version number, string, e.g, “1.0.0”
• versionNumberLast - latest version number, string, e.g, “1.0.1”
• dependenciesStatus - application dependencies status, list

Install Application

Path: {{baseUrl}}/environments/:environment_id/customers/:customer_id/:app

Method: POST

Description: Install the application. Replace :environment_id with the environment id, :customer_id with the customer id, and :app with the application name.

Request Body: Body should be a JSON object with the fields compatible to your application.

Query Parameters:

• version - string, version of the application to be installed
• strictVersion - boolean, if true, the installer will install the exact version specified in the version parameter. If false, the installer will install the latest version available.

Response:

• 200 - application installed successfully
• 400 - bad request
• 404 - application not found
• 409 - conflict

Update Application

Path: {{baseUrl}}/environments/:environment_id/customers/:customer_id/:app

Method: PUT

Description: Update the application. Replace :environment_id with the environment id, :customer_id with the customer id, and :app with the application name.

Request Body: Body should be a JSON object with the fields compatible to your application.

Query Parameters:

• version - string, version of the application to be updated
• strictVersion - boolean, if true, the installer will update the exact version specified in the version parameter. If false, the installer will update to the latest version available.
• forceUpdate - boolean, if true, the installer will update the application even if the version is the same as the current one.
• fullUpdate - boolean, if true, the installer will update all the dependencies of the application to the latest versions available.

Response:

• 200 - application updated successfully
• 400 - bad request
• 404 - application not found
• 409 - conflict