Plans and nodes

Plans are the preset instance sizes you pick when provisioning with type: PLAN. Each plan fixes the vCPU count, memory, disk size, network speed, and hourly rate. Nodes are the underlying compute hosts. Most callers never need the node endpoints; they are primarily useful for private-cloud workspaces that target a specific host.

Search plans

GET/v1/plansSearch available plans

Returns plans available on the platform, with pagination.

Query parameters

Name	Type	Description
q	string	Quick search by name or ID
id	integer[]	Filter to specific plan IDs
name	string	Filter by plan name
group	string	Filter by service group: LIGHTNING, RYZEN, DEDICATED
rate	integer	Return only plans with an hourly rate at or below this value (micro-USD)
disabled	boolean	Pass true to include disabled plans; pass false to exclude them

Returns a keyset-paged list of plan objects. Each item includes:

Field	Type	Description
id	string	Plan ID
name	string	Display name
group	string	Service group: LIGHTNING, RYZEN, or DEDICATED
cpu	integer	Number of vCPU cores
memory	integer	Allocated memory in bytes
disk_size	integer	Boot disk size in bytes
upload	integer	Upload bandwidth cap in bytes per second
download	integer	Download bandwidth cap in bytes per second
rate	integer	Hourly rate in micro-USD
disabled	boolean	Whether the plan is unavailable for new instances
backup_plan	object	Default backup plan attached to this plan, if any: { "id", "name" }

curl "https://api.galaxygate.net/v1/plans?group=LIGHTNING" \
  -H "Authorization: Bearer $GALAXYGATE_TOKEN" \
  -A 'curl/8.5'

Fetch a plan

GET/v1/plans/{id}Fetch plan detail

Returns the full detail for one plan, including IO limits.

Path parameters

Name	Type	Description
id	integer	Plan ID

Returns a plan detail object. All fields from the list view apply, plus:

Field	Type	Description
io_limits	object	Disk IO limits for this plan, or null if none are set. Fields: read_bytes_sec, write_bytes_sec, read_iops, write_iops (all integers, bytes or operations per second)

List nodes

GET/v1/nodesList all nodes

Administrator only

This endpoint is restricted to administrator sessions. A user-scoped token receives 400 Bad Request.

Returns all compute nodes across the platform.

Query parameters

Name	Type	Description
q	string	Quick search by name or ID
id	integer[]	Filter to specific node IDs
owner	integer[]	Filter by owning workspace ID
group	string	Filter by service group: LIGHTNING, RYZEN, DEDICATED
region	string	Filter by region, for example NA_01
name	string	Filter by node name

Plus the shared pagination parameters. Returns a keyset-paged list of node objects.

Fetch a node

GET/v1/nodes/{id}Fetch node detail

Returns the detail for a single node.

Path parameters

Name	Type	Description
id	integer	Node ID

Returns a node detail object. Fields:

Field	Type	Description
id	string	Node ID
name	string	Node hostname
owner	object	Workspace that owns this node, if privately owned: { "id", "name" }, or null for platform nodes
group	string	Service group
region	string	Region where the node is deployed
max_memory	integer	Total memory available on the node in bytes
cores	integer	Number of CPU cores
flags	string[]	Capability flags. Currently defined: CEPH (node participates in the Ceph cluster)

List workspace nodes

GET/v1/workspaces/{wid}/nodesList nodes available to a workspace

Returns the nodes available to a workspace. For private-cloud workspaces this lists the nodes owned by that workspace; for standard workspaces the list is empty because placement is managed by the allocator.

Path parameters

Name	Type	Description
wid	integer	Workspace ID

Query parameters

Same filter parameters as List nodes above.

Plus the shared pagination parameters. Returns a keyset-paged list of node objects.

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