Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Novu Domains API

Used to manage your inbound email domains.

Novu Domains API is one of 19 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, a getting-started guide, and 26 JSON Schemas.

This API exposes 15 operations across 9 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 3.15.0.

Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.

15 operations 9 paths 23 schemas 2 DELETE5 GET2 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.15.0
Base URL
https://api.novu.co
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Novu Domains API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (secretKey). By default, every request must be authenticated.

  • secretKey — API key authentication. Allowed headers-- "Authorization: ApiKey ".

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 2 DELETE, 5 GET, 2 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Domains 15

Used to manage your inbound email domains.

GET
/v1/domains
Novu List Domains for an Environment
DomainsController_listDomains 7 params → 200400401403404405409413
POST
/v1/domains
Novu Create a Domain
DomainsController_createDomain body → 201400401403404405409413
GET
/v1/domains/{domain}
Novu Retrieve a Domain by Name
DomainsController_getDomain 1 param → 200400401403404405409413
PATCH
/v1/domains/{domain}
Novu Update a Domain
DomainsController_updateDomain 1 param body → 200400401403404405409413
DELETE
/v1/domains/{domain}
Novu Delete a Domain
DomainsController_deleteDomain 1 param → 204400401403404405409413
POST
/v1/domains/{domain}/verify
Novu Verify a Domain
DomainsController_verifyDomain 1 param → 200400401403404405409413
POST
/v1/domains/{domain}/diagnose
Novu Diagnose Inbound DNS for a Domain
DomainsController_diagnoseDomain 1 param → 200400401403404405409413
GET
/v1/domains/{domain}/routes
Novu List Routes for a Domain
DomainsController_listDomainRoutes 8 params → 200400401403404405409413
POST
/v1/domains/{domain}/routes
Novu Create a Route
DomainsController_createDomainRoute 1 param body → 201400401403404405409413
GET
/v1/domains/{domain}/routes/{address}
Novu Retrieve a Route by Address
DomainsController_getDomainRoute 2 params → 200400401403404405409413
PATCH
/v1/domains/{domain}/routes/{address}
Novu Update a Route
DomainsController_updateDomainRoute 2 params body → 200400401403404405409413
DELETE
/v1/domains/{domain}/routes/{address}
Novu Delete a Route
DomainsController_deleteDomainRoute 2 params → 204400401403404405409413
POST
/v1/domains/{domain}/routes/{address}/test
Novu Test an Inbound Route
DomainsController_testDomainRoute 2 params body → 200400401403404405409413
GET
/v1/domains/{domain}/auto-configure
Novu Retrieve Auto-configuration Availability
DomainsController_getDomainAutoConfigure 1 param → 200400401403404405409413
POST
/v1/domains/{domain}/auto-configure/start
Novu Start DNS Auto-configuration
DomainsController_startDomainAutoConfigure 1 param body → 201400401403404405409413

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are DomainResponseDto (11 properties), DomainRouteResponseDto (10 properties), TestDomainRouteResponseDto (9 properties), ValidationErrorDto (7 properties). Each schema is shown below with its type and property counts.

TestDomainRouteAgentResultDto
object
4 properties 3 required
CreateDomainConnectApplyUrlDto
object
1 property
ListDomainsResponseDto
object
5 properties 5 required
DomainConnectApplyUrlResponseDto
object
3 properties 3 required
DiagnoseDomainResponseDto
object
4 properties 4 required
ConstraintValidation
object
2 properties 1 required
TestDomainRouteResponseDto
object
9 properties 2 required
ListDomainRoutesResponseDto
object
5 properties 5 required
UpdateDomainDto
object
1 property
ValidationErrorDto
object
7 properties 4 required
ErrorDto
object
6 properties 3 required
TestDomainRouteDto
object
5 properties 2 required
DomainRouteDto
object
4 properties 2 required
DomainDiagnosticCheckDto
object
3 properties 3 required
TestDomainRouteWebhookResultDto
object
2 properties 1 required
DomainRouteResponseDto
object
10 properties 8 required
TestDomainRouteFromDto
object
2 properties 1 required
DomainDiagnosticIssueDto
object
4 properties 4 required
CreateDomainDto
object
2 properties 1 required
UpdateDomainRouteDto
object
3 properties
DomainConnectStatusResponseDto
object
6 properties 2 required
ExpectedDnsRecordDto
object
5 properties 4 required
DomainResponseDto
object
11 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-domains-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox / In-App API
Novu Framework (Code-First Workflows)
Novu MCP Server
Novu Activity API
Novu Channel Connections API
Novu Channel Endpoints API
Novu Contexts API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API
Novu Layouts API