API v2: Healthcheck

By using healthcheck, you can check the overall Fudo Enterprise health and verify its proper functioning. This method is accessible without authentication.

Note

• Healthcheck is disabled by default. Please go to Settings > System, and enable the API health check option on the General tab, under the Maintenance and supervision section.

Retrieving healthcheck status

Request

Method	GET
Path	/api/v2/healthcheck

Example request

Sending GET https://10.0.0.0/api/v2/healthcheck

Response - positive

{
    "result": "success",
    "status": "ok"
}

Response - negative

{
    "result": "success",
    "status": "error"
}

Note

To check allowed methods, available URL parameters and possible responses please refer to the API overview section.