« API
Overview
The Configuration Variables resources allow you to retrieve
information about the user-created environment settings for an
application.
Contents
List Configuration Variables
Retrieves the list of configuration variables for the
application. The item properties are the same as the Configuration Variable detail with the addition of
the URL for the detail of each item.
Request
GET /applications/:slug/configurationvariables
Response
Status: 200 OK
[{
"key" : "foo",
"value" : "bar",
"url" : "https://appharbor.com/applications/:application/configurationvariables/:id"
}]
Get Configuration Variable Detail
Request
GET /applications/:slug/configurationvariables/:id
Response
Status: 200 OK
{
"key" : "foo",
"value" : "bar"
}
Response Properties
| key |
The name of the configuration variable. |
| value |
The value to assign to the configuration variable. |
Create Configuration Variable
Request
POST /applications/:slug/configurationvariables
{
"key" : "foo",
"value" : "bar"
}
Request Parameters
| key |
Required |
The name of the configuration variable. |
| value |
Required |
The value to assign to the configuration variable. |
Response
Status: 201 (Created)
Location: https://appharbor.com/applications/:slug/configurationvariables/:id
Edit Configuration Variable
Request
PUT /applications/:slug/configurationvariables/:id
{
"key" : "foo",
"value" : "bar"
}
Request Parameters
| key |
Required |
The name of the configuration variable. |
| value |
Required |
The value to assign to the configuration variable. |
Response
Status: 200 OK
Remove Configuration Variable
Request
DELETE /applications/:slug/configurationvariables/:id
Response
Status: 204 No Content
Back
to overview