> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Probely Security Scanner Plugin

View this plugin on the Plugins site

probelyScan: Probely Security Scanner

  • targetId

    ID of the target you want Probely to scan.

    • Type: String
  • authToken (optional)

    Raw Probely API authentication key.

    Please use the credentialsId field instead, unless you understand the security implications of using this mechanism. Passing the API authentication token directly is not advised, unless it is properly secured using a secret storage mechanism, such as HashiCorp Vault.

    • Type: String
  • credentialsId (optional)

    Credential identifier for the Probely API authentication key.

    • Type: String
  • failThreshold (optional)

    Mark the build as failed if a vulnerability with the following severity level is found.

    • Type: String
  • stopIfFailed (optional)

    If the build fails because the target is vulnerable, stop scanning for more vulnerabilities.

    • Type: boolean
  • waitForScan (optional)

    Wait for the scan to complete before proceeding to the next step in the pipeline.

    Since a scan can take a long time, the plugin will return as soon as the scan starts. This is enabled by default to make the build faster.
    Please note that disabling this option implies that the build step always finishes successfully, even if vulnerabilities are found later on.

    Enabling this option allows the plugin to mark the build as failed if it finds any vulnerabilities.

    • Type: boolean

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.