Create a new API key

Mints an API key bound to an allowed role. Only SUPER_ADMIN may mint SPAR_MARKUP_INTEGRATION, SPAR_MATCHED_INTEGRATION, or SPAR_RECONCILIATION_INTEGRATION. Only SUPER_ADMIN may also mint MVNO_INTEGRATION, which is partnerless, uses the protected role live permission set, requires an explicit environment, and rejects open internet CIDRs. The plain key is returned ONCE in plainKey — store it immediately. The caller must hold a permission-superset of the requested role. Each key requires one or more allowed source IP addresses or CIDR ranges.

Access: Auth methods: JWT bearer. Allowed user types: PARTNER, MVNO. Requires permissions: api-key:admin.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
enum
required
Allowed:
string

Partner UUID. REQUIRED iff role === PARTNER_ADMIN; FORBIDDEN otherwise.

string
enum
Defaults to production

Required and enforced at authentication time for MVNO_INTEGRATION keys. Also enforced for SPAR_MARKUP_INTEGRATION, SPAR_MATCHED_INTEGRATION, and SPAR_RECONCILIATION_INTEGRATION keys. For existing human roles this remains metadata pending a compatibility migration.

Allowed:
string
allowedSourceCidrs
array of strings
required

One to 50 allowed source IP addresses or CIDR ranges. Exact IPs are normalized to /32 or /128. MVNO_INTEGRATION rejects 0.0.0.0/0 and ::/0.

allowedSourceCidrs*
Responses
201

Key created; plainKey shown once.

400

Invalid request body, source CIDR list, or partner mismatch

403

Caller cannot mint a key with that role

404

Partner UUID not found

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!