Intelup icon

Intelup

Interact with the Intelup API

Actions335

miscellaneous → Get Miscellaneous Healthcheck

AI-generated

Summary

Test the Intelup API connection by sending a POST request to the /public/miscellaneous/test-connection endpoint for the specified API version.

Inputs

  • Version — Select the Intelup API version to use for the health check request. Options include 3.42.3 (default), 3.41.6, and 3.41.5.

Output shape

a single JSON object indicating connection status and a message

Returns an object with 'status' set to 'OK' and a success message if the connection is established; otherwise 'status' is 'Error' with the failure reason. The message may include client and unit codes if available.

Examples

Example 1: Check API health with default version

Set resource to 'miscellaneous', operation to 'Get Miscellaneous Healthcheck', and optionally select the API version if different from default. The node will perform a connection test using the stored API credentials and return success or error status.

Links

Discussion