Environment Variables

API Reference for ProcessMaker Environment Variable API

Returns all environmentVariables that the user has access to. For security, values are not included.

Fetch a collection of variables based on paged request and filter if provided

GET/api/1.0/environment_variables

Query parameters

Response

200

list of environmentVariables

Body

application/json

dataarray of EnvironmentVariable (all of)

metaobject

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/environment_variables', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "value": "text",
      "created_at": "2024-11-16T07:19:45.093Z",
      "updated_at": "2024-11-16T07:19:45.093Z"
    }
  ]
}

Create a new environment variable

Creates a new global Environment Variable in the system

POST/api/1.0/environment_variables

Body

application/json

namestring

descriptionstring

valuestring

Response

201

success

Body

application/json

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/environment_variables', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "name": "text",
  "description": "text",
  "value": "text",
  "created_at": "2024-11-16T07:19:45.093Z",
  "updated_at": "2024-11-16T07:19:45.093Z"
}

Get an environment variable by id. For security, the value is not included.

Return an environment variable instance Using implicit model binding, will automatically return 404 if variable now found

GET/api/1.0/environment_variables/{environment_variable_id}

Path parameters

environment_variable_id*integer

ID of environment_variables to return

Response

201

success

Body

application/json

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/environment_variables/{environment_variable_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

201

{
  "name": "text",
  "description": "text",
  "value": "text",
  "created_at": "2024-11-16T07:19:45.093Z",
  "updated_at": "2024-11-16T07:19:45.093Z"
}

Update an environment variable

Update an environment variable

PUT/api/1.0/environment_variables/{environment_variable_id}

Path parameters

environment_variable_id*integer

ID of environment variables to update

Body

application/json

namestring

descriptionstring

valuestring

Response

200

success

Body

application/json

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/environment_variables/{environment_variable_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "name": "text",
  "description": "text",
  "value": "text",
  "created_at": "2024-11-16T07:19:45.093Z",
  "updated_at": "2024-11-16T07:19:45.093Z"
}

Delete an environment variable

DELETE/api/1.0/environment_variables/{environment_variable_id}

Path parameters

environment_variable_id*integer

ID of environment_variables to return

Response

200

success

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/environment_variables/{environment_variable_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();