Initiating a health check (API method)

The API POST call described here will initiate the health check on a given OHS instance. Depending on the response message received, you can identify the health check status and take the required action.

Variables

Variable	Description
TenantId	Tenant Management Tenant ID GUID.
TenantInstanceId	The value of tenantInstanceId in the corresponding instance block as obtained by invoking the API Get instance health details.
CorrelationId	Correlation identifier GUID as set by the requestor for tracking requests to responses.

Sample cURL Request

curl --location --request POST 'https://k8s.itrontotal.com/ihcconfiggateway/api/v1/tenants/{TenantId}/tenantinstances/{TenantInstanceId}/healthcheck?userName=User_Name_Value'

--header 'Content-Type: application/json'

--header 'Grpc-Metadata-CorrelationId: {CorrelationId}'

--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiI' \

Sample JSON Response

{

"message": "OHS Health Check has been initiated successfully"

}