Class Fs

exposed methods

Hierarchy (view full)

Constructors

constructor

Methods

createArtifact createArtifactBase createAssetVersionOnAsset createAssetVersionOnAssetBase createNewAssetVersionAndUploadBinary createNewAssetVersionAndUploadBinaryBase createNewAssetVersionAndUploadTestResults createNewAssetVersionAndUploadTestResultsBase createProduct createProductBase createTest createTestAsBinaryAnalysis createTestAsBinaryAnalysisBase createTestAsThirdPartyScanner createTestAsThirdPartyScannerBase createTestBase downloadAssetVersionReport downloadAssetVersionReportBase downloadProductReport downloadProductReportBase downloadSbom downloadSbomBase generateReportDownloadUrl generateReportDownloadUrlBase generateSbomDownloadUrl generateSbomDownloadUrlBase getAllAssets getAllAssetsBase getAllBusinessUnits getAllBusinessUnitsBase getAllPaginatedResults getAllPaginatedResultsBase getAllProducts getAllProductsBase getAllUsers getAllUsersBase getAssetVersions getAssetVersionsBase getFindings getFindingsBase getProductAssetVersions getProductAssetVersionsBase getProducts getProductsBase getSoftwareComponents getSoftwareComponentsBase searchSbom searchSbomBase sendGraphqlQuery sendGraphqlQueryBase updateFindingStatuses updateFindingStatusesBase

Constructors

constructor

Methods

createArtifact

  • createArtifact(params): Promise<CreateArtifactResponse>

  • Create a new Artifact.

    This is an advanced method - you are probably looking for createNewAssetVersionAndUploadBinary or createNewAssetVersionAndUploadTestResults.

    Parameters

    Returns Promise<CreateArtifactResponse>

ProtectedcreateArtifactBase

createAssetVersionOnAsset

ProtectedcreateAssetVersionOnAssetBase

createNewAssetVersionAndUploadBinary

ProtectedcreateNewAssetVersionAndUploadBinaryBase

createNewAssetVersionAndUploadTestResults

  • createNewAssetVersionAndUploadTestResults(params): Promise<CompleteTestResultUploadResponse>

  • Creates a new Asset Version for an existing asset, and uploads test results for that asset version. By default, this uses the existing Business Unit and Created By User for the Asset. If you need to change these, you can provide the IDs for them.

    Parameters

    Returns Promise<CompleteTestResultUploadResponse>

    The response from the GraphQL query, a createAssetVersion Object.

ProtectedcreateNewAssetVersionAndUploadTestResultsBase

createProduct

ProtectedcreateProductBase

createTest

  • createTest(params): Promise<CreateTestResponse>

  • Create a new Test object for uploading files.

    This is an advanced method - you are probably looking for createNewAssetVersionAndUploadBinary or createNewAssetVersionAndUploadTestResults.

    Parameters

    Returns Promise<CreateTestResponse>

createTestAsBinaryAnalysis

ProtectedcreateTestAsBinaryAnalysisBase

createTestAsThirdPartyScanner

ProtectedcreateTestAsThirdPartyScannerBase

ProtectedcreateTestBase

downloadAssetVersionReport

  • downloadAssetVersionReport(params): Promise<void>

  • Download a report for a specific asset version and save it to a local file. This is a blocking call, and can sometimes take minutes to return if the report is very large.

    Parameters

    Returns Promise<void>

ProtecteddownloadAssetVersionReportBase

downloadProductReport

  • downloadProductReport(params): Promise<void>

  • Download a report for a specific product and save it to a local file. This is a blocking call, and can sometimes take minutes to return if the report is very large.

    Parameters

    Returns Promise<void>

ProtecteddownloadProductReportBase

downloadSbom

  • downloadSbom(params): Promise<void>

  • Download an SBOM for an Asset Version and save it to a local file. This is a blocking call, and can sometimes take minutes to return if the SBOM is very large.

    Parameters

    Returns Promise<void>

ProtecteddownloadSbomBase

generateReportDownloadUrl

  • generateReportDownloadUrl(params): Promise<string>

  • Blocking call: Initiates generation of a report, and returns a pre-signed URL for downloading the report. This may take several minutes to complete, depending on the size of the report.

    Parameters

    Returns Promise<string>

ProtectedgenerateReportDownloadUrlBase

generateSbomDownloadUrl

  • generateSbomDownloadUrl(params): Promise<string>

  • Blocking call: Initiates generation of an SBOM for the asset_version_id, and return a pre-signed URL for downloading the SBOM. This may take several minutes to complete, depending on the size of SBOM.

    Parameters

    Returns Promise<string>

ProtectedgenerateSbomDownloadUrlBase

getAllAssets

  • getAllAssets(params): Promise<any[]>

  • Gets all assets in the organization. Uses pagination to get all results.

    Parameters

    Returns Promise<any[]>

ProtectedgetAllAssetsBase

getAllBusinessUnits

  • getAllBusinessUnits(): Promise<any[]>

  • Get all business units in the organization. NOTE: The return type here is Group. Uses pagination to get all results.

    Returns Promise<any[]>

ProtectedgetAllBusinessUnitsBase

getAllPaginatedResults

  • getAllPaginatedResults(query, variables?, field?, limit?): Promise<any[]>

  • Get all results from a paginated GraphQL query

    Parameters

    • query: string

      The GraphQL query string

    • Optionalvariables: Record<string, any>

      Variables to be used in the GraphQL query, by default None

    • Optionalfield: string

      The field in the response JSON that contains the results

    • Optionallimit: number

      The maximum number of results to return. By default, None to return all results. Limit cannot be greater than 1000.

    Returns Promise<any[]>

ProtectedgetAllPaginatedResultsBase

  • getAllPaginatedResultsBase(query, variables?, field?, limit?): Promise<any[]>

  • Parameters

    • query: string
    • Optionalvariables: Record<string, any>
    • Optionalfield: string
    • Optionallimit: number

    Returns Promise<any[]>

getAllProducts

  • getAllProducts(): Promise<any[]>

  • Get all products in the organization. Uses pagination to get all results.

    Returns Promise<any[]>

    Deprecated

    Use: getProducts instead

ProtectedgetAllProductsBase

  • getAllProductsBase(): Promise<any[]>

  • Returns Promise<any[]>

getAllUsers

  • getAllUsers(): Promise<any[]>

  • Get all users in the organization. Uses pagination to get all results.

    Returns Promise<any[]>

ProtectedgetAllUsersBase

  • getAllUsersBase(): Promise<any[]>

  • Returns Promise<any[]>

getAssetVersions

  • getAssetVersions(params): Promise<any[]>

  • Gets asset versions in the organization. Uses pagination to get all results.

    Parameters

    Returns Promise<any[]>

ProtectedgetAssetVersionsBase

getFindings

  • getFindings(params): Promise<any[] | FindingsMeta>

  • Gets all the Findings for an Asset Version. Uses pagination to get all results.

    Parameters

    Returns Promise<any[] | FindingsMeta>

ProtectedgetFindingsBase

getProductAssetVersions

  • getProductAssetVersions(productId): Promise<any[]>

  • Gets all the asset versions for a product.

    Parameters

    • productId: string

      Product ID to get asset versions for. If not provided, will get all asset versions in the organization.

    Returns Promise<any[]>

ProtectedgetProductAssetVersionsBase

  • getProductAssetVersionsBase(productId): Promise<any[]>

  • Parameters

    • productId: string

    Returns Promise<any[]>

getProducts

ProtectedgetProductsBase

getSoftwareComponents

ProtectedgetSoftwareComponentsBase

searchSbom

  • searchSbom(params): Promise<SoftwareComponentInstance[]>

  • Searches the SBOM of a specific asset version or the entire organization for matching software components. Search Methods: EXACT or CONTAINS An exact match will return only the software component whose name matches the name exactly. A contains match will return all software components whose name contains the search string.

    Parameters

    Returns Promise<SoftwareComponentInstance[]>

ProtectedsearchSbomBase

sendGraphqlQuery

  • sendGraphqlQuery(organizationContext, query, variables?): Promise<any>

  • Send a GraphQL query to the API

    Parameters

    • organizationContext: string
    • query: string

      The GraphQL query string

    • Optionalvariables: Record<string, any>

      Variables to be used in the GraphQL query, by default null

    Returns Promise<any>

    • Response JSON

    Throws

    • If the response status code is not 200

ProtectedsendGraphqlQueryBase

  • sendGraphqlQueryBase(organizationContext, query, variables?): Promise<any>

  • Parameters

    • organizationContext: string
    • query: string
    • Optionalvariables: Record<string, any>

    Returns Promise<any>

updateFindingStatuses

  • updateFindingStatuses(params): Promise<any>

  • Updates the status of a findings or multiple findings. This is a blocking call.

    Parameters

    Returns Promise<any>

ProtectedupdateFindingStatusesBase

Settings

Member Visibility

On This Page

Constructors
Methods
createArtifactcreateArtifactBasecreateAssetVersionOnAssetcreateAssetVersionOnAssetBasecreateNewAssetVersionAndUploadBinarycreateNewAssetVersionAndUploadBinaryBasecreateNewAssetVersionAndUploadTestResultscreateNewAssetVersionAndUploadTestResultsBasecreateProductcreateProductBasecreateTestcreateTestAsBinaryAnalysiscreateTestAsBinaryAnalysisBasecreateTestAsThirdPartyScannercreateTestAsThirdPartyScannerBasecreateTestBasedownloadAssetVersionReportdownloadAssetVersionReportBasedownloadProductReportdownloadProductReportBasedownloadSbomdownloadSbomBasegenerateReportDownloadUrlgenerateReportDownloadUrlBasegenerateSbomDownloadUrlgenerateSbomDownloadUrlBasegetAllAssetsgetAllAssetsBasegetAllBusinessUnitsgetAllBusinessUnitsBasegetAllPaginatedResultsgetAllPaginatedResultsBasegetAllProductsgetAllProductsBasegetAllUsersgetAllUsersBasegetAssetVersionsgetAssetVersionsBasegetFindingsgetFindingsBasegetProductAssetVersionsgetProductAssetVersionsBasegetProductsgetProductsBasegetSoftwareComponentsgetSoftwareComponentsBasesearchSbomsearchSbomBasesendGraphqlQuerysendGraphqlQueryBaseupdateFindingStatusesupdateFindingStatusesBase