Dedibox
A dedibox is a dedicated bare-metal server assigned to your workspace. These endpoints let you list, inspect, rename, power-cycle, reset the VNC connection, and manage IP addresses on dediboxes. Power cycle is asynchronous and returns a workflow. See shared conventions for pagination, authentication, and error handling. All path parameters are required. All query parameters are optional. IDs are decimal strings.
Search dediboxes
/v1/workspaces/{wid}/dediboxSearch dediboxes in a workspaceReturns the dediboxes in a workspace, with pagination.
Path parameters
| Name | Type | Description |
|---|---|---|
wid | string | Workspace ID |
Query parameters
| Name | Type | Description |
|---|---|---|
q | string | Quick search by name or ID |
id | string[] | Filter to specific dedibox IDs |
name | string | Filter by name |
region | string | Filter by region: NA_01 |
online | boolean | Only online (true) or only offline (false) dediboxes |
Plus the shared pagination parameters. Returns 200 OK with a paged list of dediboxes. Each item includes id, name, region, online, sku, and owner.
curl -A 'curl/8.5' \
-H "Authorization: Bearer $GALAXYGATE_TOKEN" \
"https://api.galaxygate.net/v1/workspaces/1524141521580666880/dedibox"Fetch a dedibox
/v1/dedibox/{did}Fetch dedibox detailPath parameters
| Name | Type | Description |
|---|---|---|
did | string | Dedibox ID |
Returns 200 OK with the full dedibox object, including name, region, online, sku, owner, iso (attached image, if any), and vnc (an object with port, token, and proxied). The vnc.host field is internal and is omitted from user-scoped responses.
Update a dedibox
/v1/dedibox/{did}Update dedibox settingsUpdates dedibox settings. Every field is optional. Send only what you are changing.
Path parameters
| Name | Type | Description |
|---|---|---|
did | string | Dedibox ID |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | Rename the dedibox (4 to 32 characters) |
Returns 200 OK with the updated dedibox.
Power cycle a dedibox
/v1/commands/dedibox-power-cycleIssue a power actionIssues a power action on a dedibox. Responds 202 Accepted with a workflow. SHUTDOWN is not supported and will be rejected.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
dedibox_id | string | yes | Dedibox ID |
action | string | yes | One of POWER_ON, POWER_OFF, POWER_CYCLE |
Returns a workflow. Poll GET /v1/dedibox/{did} and watch online settle.
Reset VNC
/v1/commands/dedibox-reset-vncReset the VNC connectionResets the VNC connection for a dedibox, which can resolve connection issues. Responds 200 OK with a workflow.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
dedibox_id | string | yes | Dedibox ID |
Returns a workflow.
IP addresses
Dediboxes have their own IP address objects separate from floating IPs. Each IP record has an id, address, type (IPv4 or IPv6), and a nested dedibox summary.
List IPs across a workspace
/v1/workspaces/{wid}/dedibox/ipsList dedibox IPs for a workspacePath parameters
| Name | Type | Description |
|---|---|---|
wid | string | Workspace ID |
Query parameters
| Name | Type | Description |
|---|---|---|
q | string | Quick search by address or ID |
id | string[] | Filter to specific IP IDs |
dedibox | string[] | Filter to specific dedibox IDs |
address | string | Filter by IP address string |
type | string | Filter by address family: IPv4 or IPv6 |
Plus the shared pagination parameters. Returns 200 OK with a paged list of dedibox IP objects.
List IPs on a dedibox
/v1/dedibox/{did}/ipsList IPs attached to a dediboxPath parameters
| Name | Type | Description |
|---|---|---|
did | string | Dedibox ID |
Plus the shared pagination parameters. Returns 200 OK with a paged list of IP objects for that dedibox.
Add an IP to a dedibox
/v1/dedibox/{did}/ipsAdd an IP addressStaff only
This operation requires a staff session. User-scoped tokens receive 403 Forbidden.
Responds 202 Accepted with the created IP object. Rejects addresses already in use.
Path parameters
| Name | Type | Description |
|---|---|---|
did | string | Dedibox ID |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
address | string | yes | IP address to attach, matching type |
type | string | yes | Address family: IPv4 or IPv6 |
Returns the created dedibox IP object.
Fetch an IP
/v1/dedibox/{did}/ips/{ip}Fetch a single IP recordPath parameters
| Name | Type | Description |
|---|---|---|
did | string | Dedibox ID |
ip | string | IP record ID |
Returns 200 OK with the dedibox IP object.
Update an IP
/v1/dedibox/{did}/ips/{ip}Update an IP recordStaff only
This operation requires a staff session. User-scoped tokens receive 403 Forbidden.
Replaces the address and type. Rejects addresses already in use on another record.
Path parameters
| Name | Type | Description |
|---|---|---|
did | string | Dedibox ID |
ip | string | IP record ID |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
address | string | yes | New IP address, matching type |
type | string | yes | Address family: IPv4 or IPv6 |
Returns 200 OK with the updated dedibox IP object.
Remove an IP
/v1/dedibox/{did}/ips/{ip}Remove an IP from a dediboxStaff only
This operation requires a staff session. User-scoped tokens receive 403 Forbidden.
Responds 202 Accepted. Returns no body.
Path parameters
| Name | Type | Description |
|---|---|---|
did | string | Dedibox ID |
ip | string | IP record ID |