Connecting
:::caution Last revised 2026-05-01 — not re-verified
This page has not been checked against the running system since it was
written, and predates a large part of the current product. It is scheduled
for rewrite. For anything about the API, /docs on a running server is
authoritative.
:::
Before you can run GRASS modules or add layers you need to point the GRASS Runner at a running FastGIS server and supply an API token.
Connection panel
Open the Connection section in the left panel. You will find two fields:
| Field | Description |
|---|---|
| Base URL | The root URL of the FastGIS server, e.g. https://fastgis.example.com |
| X-API-Key | Your personal API token (generated in Settings → Profile) |
Click Connect & load environments to validate the connection and populate the Environment dropdowns.
Generating an API token
- Log in and navigate to Profile (top-right menu)
- Click Generate token
- Copy the token — it is only shown once
Store your token securely. Anyone with the token can run GRASS modules on your behalf.
Selecting an environment
After connecting, choose a Location and Mapset from the dropdowns. The environment id shown below the selects (location/mapset) is used in all subsequent API calls.
Persisted credentials
The base URL is saved to localStorage automatically. The API key is never stored in localStorage — you need to re-enter it after a page refresh, or use the Workspace autosave feature which stores connection details in the session state.