getArtifact

Retrieves detailed information about a specific artifact, including its metadata, associated packages, and deployment details for a given organization.

Examples

GraphQL

query GetArtifact($getArtifactInput: GetArtifactInput) {
  getArtifact(getArtifactInput: $getArtifactInput) {
    vulnDepIssues
    vulnDepBaseIssues
    vulnDepInstructionIssues
    secretIssues
    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
    }
  }
}

Variables

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

{
  "getArtifactInput": {
    "artifactId": "f01a11a3bb540707351a015edf5d8311adad31d3003bf122e1cd62cb01977b0e_some-container_*Amazon ECR"
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetArtifact($getArtifactInput: GetArtifactInput) { getArtifact(getArtifactInput: $getArtifactInput) { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues secretIssues 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 } } }",
 "variables": {
    "getArtifactInput": {
      "artifactId": "f01a11a3bb540707351a015edf5d8311adad31d3003bf122e1cd62cb01977b0e_some-container_*Amazon ECR"
    }
  }
}'

Node.js

const query = 'query GetArtifact($getArtifactInput: GetArtifactInput) { getArtifact(getArtifactInput: $getArtifactInput) { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues secretIssues 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 } } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      getArtifactInput: {
        artifactId: "f01a11a3bb540707351a015edf5d8311adad31d3003bf122e1cd62cb01977b0e_some-container_*Amazon ECR"
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetArtifact($getArtifactInput: GetArtifactInput) { getArtifact(getArtifactInput: $getArtifactInput) { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues secretIssues 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 } } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "getArtifactInput": {
        "artifactId": "f01a11a3bb540707351a015edf5d8311adad31d3003bf122e1cd62cb01977b0e_some-container_*Amazon ECR"
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

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

Argument	Description	Supported fields
getArtifactInput GetArtifactInput	Input containing artifact identifier and additional filters	artifactId String

Fields

Return type: ArtifactInfo

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

Field	Description	Supported fields
vulnDepIssues [String]	List of vulnerability dependency issue IDs
vulnDepBaseIssues [String]	List of base vulnerability dependency issue IDs
vulnDepInstructionIssues [String]	List of instruction-level vulnerability dependency issue IDs
secretIssues [String]	List of secret-related issue IDs
id String	Unique identifier of the artifact
appDescription ArtifactApplication	Description of the artifact's application context	appName String appType String appId String businessPriority Float
artifactInfo IArtifactInfo	Core artifact metadata and info	type ArtifactInfoTypes name String version String hash String artifactIntegrity String registry String
categories [ArtifactCategories]	List of categories assigned to the artifact	catId String severities Severities name String score String
artifactCategories [ArtifactCategories]	List of artifact categories (possibly duplicates or synonyms)	catId String severities Severities name String score String
registryDescription [ArtifactRegistryDescription]	Registry descriptions related to the artifact	type String name String project String link String hash String tags [String] username String userType String uploadTime Float lastUpdate Float buildTime Float
cloudData [CloudArtifactData]	Cloud-related data for the artifact	cloudIdentifier String link String lastExecutionTime Float lastModifiedTime Float account String zone String cluster String cloudDescription CloudDescription
totalIssuesBySeverity Severities	Aggregated counts of issues by severity for the artifact	info Int low Int medium Int high Int critical Int appox Int
packages [ArtifactPackage]	List of packages included in the artifact	appId String appName String repoName String link String type String