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.

Finite State Analysis

View this plugin on the Plugins site

finiteStateAnalyzeBinary: Finite State Analyze Binary

  • subdomain : String

    The subdomain of your Finite State instance (e.g., "fs-yolo.finitestate.io" for https://fs-yolo.finitestate.io)

  • projectName : String

    The name of the project in Finite State. This will be used to identify the scan results.

  • apiTokenCredentialsId : String (optional)
  • binaryFilePath : String (optional)

    The path to the binary file to upload for analysis. This can be an absolute path or relative to the workspace.

  • configEnabled : boolean (optional)
  • externalizableId : boolean (optional)
  • platform : String (optional)
    Selects which Finite State platform (and transport) this build step targets:
    • Legacy Platform (Java CLT) — the default. Downloads and runs the Finite State Java command-line tool (CLT) on the build agent, exactly as previous plugin versions did. Requires Java on the agent. Choose this if your organization is still on the legacy platform.
    • 2026 Platform Release (REST API) — calls the Finite State public v0 REST API directly. No CLT download and no Java required on the agent. Choose this only once your organization has been upgraded to the 2026 platform release.
    Jobs saved before this option existed default to Legacy Platform, so upgrading the plugin does not change their behavior.
  • pollTimeoutMinutes : int (optional)
    Maximum number of minutes to wait for the scan to complete when "Wait for completion" is enabled. Defaults to 30. If the scan has not reached a terminal state within this window, the build fails with a message that includes the scan ID and a link so you can check status in the Finite State UI. Ignored when "Wait for completion" is disabled.
  • preRelease : boolean (optional)
    Enable this to mark versions as pre-release, typically used for development or staging builds.
  • projectVersion : String (optional)

    The version of the project. This is optional but recommended for tracking different versions of the same project.

  • reachabilityEnabled : boolean (optional)
  • sastEnabled : boolean (optional)
  • scaEnabled : boolean (optional)
  • waitForCompletion : boolean (optional)
    When disabled (the default), the build step returns as soon as the upload is accepted and the scan is queued, logging the scan ID and a link to follow progress in the Finite State UI — the build does not block. Enable it to make the step poll the Finite State API until the scan reaches a terminal state (completed or error) or the poll timeout elapses, and set the build result accordingly.

finiteStateImportSbom: Finite State Import SBOM

  • subdomain : String

    The subdomain of your Finite State instance (e.g., "fs-yolo.finitestate.io" for https://fs-yolo.finitestate.io)

  • projectName : String

    The name of the project in Finite State. This will be used to identify the scan results.

  • apiTokenCredentialsId : String (optional)
  • sbomFilePath : String (optional)

    The path to the SBOM file to import. This can be an absolute path or relative to the workspace. Supported formats include SPDX, CycloneDX, and other standard SBOM formats.

  • externalizableId : boolean (optional)
  • platform : String (optional)
    Selects which Finite State platform (and transport) this build step targets:
    • Legacy Platform (Java CLT) — the default. Downloads and runs the Finite State Java command-line tool (CLT) on the build agent, exactly as previous plugin versions did. Requires Java on the agent. Choose this if your organization is still on the legacy platform.
    • 2026 Platform Release (REST API) — calls the Finite State public v0 REST API directly. No CLT download and no Java required on the agent. Choose this only once your organization has been upgraded to the 2026 platform release.
    Jobs saved before this option existed default to Legacy Platform, so upgrading the plugin does not change their behavior.
  • pollTimeoutMinutes : int (optional)
    Maximum number of minutes to wait for the scan to complete when "Wait for completion" is enabled. Defaults to 30. If the scan has not reached a terminal state within this window, the build fails with a message that includes the scan ID and a link so you can check status in the Finite State UI. Ignored when "Wait for completion" is disabled.
  • preRelease : boolean (optional)
    Enable this to mark versions as pre-release, typically used for development or staging builds.
  • projectVersion : String (optional)

    The version of the project. This is optional but recommended for tracking different versions of the same project.

  • waitForCompletion : boolean (optional)
    When disabled (the default), the build step returns as soon as the upload is accepted and the scan is queued, logging the scan ID and a link to follow progress in the Finite State UI — the build does not block. Enable it to make the step poll the Finite State API until the scan reaches a terminal state (completed or error) or the poll timeout elapses, and set the build result accordingly.

finiteStateImportThirdParty: Finite State Import 3rd Party Scan

  • subdomain : String

    The subdomain of your Finite State instance (e.g., "fs-yolo.finitestate.io" for https://fs-yolo.finitestate.io)

  • projectName : String

    The name of the project in Finite State. This will be used to identify the scan results.

  • apiTokenCredentialsId : String (optional)
  • scanFilePath : String (optional)

    The path to the third-party scan results file to import. This can be an absolute path or relative to the workspace. The file should contain results from security scanning tools like SonarQube, Checkmarx, Snyk, etc.

  • externalizableId : boolean (optional)
  • platform : String (optional)
    Selects which Finite State platform (and transport) this build step targets:
    • Legacy Platform (Java CLT) — the default. Downloads and runs the Finite State Java command-line tool (CLT) on the build agent, exactly as previous plugin versions did. Requires Java on the agent. Choose this if your organization is still on the legacy platform.
    • 2026 Platform Release (REST API) — calls the Finite State public v0 REST API directly. No CLT download and no Java required on the agent. Choose this only once your organization has been upgraded to the 2026 platform release.
    Jobs saved before this option existed default to Legacy Platform, so upgrading the plugin does not change their behavior.
  • pollTimeoutMinutes : int (optional)
    Maximum number of minutes to wait for the scan to complete when "Wait for completion" is enabled. Defaults to 30. If the scan has not reached a terminal state within this window, the build fails with a message that includes the scan ID and a link so you can check status in the Finite State UI. Ignored when "Wait for completion" is disabled.
  • preRelease : boolean (optional)
    Enable this to mark versions as pre-release, typically used for development or staging builds.
  • projectVersion : String (optional)

    The version of the project. This is optional but recommended for tracking different versions of the same project.

  • scanType : String (optional)

    The type of scan results being imported. Select the appropriate scan type that matches the format of your scan results file (e.g., SonarQube Scan, Checkmarx Scan, Snyk Scan, etc.).

  • waitForCompletion : boolean (optional)
    When disabled (the default), the build step returns as soon as the upload is accepted and the scan is queued, logging the scan ID and a link to follow progress in the Finite State UI — the build does not block. Enable it to make the step poll the Finite State API until the scan reaches a terminal state (completed or error) or the poll timeout elapses, and set the build result accordingly.

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.