GovDash
Menu

Security

Use a separate service account for each integration, keep its keys on your server, and restrict what it can access. For how keys are stored and validated, see Authentication.

Store keys on your server

  • Keep keys in a secrets manager or an environment variable, such as GOVDASH_API_KEY. Don't commit them to source control.
  • Never put a key in browser code, mobile apps, or anything else you ship to users. Anyone who has the key can act as its service account. Call the API from your backend instead.
  • Don't log the Authorization header.

The Try it form in the API reference is the one place GovDash asks you to paste a key into a browser. It keeps the key only in that browser tab and sends it only to the API. Use a separate key for it that you can revoke, and click Forget when you're done.

Warning

If a key leaks, open Developer settings, choose the service account's API keys, and revoke it right away. Create a replacement key and update the integration before resuming requests.

Use least privilege

  • Create a separate service account for each integration. Then you can revoke one integration's access without touching the others, and the audit trail shows which integration did what.
  • Give each service account the narrowest role that works. A key can do whatever its service account's role allows. If a request returns 403 forbidden, add the one permission it needs rather than switching to an admin role.
  • Use an UNCLASSIFIED key unless the integration needs CUI. See Classification.
  • Set an expiration of 30, 90, or 180 days unless you have a reason not to.

Restrict source IP addresses

When you create a key in Developer settings, enter the public CIDR ranges your integration uses in Allowed IP ranges, one per line. For a single address, use /32 for IPv4 or /128 for IPv6. Requests from other addresses are rejected. Leave the allowlist empty only if the integration needs to connect from any address.

Use your server's outbound public address, not its private network address. If you use a proxy or NAT gateway, allow that gateway's outbound address. Restrictions are set when you create the key. If your infrastructure changes, create a replacement key with the new ranges, deploy it, and revoke the old key.

Rotate keys

A service account can have more than one active key, so you can rotate without downtime:

  1. Create a new key on the same service account.
  2. Deploy the new key everywhere the old one is used.
  3. Watch the old key's Last used column until it stops changing. It updates at most once a minute.
  4. Revoke the old key. You can't undo this.

Report a security issue

If you think you've found a security problem in the API, email [email protected] right away rather than testing it further.

Security questionnaires

To send us a security questionnaire, email [email protected].