For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd a new certificate
        • GETCheck if a specific gateway connection is healthy
        • POSTCreate a new gateway
        • POSTCreate a new service group
        • DELDelete a certificate by ID
        • DELDelete a gateway by ID
        • DELDelete service group
        • GETGet a certificate by its ID
        • GETGet gateway by ID
        • GETGet gateway service details
        • GETGet service group by ID
        • GETList all actively connected gateways
        • GETList all certificates
        • GETList all gateways
        • GETList all service groups
        • GETList all services
        • POSTRun a gateway service
        • GETSimple health check
        • GETThe version of app-gateway_manager
        • PUTUpdate a certificate by ID
        • PUTUpdate gateway
        • PATCHUpdate service group
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceGateway Manager

Check if a specific gateway connection is healthy

GET
http://localhost:3000/gateway_manager/v1/connections/:clusterId
GET
/gateway_manager/v1/connections/:clusterId
$curl http://localhost:3000/gateway_manager/v1/connections/clusterId \
> -u "<username>:<password>"
1{
2 "id": "670fc09db12a3c6c180db1a7",
3 "jsonrpc": "2.0",
4 "result": {
5 "reply": "Health test from GatewayManager"
6 },
7 "receiveTime": 1729085597352,
8 "status": "success"
9}
Given the cluster ID of an gateway connection, this endpoint will return the health status of the device.
Was this page helpful?
Previous

Create a new gateway

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

clusterIdstringRequired
The cluster Id of the specific gateway connection

Response

The result of the device health status check returned from the device itself
idstring
jsonrpcstring
resultobject
receiveTimeinteger
statusstring

Errors

500
Internal Server Error