Skip to content

IPs

A floating IP is a public address that can be moved between instances without changing the address itself. Each IP belongs to a workspace and can be attached to at most one instance at a time. DHCP settings control how the platform delivers the address to the guest. Reverse DNS (rDNS) maps the IP back to a hostname.

Allocation and release are asynchronous and return workflows. Attach and detach are command endpoints covered in Network commands.

See Workspaces and scope and Pagination for shared conventions.

Search IPs

GET/v1/workspaces/{wid}/ipsSearch IPs in a workspace

Lists the floating IPs in a workspace, with pagination.

Path parameters

NameTypeDescription
widintegerWorkspace ID

Query parameters

NameTypeDescription
qstringQuick search by address or ID
addressstringFilter by exact or partial IP address
instanceinteger[]Filter to IPs attached to specific instance IDs
availablebooleanWhen true, return only unattached IPs
dnsstringFilter by reverse DNS value
regionstringFilter by region, for example NA_01
typestringFilter by IP family: IPv4 or IPv6

Plus the shared pagination parameters. Returns a paged list of IP objects.

Allocate a floating IP

POST/v1/workspaces/{wid}/ipsAllocate a floating IP

Allocates a new standalone floating IP in the workspace. The system automatically selects a free address in the requested region and family.

Path parameters

NameTypeDescription
widintegerWorkspace ID

Request body

FieldTypeRequiredDescription
typestringyesIP family to allocate: IPv4 or IPv6
ddosbooleanyesWhether to allocate from a DDoS-protected address pool
regionstringyesRegion to allocate in, for example NA_01
bash
curl -X POST https://api.galaxygate.net/v1/workspaces/42/ips \
  -H "Authorization: Bearer $GALAXYGATE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "IPv4",
    "ddos": false,
    "region": "NA_01"
  }'

Returns a WorkflowWithResource containing the new IP object. Poll the workflow until it completes, then use the IP ID to attach it to an instance via POST /v1/commands/attach-ip.

Fetch an IP

GET/v1/networking/ips/{id}Fetch an IP address

Path parameters

NameTypeDescription
idintegerIP address ID

Returns the full IP object, including the attached instance and range details.

Release a floating IP

DELETE/v1/ips/{fid}Release a floating IP

Releases the address back to the pool. The IP must be detached from any instance before it can be released.

Path parameters

NameTypeDescription
fidintegerIP address ID

Returns a WorkflowData object. This is an asynchronous operation.

Set reverse DNS

PUT/v1/networking/ips/{id}/dnsSet reverse DNS for an IP

Sets or replaces the rDNS PTR record for an IP address.

Path parameters

NameTypeDescription
idintegerIP address ID

Request body

FieldTypeRequiredDescription
dnsstringyesHostname to point to, for example mail.example.com

Returns a WorkflowData object.

Remove reverse DNS

DELETE/v1/networking/ips/{id}/dnsRemove reverse DNS for an IP

Clears the rDNS PTR record, returning the address to default reverse DNS.

Path parameters

NameTypeDescription
idintegerIP address ID

Returns a WorkflowData object.

Fetch DHCP settings

GET/v1/instances/{id}/dhcpFetch DHCP settings for an instance

Returns the DHCP configuration for an instance. When no custom settings have been applied the response is empty and the platform uses automatic addressing.

Path parameters

NameTypeDescription
idintegerInstance ID

Returns the DHCP settings object.

Update DHCP settings

PUT/v1/instances/{id}/dhcpUpdate DHCP settings for an instance

Replaces the DHCP configuration for an instance. All fields are optional; omit a field to leave it unchanged.

Path parameters

NameTypeDescription
idintegerInstance ID

Request body

FieldTypeDescription
enabledbooleanWhether DHCP is enabled for this instance
v4integerIPv4 address ID to assign via DHCP
v6integerIPv6 address ID to assign via DHCP

Returns a WorkflowData object. Network changes take effect once the workflow completes.

Delete DHCP settings

DELETE/v1/instances/{id}/dhcpDelete DHCP settings for an instance

Removes any custom DHCP settings and restores automatic mode.

Path parameters

NameTypeDescription
idintegerInstance ID

Returns a WorkflowData object.