Define application to the server or cluster. This process is asynchronous – the initial request will wait until the application is defined, and the initial response will show information about the application being defined – however the staging and activation process will proceed after the response is returned. The user is expected to continue checking the application status using the applicationGetStatus method until the deployment process is complete.
Version: 1.3
Required Permissions: Full
HTTP method: POST
Supported by Editions: All
Request Parameters:
Parameter |
Type |
Required |
Description |
name |
File |
Yes |
Application name. |
baseUrl |
String |
Yes |
Base URL to define the application to. Must be an HTTP URL. use <default-server> if needed. |
version |
String |
No |
The version of the application. |
healthCheck |
String |
No |
The health check url. |
logo |
File |
No |
Logo image file. |
Expected Response Code: 202 OK. For more information see Response Format.
Response Type: applicationInfo
Possible Action Specific Error Codes:
HTTP Code |
Error Code |
Description |
409 |
baseUrlConflict |
Provided base URL is already in use. |
400 |
missingParameter |
A required parameter is missing. |
400 |
invalidParameter |
A value provided for a parameter is invalid. |
|
Request(some headers removed for clarity)
Response
|