Skip to navigation

Convert a VM public IP to a Reserved IP

Turns the automatically assigned public IPv4 of a VM into a Reserved IP that survives the VM, as the portal’s Convert Existing IP does. The address stays on the VM. Billing for the Reserved IP starts now. 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/convert?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"vm_id": "<vm_id>", "site_id": "<site_id>"}'

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.
vm_idstringRequired1-160 characters
VM whose current public IPv4 becomes a Reserved IP.
site_idstringRequired1-120 characters

The VM’s site, from GET /networking/sites.

labelstringOptional<=120 characters
Optional label for the Reserved IP.

Response

Reserved IP created.
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

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found 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