Removes application environment variables. This operation supports only PolarClaw.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ApplicationId |
string |
Yes |
The application ID. |
pa-******************** |
| VariableNames |
array |
Yes |
A list of the environment variable names to remove. |
|
|
string |
No |
The environment variable name. |
TEST_ENV |
|
| Restart |
boolean |
No |
Specifies whether to restart the gateway after removing the variables. The default is |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| RequestId |
string |
The request ID. |
CDB3258F-B5DE-43C4-8935-CBA0CA****** |
| Message |
string |
The response message. |
successful |
| Code |
integer |
The response status code. |
200 |
| ApplicationId |
string |
The application ID. |
pa-************** |
| Ok |
boolean |
Indicates whether the operation was successful. |
true |
| RemovedCount |
integer |
The number of variables removed. |
1 |
| TotalVariables |
integer |
The total number of application environment variables remaining. |
0 |
| Restarted |
boolean |
Indicates whether the gateway was restarted. |
true |
Examples
Success response
JSON format
{
"RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Ok": true,
"RemovedCount": 1,
"TotalVariables": 0,
"Restarted": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.