Retrieve the active gateway tunnel information of gateway in a realm

GET 
https://demo.openremote.io/api/master/gateway/tunnel/:realm/:id

Retrieve the active gateway tunnel information of gateway in a realm

Request

Path Parameters

realm stringrequired
id stringrequired

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

Responses

default

default response

application/json

Schema

Schema

• Array [

realmstring
gatewayIdstring
targetPortint32
targetstring
assignedPortint32
hostnamestring
typestring

Possible values: [HTTPS, HTTP, TCP]

autoCloseTimedate-time
idstring

• ]

Example (from schema)

[
  {
    "realm": "string",
    "gatewayId": "string",
    "targetPort": 0,
    "target": "string",
    "assignedPort": 0,
    "hostname": "string",
    "type": "HTTPS",
    "autoCloseTime": "2024-07-29T15:51:28.071Z",
    "id": "string"
  }
]

Authorization: oauth2

name: openidtype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  }
}

• curl
• nodejs
• java
• python
• ruby
• csharp
• go
• php
• powershell

• CURL

curl -L 'https://demo.openremote.io/api/master/gateway/tunnel/:realm/:id' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

Parameters

realm — pathrequired

id — pathrequired

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

ResponseClear

Click the Send API Request button above and see the response here!