Environment Variables

API Reference for ProcessMaker Environment Variable API

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

get

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

Authorizations

passportbearer

Query parameters

filterstringoptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/environment_variables'

200

200

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "value": "text",
      "id": 1,
      "created_at": "2025-03-28T01:16:38.491Z",
      "updated_at": "2025-03-28T01:16:38.491Z"
    }
  ],
  "meta": {}
}

list of environmentVariables

Create a new environment variable

post

Creates a new global Environment Variable in the system

Authorizations

passportbearer

Body

namestringoptional

descriptionstringoptional

valuestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/environment_variables' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "value": "text"
  }'

201

201

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-03-28T01:16:38.491Z",
  "updated_at": "2025-03-28T01:16:38.491Z"
}

success

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

get

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

Authorizations

passportbearer

Path parameters

environment_variable_idintegerrequired

ID of environment_variables to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/environment_variables/{environment_variable_id}'

201

201

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-03-28T01:16:38.491Z",
  "updated_at": "2025-03-28T01:16:38.491Z"
}

success

Update an environment variable

put

Update an environment variable

Authorizations

passportbearer

Path parameters

environment_variable_idintegerrequired

ID of environment variables to update

Body

namestringoptional

descriptionstringoptional

valuestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/environment_variables/{environment_variable_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "value": "text"
  }'

200

200

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-03-28T01:16:38.491Z",
  "updated_at": "2025-03-28T01:16:38.491Z"
}

success

Delete an environment variable

delete

Authorizations

passportbearer

Path parameters

environment_variable_idintegerrequired

ID of environment_variables to return

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/environment_variables/{environment_variable_id}'

200

200

No body

success