API Keys

Create Api Key

Mint a new API key for the caller's own org. The token is returned exactly once.

post/api-keys

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/api-keys
  • Auth: HTTP bearer

Headers

X-Target-Org-Idstring nullable
Authorizationstring nullable

Request body

namestring required

Human-readable name for the key

expires_in_daysinteger nullable

Days until key expires (optional)

mode'live' | 'test' | 'sandbox'

Key mode. A 'test' key is returned with a g8_test_ prefix; a 'live' key carries g8_live_; a 'sandbox' key carries g8_sbx_ and only authenticates against the graph8 developer sandbox. A key minted by a 'test'-mode credential is always forced to 'test' regardless of this field — a test key may not mint itself a live successor.

scopesstring[] nullable

Restrict the new key to specific resource:action scopes (e.g. ['contacts:read', 'deals:']). '' grants everything; 'resource:*' grants every action on a resource. Omitted or empty grants the full current scope vocabulary (today's status quo for an unscoped key), stored explicitly so the key stays narrowable and auditable rather than permanently unrestricted.

ip_allowliststring[]

Optional list of IPv4/IPv6 CIDR strings (e.g. ['10.0.0.0/8', '2001:db8::/32']). Bare IPs are accepted as /32 (IPv4) or /128 (IPv6). When non-empty, only requests from a matching IP are accepted — all others receive 403. Empty list (the default) means unrestricted: the key works from any IP address. Maximum 50 entries.

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.