ports

Extend a reservation.

Changed on

Moves the reservation's expiry to now plus ttl_secs. A reservation that has already lapsed is gone: request it again with the same owner_id through POST /api/ports/reservations instead.

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

Request

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

Path parameters

idstring uuid required

Reservation id

Request body

ttl_secsinteger nullable

New lifetime in seconds, counted from now. Defaults to the server's configured TTL.

Response

The renewed 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