Skip to main content
An API key belongs to one project and one environment. It tells GOL which developer application made a request. Its scopes limit API access, but the key is never a substitute for an account owner’s approval.

Choose the smallest scope

For a first request, select project:read. It is enough for GET /v1/whoami. Add only the scopes needed for the documented testnet account, mandate, action, and webhook operations. A scope does not give an API key owner authority over a mandate. The test environment is available through the hosted public API and, for developers with access to the unpublished password gate, console.gol.network. Existing test API keys work directly with the public API. Live project and credential creation returns capability_unavailable; GOL does not currently support a live or mainnet setup.

Keep keys on the server

Send the key in the Authorization header from a backend service:
Do not put the value in a web page, mobile bundle, URL, analytics event, issue, or repository. GOL displays the new secret once. Later views show only a hint so you can identify the key without exposing it.

Rotate or revoke

Rotate a key when you need to replace it without an abrupt cutover. The local console supports a bounded overlap window so your server can switch to the new secret. Update your server configuration, verify a request using the new key, then let the old key expire or revoke it. Revocation immediately makes the old key unusable.
API keys after a rotation, with the new key Active and the previous key Rotating

After a rotation, the new key is Active and the previous key shows Rotating until its overlap ends. The X button asks for confirmation, then revokes the key.

If a key may be exposed, revoke it immediately and issue a new one. Review the project’s audit events to see authentication activity. See make your first request for the verification call.