Skip to main content
POST
Create API key

Authorizations

aropay_session
string
cookie
required

Browser session cookie minted by POST /auth/login (or passkey login). httpOnly, SameSite=Lax, 24 h TTL. Endpoints marked Session-only accept only this credential and return 403 session_required for API keys.

Body

application/json
name
string
required

Label identifying the consumer, e.g. "CI integration".

password
string
required

Step-up. The account password, re-entered.

expiresInDays
integer
default:90

Days until the key expires.

Required range: 1 <= x <= 365
code
string

Step-up. A fresh authenticator code; required when 2FA is enabled, ignored otherwise. Single-use.

Pattern: ^[0-9]{6}$

Response

Key created. Store plaintext now; it is never shown again.

ok
any
required
data
object
required