30 Days of Postman API Documentation

Update Environment

PUT https://api.getpostman.com/environments/{{environment_uid}}

This endpoint replaces an existing environment.

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",
                                "maxLength": 254,
                                "minLength": 1
                            },
                            "type": {
                                "type": "string"
                            },
                            "enabled": {
                                "type": "boolean"
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ]
                    }
                }
            }
        }
    },
    "required": [
        "environment"
    ]
}

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

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": "357668d2-84f1-2264-438b-113095359f80", "name": "New Name", "uid": "631643-357668d2-84f1-2264-438b-113095359f80" } }

Curl

curl -X PUT 'https://api.getpostman.com/environments/undefined' -H 'Content-Type: application/json' -d '{"environment":{"name":"New Name","values":[{"key":"name","value":"Bruce Wayne"},{"key":"occupation","value":"Vigilante"}]}}'