Version 4.0.25.18 (latest)
Checks to see if the user is able to connect to their integration hub
Request
GET
/integration_hubs/{integration_hub_id}/health
Datatype
Description
Request
path
Expand HTTP Path definition...
integration_hub_id
Id of integration_hub
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: Health Result
Datatype
Description
(object)
success
lock
Whether or not the health check was successful
message
lock
A message representing the results of the health check.
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link