---
title: "Create an environment"
method: POST
path: "/v1/environments"
tags: ["Environments"]
---

# Create an environment

`POST /v1/environments`

## Request

- Base URL: `https://api.notifly.io`
- URL: `https://api.notifly.io/v1/environments`
- Auth: API key in header `Authorization`

Creates a new environment within the current organization. 
    Environments allow you to manage different stages of your application development lifecycle.
    Each environment has its own set of API keys and configurations.

## Request body

- CreateEnvironmentRequestDto
  - `name` string, required: Name of the environment to be created
  - `parentId` string: MongoDB ObjectId of the parent environment (optional)
  - `color` string, required: Hex color code for the environment

## Response `201`

Created

- object
  - `data` EnvironmentResponseDto
    - `_id` string, required: Unique identifier of the environment
    - `name` string, required: Name of the environment
    - `_organizationId` string, required: Organization ID associated with the environment
    - `identifier` string, required: Unique identifier for the environment
    - `type` 'dev' | 'prod', nullable: Type of the environment
    - `apiKeys` ApiKeyDto[]: List of API keys associated with the environment
      - `key` string, required: API key
      - `_userId` string, required: User ID associated with the API key
      - `hash` string: Hashed representation of the API key
    - `_parentId` string: Parent environment ID
    - `slug` string: URL-friendly slug for the environment

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `403`: Forbidden
- `404`: Not Found
- `405`: Method Not Allowed
- `409`: Conflict
- `413`: Payload Too Large
- `414`: URI Too Long
- `415`: Unsupported Media Type
- `422`: Unprocessable Entity
- `429`: The client has sent too many requests in a given amount of time.
- `500`: Internal Server Error
- `503`: The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.

---

[API](https://skmtc.dev/notifly/apis/notifly-api.md) · [All operations](https://skmtc.dev/notifly/apis/notifly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/notifly/apis/notifly-api/revisions/af909b9e1e57?raw)