Novu

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.

Documentation GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/environments Create an environment · Novu Create an Environment #

Ask an LLM

“How do I add a staging environment with its own API keys?”

“Can a new environment inherit from a parent environment?”

Tell an agent

Create an environment named {name} with color {color}.

Create environment {name} in color {color} under parent {parentId}.

GET /v1/environments List environments · Novu List All Environments #

Ask an LLM

“What environments does my Novu organization have?”

“Where can I find the API keys for each of my environments?”

Tell an agent

List all environments in my organization.

Show my environments with their configuration and API keys.

PUT /v1/environments/{environmentId} Update an environment · Novu Update an Environment #

Ask an LLM

“How do I rename an environment or change its color?”

“Can I update the bridge or DNS settings of an existing environment?”

Tell an agent

Rename environment {environmentId} to {name}.

Set the bridge configuration on environment {environmentId} to {bridge}.

DELETE /v1/environments/{environmentId} Delete an environment · Novu Delete an Environment #

Ask an LLM

“What gets removed when I delete an environment?”

“Can a deleted environment be recovered?”

Tell an agent destructive · confirm first

Delete environment {environmentId} and all its data.

Permanently remove the environment {environmentId}.

GET /v2/environments/{environmentId}/tags List workflow tags in an environment · Novu List Environment Tags #

Ask an LLM

“Which tags are used across the workflows in an environment?”

“How can I get the tag list I'd use to filter workflows in one environment?”

Tell an agent

List the workflow tags used in environment {environmentId}.

Show all unique tags in environment {environmentId}.

POST /v2/environments/{targetEnvironmentId}/publish Publish resources to another environment · Novu Publish Resources to Target Environment #

Ask an LLM

“How do I promote my development workflows to production?”

“Can I publish only selected resources instead of everything?”

Tell an agent

Publish everything from {sourceEnvironmentId} to environment {targetEnvironmentId}.

Publish only {resources} to environment {targetEnvironmentId}.

POST /v2/environments/{targetEnvironmentId}/diff Compare two environments · Novu Compare Resources Between Environments #

Ask an LLM

“What's different between my development and production workflows?”

“Can I see which resources were added, modified or deleted between environments?”

Tell an agent

Diff environment {sourceEnvironmentId} against {targetEnvironmentId}.

Show what differs in target environment {targetEnvironmentId}.

Novu Environments API

Operations 7

Documentation

Specifications

Code Examples

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification