IoT Integrator

Patch single device endpoint

Update endpoint related settings.

patch/v1/integrate/devices/endpoints/{protocol}

Request

  • Base URL
    https://api.1nce.com/management-api
  • Auth
    HTTP bearer

Path parameters

protocolstring required
Example:COAP

Available protocols: <ul><li>LWM2M</li><li>UDP</li><li>COAP</li></ul>

Request body

activeboolean

Not used.

Example request

{
  "active": true,
  "settings": [
    {
      "state": "ENABLED"
    }
  ]
}

Response

OK

protocolstring required

The protocol of the endpoint.

activeboolean required

The current status of the endpoint.

domainstring required

The domain of the endpoint.

ipAddressesstring[] required
portnumber required

The port of the endpoint.

securePortnumber

The port of the endpoint.

Example response

{
  "protocol": "COAP",
  "active": true,
  "domain": "coap.os.1nce.com",
  "ipAddresses": [
    "127.0.0.1"
  ],
  "port": 5683,
  "securePort": 5684,
  "settings": [
    {
      "name": "LWM2M_PASSIVE_REPORTING",
      "state": "ENABLED",
      "description": "This is an example description of a setting"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.