Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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>/healthCheck healthCheckStatus (e.g. , https://saas.whitesourcesoftware.com/healthCheckhealthCheckStatus)

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.

...

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:

Code Block
{
   "scanner_version": "x.x.x"
}

wss-remediate Container

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:

Code Block
{
   "status": "OK"
}

Accessing Scan Statistics via API

...

For example: {wss-<integration_type>-app-container-url}:5678/payload/scanner/request?state=scanning


Response:

Code Block
{
  "extraData":null,
  "requestedScanState":"pending",
  "requestsCount":"6"
}