Update Gateway

PUT 
/lns/tenants/:tenantId/gateways/:gatewayId

Update gateway

Request

Path Parameters

tenantId stringrequired

The ID of tenant.

gatewayId stringrequired

The ID of gateway.

application/json

Body

required

name stringrequired

The name of gateway.

description string

The description of gateway.

statsInterval numberrequired

The stats interval of gateway.

tagsMap object[]
The tagsMsp of gateway.
Array [
]

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the gateway.
tenantId stringrequired
gatewayId stringrequired
name stringrequired
description stringrequired
statsInterval numberrequired
tagsMap object[]required
Array [
]

Example (from schema)

{
  "data": {
    "tenantId": "string",
    "gatewayId": "string",
    "name": "string",
    "description": "string",
    "statsInterval": 0,
    "tagsMap": [
      {}
    ]
  }
}

Example

{
  "data": {
    "tenantId": "b004ebe0-xxxx-xxxx-xxxx-dacd251b6f00",
    "gatewayId": "24e124fffef23456",
    "name": "24E124FFFEF23456",
    "description": "IDT-Gateway-Description",
    "statsInterval": 30,
    "tagsMap": []
  }
}

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