EYeyevinn
ports

Declare which ports a flow uses.

Changed on

Records that these ports of this reservation are used by that flow. The pool will not return them while the flow exists, so a reservation that lapses under a running pipeline releases only its idle ports. Replaces whatever was recorded for the same flow, so a caller can correct itself by assigning again. Nothing verifies that the flow actually binds them.

post/api/ports/reservations/{id}/assign

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

idstring uuid required

Reservation id

Request body

flow_idstring uuid required

The flow using them.

portsinteger[] required

Ports, all of which must belong to this reservation.

Response

The reservation

created_atstring required

When the reservation was first granted (RFC 3339, UTC).

expires_atstring required

When it lapses unless renewed (RFC 3339, UTC).

idstring uuid required

Reservation identifier, used to renew, release and assign.

owner_idstring required

The owner's stable name. One reservation per owner; asking again returns it.

portsinteger[] required

The ports held, ascending.

Changes