Reserve a public IP
Reserves an address from a site’s public IP pool. Discover an available site with GET /networking/sites. Requires scope: network.write.
Authentication
IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.
Headers
Retry key for this create. Send the same key and the same body on every retry. The key is scoped to organization, workspace and path.
- Create completed: you get the original answer for 24 hours, even if the plan limit has since been reached.
- Refused or never sent: nothing was created, so the key is free to use again, including with a corrected body.
- Unknown outcome (timeout, server error, lost connection): 409
idempotency_in_progresswithRetry-After. This usually lasts 30 seconds and at most 3 minutes. Keep retrying with the same key and body. The next retry returns the Reserved IP, subnet or NAT gateway. For a VPC, firewall group or port forward, it either creates the resource or answers 409 “already exists”. - Changed body, while the outcome is unresolved or after the create completed: 409
idempotency_conflict. - New key at the plan limit: 402.
Query parameters
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
Site whose public IP pool allocates the address. Copy an available site_id from GET /networking/sites; use the target VM or VPC’s site when the address will be attached.
Optional label for the address (up to 120 characters), shown as its name in the portal.
Response
reserved when not attached, attached when in use, releasing while being released.
When the resource was created (ISO 8601).
When the resource was last changed (ISO 8601).
Reverse DNS hostname set on the address; empty when none.
user_reserved: a Reserved IP created by the customer.platform_assigned: an address IBEE assigned to an instance or service. Null on legacy records whose classification the service infers.
Kind of resource the address is attached to, for example vm or nat_gateway; null when not attached.
ID of that resource; null when not attached.
