Get status¶
Fetch API status
- HTTP Method:
GET - URL:
https://example.domain.tld/api/v1/status/ - Require authentication:
No
Note
This is a basic API status route exposed for external monitoring and does not reflect issues caused due to flapping network, server overload, or internal errors.
Response parameters¶
| Parameter | Type | Description |
|---|---|---|
| status | str | Status of API |
Example request (Python)¶
import requests
import json
from pprint import pprint
url = "https://example.domain.tld/api/v1/status/"
r = requests.get(url)
try:
pprint(r.json())
except:
print(r.text)
Example response (JSON)¶
{'status': 'OK'}