MailSlurp logo

MailSlurp API authentication

Documentation navigation
Search documentation

Authenticate MailSlurp REST and SDK requests with API keys, keep credentials outside source code, and choose the correct account key for each environment.

View MarkdownAgent setup

To use MailSlurp APIs authenticate your requests with an API Key.

Authentication methods

MailSlurp accepts API keys using:

  • Request header: x-api-key: YOUR_API_KEY (recommended)
  • Query parameter: ?apiKey=YOUR_API_KEY

Use header-based authentication by default, especially in server-side applications.

Basic HTTP example

curl -sS https://api.mailslurp.com/inboxes \
  -H 'x-api-key: YOUR_API_KEY'

API key handling guidance

  • Use environment variables or secret stores, not hardcoded keys.
  • Use separate keys for local, staging, and production contexts.
  • Rotate keys on a regular schedule and after credential exposure.
  • Restrict dashboard/API key ownership to the minimum required team members.