PUT /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-Keyrequest header orapikeyURL query parameter.
Servers
- https://api.getpostman.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
environment_uid |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
environment |
Object | No | |
environment.values[] |
Array | No | |
environment.values[].key |
String | No | |
environment.values[].value |
String | No | |
environment.name |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.