# getArtifact Retrieves detailed information about a specific artifact, including its metadata, associated packages, and deployment details for a given organization. ### Examples {% tabs %} {% tab title="GraphQL" %} ```graphql query GetArtifact($getArtifactInput: GetArtifactInput) { getArtifact(getArtifactInput: $getArtifactInput) { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues secretIssues sbomIssues counts { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues vulnDepPublicImageIssues } id appDescription { appName appType appId businessPriority } artifactInfo { type name version hash artifactIntegrity registry visibility firstSeenDate runtime runtimeLastSeenDate cloudDeployed biVisibility biName biVersion osName osVersion } 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 } issueSeverityBreakdown { name tab severities { info low medium high critical appox } } artifactContext { name icon items { name trend } } scaSeveritySummary { info low medium high critical appox } } } ``` **Variables** This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. ```json { "getArtifactInput": { "artifactId": "f01a11a3bb540707351a015edf5d8311adad31d3003bf122e1cd62cb01977b0e_some-container_*Amazon ECR" } } ``` {% endtab %} {% tab title="cURL" %} ```shell 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 sbomIssues counts { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues vulnDepPublicImageIssues } id appDescription { appName appType appId businessPriority } artifactInfo { type name version hash artifactIntegrity registry visibility firstSeenDate runtime runtimeLastSeenDate cloudDeployed biVisibility biName biVersion osName osVersion } 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 } issueSeverityBreakdown { name tab severities { info low medium high critical appox } } artifactContext { name icon items { name trend } } scaSeveritySummary { info low medium high critical appox } } }", "variables": { "getArtifactInput": { "artifactId": "f01a11a3bb540707351a015edf5d8311adad31d3003bf122e1cd62cb01977b0e_some-container_*Amazon ECR" } } }' ``` {% endtab %} {% tab title="Node.js" %} ```javascript const query = 'query GetArtifact($getArtifactInput: GetArtifactInput) { getArtifact(getArtifactInput: $getArtifactInput) { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues secretIssues sbomIssues counts { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues vulnDepPublicImageIssues } id appDescription { appName appType appId businessPriority } artifactInfo { type name version hash artifactIntegrity registry visibility firstSeenDate runtime runtimeLastSeenDate cloudDeployed biVisibility biName biVersion osName osVersion } 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 } issueSeverityBreakdown { name tab severities { info low medium high critical appox } } artifactContext { name icon items { name trend } } scaSeveritySummary { info low medium high critical appox } } }'; 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)); ``` {% endtab %} {% tab title="Python" %} ```python import requests query = 'query GetArtifact($getArtifactInput: GetArtifactInput) { getArtifact(getArtifactInput: $getArtifactInput) { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues secretIssues sbomIssues counts { vulnDepIssues vulnDepBaseIssues vulnDepInstructionIssues vulnDepPublicImageIssues } id appDescription { appName appType appId businessPriority } artifactInfo { type name version hash artifactIntegrity registry visibility firstSeenDate runtime runtimeLastSeenDate cloudDeployed biVisibility biName biVersion osName osVersion } 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 } issueSeverityBreakdown { name tab severities { info low medium high critical appox } } artifactContext { name icon items { name trend } } scaSeveritySummary { info low medium high critical appox } } }' 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) ``` {% endtab %} {% endtabs %} ### Arguments You can use the following argument(s) to customize your `getArtifact` query. | Argument | Description | Supported fields | | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | ------------------- | | getArtifactInput [`GetArtifactInput`](/api-documentation/api-reference/api--artifact/types/inputs/get-artifact-input.md) | Input containing artifact identifier and additional filters | artifactId `String` | ### Fields Return type: [`ArtifactInfo`](/api-documentation/api-reference/api--artifact/types/objects/artifact-info.md) 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 | | | sbomIssues `[String]` | List of SBOM issue IDs | | | counts [`IssueCounts`](/api-documentation/api-reference/api--artifact/types/objects/issue-counts.md) | Counts of different issue types |

vulnDepIssues Int
vulnDepBaseIssues Int
vulnDepInstructionIssues Int
vulnDepPublicImageIssues Int

| | id `String` | Unique identifier of the artifact | | | appDescription [`ArtifactApplication`](/api-documentation/api-reference/api--artifact/types/objects/artifact-application.md) | Description of the artifact's application context |

appName String
appType String
appId String
businessPriority Float

| | artifactInfo [`IArtifactInfo`](/api-documentation/api-reference/api--artifact/types/objects/i-artifact-info.md) | Core artifact metadata and info |

type ArtifactInfoTypes
name String
version String
hash String
artifactIntegrity String
registry String
visibility String
firstSeenDate Float
runtime Boolean
runtimeLastSeenDate Float
cloudDeployed Boolean
biVisibility String
biName String
biVersion String
osName String
osVersion String

| | categories [`[ArtifactCategories]`](/api-documentation/api-reference/api--artifact/types/objects/artifact-categories.md) | List of categories assigned to the artifact |

catId String
severities Severities
name String
score String

| | artifactCategories [`[ArtifactCategories]`](/api-documentation/api-reference/api--artifact/types/objects/artifact-categories.md) | List of artifact categories (possibly duplicates or synonyms) |

catId String
severities Severities
name String
score String

| | registryDescription [`[ArtifactRegistryDescription]`](/api-documentation/api-reference/api--artifact/types/objects/artifact-registry-description.md) | 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]`](/api-documentation/api-reference/api--artifact/types/objects/cloud-artifact-data.md) | Cloud-related data for the artifact |

cloudIdentifier String
link String
lastExecutionTime Float
lastModifiedTime Float
account String
zone String
cluster String
cloudDescription CloudDescription

| | totalIssuesBySeverity [`Severities`](/api-documentation/api-reference/api--application/types/objects/severities.md) | Aggregated counts of issues by severity for the artifact |

info Int
low Int
medium Int
high Int
critical Int
appox Int

| | packages [`[ArtifactPackage]`](/api-documentation/api-reference/api--artifact/types/objects/artifact-package.md) | List of packages included in the artifact |

appId String
appName String
repoName String
link String
type String

| | issueSeverityBreakdown [`[IssueSeverityBreakdown]`](/api-documentation/api-reference/api--artifact/types/objects/issue-severity-breakdown.md) | Issue severity breakdown for the artifact |

name String
tab String
severities Severities

| | artifactContext [`[ArtifactContextCategory]`](/api-documentation/api-reference/api--artifact/types/objects/artifact-context-category.md) | Context categories for the artifact (reachability, exportability, damage) |

name String
icon String
items \[ArtifactContextItem]

| | scaSeveritySummary [`Severities`](/api-documentation/api-reference/api--application/types/objects/severities.md) | Sca issues summary |

info Int
low Int
medium Int
high Int
critical Int
appox Int

| --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ox.security/api-documentation/api-reference/api--artifact/queries/get-artifact.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.