API keys

API keys let your own systems and integrations talk to GitCharger programmatically, scoped to your workspace. Manage them under Settings → API keys.

note

This page is about managing keys in the dashboard. The public REST API itself (endpoints and payloads) is documented separately and is coming soon.

Create a key

1. Go to Settings → API keys and choose Create key.
2. Give it a label so you can recognize it later.
3. Set its scope, the permissions and the set of chargers the key may act on.
4. Create the key and copy the secret now: it's shown once and can't be retrieved again. Store it somewhere safe.

Manage keys

From a key's detail you can:

• review its scope and the chargers it's allowed to act on,
• adjust scope assignments, and
• revoke the key if it's no longer needed or may be compromised.

Good practice

• Create a separate key per integration so you can revoke one without affecting others.
• Grant the narrowest scope that works.
• Rotate keys periodically and revoke anything unused.

Related

• Members & roles, human access (vs. programmatic keys).
• API reference (the REST API, coming soon).