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 Environments API

Environments allow you to manage different stages of your application development lifecycle. Each environment has its own set of API keys and configurations, enabling you to separate development, staging, and production workflows.

Novu Environments 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 Environments. 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 7 operations across 5 paths, and defines 31 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.

7 operations 5 paths 31 schemas 1 DELETE2 GET3 POST1 PUT

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 Environments 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 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Environments 7

Environments allow you to manage different stages of your application development lifecycle. Each environment has its own set of API keys and configurations, enabling you to separ…

POST
/v1/environments
Novu Create an Environment
EnvironmentsControllerV1_createEnvironment body → 201400401402403404405409
GET
/v1/environments
Novu List All Environments
EnvironmentsControllerV1_listMyEnvironments → 200400401403404405409413
PUT
/v1/environments/{environmentId}
Novu Update an Environment
EnvironmentsControllerV1_updateMyEnvironment 1 param body → 200400401403404405409413
DELETE
/v1/environments/{environmentId}
Novu Delete an Environment
EnvironmentsControllerV1_deleteEnvironment 1 param → 200400401403404405409413
GET
/v2/environments/{environmentId}/tags
Novu List Environment Tags
EnvironmentsController_getEnvironmentTags 1 param → 200400401403404405409413
POST
/v2/environments/{targetEnvironmentId}/publish
Novu Publish Resources to Target Environment
EnvironmentsController_publishEnvironment 1 param body → 200400401403404405409413
POST
/v2/environments/{targetEnvironmentId}/diff
Novu Compare Resources Between Environments
EnvironmentsController_diffEnvironment 1 param body → 200400401403404405409413

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ResourceDiffDto (8 properties), EnvironmentResponseDto (8 properties), ValidationErrorDto (7 properties), UpdateEnvironmentRequestDto (6 properties). Each schema is shown below with its type and property counts.

SyncActionEnum
string
Sync action performed
ResourceToPublishDto
object
2 properties 2 required
ResourceTypeEnum
string
Type of the layout
ApiKeyDto
object
3 properties 2 required
DiffEnvironmentRequestDto
object
1 property
CreateEnvironmentRequestDto
object
3 properties 2 required
UserInfoDto
object
4 properties 2 required
EnvironmentDiffSummaryDto
object
3 properties 3 required
ResourceDiffDto
object
8 properties 2 required
BridgeConfigurationDto
object
1 property
ResourceDiffResultDto
object
6 properties 3 required
ConstraintValidation
object
2 properties 1 required
SyncedWorkflowDto
object
4 properties 4 required
ResourceDependencyDto
object
5 properties 5 required
FailedWorkflowDto
object
5 properties 4 required
SyncResultDto
object
5 properties 5 required
ResourceInfoDto
object
4 properties
ValidationErrorDto
object
7 properties 4 required
ErrorDto
object
6 properties 3 required
PublishSummaryDto
object
4 properties 4 required
DependencyReasonEnum
string
Reason for the dependency
UpdateEnvironmentRequestDto
object
6 properties
DiffSummaryDto
object
4 properties 4 required
SkippedWorkflowDto
object
4 properties 4 required
EnvironmentResponseDto
object
8 properties 4 required
PublishEnvironmentRequestDto
object
3 properties
InBoundParseDomainDto
object
1 property
GetEnvironmentTagsDto
object
1 property 1 required
DiffActionEnum
string
Type of change
DiffEnvironmentResponseDto
object
4 properties 4 required
PublishEnvironmentResponseDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-environments-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 Domains API
Novu Environment Variables API
Novu Events API
Novu Integrations API
Novu Layouts API