Ir al contenido

Self-service create API key (cliente, con cap por plan)

POST
/v1/client/keys
curl --request POST \
--url https://api.mailerdash.com/v1/client/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "label": "example", "domain_access": "all", "allowed_from_domains": [ "example" ] }'

Cliente crea una nueva API key vinculada a su cuenta. Cap por package transactional (packages.max_api_keys — Free=2, Starter=5, Pro=20). Token devuelto UNA SOLA VEZ en la response — el cliente debe copiarlo al crear. Sin password re-auth (v0.9.0+, crear key es low-friction).

Media type application/json
object
label
required

Display name de la key, ej “production-app”

string
domain_access

‘all’ (default): hereda en vivo todos los dominios verificados de la cuenta. ‘restricted’: opt-in least-privilege — solo los dominios listados en allowed_from_domains, con grant explícito.

string
default: all
Allowed values: all restricted
allowed_from_domains

Dominios a autorizar (grant explícito). Solo aplica si domain_access=restricted.

Array<string>

Key creada

Media type application/json
object
id
string
label
string
token

ONE-TIME. Copiar inmediato — no se vuelve a mostrar.

string
domain_access
string
Allowed values: all restricted
allowed_from_domains
Array<string>
Example
{
"domain_access": "all"
}

Validation error (label vacío, domain_access inválido, dominios inválidos)

Max_api_keys_exceeded — cap del plan alcanzado