Getting A List Of Health Checks
Basic Description
This endpoint is used to get a list of Health Checks in Taurus-PROTECT.
This endpoint would accept a GET request with no required parameters. By default, the request will return all health checks for all tenants. However, it also provides the flexibility to filter them based on tenantId.
Prerequisites
Required Roles
Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.
Here is the list of required Roles for this particular endpoint:
- TPUser
To find out more about roles, please refer to the following page in the Taurus User Guides.
Required Input Parameters
There are no Required Input Parameters for this endpoint.
Preconditions
It is important to note that Health Checks are only available on Taurus-PROTECT 3.14 and later versions.
Call Example
You can find a basic example for all tenants in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.
export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/health" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken"
This piece of code submits a GET request to https://your-protect-instance.example.com/api/rest/v1/health with no parameters.
Call Result
A successful response for the GET call to get the list of all health checks for all tenants in Taurus-PROTECT might look like this:
{
"groups": {
"blocksd": {
"healthChecks": [
{
"tenantId": "3",
"componentName": "tg-validatord",
"componentId": "295f8434-3539-4d77-b9e2-57b004826a1b",
"group": "blocksd",
"healthCheck": "connectivity",
"status": "success",
"report": {
"name": "connectivity",
"status": "success",
"duration": "67.53513ms"
},
"lastUpdateDate": "2023-06-08T16:50:01.001688Z",
"validUntilDate": "2023-06-08T16:56:01.001688Z"
},
{
"tenantId": "3",
"componentName": "tg-validatord",
"componentId": "295f8434-3539-4d77-b9e2-57b004826a1b",
"group": "blocksd",
"healthCheck": "getbalance",
"status": "success",
"report": {
"name": "getbalance",
"status": "success",
"duration": "208.47284ms",
"results": {
"ADA": "no valid address",
"BCH": "no valid address",
"BTC": "no valid address",
"DOT": "no valid address",
"ETH": "no valid address",
"FTM": "no valid address",
"LTC": "no valid address",
"XLM": "no valid address",
"XRP": "no valid address",
"XTZ": "no valid address"
}
},
"lastUpdateDate": "2023-06-08T16:50:04.994359Z",
"validUntilDate": "2023-06-08T16:56:04.994359Z"
},
{
"tenantId": "3",
"componentName": "tg-validatord",
"componentId": "295f8434-3539-4d77-b9e2-57b004826a1b",
"group": "blocksd",
"healthCheck": "getfees",
"status": "success",
"report": {
"name": "getfees",
"status": "success",
"duration": "386.036241ms",
"results": {
"ADA": "success",
"BCH": "success",
"BTC": "success",
"DOT": "success",
"ETH": "success",
"FTM": "success",
"LTC": "success",
"XLM": "success",
"XRP": "success"
}
},
"lastUpdateDate": "2023-06-08T16:50:03.112652Z",
"validUntilDate": "2023-06-08T16:56:03.112652Z"
}
]
},
"exchanges": {
"healthChecks": [
{
"tenantId": "3",
"componentName": "tg-validatord",
"componentId": "295f8434-3539-4d77-b9e2-57b004826a1b",
"group": "exchanges",
"healthCheck": "connectivity",
"status": "success",
"report": {
"name": "connectivity",
"status": "success",
"duration": "10.415µs"
},
"lastUpdateDate": "2023-06-08T16:50:00.208764Z",
"validUntilDate": "2023-06-08T16:56:00.208764Z"
},
{
"tenantId": "3",
"componentName": "tg-validatord",
"componentId": "295f8434-3539-4d77-b9e2-57b004826a1b",
"group": "exchanges",
"healthCheck": "getbalances",
"status": "success",
"report": {
"name": "getbalances",
"status": "success",
"duration": "2.317µs"
},
"lastUpdateDate": "2023-06-08T16:50:00.363749Z",
"validUntilDate": "2023-06-08T16:56:00.363749Z"
}
]
},
"hsm": {
"healthChecks": [
{
"tenantId": "3",
"componentName": "tg-validatord",
"componentId": "295f8434-3539-4d77-b9e2-57b004826a1b",
"group": "hsm",
"healthCheck": "status",
"status": "success",
"report": {
"name": "status",
"status": "success",
"duration": "1.926824ms"
},
"lastUpdateDate": "2023-06-08T16:50:00.375041Z",
"validUntilDate": "2023-06-08T16:56:00.375041Z"
}
]
}
}
}
In this example, Taurus-PROTECT responds with a JSON object containing a list of all the health checks in Taurus-PROTECT.
Call Example
You can find a basic example for one single tenant in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.
export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
export TENANTID=1
curl --location "$BASEURL/api/rest/v1/health?tenantId=$TENANTID" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken"
This piece of code submits a GET request to https://your-protect-instance.example.com/api/rest/v1/health with the parameter tenantId set to 1.
Requirements for Future Use
For this endpoint, the storing requirements vary according to the use case.
You can find the Swagger-generated page for this endpoint in the following link.
Updated 22 days ago