Create Xray plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Xray plugin configuration parameters

Table 1. Xray plugin configuration parameters
Parameter Description


Required. The unique name for the configuration.


The configuration description.


JFrog platform endpoint URL. For example, https://<your-instance>

Xray URL path

JFrog Xray API URL path. Typically, this is /xray.

JFrog CLI executable path

Required. Absolute or relative path to the JFrog CLI executable.

Auth type

Required. Type of authorization to use.

Basic auth

Authenticate with a username and password.

Access token

Authenticate with an access token.

Server ID

Server ID configured using the jfrog c add command.

Check configuration resource

Resource that is used to check the configuration. JFrog CLI must be installed on the resource.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.