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
/v1/workspaces/{wid}/ipsSearch IPs in a workspaceLists the floating IPs in a workspace, with pagination.
Path parameters
| Name | Type | Description |
|---|---|---|
wid | integer | Workspace ID |
Query parameters
| Name | Type | Description |
|---|---|---|
q | string | Quick search by address or ID |
address | string | Filter by exact or partial IP address |
instance | integer[] | Filter to IPs attached to specific instance IDs |
available | boolean | When true, return only unattached IPs |
dns | string | Filter by reverse DNS value |
region | string | Filter by region, for example NA_01 |
type | string | Filter by IP family: IPv4 or IPv6 |
Plus the shared pagination parameters. Returns a paged list of IP objects.
Allocate a floating IP
/v1/workspaces/{wid}/ipsAllocate a floating IPAllocates a new standalone floating IP in the workspace. The system automatically selects a free address in the requested region and family.
Path parameters
| Name | Type | Description |
|---|---|---|
wid | integer | Workspace ID |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
type | string | yes | IP family to allocate: IPv4 or IPv6 |
ddos | boolean | yes | Whether to allocate from a DDoS-protected address pool |
region | string | yes | Region to allocate in, for example NA_01 |
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
/v1/networking/ips/{id}Fetch an IP addressPath parameters
| Name | Type | Description |
|---|---|---|
id | integer | IP address ID |
Returns the full IP object, including the attached instance and range details.
Release a floating IP
/v1/ips/{fid}Release a floating IPReleases the address back to the pool. The IP must be detached from any instance before it can be released.
Path parameters
| Name | Type | Description |
|---|---|---|
fid | integer | IP address ID |
Returns a WorkflowData object. This is an asynchronous operation.
Set reverse DNS
/v1/networking/ips/{id}/dnsSet reverse DNS for an IPSets or replaces the rDNS PTR record for an IP address.
Path parameters
| Name | Type | Description |
|---|---|---|
id | integer | IP address ID |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
dns | string | yes | Hostname to point to, for example mail.example.com |
Returns a WorkflowData object.
Remove reverse DNS
/v1/networking/ips/{id}/dnsRemove reverse DNS for an IPClears the rDNS PTR record, returning the address to default reverse DNS.
Path parameters
| Name | Type | Description |
|---|---|---|
id | integer | IP address ID |
Returns a WorkflowData object.
Fetch DHCP settings
/v1/instances/{id}/dhcpFetch DHCP settings for an instanceReturns 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
| Name | Type | Description |
|---|---|---|
id | integer | Instance ID |
Returns the DHCP settings object.
Update DHCP settings
/v1/instances/{id}/dhcpUpdate DHCP settings for an instanceReplaces the DHCP configuration for an instance. All fields are optional; omit a field to leave it unchanged.
Path parameters
| Name | Type | Description |
|---|---|---|
id | integer | Instance ID |
Request body
| Field | Type | Description |
|---|---|---|
enabled | boolean | Whether DHCP is enabled for this instance |
v4 | integer | IPv4 address ID to assign via DHCP |
v6 | integer | IPv6 address ID to assign via DHCP |
Returns a WorkflowData object. Network changes take effect once the workflow completes.
Delete DHCP settings
/v1/instances/{id}/dhcpDelete DHCP settings for an instanceRemoves any custom DHCP settings and restores automatic mode.
Path parameters
| Name | Type | Description |
|---|---|---|
id | integer | Instance ID |
Returns a WorkflowData object.