getSingleIssueInfo
The getSingleIssueInfo
API retrieves detailed information for a single security issue detected during a scan for a specific organization.
Type
Query
Query Example
Parameters
getSingleIssueInfo
The API accepts input parameters that .
SingleIssueInput
object
orgId
The unique identifier of the organization.
String (Alphanumeric identifier)
Input Object Variables
Object
Type
Description
issueId
String
The ID of the issue.
Response object variables
Object Variable
Description
Value
aggregations
IAggregations
app
IAppsInfo
autoFix
FixIssue
cancelFalsePositiveComment
Cancels a user-provided comment explaining why an issue was marked as a false positive.
String
category
ICategory
comment
A user-added comment to an issue.
String
compliance
[ComplianceItem]
correlatedIssueId
If two issues are related, the system shows the connected issue ID. For example, an SCA repository issue linked to an SCA image issue.
String
created
The timestamp when the issue was created.
Float
createdAt
The date and time when the issue was created.
Float
cwe
List of Common Weakness Enumeration (CWE) IDs and descriptions for the issue.
[String]
cweList
[CweList]
daysPastSLA
Days count of issue's SLA breach.
Int
dependencyChain
Information about the chain of dependencies related to the issue.
[String]
dependencyGraph
Includes dependency chain
, dependency graph
, dependency graph edges
, and dependency graph nodes
.
SbomDependencyGraphResponse
description
Description of an issue.
String
excludedByAlert
Indicates if an issue is excluded by alerts.
Boolean
excludedByApp
Indicates if an issue is excluded by a repo.
Boolean
excludedByPolicy
Indicates if an issue is excluded by a policy.
Boolean
exclusions
[RecommendedExclusions]
extraInfo
[ExtraInfo]
falsePositiveComment
Holds a user-provided comment explaining why an issue is marked as a false positive.
String
fixAppliedDeatils
Details about fixes that were applied to the issue.
FixAppliedDeatils
fixIssue
FixIssue
fixLink
URL linking to the fix for the issue.
String
fixes
List of fixes associated with the issue.
PolicyFix
gptInfo
GPTInfo
graphExist
Boolean
highestOXCVESeverity
The highest CVE severity by Ox's calculation.
String
id
String
impact
String
importantSeverityBreakdown
The severity impact breakdown that adjusts the overall severity.
[String]
isCanceledFalsePositive
Indicates that when the issue was previously identified as FalsePositive, it was incorrect.
Boolean
isFalsePositive
Indicates when the issue was reported as FalsePositive.
Boolean
isFixApplied
Indicates if the fix was applied.
Boolean
isFixAvailable
Indicates whether this issue can be fixed.
Boolean
isGPTFixAvailable
Indicates if ChatGPT can provide info about this issue.
Boolean
isMonoRepoChild
Indicates if this issue comes from a mono sub-repo or regular repo.
Boolean
isPRAvailable
Indicates if a pull request is available for this issue.
Boolean
issueId
The ID of the issue.
String
issueStatus
The status of the issue can be New, Updated, or Unchanged.
IssueStatus
issueUpdatedAt
The date on which the issue was updated.
Float
languageInfo
The programming language used in the code where the security issue was detected.
LanguageInfo
latestCommit
LatestCommit
learnMore
A link to a video for more information about the specific issue.
[String]
mainTitle
The title or name of the issue, displayed in the application as the "Name".
String
messages
The message that was sent about the issue through an external channel, such as Slack or Teams. Usually messages are sent in one of the following ways: manually in the Get Issues page or automatically, as part of a flow.
[IssueMessage]
name
The issue name.
String
occurrences
Number of occurrences related to the issue.
Int
originalSeverity
The original severity of the issue.
Int
originalToolSeverity
Severity as determined by the original scanning tool.
String
oscarData
[OscarItem]
overrideSeverity
Indicates whether the severity was overridden.
Boolean
overrideSeverityReason
Reason for overriding the severity.
String
ownerEmails
List of email addresses of the issue owners.
[String]
owners
List of issue owner names.
[String]
policy
Information about the policy under which the issue was created, including name and ID.
IPolicy
prDeatils
Information about the pull request (PR) created for the issue, including links and metadata.
PullRequest
previousSeverity
The severity level for this issue in the previous scan.
PrevSeverity
recommendation
Suggestions for resolving the issue, often defined by policies.
String
resource
IssueResource
ruleId
The rule ID.
String
sbom
SbomLib
scaFixType
Information about the SCA (Software Composition Analysis) fix type.
ScaFixType
scaTriggerPkgs
If the security issue is in an indirect (transitive) package, this field indicates the parent package that introduced the vulnerable package. If the issue is in a direct dependency, this field will be the same as the direct package.
[TriggerPackage]
scaVulnerabilities
List of CVEs.
[SCAVulnerability]
scanDate
The date of the scan in which the issue was generated.
Float
scanId
The ID of the scan during which the issue was identified.
String
scanIssueStatus
IssueStatus
secondTitle
An issue description as it appears in the Summary tab in the app.
String
severity
The severity level of the issue, such as "low," "medium," or "critical."
String
severityChange
The severity change status.
String
severityChangeReason
[String]
severityChangedReason
All severity factors within the issue.
[SeverityChangedReason]
slackNotification
Indicates whether the issue was sent to Slack, including the channel and timestamp.
[SlackNotification]
sourceTools
Tools that detected the issue, including OX tools and third-party tools.
[String]
tags
Tags assigned to the application associated with the issue.
[AppTag]
tickets
Indicates JIRA or other system tickets created for the issue.
[Ticket]
aggregations
object variables
aggregations
object variablesField Name
Description
Values
columns
IAggColumns
items
[AggItem]
summary
Summary information related to aggregation, such as:
comment
: Stringsummary
: String | IAggSummary | |type
| Type of aggregation | String |
Aggregation columns
Field
Description
Value
columns
Aggregation columns, such as:
header
: String representing the header texthref
: Hyperlink reference (URL)key
: Unique key identifiertooltip
: Tooltip text for additional contexttype
: String representing the data type | [AggregationColumn] | |comment
| A comment in string format | String |
Aggregation items
​
Field Name
Type
Description
_id
String
Unique identifier for the entity.
accessLevel
String
User's access level or permissions within the system.
accountId
String
Unique identifier for the account associated with the entity.
accountName
String
Name of the account associated with the entity.
additionalToolData
String
Extra metadata or data collected from external tools.
adminLocation
String
Location from which administrative actions were performed.
adminOperation
String
Type of administrative action taken.
adminOperationDate
String
Date when the administrative action occurred.
aggId
String
Aggregation identifier used for grouping related data.
baseImage
String
Name or identifier of the base image used in a container.
binariesCount
Int
Number of binary files associated with this entity.
branch
String
Git branch where the action or event occurred.
cloudEnv
String
Cloud environment where the resource is hosted (e.g., AWS, GCP).
cluster
String
Cluster name or identifier in a cloud or Kubernetes environment.
commitBy
String
User who made the commit in version control.
commitLink
String
URL linking to the commit details.
consoleLink
String
URL to access the management console of the system.
createdAt
String
Date and time when the entity was created.
cvss
Float
CVSS (Common Vulnerability Scoring System) score of a vulnerability.
date
String
General date field indicating an event timestamp.
daysOpen
String
Number of days since the issue or event was reported.
dependencyChain
[Dependency]
List of dependencies related to the entity.
dependencyType
String
Type of dependency (e.g., direct, transitive).
destinationCreationDate
String
Date when the destination repository or resource was created.
destinationLastModifyDate
String
Date when the destination resource was last modified.
destinationRepoLink
String
URL linking to the destination repository.
destinationRepoName
String
Name of the destination repository.
destinationRepoVisibility
String
Visibility status of the destination repository (public/private).
devOperation
String
Type of development operation performed.
devOperationDate
String
Date when the development operation occurred.
dockerVer
String
Version of Docker used.
downloads
String
Number of downloads for a package or artifact.
earliestActivityDate
String
Date of the earliest recorded activity related to the entity.
eduVideoLink
String
URL linking to an educational or training video.
email
String
Email address associated with the user or account.
endLine
Int
Ending line number for the match in a file (for code analysis).
events
String
Collection of events related to the entity.
evidence
String
Supporting data or proof related to an issue.
excludedByAlert
Boolean
Indicates whether the issue was excluded based on an alert.
fileCount
Int
Number of files related to the entity.
fileName
String
Name of the file.
filePath
String
Full path of the file.
fileUri
String
URI linking to the file location.
fixedVersion
String
Version where the issue or vulnerability was fixed.
forks
String
Number of forks for a repository.
image
String
Name or identifier of the image.
imageCreatedAt
String
Date when the image was created.
imageLink
String
URL linking to the image.
installedVersion
String
Version of a package currently installed.
isFixAvailable
Boolean
Indicates if a fix is available for an issue.
k8sType
String
Type of Kubernetes resource.
language
String
Programming language used.
lastAccess
String
Date of the last access event.
lastAdminOperation
String
Most recent administrative action taken.
lastCodeDate
String
Date of the last code change.
layer
String
Container or image layer details.
link
String
Generic URL link associated with the entity.
location
String
Physical or logical location of the entity.
match
String
Matching criteria or results for the entity.
mergedBy
String
User who merged a pull request.
name
String
Name of the entity.
orgRole
String
Role assigned to the user within an organization.
os
String
Operating system associated with the entity.
pkgCount
Int
Number of packages associated with the entity.
pkgName
String
Name of the package.
project
String
Name of the project associated with the entity.
pushType
String
Type of push operation performed, can be push/pull
pushedAt
String
Date and time of the last push event.
region
String
Cloud region where the resource is deployed.
repo
String
Repository name.
repoCreator
String
User or system that created the repository.
repoPermissions
String
Permissions associated with the repository.
reputation
String
Reputation score or trust level of the entity.
reviewers
String
Users who reviewed a pull request.
ruleId
String
Unique identifier for a security rule.
secret
String
Represents a stored secret or credential.
service
String
Name of the service related to the entity.
sha
String
SHA hash of the commit or file.
size
String
Size of the file or artifact.
snippet
String
Code snippet related to an issue.
source
String
Source system or origin of the data.
stars
String
Number of stars for a repository.
type
String
Type classification of the entity.
url
String
URL linking to the entity.
user
String
Username associated with the entity.
vulBySeverity
String
Vulnerability categorized count by severity level.
app
object variables
app
object variablesField
Type
Description
applicationFlows
ApplicationFlow
businessPriority
Float
Indicates the business priority of an application. Relevant for sorting or prioritizing applications.
fakeApp
Boolean
Boolean field indicating if the application is marked as fake. Default value is false
.
id
String
A unique application ID, typically derived from source control (e.g., GitLab or GitHub). Relevant to users.
name
String
The full application name, as retrieved from source control. A combination of the repo name and the branch name.
organization
String
The organization associated with the application, such as a GitLab group or OX.
originBranchName
String
The primary branch from which the application was scanned.
owners
[OwnerInfo]
Lists the application owners, such as developers, security, watchers, or business owners. Default is empty.
repoId
String
Repository ID of the application. Requires clarification if this or ID
is the derived value.
repoName
String
Displays just the repository name without path or branch.
riskScore
Float
secPosture
Float
type
String
Indicates the type of source control, such as GitLab, GitHub, or Bitbucket. Relevant for identifying the source of scanned applications.
typeComments
String
autofix
object variables
autofix
object variablesIndicates if an automatic fix was suggested or created for the issue, including creating a pull request from the application.
Field
Type
Description
activeFix
ActiveFix
Represents the active fix applied to the issue as follows:
- fixId
: The unique identifier for the fix.
- fixUrl
: The URL of the pull request created for the fix.
fixAppliedBy
String
Username of the user who applied the fix.
fixDate
Date
The date when the fix was applied.
fixDescription
String
Description of the fix, typically matching the PR description.
fixInput
[Input]
Fix description or details of the input for the fix.
fixPR
FixPR
The URL of the pull request created for the fix.
fixTitle
String
The title of the pull request for the fix.
fixType
String
Specifies the type of fix applied (e.g., pull request or getPosture).
isFixApplied
Boolean
Indicates whether the fix has been applied.
sourceControlType
String
Indicates the source control system used (e.g., GitLab, GitHub, Bitbucket).
exclusions
object variables
exclusions
object variablesField
Type
Description
label
String
The exclusion label.
recommended
Boolean
When using bulk actions, the default exclusion is activated.
oxRuleId
String
The exclusion ID required for defining exclusions.
category
object variables
category
object variablesField
Type
Description
categoryId
Int
Unique identifier for the category.
name
String
Name of the category.
subCategoryComment
String
Additional comments or notes related to the subcategory.
subCategoryName
String
Name of the subcategory under the main category.
compliance
object variables
compliance
object variablesField
Type
Description
standard
String
The compliance framework or standard this control belongs to (e.g., ISO 27001, SOC 2, NIST 800-53).
standardLink
String
A URL linking to the official documentation or reference for the compliance standard.
control
String
The specific compliance control identifier within the standard (e.g., "AC-2" for NIST 800-53).
category
String
The category or domain under which the control falls (e.g., "Access Control", "Data Protection").
description
String
A brief explanation of the compliance control and its intent.
categoryLink
String
A URL linking to documentation about the category or domain of the compliance standard.
controlLink
String
A URL linking to detailed documentation about this specific compliance control.
latestCommit
Object Variables
latestCommit
Object VariablesField
Type
Description
date
String
The date of the latest commit.
commitLink
String
The link to the commit page.
match
String
The actual string that was found in code.
snippet
String
The snippet containing the match.
snippetLineNumber
Int
The start line number of the snippet.
sbom
object variables
sbom
object variablesField
Type
Description
id
String
Unique identifier for the library or package.
references
[SbomReference]
appType
String
Type of application repository/artifact.
language
String
Programming language in which the library is written.
libId
String
Unique identifier for the library in the SBOM.
libraryName
String
Name of the library.
libraryVersion
String
Version of the library being used.
license
String
License type under which the library is distributed.
appName
String
Name of the application using the library.
location
String
File path or package registry location of the library.
dependencyType
String
Type of dependency (e.g., direct, transitive).
source
String
Source from where the library was obtained (e.g., GitHub, NPM, Maven).
appId
String
Unique identifier for the application using the library.
locationLink
String
URL linking to the file or package registry location.
appLink
String
URL linking to the application details.
pkgName
String
Name of the package containing the library.
copyWriteInfo
[String]
Copyright information associated with the library.
copyWriteInfoLink
String
URL linking to copyright details.
libLink
String
URL linking to the library's official repository or documentation.
vulnerabilityCounts
IssuesBySeverity
triggerPackage
String
Package that introduced the vulnerability.
vulnerabilities
[SCAVulnerability]
latestVersion
String
Most recent version of the library.
latestVersionDate
String
Release date of the latest version.
stars
Int
Number of stars the library has on its repository (e.g., GitHub).
forks
Int
Number of forks of the library repository.
openIssues
Int
Number of open issues in the library repository.
packageManager
String
Name of the package manager (e.g., NPM, PyPI, Maven).
packageManagerLink
String
URL linking to the package manager's page for the library.
maintainers
String
List of maintainers responsible for the library.
contributors
String
List of contributors who have worked on the library.
downloads
Int
Number of downloads of the library.
sourceLink
String
URL linking to the source repository of the library.
notPopular
Boolean
Indicates if the library is not widely used.
licenseIssue
Boolean
Indicates if there are license-related concerns.
notMaintained
Boolean
Indicates if the library is no longer actively maintained.
isDeprecated
Boolean
Indicates if the library has been deprecated.
notImported
Boolean
Indicates if the library is declared but not imported in the application.
notUsed
Boolean
Indicates if the library is included but not actually used in the codebase.
notUpdated
Boolean
Indicates if the library has not received recent updates.
dependencyLevel
String
Indicates how deep the library is within the dependency chain.
requestId
String
Unique identifier for tracking the request that retrieved this library data.
licenseLink
String
URL linking to the official license documentation.
artifactInSbomLibs
[ArtifactInSbomLibs]
sha
String
SHA hash of the library package for integrity verification.
maintainersList
[Maintainer]
maintainersList
object variables
maintainersList
object variablesField
Type
Description
name
String
The full name of the user or entity.
email
String
The email address associated with the user or entity.
references
object variables
references
object variablesField
Type
Description
triggerPackage
String
Name of the package that introduced the dependency or vulnerability.
location
String
File path or package registry location of the dependency.
locationLink
String
URL linking to the file or package registry location.
dependencyType
String
Type of dependency (e.g., direct, transitive).
dependencyLevel
String
Depth of the dependency in the dependency chain (e.g., top-level, deep).
commit
Commit
fileName
String
Name of the file where the dependency is defined or referenced.
Commit
object variables
Field
Type
Description
commitedAt
String
Timestamp indicating when the commit was made.
committerName
String
Name of the user who committed the changes.
committerEmail
String
Email address of the user who committed the changes.
vulnerabilityCounts
object variables
vulnerabilityCounts
object variablesField
Type
Description
appox
Int
Number of vulnerabilities categorized as Appoxalypse severity.
critical
Int
Number of vulnerabilities categorized as Critical severity.
high
Int
Number of vulnerabilities categorized as High severity.
medium
Int
Number of vulnerabilities categorized as Medium severity.
low
Int
Number of vulnerabilities categorized as Low severity.
info
Int
Number of issues categorized as Informational (non-severe).
vulnerabilities
object variables
vulnerabilities
object variablesField
Type
Description
issueId
String
Unique identifier for the security issue.
oxSeverity
String
Severity level of the issue as assessed by OX security analysis.
severityFromTool
String
Severity category (e.g., Critical, High, Medium, Low) assigned by the scanning tool.
cve
String
Common Vulnerabilities and Exposures (CVE) identifier for the issue.
cveLink
String
URL linking to the official CVE database entry for the vulnerability.
cvsVer
String
CVSS (Common Vulnerability Scoring System) version used for scoring.
cvssVersion
String
Specific version of CVSS used for assessing severity (e.g., CVSS 3.1).
epss
String
Exploit Prediction Scoring System (EPSS) score estimating the likelihood of exploitation.
percentile
String
EPSS percentile ranking compared to other vulnerabilities.
libName
String
Name of the affected library or software package.
dependencyChain
String
Path of dependencies leading to the vulnerable component.
libVersion
String
Version of the affected library or software package.
chainDepth
Int
Depth level of the affected library in the dependency chain.
exploitInTheWild
Boolean
Indicates whether the vulnerability is actively exploited in the wild.
exploitInTheWildLink
String
URL linking to reports or evidence of real-world exploitation.
description
String
Detailed description of the vulnerability and its potential impact.
dateDiscovered
String
Date when the vulnerability was first discovered or disclosed.
minorVerWithFix
String
The earliest minor version of the affected library that contains a fix.
majorVerWithFix
String
The earliest major version of the affected library that contains a fix.
exploitRequirement
String
Conditions or requirements necessary to exploit the vulnerability.
exploitCode
String
Indicator of whether public exploit code is available for this vulnerability.
originalSeverity
String
Severity of the issue as originally reported before any adjustments.
artifactInSbomLibs
object variables
artifactInSbomLibs
object variablesField
Type
Description
image
String
Name or identifier of the container image.
imageLink
String
URL linking to the container image in the registry.
imageCreatedAt
String
Timestamp indicating when the image was created.
sha
String
SHA hash of the container image for integrity verification.
os
String
Operating system used in the container image.
osVersion
String
Version of the operating system in the container image.
baseImage
String
Name of the base image used to build the container.
baseImageVersion
String
Version of the base image.
tag
String
Tag assigned to the image (e.g., latest
, v1.0
).
layer
String
Specific layer in the container image structure.
registryName
String
Name of the container image registry (e.g., Docker Hub, AWS ECR).
extraInfo
object variables
extraInfo
object variablesField
Type
Description
key
String
A unique identifier or name for a data entry.
value
String
Alternative representation of the associated data value.
resource
object variables
resource
object variablesField
Type
Description
id
String
A unique identifier for the entity.
type
String
A category or classification of the entity.
cweList
object variables
cweList
object variablesField
Type
Description
name
String
Name of cwe the entity, resource, or item.
description
String
Brief explanation or details about the cwe entity.
url
String
URL linking to additional information or an external cwe resource.
severityChangedReason
object variables
severityChangedReason
object variablesField
Type
Description
changeNumber
Int
Unique identifier for the change record.
evidenceLabel
String
Label or tag assigned to the change evidence.
reason
String
Explanation or justification for the change.
shortName
String
Abbreviated or concise name for the change.
changeCategory
String
Classification of the change (e.g., bug fix, feature update).
extraInfo
[ExtraInfo]
Additional details or metadata related to the change.
extraInfoContainer
String
Container holding supplementary information about the change.
oscarData
object variables
oscarData
object variablesField
Type
Description
name
String
Name of the oscar entity, resource, or item.
description
String
Brief explanation or details about the oscar entity.
url
String
URL linking to additional information or an external oscar resource.
id
String
Unique identifier for the oscar entity.
gptInfo
object variables
gptInfo
object variablesField
Type
Description
gptRespose
String
Response generated by chatGPT for this issue.
user
String
The info of the user who triggered to generate chatGPT response.
createdAt
Date
The timestamp that indicates when the chatGPT response was requested.