Check the health of Integration Hub

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
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
integration_hub_id
string
Id of integration_hub
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.

Response

200: Health Result

Datatype
Description
success
boolean
Whether or not the health check was successful
message
string
A message representing the results of the health check.

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link