GalaxyGate Docs

Appearance

API reference ​

This is the full reference for our API: every resource, every endpoint. If you are just getting started, read the guides first. This section is the exhaustive map you come back to.

Every path is relative to the API root:

https://api.galaxygate.net/v1

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

Authentication ​

Every call carries a bearer token in the Authorization header. You create one in the panel under Security, or through the Tokens endpoints.

Authorization: Bearer <your-token>

A request with no Authorization header is rejected with 403 Forbidden. A token the server does not recognize is rejected with 401 Unauthorized. The reason is returned in an X-Message header and the body is empty.

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/{id}. Your access to each call is checked against your role in the owning workspace (Viewer, Editor, Administrator, or Owner).

Pagination ​

List endpoints accept these query parameters and return a paged envelope.

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": [ /* ... */ ],
  "hasNext": true,
  "hasPrevious": false,
  "after": "b3BhcXVl",
  "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 ​

Anything that provisions, changes, or tears down real infrastructure runs in the background. Those endpoints return a workflow object right away instead of the finished resource, and typically respond with 202 Accepted. The workflow object looks like this:

json
{ "id": "wf_01H...", "name": "instance.power", "state": "QUEUED" }

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/workflows/{wfid} (see Workflows).
  • Poll the affected resource, for example GET /v1/instances/{id}, and watch its own state settle.

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

Errors ​

StatusMeaning
400 Bad RequestThe body failed validation. The reason is in the X-Message header, and field errors come back in the 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.

Some endpoints are marked Administrator or Operator only. Those require an elevated role and are listed for completeness; a normal workspace token cannot call them.

Resources ​

Compute ​

  • Instances: create, search, inspect, power, and update servers.
  • 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, DHCP, and reverse DNS.
  • VPCs: private networks and attachments.
  • Network commands: attach, detach, and auto-assign IPs; suspend networking.
  • 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, and two-factor.
  • OAuth apps: register and authorize OAuth applications.
  • Audit logs: the record of workspace actions.

Platform ​