The API allows you to view, list, create and edit environment variables.
Returns list of environment variables filtered by specified query parameters.
name | type | description |
---|---|---|
application | query | |
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of EnvVariableDetails (JSON) | list of environment variables filtered by specified query parameters |
GET /env-variables
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
} ]
Create environment variable.
media type | data type | description |
---|---|---|
application/json | EnvVariableRequest (JSON) | specify details for new environment variable |
media type | data type | description |
---|---|---|
application/json | EnvVariableDetails (JSON) | details of newly created environment variable |
POST /env-variables
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"value" : "...",
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hiddenInUI" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}
Remove environment variable.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for environment variable (use by vProtect) |
DELETE /env-variables/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single environment variable.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for environment variable (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | EnvVariableDetails (JSON) | environment variable details |
GET /env-variables/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}
Change environment variable.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for environment variable (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | EnvVariableRequest (JSON) | specify environment variable details to update |
media type | data type | description |
---|---|---|
application/json | EnvVariableDetails (JSON) | updated details of environment variable |
PUT /env-variables/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"value" : "...",
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hiddenInUI" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}