Gel EdgeQL over HTTP

REST discovered

Details

URL: https://<hostname>:<port>/branch/<branch-name>/edgeql
Docs: https://docs.geldata.com/reference/using/http

Authentication

Gel database username and password basic discovered

Authorization: Basic <credential>

Create or set a database role password on your Gel instance. The docs note Gel creates an admin user by default with a randomized password, and you can set one with alter role admin { set password := '<password>'; }; or create a new role with create superuser role <name> { set password := '<password>'; };. For linked or local instances, the CLI can also save these credentials locally as described in Connection parameters.

Gel database JWT for SIMPLE_HTTP transport Authorization: Bearer <credential> + Gel database username and password X-EdgeDB-User: <credential> discovered

Gel database JWT for SIMPLE_HTTP transport jwt

Configure your Gel instance to use cfg::JWT for the SIMPLE_HTTP transport as described in EdgeQL over HTTP. Then mint a JWT for a Gel database user according to your instance's JWT configuration. Requests must include Authorization: Bearer <token> and X-EdgeDB-User: <gel-username>.

Gel Cloud secret key api_key discovered Get key ↗

Authorization: Bearer <credential>

Create a Gel Cloud secret key from the Gel Cloud CLI docs. The connection docs state that to authenticate with a Gel Cloud instance you provide the instance name and a secret key; the Cloud docs also say you can generate a secret key in the Cloud UI or by running gel cloud secretkey create.