getArtifacts

Retrieves all artifacts. Artifacts are typically software components, container images, libraries, or other digital assets that have been scanned for security vulnerabilities and compliance issues. This API provides a structured way to access, filter, and analyze artifacts within your system.

With this API, you can:

• Retrieve a list of artifacts.

• Access detailed metadata for each artifact, including version, repository, associated vulnerabilities, and security posture.

• Sort and filter artifacts based on various criteria to track security risks, compliance status, and artifact integrity.

Examples

GraphQL

query GetArtifacts($getArtifactsInput: GetArtifactsInput) {
  getArtifacts(getArtifactsInput: $getArtifactsInput) {
    artifacts {
      vulnDepIssues
      vulnDepBaseIssues
      vulnDepInstructionIssues
      secretIssues
      counts {
        vulnDepIssues
        vulnDepBaseIssues
        vulnDepInstructionIssues
        vulnDepPublicImageIssues
      }
      id
      appDescription {
        appName
        appType
        appId
        businessPriority
      }
      artifactInfo {
        type
        name
        version
        hash
        artifactIntegrity
        registry
      }
      categories {
        catId
        severities {
          info
          low
          medium
          high
          critical
          appox
        }
        name
        score
      }
      artifactCategories {
        catId
        severities {
          info
          low
          medium
          high
          critical
          appox
        }
        name
        score
      }
      registryDescription {
        type
        name
        project
        link
        hash
        tags
        username
        userType
        uploadTime
        lastUpdate
        buildTime
      }
      cloudData {
        cloudIdentifier
        link
        lastExecutionTime
        lastModifiedTime
        account
        zone
        cluster
        cloudDescription {
          type
          subType
          cloudEntityAttributes {
            ... on ECS {
              os
              cpu
              memory
              containers
              registeredAt
              registeredBy
              account
              zone
            }
          }
        }
      }
      totalIssuesBySeverity {
        info
        low
        medium
        high
        critical
        appox
      }
      packages {
        appId
        appName
        repoName
        link
        type
      }
    }
    offset
    total
    totalFilteredArtifacts
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "getArtifactsInput": {
    "limit": 100,
    "offset": 0,
    "sort": {
      "field": ["AppName"],
      "order": ["ASC"]
    },
    "dateRange": {
      "from": 1749000000000,
      "to": 1749900000000
    },
    "filters": {
      "apps": ["example"],
      "artifactType": ["example"],
      "artifactName": ["example"],
      "artifactFullName": ["example"],
      "version": ["example"],
      "sourceType": ["example"],
      "sourceTools": ["example"],
      "registryType": ["example"],
      "registryName": ["example"],
      "cloud": ["example"],
      "cluster": ["example"],
      "namespace": ["example"],
      "cloudDeployments": ["example"],
      "categories": ["example"],
      "issueSeverities": ["example"],
      "reachability": ["example"],
      "artifactIntegrity": ["example"],
      "artifactSha": ["example"],
      "imageSource": ["example"]
    },
    "artifactTopFilters": ["WithHighSeverityIssues"],
    "owners": ["example"],
    "tagIds": ["example"],
    "search": "example",
    "openItems": ["digest"]
  }
}

cURL

Node.js

Python

Arguments

You can use the following argument(s) to customize your getArtifacts query.

Argument	Description	Supported fields
getArtifactsInput GetArtifactsInput	Input parameters for filtering, sorting, and pagination	limit Int offset Int sort ArtifactsSort dateRange DateRange filters ArtifactFilters artifactTopFilters [ArtifactTopFilters] owners [String] tagIds [String] search String openItems [FilterTypes]

Fields

Return type: ArtifactsResponse

You can use the following field(s) to specify what information your getArtifacts query will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
artifacts [ArtifactInfo]	List of artifact information items	vulnDepIssues [String] vulnDepBaseIssues [String] vulnDepInstructionIssues [String] secretIssues [String] counts IssueCounts id String appDescription ArtifactApplication artifactInfo IArtifactInfo categories [ArtifactCategories] artifactCategories [ArtifactCategories] registryDescription [ArtifactRegistryDescription] cloudData [CloudArtifactData] totalIssuesBySeverity Severities packages [ArtifactPackage]
offset Int	Pagination offset value for virtualization
total Int	Total number of artifacts available
totalFilteredArtifacts Int	Total number of artifacts after applying filters