Get a sandbox inbox's SMTP credentials

GET/api/v1/sandbox/inboxes/{id}/credentials
Requires anorganization API keywith the scopesandbox:write

The inbox's SMTP username and secret, with the host and ports to use them on. Unlike live SMTP credentials and API keys, sandbox credentials are always viewable: they can only drop mail into your own sandbox, never deliver it. secret is null for an inbox created before this was possible; reset its credentials to get one. Needs a key with sandbox:write, because it reveals a secret.

Parameters

NameInTypeDescription
idrequiredpathstringThe id identifier.

Request

GET/api/v1/sandbox/inboxes/{id}/credentials
curl -X GET 'https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V/credentials' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • usernamestring

      The SMTP username (`sbx_…`).

    • secretstring

      The SMTP password (`mlt_sbx_…`). Null for an inbox created before sandbox credentials became viewable: reset its credentials to get one you can see.

    • smtp_hoststring

      The sandbox SMTP host, `sandbox.smtp.mailyte.com`.

    • smtp_portsarray<integer>

      2525 (STARTTLS) and 2465 (implicit TLS).

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.