Plug-in Documentation



The Twistlock plug-in provides for integration with a Twistlock server. Data is uploaded to the UrbanCode Velocity server using an HTTP Post request.


Must be running UrbanCode Velocity version 1.2.1 and later to use the plug-in.


There is no install process for this plug-in. The xxx plug-in is identified to UrbanCode Velocity as a value stream
integration. UrbanCode Velocity plug-in images are located in DockerHub and the UrbanCode Velolcity code accesses the version
that you select. To view available versions,
see the UrbanCode DockerHub.


Version 1.0.38

  • Minor bug fix

Version 1.0.35

  • Update plugin version from 0.x.x to 1.x.x format.

Version 0.0.32

  • Initial release


The Twistlock plug-in does not require configuration, like other types of UrbanCode Velocity plug-ins. To use the plug-in send an HTTP Post request with the data to parse. Whenever a there is a hit to the endpoint, the data is parsed and displayed as metrics in UrbanCode Velocity.

Integration type

The Twistlock plug-in is a parser type plug-in. It parses data from Twistlock JSON files.

Invoking the plug-in

You can invoke the plug-in manually using a REST Call or by using a Jenkins plug-in to integrate UrbanCode Velocity in a Jenkins environment.

Invoke using Jenkins plug-in

Install the UrbanCode Velocity plug-in into your Jenkins server. In your freestyle job or pipeline use the UCV-Upload Metrics File to UrbanCode Velocity step and provide the required fields. This step allows your build job to upload generated coverage results files to UrbanCode Velocity.


pipeline {
   agent any
   stages {
      stage('twistlockMetrics') {
         steps {
            step([$class: 'UploadMetricsFile',  appName: 'My Twistlock Test', dataFormat: 'twistlockJSON', filePath: '<location of the twistlock report>', name: 'my-twistlock-test', pluginType: 'twistlock', tenantId: '<tenant Id>', testSetName: 'twistlock', metricsRecordUrl: "${env.BUILD_URL}"])

Invoke the plug-in using a Rest call

When using a REST call to invoke the Code Coverage plug-in, it must be a POST method and include the location of the UrbanCode Velocity quality data endpoint.

The following request sample shows a REST call that you can copy and update as necessary. Key points about the snippet:

  • The URL points to the UrbanCode Velocity quality data endpoint. Update with the server location for your installation of UrbanCode Velocity.
  • The BODY of the call is a multipart/form data. It includes information about the payload.

URL: https://<url_urbancodevelocity_server>/reporting-consumer/metrics
BODY (multipart/form-data):
  payload: <json_object_string> // See below for schema format
 testArtifact: <twistlock_json_file>

The following shows the schema for the payload. Replace the angle brackets with your values for the parameters.

  "tenant_id": "<tenant_id>",    // required Tenant ID
  "metricName": "<metric_name>", // optional: name for recurring test set
  "application": {
    "name": "<application_name>"  //Name of application
  "record": {
    "recordName": "<record_name>", // optional: Name for this record
    "executionDate": 1547983466015, // optional: UNIX Epoch
    "pluginType": "twistlock",
    "dataFormat": "twistlockJSON",
    "metricsRecordUrl": "<Jenkins_build_url>" // optional: To link the Jenkins build with test results
  "build": {  // Optional: One of the following fields must be included 
    "buildId": "<build_id>",
    "jobExternalId": "<external_job_id>",
    "url": "<build_url>",
  "commitId": "<commit_id>",  // optional
  "pullRequestId": "<pullrequest_id>", // optional
  "environment": "<environment_name>" // optional

Example: Invoking using Curl

curl --request POST \
  --url https:///reporting-consumer/metrics \
  --form 'payload={
    "tenant_id": "5ade13625558f2c6688d15ce",
    "application": {
    "name": "My Application"
  "record": {
    "pluginType": "twistlock",
    "dataFormat": "twistlockJSON"
' \
  --form testArtifact=@test-result/twistlock.json