uploadSbomFile

Upload a vendor-provided CycloneDX SBOM (OX format) for SCA analysis. Returns a requestId that can be used to track the upload status.

Examples

GraphQL

mutation UploadSbomFile($tool: String!, $file: Upload!) {
  uploadSbomFile(tool: $tool, file: $file) {
    requestId
    success
    message
  }
}

Variables

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

{
  "tool": "example",
  "file": "example"
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation UploadSbomFile($tool: String!, $file: Upload!) { uploadSbomFile(tool: $tool, file: $file) { requestId success message } }",
 "variables": {
    "tool": "example",
    "file": "example"
  }
}'

Node.js

const query = 'mutation UploadSbomFile($tool: String!, $file: Upload!) { uploadSbomFile(tool: $tool, file: $file) { requestId success message } }';

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: {
      tool: "example",
      file: "example"
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation UploadSbomFile($tool: String!, $file: Upload!) { uploadSbomFile(tool: $tool, file: $file) { requestId success message } }'

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": {
      "tool": "example",
      "file": "example"
    }
  }
)

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 uploadSbomFile mutation.

Argument	Description	Supported fields
tool String! required	App / SBOM name used to label the file
file Upload! required

Fields

Return type: UploadFileResponse!

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

Field	Description	Supported fields
requestId String!	Unique identifier for tracking the upload request
success Boolean!	Indicates whether the file upload was successful
message String	Human-readable error message when success is false (e.g. duplicate or oversized upload)