Email Providers

List domain identities already registered on a provider's side, for populating an "import existing domain" picker instead of requiring the operator to type the domain name (and, for Scaleway, its internal UUID) by hand.

Always returns 200, even when the provider type has no domain-listing API (SMTP) or the live fetch failed — supported: false or a non-null error signal the caller to fall back to manual entry instead of treating this as a hard failure. Only a genuine failure to resolve the provider itself (not found, undecryptable credentials) returns an error status.

get/email-providers/{id}/discoverable-domains

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/email-providers/{id}/discoverable-domains
  • Auth: HTTP bearer

Path parameters

idinteger required

Provider ID

Response

Discoverable domains (see supported/error for fallback state)

errorstring nullable
supportedboolean required

Example response

{
  "domains": [
    {
      "domain": "example.com",
      "provider_identity_id": "12345678-1234-1234-1234-123456789012",
      "status": "verified"
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.