Skip to navigation
API Referencepublic-ips

Reserve a new public IP address

Reserves a public IP address and associates it with the specified virtual machine. The region is automatically inferred from the virtual machine. To preview pricing without reserving anything, use POST /networks/public-ip/cost-estimate.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Request

This endpoint expects an object.
regionstringRequired
Label of the region where the IP address should be allocated
networkIdstringOptionalformat: "uuid"
Identifier of the isolated network the public IP should attach to.
vpcIdstringOptionalformat: "uuid"
Identifier of the VPC the public IP should attach to.

Response

The public IP address has been reserved
idstringformat: "uuid"
Unique identifier for the public IP address.
ipAddressstringformat: "ipv4"
The public IPv4 address.
networkIdstringformat: "uuid"
Identifier of the network the IP is associated with.
statusstring
Current lifecycle state of the IP address.
regionstring
Region the IP is allocated in.
isSourceNatboolean
Whether this IP is used as the source NAT for its network.
vmIdstringOptionalformat: "uuid"
Identifier of the VM the IP is assigned to via static NAT.
vmNamestringOptional
Name of the VM the IP is assigned to via static NAT.
createdAtdatetimeOptional
When the IP was allocated.
isStaticNatbooleanOptional
Whether this IP is configured as a static NAT.
hasFirewallRulesbooleanOptional
Whether any firewall rules currently reference this IP.
vpcIdstringOptionalformat: "uuid"
Identifier of the VPC the IP is associated with, when applicable.
vpcNamestringOptional
Name of the VPC the IP is associated with, when applicable.
associatedNetworkIdstringOptionalformat: "uuid"
Identifier of the network tier the IP is attached to inside the parent VPC.
associatedNetworkNamestringOptional
Name of the network tier the IP is attached to inside the parent VPC.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error