GalaxyGate Docs

API reference ​

This section is a summary of our API. The full documentation with every schema is at api.galaxygate.net/docs. If you are just getting started, read the guides first.

Our API root is:

https://api.galaxygate.net/v1

Endpoint paths on these pages include /v1. Append them to https://api.galaxygate.net once.

The conventions below apply to every endpoint, so each page assumes them rather than repeating them.

Authentication ​

Protected calls carry a bearer token in the Authorization header. We also accept authenticated browser cookies. Open operations, including login, registration, and gateway webhooks, do not require bearer authentication. You create a token in the panel under Security, or through the Tokens endpoints.

Authorization: Bearer <your-token>

A protected request without a bearer token or authenticated browser cookie returns 403 Forbidden. A token the server does not recognize is rejected with 401 Unauthorized. We return an ApiError JSON body with status, error, and optional nullable code. We do not use an X-Message header.

Workspaces and scope ​

Most resources belong to a workspace. Collection endpoints are addressed under the workspace, for example GET /v1/workspaces/{wid}/instances, while endpoints that act on one resource are addressed by that resource's own ID, for example GET /v1/instances/{iid}. Your access to each call is checked against your role in the owning workspace (member, admin, or owner) and resource write grants.

Pagination ​

Paginated endpoints accept the following query parameters. Other collection endpoints may return arrays. Each resource page identifies its response.

ParameterTypeDefaultDescription
limitinteger50How many items to return
pageinteger1Page number to fetch
sortstringField to order by, for example id
dirstringascOrder direction, asc or desc
afterstringForward keyset cursor, from a previous page's after
beforestringBackward keyset cursor, from a previous page's before

A list response wraps the rows in items and carries cursors for the next and previous pages:

json
{
  "items": [],
  "total": 0,
  "limit": 50,
  "page": 1,
  "has_next": false,
  "has_previous": false,
  "after": null,
  "before": null
}

Follow after to walk forward and before to walk back. When a cursor is null, there is no page in that direction.

Asynchronous operations ​

Each endpoint specifies its status and response schema. Operations documented as 202 Accepted with WorkflowData return a workflow immediately. A 202 response can also have an empty body. Other asynchronous operations return 200 OK with a workflow wrapper or a resource. Billing orders return 200 OK with CreateOrderResponse.

A WorkflowData response includes:

json
{
  "id": "9f2c1d7a-4b83-4c1e-9a55-6d0f3b8e27c4",
  "name": "instance.power",
  "state": "QUEUED",
  "duration": 0,
  "started": "2026-10-28T07:26:11Z"
}

state starts at QUEUED and moves through RUNNING to COMPLETED, or one of FAILED, ABORTED, TIMED_OUT. Watch it in one of two ways:

  • Poll the workflow at GET /v1/workspaces/{wid}/workflows/{wfid} (see Workflows).
  • Poll the affected resource, for example GET /v1/instances/{iid}, and watch its own state settle.

An instance state is one of PENDING, AVAILABLE, FAILED, SUSPENDED, DELETING, or UNPLACED. Pages note where a call behaves this way.

Errors ​

StatusMeaning
400 Bad RequestThe request failed validation. Read error in the ApiError body.
401 UnauthorizedThe bearer token is invalid or expired.
403 ForbiddenNo token was sent, or your role does not allow the action.
404 Not FoundThe resource does not exist, or is not visible to your workspace.
409 ConflictThe resource is in a state that does not allow the action.
429 Too Many RequestsYou hit the rate limit. Back off and retry after a short delay.

Pages identify operations requiring workspace admin, account owner, or staff access. A workspace admin role does not grant staff privileges.

Resources ​

Compute ​

  • Instances: search, inspect, power, and update servers, with links to billing orders and cancellation.
  • Instance commands: snapshots, ISOs, recipes, password resets, upgrades, and batch actions.
  • Snapshots: point-in-time disk snapshots.
  • Disks: additional block volumes.
  • Images: templates and backups you can provision from.
  • Recipes: reusable first-boot install scripts.

Networking ​

  • Firewall rules: per-instance network ACLs.
  • IPs: floating IPs, address ranges, DHCP, and reverse DNS.
  • VPCs: private networks and attachments.
  • Network commands: attach, detach, and auto-assign IPs.
  • Load balancers: network load balancers and their members.
  • BGP: bring-your-own-IP announcements.

Software and apps ​

Access and account ​

  • Workspaces: workspaces, members, invites, and quota.
  • Tokens: API tokens and their permissions.
  • SSH keys: workspace SSH keys.
  • Account: sign up, sign in, profile, password, two-factor, and feedback.
  • OAuth apps: register and authorize OAuth applications.
  • Audit logs: the record of workspace actions.

Platform ​