Skip to main content
GET
/
v1
/
domains
/
{domain}
/
auto-configure
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->domains->autoConfigure->retrieve(
    domain: 'hidden-subsidy.info'
);

if ($response->domainConnectStatusResponseDto !== null) {
    // handle response
}
{
  "available": true,
  "manualRecords": [
    {
      "type": "MX",
      "name": "inbound",
      "content": "inbound-smtp.us-east-1.amazonaws.com",
      "ttl": "Auto",
      "priority": 10
    }
  ],
  "providerName": "<string>",
  "providerId": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

idempotency-key
string

A header for idempotency purposes

Path Parameters

domain
string
required

Response

OK

available
boolean
required
manualRecords
object[]
required
providerName
string
providerId
string
reason
string
reasonCode
enum<string>
Available options:
disabled,
discovery_not_configured,
unsupported_provider,
incomplete_configuration,
provider_settings_unavailable,
untrusted_provider_flow,
template_not_onboarded