Skip to main content
POST
Swap a device in an 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

Inbound and outbound device for an atomic allocation membership swap.

outbound_device_id
string<uuid>
required

Device UUID to remove. Must currently be a member of this allocation.

inbound_device_id
string<uuid>
required

Device UUID to add. Must be in the allocation's site, allocatable, and free of allocations overlapping this one.

dry_run
boolean
default:false

Validate the swap and return the planned outcome without changing memberships.

Response

Typed result for a live allocation device swap or dry run.

allocation_id
string<uuid>
required
read-only
dry_run
boolean
required
read-only
outbound_device
object
required

Compact device reference in an allocation-assignment result.

inbound_device
object
required

Compact device reference in an allocation-assignment result.