Get Edge Gateway Connectivity Info

GET 
/organizations/:organizationId/edge-gateways/:thingName/connectivity-info

Get Edge Gateway Connectivity Info

Request

Path Parameters

organizationId stringrequired

The ID of organization.

edgeGatewayId stringrequired

Edge Gateway ID

Responses

200

application/json

Schema

Schema

data objectrequired
The container object for the response data.
thingName stringrequired
connectivityInfo objectrequired
macAddress stringrequired
ipAddress stringrequired
port stringrequired
protocol stringrequired

Example (from schema)

{
  "data": {
    "thingName": "string",
    "connectivityInfo": {
      "macAddress": "string",
      "ipAddress": "string",
      "port": "string",
      "protocol": "string"
    }
  }
}

Example

{
  "data": {
    "thingName": "IDT-Edge-Gateway-A",
    "connectivityInfo": {
      "macAddress": "00000000000000000",
      "ipAddress": "192.168.0.1",
      "port": "80",
      "protocol": "HTTP"
    }
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...