Liveness check
curl --request GET \
--url https://web-api.soxai.site/api/pingimport requests
url = "https://web-api.soxai.site/api/ping"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://web-api.soxai.site/api/ping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "ok"
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}System
Liveness check
Confirm that the API process is running.
Nothing behind the API is contacted, so a 200 here means only that the process answers.
Use /api/health to find out whether its dependencies are reachable.
Parameters
- None. This endpoint takes no path, query or body parameter.
Response
200{"status": "ok"}.
Errors
- None. The route reaches nothing that can fail; if the process is up, it answers.
Authorization
- No authentication, so a monitor can call it without credentials.
GET
/
api
/
ping
Liveness check
curl --request GET \
--url https://web-api.soxai.site/api/pingimport requests
url = "https://web-api.soxai.site/api/ping"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://web-api.soxai.site/api/ping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "ok"
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Response
The process is serving requests. Nothing downstream is checked.