Skip to navigation

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.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl -X POST "https://api.ibee.ai/v1/networking/reserved-ips?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"site_id": "68b99bd78a8eda32ff3f16ea"}'

Authentication

AuthorizationBearer

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

X-Idempotency-KeystringOptionalformat: "^[!-~]{1,256}$"1-256 characters

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_progress with Retry-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

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
site_idstringRequired

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.

labelstringOptional<=120 charactersDefaults to

Optional label for the address (up to 120 characters), shown as its name in the portal.

Response

Public IP reserved successfully.
public_ip_idstring
Unique ID of the Reserved IP.
addressstring
The IPv4 address.
site_idstring
Site whose pool the address comes from.
statusstring

reserved when not attached, attached when in use, releasing while being released.

created_atdatetime

When the resource was created (ISO 8601).

updated_atdatetime

When the resource was last changed (ISO 8601).

organization_idstringOptional
ID of the owning organization.
workspace_idstringOptional
ID of the owning workspace.
labelstringOptional
Label shown as the address's name in the portal.
reverse_dnsstringOptional

Reverse DNS hostname set on the address; empty when none.

reservation_typeenum or nullOptional
  • 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.
Allowed values:
attached_resource_typestring or nullOptional

Kind of resource the address is attached to, for example vm or nat_gateway; null when not attached.

attached_resource_idstring or nullOptional

ID of that resource; null when not attached.

attached_vpc_idstring or nullOptional
VPC of the attachment, when the address is attached inside a VPC.
attached_subnet_idstring or nullOptional
Subnet of the attachment, when the address is attached inside a VPC.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error