processmaker.com Knowledge Center ProcessMaker University

Environment Variables

API Reference for ProcessMaker Environment Variable API

Last updated 5 months ago

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

Path parameters

environment_variable_idintegerRequired

ID of environment_variables to return

Responses

201

success

application/json

Responseall of

get

GET /api/1.0/environment_variables/{environment_variable_id} HTTP/1.1
Host: 
Accept: */*

201

success

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-05-21T22:41:29.340Z",
  "updated_at": "2025-05-21T22:41:29.340Z"
}

Delete an environment variable

delete

Authorizations

Path parameters

environment_variable_idintegerRequired

ID of environment_variables to return

Responses

200

success

delete

DELETE /api/1.0/environment_variables/{environment_variable_id} HTTP/1.1
Host: 
Accept: */*

200

success

No content

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

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

includestringOptional

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

Default: ""

Responses

200

list of environmentVariables

application/json

get

GET /api/1.0/environment_variables HTTP/1.1
Host: 
Accept: */*

200

list of environmentVariables

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "value": "text",
      "id": 1,
      "created_at": "2025-05-21T22:41:29.340Z",
      "updated_at": "2025-05-21T22:41:29.340Z"
    }
  ],
  "meta": {}
}

Create a new environment variable

post

Creates a new global Environment Variable in the system

Authorizations

Body

namestringOptional

descriptionstringOptional

valuestringOptional

Responses

201

success

application/json

Responseall of

post

POST /api/1.0/environment_variables HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": "text",
  "value": "text"
}

201

success

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-05-21T22:41:29.340Z",
  "updated_at": "2025-05-21T22:41:29.340Z"
}

Update an environment variable

put

Update an environment variable

Authorizations

Path parameters

environment_variable_idintegerRequired

ID of environment variables to update

Body

namestringOptional

descriptionstringOptional

valuestringOptional

Responses

200

success

application/json

Responseall of

put

PUT /api/1.0/environment_variables/{environment_variable_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": "text",
  "value": "text"
}

200

success

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-05-21T22:41:29.340Z",
  "updated_at": "2025-05-21T22:41:29.340Z"
}