Skip to main content
POST
Unassign devices from allocation

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string<uuid>
required

A UUID string identifying this allocation.

Body

Selectors for removing a device cohort from an existing allocation.

Shares the assignment request contract, including the all_devices whole-site consent flag.

device_ids
string<uuid>[]

Device UUIDs to select. Mutually exclusive with rack_names.

Required array length: 1 - 2000 elements
rack_names
string[]

Rack names in the allocation's site whose devices should be selected.

Required array length: 1 - 100 elements
Minimum string length: 1
device_role_slugs
string[]

Optional device-role slugs applied after the device or rack selector.

Required array length: 1 - 100 elements
Minimum string length: 1
all_devices
boolean
default:false

Explicitly select every device in the allocation's site. Required when device_ids and rack_names are both omitted.

dry_run
boolean
default:false

Return the planned outcome without changing allocation memberships.

Response

Typed result for a live allocation unassignment or dry run.

allocation_id
string<uuid>
required
read-only
dry_run
boolean
required
read-only
matched_device_count
integer
required
read-only
filtered_out_device_count
integer
required
read-only
unassigned_devices
object[]
required
read-only
not_member_devices
object[]
required
read-only