UpdateController

PUT

/api/sites/{siteId}/controllers/{controllerId}

const url = 'https://demo.consystence.com/api/sites/example/controllers/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","platform":0,"firmwareVersion":"example","connection":{"protocol":"example","ipAddress":"example","port":1,"cipPath":"example","pollIntervalMs":1,"timeoutMs":1,"retryDelayMs":1,"maxRetries":1}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://demo.consystence.com/api/sites/example/controllers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "platform": 0, "firmwareVersion": "example", "connection": { "protocol": "example", "ipAddress": "example", "port": 1, "cipPath": "example", "pollIntervalMs": 1, "timeoutMs": 1, "retryDelayMs": 1, "maxRetries": 1 } }'

Authorizations

Bearer
ApiKey

Parameters

Path Parameters

siteId

required

string

controllerId

required

string

Request Body^required

application/json

object

name

string

nullable 0 <= 200 characters

platform

integer format: int32

Allowed values: 0 1 2 3 4 5 6

firmwareVersion

string

nullable 0 <= 50 characters

connection

object

protocol

required

string

>= 1 characters

ipAddress

required

string

>= 1 characters

port

integer format: int32

>= 1 <= 65535

cipPath

string

nullable

pollIntervalMs

integer format: int32

>= 100 <= 60000

timeoutMs

integer format: int32

>= 1000 <= 30000

retryDelayMs

integer format: int32

>= 1000 <= 60000

maxRetries

integer format: int32

>= 1 <= 10

UpdateController

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Request Body^required