Skip to content

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.

Search dediboxes

GET/v1/workspaces/{wid}/dediboxSearch dediboxes in a workspace

Returns the dediboxes in a workspace, with pagination.

Path parameters

NameTypeDescription
widintegerWorkspace ID

Query parameters

NameTypeDescription
qstringQuick search by name or ID
idinteger[]Filter to specific dedibox IDs
namestringFilter by name
regionstringFilter by region, for example NA_01
onlinebooleanOnly online (true) or only offline (false) dediboxes

Plus the shared pagination parameters. Returns a paged list of dediboxes. Each item includes id, name, region, online, plan, and owner.

bash
curl -A 'curl/8.5' \
  -H "Authorization: Bearer $GALAXYGATE_TOKEN" \
  "https://api.galaxygate.net/v1/workspaces/1524141521580666880/dedibox"

Fetch a dedibox

GET/v1/dedibox/{id}Fetch dedibox detail

Path parameters

NameTypeDescription
idintegerDedibox ID

Returns the full dedibox object, including name, region, online, plan, 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

PATCH/v1/dedibox/{id}Update dedibox settings

Updates dedibox settings. Every field is optional; send only what you are changing.

Path parameters

NameTypeDescription
idintegerDedibox ID

Request body

FieldTypeDescription
namestringRename the dedibox (4 to 32 characters)

Returns the updated dedibox.

Power cycle a dedibox

POST/v1/commands/dedibox-power-cycleIssue a power action

Issues a power action on a dedibox. Responds 202 Accepted with a workflow. SHUTDOWN is not supported and will be rejected.

Request body

FieldTypeRequiredDescription
dedibox_idintegeryesDedibox ID
actionstringyesOne of POWER_ON, POWER_OFF, POWER_CYCLE

Returns a workflow. Poll GET /v1/dedibox/{id} and watch online settle.

Reset VNC

POST/v1/commands/dedibox-reset-vncReset the VNC connection

Resets the VNC connection for a dedibox, which can resolve connection issues. Returns a workflow.

Request body

FieldTypeRequiredDescription
dedibox_idintegeryesDedibox 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

GET/v1/workspaces/{workspace}/dedibox/ipsList dedibox IPs for a workspace

Path parameters

NameTypeDescription
workspaceintegerWorkspace ID

Query parameters

NameTypeDescription
qstringQuick search by address or ID
idinteger[]Filter to specific IP IDs
dediboxinteger[]Filter to specific dedibox IDs
addressstringFilter by IP address string
typestringFilter by address family: IPv4 or IPv6

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

List IPs on a dedibox

GET/v1/dedibox/{id}/ipsList IPs attached to a dedibox

Path parameters

NameTypeDescription
idintegerDedibox ID

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

Add an IP to a dedibox

POST/v1/dedibox/{id}/ipsAdd an IP address

Responds 202 Accepted. Fails with 409 Conflict if the address is already in use.

Path parameters

NameTypeDescription
idintegerDedibox ID

Request body

FieldTypeDescription
addressstringIP address to attach
typestringAddress family: IPv4 or IPv6

Returns the created dedibox IP object.

Fetch an IP

GET/v1/dedibox/{id}/ips/{ip}Fetch a single IP record

Path parameters

NameTypeDescription
idintegerDedibox ID
ipintegerIP record ID

Returns the dedibox IP object.

Update an IP (reverse DNS and type)

PUT/v1/dedibox/{id}/ips/{ip}Update an IP record

Replaces the IP record. Fails with 409 Conflict if the address is already in use on another record.

Path parameters

NameTypeDescription
idintegerDedibox ID
ipintegerIP record ID

Request body

FieldTypeDescription
addressstringNew IP address
typestringAddress family: IPv4 or IPv6

Returns the updated dedibox IP object.

Remove an IP

DELETE/v1/dedibox/{id}/ips/{ip}Remove an IP from a dedibox

Responds 202 Accepted. Returns no body.

Path parameters

NameTypeDescription
idintegerDedibox ID
ipintegerIP record ID