The <integration_type> placeholder is to be replaced with either “ghe” (GitHub Enterprise), “gls” (GitLab), or “bb” (Bitbucket). |
The access to the app can be checked by issuing an HTTP GET request using a web browser or a utility (e.g., cURL, wget):https://<your-base-url>/healthCheckStatus
(e.g. https://saas.whitesourcesoftware.com/healthCheckStatus)
It is recommended to verify that the returned status is 200 (OK).
This is only a validation URL. Access must be open for all paths and endpoints under the app’s subdomain.
If a proxy server is available, then the following proxy settings need to be obtained:
URL
Port number
Username and password (for authenticated access)
A valid SSL certificate and KeyStore containing the certificate.
This section describes how to verify the health status of each deployed running container.
Request (GET): {wss-<integration_type>-app-container-url}:5678/payload/healthcheck
Response: If the app container is healthy, the response code will be 200.
NOTE: This Health Check API is only supported from version 19.10.1.
Request (GET): {wss-scanner-container-url}:9393/health-check
Response: If the scanner container is healthy, the response code will be 200 and the response will contain the following JSON object:
|
Request (GET): {wss-remediate-container-url}:8080
Response: If the remediate container is healthy, the response code will be 200 and the response will contain the following JSON object:
|
In order to keep track of the number of scan requests that are in the scan queue at any given time, the following API call can be used via the wss-<integration_type>-app container endpoint:
Request (GET):
{wss-<integration_type>-app-container-url}/payload/scanner/request
An optional state parameter can be provided as part of the request URL. It can contain one of the following values:
pending (this is the default value when using this API call)
scanning
done
For example: {wss-<integration_type>-app-container-url}:5678/payload/scanner/request?state=scanning
Response:
|