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

/environment_variables

Authorizations

passportbearer

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

{
  "meta": {},
  "data": [
    {
      "name": "text",
      "description": "text",
      "value": "text",
      "id": 1,
      "created_at": "2025-02-20T19:14:07.382Z",
      "updated_at": "2025-02-20T19:14:07.382Z"
    }
  ]
}

list of environmentVariables

Create a new environment variable

Creates a new global Environment Variable in the system

post

/environment_variables

Authorizations

passportbearer

Body

namestring

descriptionstring

valuestring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/environment_variables' \
  --header 'Content-Type: application/json'

201

201

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-02-20T19:14:07.382Z",
  "updated_at": "2025-02-20T19:14:07.382Z"
}

success

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

/environment_variables/{environment_variable_id}

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-02-20T19:14:07.382Z",
  "updated_at": "2025-02-20T19:14:07.382Z"
}

success

Update an environment variable

Update an environment variable

put

/environment_variables/{environment_variable_id}

Authorizations

passportbearer

Path parameters

environment_variable_idintegerrequired

ID of environment variables to update

Body

namestring

descriptionstring

valuestring

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'

200

200

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-02-20T19:14:07.382Z",
  "updated_at": "2025-02-20T19:14:07.382Z"
}

success

Delete an environment variable

delete

/environment_variables/{environment_variable_id}

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