Project parameter APIs

Project parameters are user-defined key-value pairs that are accessible across all workflows within a specific project. They help you manage configuration values that might be reused in multiple workflows. By using project parameter APIs, you can create and manage project parameters.

POST - Create project parameters

Creates a project parameter.

URL
../apis/v2/rest/projects/{projectName}/configurations/variables?type=projectParameter
Parameters
  • {projectName} - Name of the project.
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
{
  "key": "<parameter_key>",
  "value": "<parameter_value>",
  "isPassword": <type_of_parameter>,
  "isRequired": <can_value_of_parameter_be_empty>,
}
Response

If the request is successful, the HTTP 201 Created status response code is displayed.

{
  "message": "Project parameter created successfully."
}

PUT - Update project parameters

Updates a project parameter.

URL
../apis/v2/rest/projects/{projectName}/configurations/variables/{variableName}?type=projectParameter
Parameters
  • {projectName} - Name of the project.
  • {variableName} - Name of the variable.
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
{
  "key": "<parameter_key>",
  "value": "<value_to_be_updated>",
  "isRequired": <can_value_of_parameter_be_empty>,
}
Note: The user interface and public API do not support updates to the isPassword field.
Response

If the request is successful, the HTTP 201 Created status response code is displayed.

{
  "message": "Project parameter updated successfully."
}

DELETE - Delete project parameters

Deletes a project parameter.

URL
../apis/v2/rest/projects/{projectName}/configurations/variables/{variableName}?type=projectParameter
Parameters
  • {projectName} - Name of the project.
  • {variableName} - Name of the variable.
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
None

GET - List project parameters

Retrieves the list of all project parameters.

URL
../apis/v2/rest/projects/{projectName}/configurations/variables?type=projectParameter
Parameters
  • {projectName} - Name of the project.
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response

If the request is successful, the HTTP 201 Created status response code is displayed.

[
  {
    "key": "<parameter_key>",
    "value": "parameter_value",
    "isPassword": <type_of_parameter>,
    "isRequired": <can_value_of_parameter_be_empty>,
    "uid": "<unique_identifier_of_parameter>",
    "type": "projectParameter"
  }
]

GET - Get project parameters

Retrieves the details of a specific project parameter.

URL
../apis/v2/rest/projects/{projectName}/configurations/variables/{variableName}?type=projectParameter
Parameters
  • {projectName} - Name of the project.
  • {variableName} - Name of the variable.
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response

If the request is successful, the HTTP 201 Created status response code is displayed.

{
  "key": "<parameter_key>",
  "value": "parameter_key",
  "isPassword": <type_of_parameter>,
  "isRequired": <can_value_of_parameter_be_empty>,
  "uid": "<unique_identifier_of_parameter>",
  "type": "projectParameter"
}