Create an environment

POST

/environments

POST

/environments

$ curl -X POST "https://api.getpostman.com/environments?workspace=1f0df51a-8658-4ee8-a2a1-d2567dfa09a9" \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "environment": {
>     "name": "Test Environment",
>     "values": [
>       {
>         "enabled": true,
>         "key": "collectionId",
>         "value": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
>         "type": "default",
>         "description": "The collection'\''s ID."
>       },
>       {
>         "enabled": false,
>         "key": "variable_1",
>         "value": "The variable_1 value.",
>         "type": "default",
>         "description": "Placeholder variable value."
>       }
>     ]
>   }
> }'

1 {
2   "environment": {
3     "id": "5daabc50-8451-43f6-922d-96b403b4f28e",
4     "name": "Test Environment",
5     "uid": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e"
6   }
7 }

Creates an environment.

Note:

The request body size cannot exceed the maximum allowed size of 30MB.
If you receive an HTTP 411 Length Required error response, manually pass the Content-Length header and its value in the request header.
If you do not include the workspace query parameter, the system creates the environment in the oldest personal Internal workspace you own.

Creates an environment. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - If you do not include the `workspace` query parameter, the system creates the environment in the oldest personal Internal workspace you own.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

workspacestringRequired

The workspace's ID.

Request

This endpoint expects an object.

environmentobjectOptional

Information about the environment.

Response

Successful Response

environmentobject

Information about the environment.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

411

Length Required Error

413

Content Too Large Error

500

Internal Server Error