Skip to main content
POST
Create Inventory Assignment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string
required

Query Parameters

dryRun
boolean
default:false

Body

application/json

Assign one or more nodes (node_ids) to a cluster with shared attrs.

nodeIds
string[]
required
Maximum array length: 1000
status
enum<string>
default:PLANNED
Available options:
PLANNED,
ACTIVE,
ENDED,
CANCELLED
type
enum<string>
default:STANDARD
Available options:
STANDARD,
FAILOVER
isController
boolean
default:false
priceHr
number | null
startDate
string<date-time> | null
endDate
string<date-time> | null
notes
string | null
metadata
AssignmentMetadata · object | null

The assignment's metadata JSON. Only playbooks is validated; other keys (e.g. the NetBox migration's source) pass through untouched.

Response

Successful Response

data
MutationResult · object | null

Response data

status
string | null

Response status