Chapter 15. Environment Variables

This chapter provides information on API resources that allow a client to add and manage user defined application environment variables. The environment variables can be set when an application is created, when a cartridge is added to an application, or they can be added to an existing application. User defined environment variables are persistent and replicated through all application gears, including new gears added in scaling events.
The following table describes each parameter associated with OpenShift environment variables.
Name Description
name Name of the environment variable
value Value of the environment variable

15.1. Add Environment Variable

Description

Add an environment variable to the specified application.

Method and URL Structure

Method URL Structure
POST /broker/rest/application/:id/environment-variables

Request Parameters

Name Description Required Default
name Name of environment variable No
value Value of environment variable No

Request

{
  "name": "MY_ENV_VAR",
  "value": "myvalue"
}

cURL Command Example

$ curl -X POST https://openshift.redhat.com/broker/rest/application/534253991015616165707776/environment-variables --user user@example.com:password --data-urlencode name=MY_ENV_VAR --data-urlencode value=myvalue

JSON Response

The API returns the environment variables resource with related resource links which have been left out for brevity. See Chapter 15, Environment Variables for more information on all parameters for environment variables. 

{
  "api_version": 1.6,
  "data": {
    "name": "MY_ENV_VAR",
    "value": "myvalue"
  },
  "messages": [
    {
      "exit_code": 0,
      "field": null,
      "severity": "info",
      "text": "Added environment variable 'MY_ENV_VAR' to application myapp"
    }
  ],
  "status": "created",
  "supported_api_versions": [
    1.0,
    1.1,
    1.2,
    1.3,
    1.4,
    1.5,
    1.6
  ],
  "type": "environment-variable",
  "version": "1.6"
}

Environment variables can also be added when an application is created, or when a cartridge is added to an application.
See Section 11.2, “Create an Application” for more information on adding environment variables when creating an application.
See Section 13.2.1, “Add Embedded Cartridge” for more information on adding environment variables when adding a cartridge to an application.