Update Environment

PUT

/environments/{environment_uid}

Environments

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.getpostman.com/environments/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "environment": {
        "name": "New Name",
        "values": [
            {
                "key": "name",
                "value": "Bruce Wayne"
            },
            {
                "key": "occupation",
                "value": "Vigilante"
            }
        ]
    }
}'

Response Example

200 - Successful Response

{
  "environment": {
    "id": "357668d2-84f1-2264-438b-113095359f80",
    "name": "New Name",
    "uid": "631643-357668d2-84f1-2264-438b-113095359f80"
  }
}

Request

Path Params

environment_uid

string

required

Body Params application/json

environment

object

optional

name

string

optional

Example:

New Name

values

array [object {2}]

optional

Examples

Responses

🟢200Successful Response

application/json

Body

environment

object

optional

string

optional

Example:

357668d2-84f1-2264-438b-113095359f80

name

string

optional

Example:

New Name

uid

string

optional

Example:

631643-357668d2-84f1-2264-438b-113095359f80

🟠400Failure Response

Modified at 2023-08-15 05:41:03

Single Environment

Import exported data