List Gateways

GET 
/lns/tenants/:tenantId/gateways

List gateways

Request

Path Parameters

tenantId stringrequired

The ID of tenant.

Query Parameters

offset number

Default value: 0

The offset of gateway.

limit number

Possible values: >= 1 and <= 100

Default value: 20

The limit of gateway.

Responses

200

application/json

Schema

Schema

data object[]required
Data of the gateway.
Array [
tenantId stringrequired
gatewayId stringrequired
name stringrequired
state objectrequired
propertiesMap objectrequired
lastSeenAt numberrequired
createdAt numberrequired
updatedAt numberrequired
]
totalCount numberrequired

The total count of gateway.

Example (from schema)

{
  "data": [
    {
      "tenantId": "string",
      "gatewayId": "string",
      "name": "string",
      "state": {},
      "propertiesMap": {},
      "lastSeenAt": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "totalCount": 0
}

Example

{
  "data": [
    {
      "tenantId": "b004ebe0-xxxx-xxxx-xxxx-dacd251b6f00",
      "gatewayId": "24e124fffef23456",
      "name": "24E124FFFEF23456",
      "state": 2,
      "propertiesMap": {
        "region_common_name": "AS923",
        "region_config_id": "as923"
      },
      "lastSeenAt": 1710838741,
      "createdAt": 1705578047,
      "updatedAt": 1705578047
    }
  ],
  "totalCount": 1
}

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."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

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

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

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...