Health Check
curl --request GET \
--url https://secureai.hiperai.ai/api/external/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}Erste Schritte & Setup
Gesundheitscheck
Check if the API is running and healthy. No authentication required.
GET
/
health
Health Check
curl --request GET \
--url https://secureai.hiperai.ai/api/external/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}Gesundheitscheck
Überprüfen Sie, ob die API ausgeführt wird und fehlerfrei ist. Keine Authentifizierung erforderlich.Endpunkt
GET /health
Beschreibung
Mit diesem Endpunkt können Sie überprüfen, ob die SecureAI External API ausgeführt wird und fehlerfrei ist. Für diesen Endpunkt ist keine Authentifizierung erforderlich.Anfrage
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Antwort
Erfolgsantwort (200)
{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}
Antwortfelder
| Feld | Geben Sie | ein Beschreibung | Beispiel |
|---|---|---|---|
success | boolescher Wert | Immer wahr für einen erfolgreichen Gesundheitscheck | true |
status | Zeichenfolge | Gesundheitsstatus der API | "healthy" |
timestamp | Zeichenfolge | Aktueller Server-Zeitstempel im ISO 8601-Format | "2024-01-15T10:30:00.000Z" |
version | Zeichenfolge | Aktuelle API-Version | "1.0.0" |
Beispielverwendung
JavaScript/Node.js
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/health');
const data = await response.json();
console.log('API Status:', data.status);
Python
import requests
response = requests.get('https://{customer.name}.hiperai.ai/api/external/health')
data = response.json()
print('API Status:', data['status'])
cURL
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Notizen
– Dieser Endpunkt erfordert keine Authentifizierung – Verwenden Sie diesen Endpunkt, um die API-Verfügbarkeit zu überwachen – Die Antwort enthält die aktuelle API-Version zur KompatibilitätsprüfungAutorisierungen
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here