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 Environment Variables API

The Environment Variables API from Novu — 3 operation(s) for environment variables.

Novu Environment Variables 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 Environment Variables. 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 6 operations across 3 paths, and defines 10 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.

6 operations 3 paths 10 schemas 1 DELETE3 GET1 PATCH1 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 Environment Variables 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 6

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

Environment Variables 6
GET
/v1/environment-variables
Novu List All Variables
EnvironmentVariablesController_listEnvironmentVariables 1 param → 200400401403404405409413
POST
/v1/environment-variables
Novu Create a Variable
EnvironmentVariablesController_createEnvironmentVariable body → 200400401403404405409413
GET
/v1/environment-variables/{variableKey}/usage
Novu Retrieve a Variable Usage
EnvironmentVariablesController_getEnvironmentVariableUsage 1 param → 200400401403404405409413
GET
/v1/environment-variables/{variableKey}
Novu Get Environment Variable
EnvironmentVariablesController_getEnvironmentVariable 1 param → 200400401403404405409413
PATCH
/v1/environment-variables/{variableKey}
Novu Update a Variable
EnvironmentVariablesController_updateEnvironmentVariable 1 param body → 200400401403404405409413
DELETE
/v1/environment-variables/{variableKey}
Novu Delete Environment Variable
EnvironmentVariablesController_deleteEnvironmentVariable 1 param → 204400401403404405409413

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EnvironmentVariableResponseDto (8 properties), ValidationErrorDto (7 properties), ErrorDto (6 properties), CreateEnvironmentVariableRequestDto (4 properties). Each schema is shown below with its type and property counts.

GetEnvironmentVariableUsageResponseDto
object
1 property 1 required
ValidationErrorDto
object
7 properties 4 required
CreateEnvironmentVariableRequestDto
object
4 properties 1 required
ErrorDto
object
6 properties 3 required
EnvironmentVariableValueResponseDto
object
2 properties 2 required
ConstraintValidation
object
2 properties 1 required
UpdateEnvironmentVariableRequestDto
object
4 properties
EnvironmentVariableValueDto
object
2 properties 2 required
EnvironmentVariableWorkflowInfoDto
object
2 properties 2 required
EnvironmentVariableResponseDto
object
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-environment-variables-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 Environments API
Novu Events API
Novu Integrations API
Novu Layouts API