Floating IPs

API Reference

GPU Droplets

Floating IPs

Floating IPs

Create a New Floating IP

gpu_droplets.floating_ips.create(FloatingIPCreateParams**kwargs) -> floating_ipFloatingIPlinksLinksFloatingIPCreateResponse

post/v2/floating_ips

Delete a Floating IP

gpu_droplets.floating_ips.delete(strfloating_ip)

delete/v2/floating_ips/{floating_ip}

List All Floating IPs

gpu_droplets.floating_ips.list(FloatingIPListParams**kwargs) -> metaMetaPropertiesfloating_ipslistlinksPageLinksFloatingIPListResponse

get/v2/floating_ips

Retrieve an Existing Floating IP

gpu_droplets.floating_ips.retrieve(strfloating_ip) -> floating_ipFloatingIPFloatingIPRetrieveResponse

get/v2/floating_ips/{floating_ip}

Floating IP

FloatingIPclass

ShowShow

dropletDropletNullobjectDroplet

optional

The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Requires droplet:read scope.

Hide ParametersShow Parameters

idintbackup_idslistcreated_atdatetimediskintfeatureslistimageImagelockedboolmemoryintnamestrnetworksNetworksnext_backup_windowDropletNextBackupWindowregionRegionsizeSizesize_slugstrsnapshot_idsliststatusliteraltagslistvcpusintvolume_idslistdisk_infolistgpu_infoGPUInfokernelKernelvpc_uuidstrDroplet

DropletNulltype

Optional[object]

If the floating IP is not assigned to a Droplet, the value will be null.

ipstr

optional

The public IP address of the floating IP. It also serves as its identifier.

formatipv4

lockedbool

optional

A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted.

project_idstr

optional

The UUID of the project to which the reserved IP currently belongs.

Requires project:read scope.

formatuuid

regionRegion

optional

The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned.

Floating IPsActions

Initiate a Floating IP Action

gpu_droplets.floating_ips.actions.create(strfloating_ip, ActionCreateParams**kwargs) -> actionActionActionCreateResponse

post/v2/floating_ips/{floating_ip}/actions

List All Actions for a Floating IP

gpu_droplets.floating_ips.actions.list(strfloating_ip) -> metaMetaPropertiesactionslistlinksPageLinksActionListResponse

get/v2/floating_ips/{floating_ip}/actions

Retrieve an Existing Floating IP Action

gpu_droplets.floating_ips.actions.retrieve(intaction_id, ActionRetrieveParams**kwargs) -> actionActionActionRetrieveResponse

get/v2/floating_ips/{floating_ip}/actions/{action_id}