Skip to main content
Paygrid Operator docs
Browse documentation

Reference

How do I create or revoke an API access key?

Create tenant-scoped API keys with read scopes, expiry, and IP restrictions, then suspend, reactivate, or revoke them.

To manage a customer-data or monitoring integration, open Settings → API Access. Choose a Key name, optional Expires at date, one or more Scopes, and optional Allowed IPs / CIDRs, then select Create API Key.

Limit and manage a key

Available scopes are Customers: read, Billing: read, and Monitoring: read. Select only the scopes the integration needs. Add exact IP addresses or CIDR ranges to restrict the source; leaving Allowed IPs / CIDRs empty allows any IP.

The generated plain-text key is shown once. Copy it when created; it is not shown again after leaving or refreshing the page. Treat the copied value as a credential and store it in the integration that uses the key.

The API Keys list shows each key's status, expiry, scopes, allowed IPs, last-used time, and last-used IP. Choose Suspend to temporarily disable an active key, Activate to restore a suspended key, or Revoke to invalidate a key permanently.

The Blocked IPs panel lists addresses blocked after repeated rate-limit breaches. Clear removes the displayed block. API access management is tenant-scoped; this page does not show keys from other workspaces.