30 Days of Postman exercises API Documentation

Create Environment

POST https://api.getpostman.com/environments

A sample body is added to the request that conforms to the following JSON schema:

{
  "type": "object",
  "properties": {
    "environment": {
      "type": "object",
      "properties": {
        "name": {
              "type": "string",
              "maxLength": 254,
              "minLength": 1
            },
        "values": {
          "type": "array",
          "maxItems": 100,
          "additionalItems": false,
          "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string",
                  "maxLength": 254
                  "minLength": 1
                },
                "value": { "type": "string" },
                "enabled": { "type": "boolean" }
              },
              "required": ["key", "value"]
            }
        }
      },
      "required": ["name"]
    }
  },
  "required": ["environment"]
}

On successful creation of the environment, the API returns the environment name and id.

You can also specify the context of a workspace to create an environment in directly by passing the workspace as a query param.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Body PARAM

Key

Datatype

Required

Description

HEADERS

Key	Datatype	Required	Description
Content-Type	string

RESPONSES

status OK

{ "environment": { "id": "f158266e-306b-4702-a2b9-e4ede7878b7a", "name": "Sample Environment Name (required)", "uid": "5665-f158266e-306b-4702-a2b9-e4ede7878b7a" } }

Curl

curl -X POST 'https://api.getpostman.com/environments' -H 'Content-Type: application/json' -d '{"environment":{"name":"Sample Environment Name (required)","values":[{"key":"variable_name_1","value":"The value of the variable"},{"key":"variable_name_2","value":""}]}}'