Create Device

Creates a new device within the specified workspace.

Endpoint

POST /rest/v1/workspaces/{workspace_uuid}/devices

Headers

Header	Value
Authorization	Bearer <YOUR_API_KEY>
Content-Type	application/json

Path Parameters

Parameter	Type	Required	Description
workspace_uuid	String	Yes	Unique identifier of the workspace.

Request Body

{
  "name": "Boiler PLC",
  "identifier": "BOILER_PLC",
  "description": "Main boiler PLC device"
}

Request Parameters

Field	Type	Required	Description
name	String	Yes	Name of the device (3–50 characters). Must begin with a letter.
identifier	String	Yes	Unique device identifier. Must begin with a letter and contain only letters, numbers, and underscores (_).
description	String	Yes	Description of the device (3–100 characters).

Validation Rules

Field	Validation
name	Required. Must be between 3 and 50 characters and begin with a letter.
identifier	Required. Must begin with a letter, contain only letters, numbers, and underscores (_), and be unique within the workspace.
description	Required. Must be between 3 and 100 characters.

Example Request

POST /rest/v1/workspaces/01kxcxpcgvdm1pacpfv1wxqqeh/devices
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json

{
  "name": "Boiler PLC",
  "identifier": "BOILER_PLC",
  "description": "Main boiler PLC device"
}

Success Response

Status: 201 Created

{
  "data": {
    "uuid": "01kabcdef123456789xyz",
    "name": "Boiler PLC",
    "identifier": "BOILER_PLC",
    "description": "Main boiler PLC device",
    "enabled_transformation": false,
    "transformation_script": "return JSON.stringify(payload);",
    "created_at": "2026-07-09T08:42:45Z",
    "updated_at": "2026-07-09T08:42:45Z"
  },
  "meta": {
    "success": true,
    "message": "Device created successfully"
  }
}