Andamio Logo
API/Authentication & Accounts

API Keys

Request, rotate, and manage API keys for the Andamio Gateway

Authenticated requests to the Andamio API require an API key in the X-API-Key header. API keys identify your application and determine your rate limits and quotas. A few public endpoints (developer registration, login, billing plans) do not require a key.

Your First Key

Your first API key comes from the developer portal at app.andamio.io/api-setup — the endpoints below all require an existing key, so the portal is the bootstrap. The portal lives on the mainnet app only and manages keys for every environment via its network selector; /api-setup on the preprod app redirects to the dashboard by design. See the Quickstart for the full flow.

Preprod keys are open to everyone

Self-serve preprod key generation is open to all registered developers as of API v2.4.1 (July 2026). If you previously hit a 403 generating a preprod key, retry — the internal-testers gate has been removed.

Prerequisites

Before requesting an API key via the endpoints below:

  1. Register a developer account
  2. Verify your email address (required for key creation)

Request a Key

curl -X POST https://preprod.api.andamio.io/api/v2/apikey/developer/key/request \
  -H "X-API-Key: $EXISTING_KEY" \
  -H "Authorization: Bearer $DEV_JWT" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-app-preprod"}'

The response includes the key value. Store it securely — it won't be shown again.

The number of keys you can create depends on your billing tier.

Rotate a Key

Replace an existing key with a new one. The old key is immediately invalidated:

curl -X POST https://preprod.api.andamio.io/api/v2/apikey/developer/key/rotate \
  -H "X-API-Key: $EXISTING_KEY" \
  -H "Authorization: Bearer $DEV_JWT" \
  -H "Content-Type: application/json" \
  -d '{"key_id": "uuid-of-key-to-rotate"}'

Rotation requires a verified email address.

Delete a Key

curl -X POST https://preprod.api.andamio.io/api/v2/apikey/developer/key/delete \
  -H "X-API-Key: $EXISTING_KEY" \
  -H "Authorization: Bearer $DEV_JWT" \
  -H "Content-Type: application/json" \
  -d '{"key_id": "uuid-of-key-to-delete"}'

Check Profile and Usage

View your developer profile and current quota:

# Profile and quota info
curl https://preprod.api.andamio.io/api/v2/apikey/developer/profile/get \
  -H "X-API-Key: $API_KEY" \
  -H "Authorization: Bearer $DEV_JWT"

# Usage statistics
curl https://preprod.api.andamio.io/api/v2/apikey/developer/usage/get \
  -H "X-API-Key: $API_KEY" \
  -H "Authorization: Bearer $DEV_JWT"

From the CLI:

andamio apikey profile
andamio apikey usage

API Key Endpoints

MethodEndpointAuth RequiredDescription
GET/v2/apikey/developer/profile/getAPI Key + Developer JWTDeveloper profile and quota
GET/v2/apikey/developer/usage/getAPI Key + Developer JWTUsage statistics
POST/v2/apikey/developer/key/requestAPI Key + Developer JWT + Verified EmailCreate new key
POST/v2/apikey/developer/key/rotateAPI Key + Developer JWT + Verified EmailRotate existing key
POST/v2/apikey/developer/key/deleteAPI Key + Developer JWTDelete a key
POST/v2/apikey/developer/account/deleteAPI Key + Developer JWTDelete developer account

Next Steps