Acknowledge App Install

Reports the final installation status observed by the client. When both the server-side status and the client-reported status are completed, the server clears the install session. When both are error, the server rolls the installation back. Other statuses are ignored.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{"token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "completed"}' \
     https://HOSTNAME/api/sonar/apps/ack-install

Request Parameters

Request Body Parameters

Success Response

{}

Error Responses

token is missing or not in valid GUID format

HTTP status code 400

{
  "error_code": "invalid-param-type",
  "error_msg": "token should be guid type."
}

status is missing

HTTP status code 400

{
  "error_code": "null-argument",
  "error_msg": "status should be not null"
}

Permission denied

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}