API Guide

System
System APIs.
Topics:
• GET /system/health
• POST /system/ping
• POST /system/license-file
GET /system/health
Retrieves overall SFD health information.
API
GET /system/health
Description This API retrieves overall system health information.
Parameters None
Responses 200 — Response for getting system health
{
"status": "enum"
}
401 — You are not authorized to perform this operation
{
"new_object_id": "string",
"id": "string",
"message": "string",
"messageParams": [
"string"
],
"messages": [
{
"id": "string",
"message": "string",
"field_name": "string",
"messageParams": [
"string"
]
}
]
}
default — Success or error response
{
"new_object_id": "string",
"id": "string",
"message": "string",
"messageParams": [
"string"
],
"messages": [
{
"id": "string",
"message": "string",
"field_name": "string",
"messageParams": [
20
System 161