Manage Typed Parameters
This article lists REST API requests concerning typed parameters.
List Typed Build Parameters
To get a list of all build parameters of a project, use:
For a build configuration:
Both endpoints respond with the Properties entity which contains a list of Property instances. These include:
name
— parameter namevalue
— parameter valuetype
— Type, contains:rawValue
— parameter specification as defined in the UI
Get Details of Build Parameter
To get a specific parameter, use:
or
Accepts and returns text/plain
, application/XML
or application/json
. Supply the relevant Content-Type header to the request.
Create Build Parameter
To create a build parameter, send Property to:
or
Note that secure parameters, for example type=password
, are listed, but the values are not included into the response.
Example payload:
Update Build Parameter
To update the whole build parameter, send an updated Property to:
or
Delete Build Parameter
To delete a specific parameter, use:
or
Create and Modify Parameters when Scheduling a Build
You can edit the parameters collection when sending POST requests to the /app/rest/buildQueue
endpoint. These parameters (if a new parameter was created) and parameter values (if an existing parameter was modified) will be in effect for this specific build only.
Learn more: Start Custom Build.