🧩 Branding3

🧩 Change requests8

🧩 CVE9

🧩 Data sources9

🧩 Multi-tenants6

🧩 OpenSCAP1

🧩 Scale out Relay2

🧩 Secret management5

🧩 System update campaigns6

API account management7

API Info3

Archives2

Campaigns10

Compliance9

Directives7

Groups11

Inventories5

Nodes12

Parameters5

Plugins3

Rules10

Settings6

Status1

System13

Techniques15

User management10

Nodes

Create one or several new nodes

Changed on Feb 9, 2026

Use the provided array of node information to create new nodes

put/nodes

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/nodes/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring required

The Rudder node unique identifier in /opt/rudder/etc/uuid.hive

hostnamestring required

The fully qualified name of the node

status'accepted' | 'pending' required

Target status of the node

policyServerIdstring

The policy server ID for that node. By default, "root"

The kind of machine for the node (use vm for a generic VM)

state'enabled' | 'ignored' | 'empty-policies' | 'initializing' | 'preparing-eol'

Node lifecycle state. Can only be specified when status=accepted. If not specified, enable is used

policyMode'enforce' | 'audit'

The policy mode for the node. Can only be specified when status=accepted. If not specified, the default (global) mode will be used

ipAddressesstring[] required

an array of IPs.

Example request

[
  {
    "id": "378740d3-c4a9-4474-8485-478e7e52db52",
    "hostname": "my.node.hostname.local",
    "os": {
      "version": "9.5",
      "fullName": "Debian GNU/Linux 9 (stretch)"
    },
    "policyServerId": "root",
    "machine": {
      "manufacturer": "corp inc.",
      "serialNumber": "ece12459-2b90-49c9-ab1e-72e38f797421"
    },
    "agentKey": {
      "value": "-----BEGIN CERTIFICATE-----\nMIIFqDCC[...]3tALNn\n-----END CERTIFICATE-----"
    },
    "properties": [
      {
        "name": "datacenter",
        "value": "AMS2"
      }
    ],
    "ipAddresses": [
      "192.168.180.90"
    ],
    "timezone": {
      "name": "CEST",
      "offset": "+0200"
    }
  }
]

Response

Creation information

result'success' | 'error' required

Result of the request

action'createNode' required

The id of the action

Example response

{
  "data": {
    "created": [
      "378740d3-c4a9-4474-8485-478e7e52db52"
    ]
  }
}

Changes

Feb 9, 2026eecc9e1231f6 Revision changes
- breaking
  removed the enum value aix of the request property //
- breaking
  removed the enum value aixlpar of the request property //
- breaking
  removed the enum value aixlpar of the request property /
- breaking
  removed the enum value bsdjail of the request property //
- breaking
  removed the enum value bsdjail of the request property /
- breaking
  removed the enum value freebsd of the request property //
- breaking
  removed the enum value solaris of the request property //
- breaking
  removed the enum value solariszone of the request property //
- breaking
  removed the enum value solariszone of the request property /

Operation history