Utility Functionality APIs
Click an API to expand/collapse it.
- Description
- Allows a client to check the current Client version deployed.
- Request Endpoint
- GET https://<Example api server address>/app/version
- Parameters
-
None.
- cURL Syntax
-
curl --include \
'https://core.dev.Example.net/api/app/version'
- Response body
-
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
"data": {
"version": "0.22"
},
"detail": null,
"error": false,
"message": "Gather version information successful"
}
Return to top
- Description
- Allows a client to check the health of the Client API server.
- Request Endpoint
- GET https://<Example api server address>/health
- Parameters
-
None.
- cURL Syntax
-
curl --include \
'https://core.dev.Example.net/api/health'
- Response body
-
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
"data": {
"status": "running"
},
"detail": null,
"error": false,
"message": "Health check successful"
}
Return to top