Exaion
Administration

API keys

Create, renew and revoke the keys your tools use to send proofs to Wipe. Client admins only.

An API key lets one of your tools talk to Wipe without a user account: an inventory system that sends proofs as they arrive, or a script that collects certificates. Keys belong to your organization, and only client admins manage them, from Settings → API keys.

Create a key

Open the form

In Settings → API keys, click Create key.

Name the key and pick its scopes

Give the key a Name that says what uses it (for example inventory-sync), then tick its Scopes:

ScopeAllows
Read proofsView proofs and their status
Write proofsCreate and submit proofs

With nothing ticked, the key gets Write proofs only. Give each key only what its tool needs.

Copy the key

The portal shows the key once. Click Copy key and store it in your tool's secret store right away: afterwards, the portal only shows its prefix.

An API key never gives access to users, licenses, settings or certificate revocation, whatever its scopes.

Use the key

Send the key in the X-Api-Key header. Every write also needs a unique Idempotency-Key header, so that a request sent twice by mistake is processed once. For example, to submit a proof:

curl -X POST "https://app.wipe.exaion.com/api/v1/proofs" \
  -H "X-Api-Key: $WIPE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "file=@proof.der"

The same limits as in the portal apply (5 MB per proof). All the routes are described in the API reference. When your organization restricts access by IP address, keys only work from the allowed networks.

Renew or revoke a key

The list shows each key with its prefix, its scopes and when it was last used. Tick Include revoked to see revoked keys too.

  • Rotate replaces the secret: the old one stops working at once, and the portal shows the new one once. Update your tool right after.
  • Revoke disables the key for good. Tools and agents that use it lose access.

Renew keys regularly, and revoke at once a key that may have leaked or that nothing uses any more. Creating, renewing and revoking keys are sensitive actions: the portal may first ask you to confirm your identity.

Contents