Attempts to initialise the specified devices. Returns a 200 if the request is successfully made. A websocket will notify the frontend when the devices are actually initialised.

POST

/api/v1/{tenantId}/system/initialise-devices

Plugin API access: this operation accepts a plugin JWT (PluginBearer) for its own tenant.

Authorizations

• PluginBearer

Parameters

Path Parameters

tenantId

required

string

Request Body

object

tenantId

string

nullable

tenantUuid

string

nullable

deviceIds

Array<string>

nullable

action

string

Allowed values: initialise uninitialise reinitialise

Responses

200

OK

object

unknownDeviceIds

Array<string>

nullable

skippedDeviceIds

Array<string>

nullable

400

Bad Request

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

403

Forbidden

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

404

Not Found

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

409

Conflict

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

429

Too Many Requests

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

503

Service Unavailable

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

504

Gateway Timeout

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable