getApplications

Provides comprehensive details about all applications within an organization. It's an effective tool for assessing the security and operational characteristics of your applications. With this information, you can prioritize your actions based on business needs and security posture.

API provides you with the following capabilities:

• Fetching a list of applications.

• Returning data about application structure, security features, deployment environments, and more.

• Filtering and sorting applications based on various attributes and metrics.

Examples

GraphQL

query GetApplications($getApplicationsInput: GetApplicationsInput) {
  getApplications(getApplicationsInput: $getApplicationsInput) {
    applications {
      appId
      repoName
      appName
      branch
      branchesCount
      branchesToScan
      businessPriority
      codeChanges
      commitCount
      committersCount
      createdAt
      creator
      daysSinceLastCodeChange
      daysSinceRepoCreation
      deployedProd
      filesCount
      forksCount
      forkDate
      forkedSourceUrl
      hasDownloads
      hasPackageContainers
      headSha
      irrelevantReasons
      languages {
        language
        languagePercentage
      }
      lastCodeChange
      new
      overrideRelevance
      overridePriority
      originalBusinessPriority
      publicVisibility
      pullCount
      pushCount
      relevant
      risk
      scanId
      scannedAt
      secInfrastructure {
        label
        clientCoverage
        oxCoverage
        noCoverage
        notApplicable
      }
      securityPosture
      appType
      appSubtype
      size
      type
      updated
      userCount
      version
      violationCount
      watchersCount
      yamlsCount
      scoreHistory {
        appId
        appName
        score
        date
        new
        updated
        scanId
      }
      applicationFlows {
        artifacts {
          type
          name
          hashType
          system
          subType
          hash
          size
          date
          location {
            runBy
            foundBy
            foundIn
            link
          }
          linkName
          k8sType
          cluster
          region
        }
        cloudDeployments {
          type
          subType
          name
          hash
          hashType
          link
          location {
            runBy
            foundBy
            foundIn
            link
          }
          k8sType
          imageName
          date
          cluster
          region
        }
        cicdInfo {
          type
          system
          latestDate
          lastMonthJobCount
          location {
            runBy
            foundBy
            foundIn
            link
          }
        }
        orchestrators {
          type
          name
          hashType
          system
          hash
          size
          date
          location {
            runBy
            foundBy
            foundIn
            link
          }
        }
        kubernetes {
          type
          name
          hashType
          system
          hash
          subType
          size
          date
          location {
            runBy
            foundBy
            foundIn
            link
          }
        }
        repository {
          type
          system
          date
          location {
            runBy
            foundBy
            foundIn
            link
          }
        }
      }
      appOwners {
        name
        email
        roles
      }
      fakeApp
      link
      branchLink
      issues
      categories {
        categoryName
        categoryId
        catId
        severities {
          info
          low
          medium
          high
          critical
          appox
        }
        score
        severityScore
        total
        reason
      }
      toolsCoverage {
        toolName
        oxDelivered
        coverage
        type
        sources {
          match
          type
        }
      }
      pipeline {
        jobId
        jobTriggeredAt
        scanResult
        issuesCount
        jobTriggeredBy
        jobUrl
      }
      organization
      pipelineScans
      issuesBySeverity {
        info
        low
        medium
        high
        critical
        appox
      }
      pkgManagers
      sbomCount
      isMonoRepoChild
      monoRepoParent
      monorepoChildrenCount
      monorepoChildrenAppIds
      tags {
        tagId
        name
        email
        displayName
        tagType
        createdBy
        purpose
        deploymentModel
        tagCategory
      }
      dockerfiles {
        path
      }
      severityChangedReason {
        tagId
        changeNumber
        shouldBeSeverityFactor
        requiredHits
        reason
        shortName
        changeCategory
        changePlusReasonFacet
        extraInfo {
          key
          link
          snippet {
            detectionType
            fileName
            snippetLineNumber
            language
            text
          }
        }
      }
      apiInventoriesTotal
      artifactCount
      sbomArtifactCount
      saasBomCount
      sbomRepoCount
      credentialsId
      oxInPipeline
      oxInPipelineDescription
      primaryAppReason
      primaryApp
      matchedProjects {
        toolName
        matchedProjects {
          externalToolProject
          matchMethod
        }
      }
      toolName
      createdAtOx
      irrelevantDate
      prevFullScanDate
      prevFullScanId
      lastFullScanDate
      lastFullScanId
      isFullScan
      isPartiallyScanned
      appClassification
    }
    offset
    total
    totalFilteredApps
    showHistoricalTrend
    totalIrrelevantApps
    selectedPosition
    topOffset
  }
}

Variables

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

{
  "getApplicationsInput": {
    "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
    "dateRange": {
      "from": 1749000000000,
      "to": 1749900000000
    },
    "orderBy": {
      "field": "BusinessPriority",
      "direction": "ASC",
      "category": "example"
    },
    "limit": 100,
    "page": 1,
    "offset": 0,
    "applicationFilters": ["New"],
    "irrelevancyFilters": ["Archived"],
    "systemFilter": {
      "name": "cicd",
      "type": "example"
    },
    "owners": ["example"],
    "tagIds": ["example"],
    "search": "example",
    "filterSearch": [
      {
        "fieldName": "example",
        "value": ["example"]
      }
    ],
    "isAppIdOnly": true,
    "appId": "30966426",
    "topOffset": 42,
    "scrollDirection": "example",
    "openItems": ["digest"],
    "irrelevant": true,
    "ignoreLimit": true,
    "conditionalFilters": [
      {
        "condition": "AND",
        "fieldName": "digest",
        "values": ["example"],
        "greaterThan": 13.37,
        "lessThan": 13.37
      }
    ]
  }
}

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 GetApplications($getApplicationsInput: GetApplicationsInput) { getApplications(getApplicationsInput: $getApplicationsInput) { applications { appId repoName appName branch branchesCount branchesToScan businessPriority codeChanges commitCount committersCount createdAt creator daysSinceLastCodeChange daysSinceRepoCreation deployedProd filesCount forksCount forkDate forkedSourceUrl hasDownloads hasPackageContainers headSha irrelevantReasons languages { language languagePercentage } lastCodeChange new overrideRelevance overridePriority originalBusinessPriority publicVisibility pullCount pushCount relevant risk scanId scannedAt secInfrastructure { label clientCoverage oxCoverage noCoverage notApplicable } securityPosture appType appSubtype size type updated userCount version violationCount watchersCount yamlsCount scoreHistory { appId appName score date new updated scanId } applicationFlows { artifacts { type name hashType system subType hash size date location { runBy foundBy foundIn link } linkName k8sType cluster region } cloudDeployments { type subType name hash hashType link location { runBy foundBy foundIn link } k8sType imageName date cluster region } cicdInfo { type system latestDate lastMonthJobCount location { runBy foundBy foundIn link } } orchestrators { type name hashType system hash size date location { runBy foundBy foundIn link } } kubernetes { type name hashType system hash subType size date location { runBy foundBy foundIn link } } repository { type system date location { runBy foundBy foundIn link } } } appOwners { name email roles } fakeApp link branchLink issues categories { categoryName categoryId catId severities { info low medium high critical appox } score severityScore total reason } toolsCoverage { toolName oxDelivered coverage type sources { match type } } pipeline { jobId jobTriggeredAt scanResult issuesCount jobTriggeredBy jobUrl } organization pipelineScans issuesBySeverity { info low medium high critical appox } pkgManagers sbomCount isMonoRepoChild monoRepoParent monorepoChildrenCount monorepoChildrenAppIds tags { tagId name email displayName tagType createdBy purpose deploymentModel tagCategory } dockerfiles { path } severityChangedReason { tagId changeNumber shouldBeSeverityFactor requiredHits reason shortName changeCategory changePlusReasonFacet extraInfo { key link snippet { detectionType fileName snippetLineNumber language text } } } apiInventoriesTotal artifactCount sbomArtifactCount saasBomCount sbomRepoCount credentialsId oxInPipeline oxInPipelineDescription primaryAppReason primaryApp matchedProjects { toolName matchedProjects { externalToolProject matchMethod } } toolName createdAtOx irrelevantDate prevFullScanDate prevFullScanId lastFullScanDate lastFullScanId isFullScan isPartiallyScanned appClassification } offset total totalFilteredApps showHistoricalTrend totalIrrelevantApps selectedPosition topOffset } }",
 "variables": {
    "getApplicationsInput": {
      "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
      "dateRange": {
        "from": 1749000000000,
        "to": 1749900000000
      },
      "orderBy": {
        "field": "BusinessPriority",
        "direction": "ASC",
        "category": "example"
      },
      "limit": 100,
      "page": 1,
      "offset": 0,
      "applicationFilters": ["New"],
      "irrelevancyFilters": ["Archived"],
      "systemFilter": {
        "name": "cicd",
        "type": "example"
      },
      "owners": ["example"],
      "tagIds": ["example"],
      "search": "example",
      "filterSearch": [
        {
          "fieldName": "example",
          "value": ["example"]
        }
      ],
      "isAppIdOnly": true,
      "appId": "30966426",
      "topOffset": 42,
      "scrollDirection": "example",
      "openItems": ["digest"],
      "irrelevant": true,
      "ignoreLimit": true,
      "conditionalFilters": [
        {
          "condition": "AND",
          "fieldName": "digest",
          "values": ["example"],
          "greaterThan": 13.37,
          "lessThan": 13.37
        }
      ]
    }
  }
}'

Node.js

const query = 'query GetApplications($getApplicationsInput: GetApplicationsInput) { getApplications(getApplicationsInput: $getApplicationsInput) { applications { appId repoName appName branch branchesCount branchesToScan businessPriority codeChanges commitCount committersCount createdAt creator daysSinceLastCodeChange daysSinceRepoCreation deployedProd filesCount forksCount forkDate forkedSourceUrl hasDownloads hasPackageContainers headSha irrelevantReasons languages { language languagePercentage } lastCodeChange new overrideRelevance overridePriority originalBusinessPriority publicVisibility pullCount pushCount relevant risk scanId scannedAt secInfrastructure { label clientCoverage oxCoverage noCoverage notApplicable } securityPosture appType appSubtype size type updated userCount version violationCount watchersCount yamlsCount scoreHistory { appId appName score date new updated scanId } applicationFlows { artifacts { type name hashType system subType hash size date location { runBy foundBy foundIn link } linkName k8sType cluster region } cloudDeployments { type subType name hash hashType link location { runBy foundBy foundIn link } k8sType imageName date cluster region } cicdInfo { type system latestDate lastMonthJobCount location { runBy foundBy foundIn link } } orchestrators { type name hashType system hash size date location { runBy foundBy foundIn link } } kubernetes { type name hashType system hash subType size date location { runBy foundBy foundIn link } } repository { type system date location { runBy foundBy foundIn link } } } appOwners { name email roles } fakeApp link branchLink issues categories { categoryName categoryId catId severities { info low medium high critical appox } score severityScore total reason } toolsCoverage { toolName oxDelivered coverage type sources { match type } } pipeline { jobId jobTriggeredAt scanResult issuesCount jobTriggeredBy jobUrl } organization pipelineScans issuesBySeverity { info low medium high critical appox } pkgManagers sbomCount isMonoRepoChild monoRepoParent monorepoChildrenCount monorepoChildrenAppIds tags { tagId name email displayName tagType createdBy purpose deploymentModel tagCategory } dockerfiles { path } severityChangedReason { tagId changeNumber shouldBeSeverityFactor requiredHits reason shortName changeCategory changePlusReasonFacet extraInfo { key link snippet { detectionType fileName snippetLineNumber language text } } } apiInventoriesTotal artifactCount sbomArtifactCount saasBomCount sbomRepoCount credentialsId oxInPipeline oxInPipelineDescription primaryAppReason primaryApp matchedProjects { toolName matchedProjects { externalToolProject matchMethod } } toolName createdAtOx irrelevantDate prevFullScanDate prevFullScanId lastFullScanDate lastFullScanId isFullScan isPartiallyScanned appClassification } offset total totalFilteredApps showHistoricalTrend totalIrrelevantApps selectedPosition topOffset } }';

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: {
      getApplicationsInput: {
        scanId: "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        dateRange: {
          from: 1749000000000,
          to: 1749900000000
        },
        orderBy: {
          field: "BusinessPriority",
          direction: "ASC",
          category: "example"
        },
        limit: 100,
        page: 1,
        offset: 0,
        applicationFilters: ["New"],
        irrelevancyFilters: ["Archived"],
        systemFilter: {
          name: "cicd",
          type: "example"
        },
        owners: ["example"],
        tagIds: ["example"],
        search: "example",
        filterSearch: [
          {
            fieldName: "example",
            value: ["example"]
          }
        ],
        isAppIdOnly: true,
        appId: "30966426",
        topOffset: 42,
        scrollDirection: "example",
        openItems: ["digest"],
        irrelevant: true,
        ignoreLimit: true,
        conditionalFilters: [
          {
            condition: "AND",
            fieldName: "digest",
            values: ["example"],
            greaterThan: 13.37,
            lessThan: 13.37
          }
        ]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetApplications($getApplicationsInput: GetApplicationsInput) { getApplications(getApplicationsInput: $getApplicationsInput) { applications { appId repoName appName branch branchesCount branchesToScan businessPriority codeChanges commitCount committersCount createdAt creator daysSinceLastCodeChange daysSinceRepoCreation deployedProd filesCount forksCount forkDate forkedSourceUrl hasDownloads hasPackageContainers headSha irrelevantReasons languages { language languagePercentage } lastCodeChange new overrideRelevance overridePriority originalBusinessPriority publicVisibility pullCount pushCount relevant risk scanId scannedAt secInfrastructure { label clientCoverage oxCoverage noCoverage notApplicable } securityPosture appType appSubtype size type updated userCount version violationCount watchersCount yamlsCount scoreHistory { appId appName score date new updated scanId } applicationFlows { artifacts { type name hashType system subType hash size date location { runBy foundBy foundIn link } linkName k8sType cluster region } cloudDeployments { type subType name hash hashType link location { runBy foundBy foundIn link } k8sType imageName date cluster region } cicdInfo { type system latestDate lastMonthJobCount location { runBy foundBy foundIn link } } orchestrators { type name hashType system hash size date location { runBy foundBy foundIn link } } kubernetes { type name hashType system hash subType size date location { runBy foundBy foundIn link } } repository { type system date location { runBy foundBy foundIn link } } } appOwners { name email roles } fakeApp link branchLink issues categories { categoryName categoryId catId severities { info low medium high critical appox } score severityScore total reason } toolsCoverage { toolName oxDelivered coverage type sources { match type } } pipeline { jobId jobTriggeredAt scanResult issuesCount jobTriggeredBy jobUrl } organization pipelineScans issuesBySeverity { info low medium high critical appox } pkgManagers sbomCount isMonoRepoChild monoRepoParent monorepoChildrenCount monorepoChildrenAppIds tags { tagId name email displayName tagType createdBy purpose deploymentModel tagCategory } dockerfiles { path } severityChangedReason { tagId changeNumber shouldBeSeverityFactor requiredHits reason shortName changeCategory changePlusReasonFacet extraInfo { key link snippet { detectionType fileName snippetLineNumber language text } } } apiInventoriesTotal artifactCount sbomArtifactCount saasBomCount sbomRepoCount credentialsId oxInPipeline oxInPipelineDescription primaryAppReason primaryApp matchedProjects { toolName matchedProjects { externalToolProject matchMethod } } toolName createdAtOx irrelevantDate prevFullScanDate prevFullScanId lastFullScanDate lastFullScanId isFullScan isPartiallyScanned appClassification } offset total totalFilteredApps showHistoricalTrend totalIrrelevantApps selectedPosition topOffset } }'

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": {
      "getApplicationsInput": {
        "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        "dateRange": {
          "from": 1749000000000,
          "to": 1749900000000
        },
        "orderBy": {
          "field": "BusinessPriority",
          "direction": "ASC",
          "category": "example"
        },
        "limit": 100,
        "page": 1,
        "offset": 0,
        "applicationFilters": ["New"],
        "irrelevancyFilters": ["Archived"],
        "systemFilter": {
          "name": "cicd",
          "type": "example"
        },
        "owners": ["example"],
        "tagIds": ["example"],
        "search": "example",
        "filterSearch": [
          {
            "fieldName": "example",
            "value": ["example"]
          }
        ],
        "isAppIdOnly": true,
        "appId": "30966426",
        "topOffset": 42,
        "scrollDirection": "example",
        "openItems": ["digest"],
        "irrelevant": true,
        "ignoreLimit": true,
        "conditionalFilters": [
          {
            "condition": "AND",
            "fieldName": "digest",
            "values": ["example"],
            "greaterThan": 13.37,
            "lessThan": 13.37
          }
        ]
      }
    }
  }
)

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 getApplications query.

Argument	Description	Supported fields
getApplicationsInput GetApplicationsInput	Parameters for filtering, sorting, and paginating the applications list, including search criteria and display preferences	scanId String dateRange DateRange orderBy OrderAppsBy limit Int page Int offset Int applicationFilters [ApplicationsFilter] irrelevancyFilters [IrrelevancyFilter] systemFilter SystemFilter owners [String] tagIds [String] search String filterSearch [AutoCompleteSearch] isAppIdOnly Boolean appId String topOffset Int scrollDirection String openItems [FilterTypes] irrelevant Boolean ignoreLimit Boolean conditionalFilters [ConditionalFilters]

Fields

Return type: ApplicationsResponse

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

Field	Description	Supported fields
applications [Application]	List of applications matching the query criteria	id String ⚠️ appId String repoName String appName String branch String branchesCount Int branchesToScan [String] businessPriority Float codeChanges Int commitCount Int committersCount Int createdAt String creator String daysSinceLastCodeChange Int daysSinceRepoCreation Int deployedProd Boolean filesCount Int forksCount Int forkDate String forkedSourceUrl String hasDownloads Boolean hasPackageContainers Boolean headSha String irrelevantReasons [String] languages [Language] lastCodeChange String new Boolean overrideRelevance String overridePriority Int originalBusinessPriority Float publicVisibility Boolean pullCount Int pushCount Int relevant Boolean risk Float scanId String scannedAt Float secInfrastructure [ServerSecurityInfraItem] securityPosture Float appType String appSubtype String size Float tagsCount Int ⚠️ type String updated Boolean userCount Int version String violationCount Int watchersCount Int yamlsCount Int scoreHistory [ScoreHistoryItem] applicationFlows ApplicationFlow isSbomPresent Boolean ⚠️ appOwners [OwnerInfo] offset Int ⚠️ improvement Float ⚠️ fakeApp Boolean link String branchLink String issues Int categories [AppCategories] toolsCoverage [AppToolCoverage] pipeline Pipeline isPipelineConfigured String ⚠️ organization String repoRealName String ⚠️ repoId String ⚠️ pipelineScans Int issuesBySeverity Severities pkgManagers [String] sbomCount Int isMonoRepoChild Boolean monoRepoParent String monorepoChildrenCount Int monorepoChildrenAppIds [String] tags [AppTag] dockerfiles [Dockerfile] severityChangedReason [ApplicationSeverityChangedReason] apiInventoriesTotal Int artifactCount Int sbomArtifactCount Int saasBomCount Int sbomRepoCount Int credentialsId String oxInPipeline String oxInPipelineDescription String primaryAppReason String primaryApp Boolean matchedProjects [MatchedProjects] toolName String createdAtOx String irrelevantDate String prevFullScanDate String prevFullScanId String lastFullScanDate String lastFullScanId String isFullScan Boolean isPartiallyScanned Boolean appClassification [String]
offset Int	Number of records skipped in the result set
total Int	Total number of applications in the system
totalFilteredApps Int	Number of applications matching the current filter criteria
showHistoricalTrend Boolean	Indicates if historical trend data is available
totalIrrelevantApps Int	Total count of applications marked as irrelevant
selectedPosition Int	Current position in the paginated result set
topOffset Int	Offset value used for top-level pagination