Skip to content
DocumentationNovu Documentation
PlatformGuidesFrameworkCommunityAPI Reference
Sign InSign Up

GitHubnovuhq/novu

38.8K

Retrieve a variable

Returns a single environment variable by id. Secret values are masked.

GET
/v1/environment-variables/{variableId}

Authorization

Authorization<token>

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

In: header

Path Parameters

variableIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

OK

_idRequiredstring
_organizationIdRequiredstring
keyRequiredstring
typeRequiredstring
Value in: "string"
isSecretRequiredboolean
valuesRequiredarray<object>
createdAtRequiredstring
updatedAtRequiredstring
export interface Response {
  _id: string;
  _organizationId: string;
  key: string;
  type: "string";
  isSecret: boolean;
  values: EnvironmentVariableValueResponseDto[];
  createdAt: string;
  updatedAt: string;
}
export interface EnvironmentVariableValueResponseDto {
  _environmentId: string;
  /**
   * Value is masked (••••••••) for secret variables
   */
  value: string;
}
 
curl -X GET "https://api.novu.co/v1/environment-variables/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"
{
  "_id": "string",
  "_organizationId": "string",
  "key": "string",
  "type": "string",
  "isSecret": true,
  "values": [
    {
      "_environmentId": "string",
      "value": "string"
    }
  ],
  "createdAt": "string",
  "updatedAt": "string"
}

Create a variable POST

Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.

Update a variable PATCH

Updates an existing environment variable. Providing values replaces all existing per-environment values.

On this page

No Headings
Edit this page on GitHub