Skip to main content

Updates channel info

PUT 

https://apis.<domain>/iot/channels/:chanId

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

Update is performed by replacing the current resource data with values provided in a request payload. Note that the channel's ID will not be affected.

Authorization Action:

core:channels:update

Request

Path Parameters

    chanId uuidrequired

    Unique channel identifier.

Body

required

JSON-formatted document describing the updated channel.

    name string

    Free-form channel name.

    metadata object

    Arbitrary, object-encoded channel's data.

Responses

Channel updated.

curl -L -X PUT 'https://apis.<domain>/iot/channels/:chanId' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "string",
"metadata": {}
}'
Request Collapse all
Base URL
https://apis.<domain>
Auth
Parameters
— pathrequired
Body required
{
"name": "string",
"metadata": {}
}