Skip to main content
PUT
Configure a Host Assigner

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Workflow identifier.

Body

application/json

external_key is required unless identity=true. test and test_args control the post-write dry run and are not persisted.

identity
enum<boolean>
required
Available options:
true
tool
string
required
Pattern: ^[a-z][a-z0-9_]*$
id_field
string
required
Minimum string length: 1
external_key
string
Pattern: ^[a-z][a-z0-9_]*$
name_field
string
Minimum string length: 1
test
boolean
default:true
test_args
object

Response

Successful response.

success
enum<boolean>
required
Available options:
true
workflow_id
string<uuid>
required
host_assigner
object | null
required
test
object | null
required
Last modified on September 8, 2026