Get Environment Variable Group
Get an environment variable group
Retrieve an environment variable group.
Request
URI
GET
https://api.example.local/v3/environment_variable_groups/{name}
COPY
Path Parameters
string
name
Required
name
Possible values are :
running,
staging,
Responses
200
OK
Returns
EnvironmentVariableGroup
of type(s)
application/json
{
"updated_at": "string",
"name": "string",
"var": {
"var": "string"
},
"links": {
"self": {
"href": "string",
"method": "string"
}
}
}
string As date-time
As date-time
updated_at
Optional
The time the environment variable group was last updated
string
name
Optional
The name of the group; can only be "running" or "staging"
object
var
Optional
Environment variables to inject; keys and values must be strings
object
links
Optional
links
400
Bad Request
Returns
BadRequest
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
401
Unauthorized
Returns
Unauthorized
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
403
Forbidden
Returns
Forbidden
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
404
Not Found
Returns
NotFound
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
409
Conflict
Returns
Conflict
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
422
Unprocessable Entity
Returns
UnprocessableEntity
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
500
Internal Server Error
Returns
500
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
502
Bad Gateway
Returns
BadGateway
of type(s)
application/json
{
"code": 0,
"detail": "string",
"title": "string"
}
integer
code
Optional
A numeric code for this error
string
detail
Optional
Detailed description of the error
string
title
Optional
Name of the error
503
Service Unavailable
Returns
ServiceUnavailable
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v3/environment_variable_groups/{name}
Environment Variable Groups Operations
GET
Get Environment Variable Group
PATCH
Update Environment Variable Group