API Health

Description

This endpoint is used to provide the client the current health status of the API backend services. The result ranges from down to green.

It is available at the following URL.


https://api.intelsentry.io/v1/health

Input Params

None.

HTTP Methods

GET: Used to retrieve the health of the API.

Example Request

Plain


GET https://api.intelsentry.io/v1/health
Authorization: Bearer <token>

Shell


curl -X GET -H "Authorization: Bearer <token>" https://api.intelsentry.io/v1/health

cmd


curl.exe -X GET -H "Authorization: Bearer <token>" https://api.intelsentry.io/v1/health

PowerShell


$headers = @{}
$headers.Add("Authorization","Bearer <token>")
Invoke-WebRequest -Headers $headers -Method GET https://api.intelsentry.io/v1/health | select -ExpandProperty Content

Python


import requests
 
headers = {"Authorization": "Bearer <token>"}
response = requests.get("https://api.intelsentry.io/v1/health", headers=headers)
print(response.text)

Example Response


HTTP/1.1 200
Content-Type: application/json
Content-Length: 45
 
{
    "status": 200,
    "result": "green"
}

Note that result JSON key has the following possible values: green, yellow, red, down.

Status Codes

Status Code	Description
200	The health status was correctly returned