API ReferenceReserved Ips

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

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.

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

Response

Public IP reserved successfully.
public_ip_idstring
addressstring
site_idstring
statusstring
created_atdatetime
updated_atdatetime
organization_idstringOptional
workspace_idstringOptional
labelstringOptional
reverse_dnsstringOptional
reservation_typeenum or nullOptional
attached_resource_typestring or nullOptional
attached_resource_idstring or nullOptional
attached_vpc_idstring or nullOptional
attached_subnet_idstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
409
Conflict Error