Using the Healthcheck API

Veracode APIs

You can use the Healthcheck API to perform a simple test for verifying authenticated connectivity to Veracode.

The Healthcheck API provides this lightweight endpoint: /healthcheck/status

You use the endpoint to verify that Veracode services are available and responding to authentication events, instead of using other API calls that can potentially return large volumes of data.

Authentication

This API provides improved security through HMAC authentication. Therefore, before using this API, you are required to enable HMAC authentication.

Ensure you access the APIs with the domain for your region.

Healthcheck API Specification

The Healthcheck API specification is available from SwaggerHub.