> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-cloud-api/aspm-cicd-and-application-security/sbom-management.md). # SBOM Management APIs for managing SBOMs ## Get an SBOM for the specified repository > Get an SBOM (Software Bill of Materials) report for the specified repository.\ > \ > Only the following combinations are supported:\ > \ > \`format\`: \`cyclonedx\`\ > \`fileType\`: \`json\` or \`xml\`\ > \`version: \`1.4\` or \`1.5\` or \`1.6\`\ > \ > \`format\`: \`spdx\`\ > \`fileType\`: \`json\` or \`txt\`\ > \`version: \`2.3\`\ > \ > \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on. ```json {"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"SBOM management","description":"APIs for managing SBOMs"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/sbom/repository":{"get":{"tags":["SBOM management"],"summary":"Get an SBOM for the specified repository","description":"Get an SBOM (Software Bill of Materials) report for the specified repository.\n\nOnly the following combinations are supported:\n\n`format`: `cyclonedx`\n`fileType`: `json` or `xml`\n`version: `1.4` or `1.5` or `1.6`\n\n`format`: `spdx`\n`fileType`: `json` or `txt`\n`version: `2.3`\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.","operationId":"GetSBOMReport","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"in":"query","name":"repoId","required":true,"schema":{"type":"string"},"description":"Unique identifier of the repository for which to retrieve the SBOM report.\n\nTo retrieve this value, call `GET /public_api/appsec/v1/repositories` and use the `id` field from each repository object in the response."},{"in":"query","name":"branchName","required":false,"schema":{"type":"string"},"description":"Branch name for which you want to export the SBOM."},{"in":"query","name":"fileType","required":false,"schema":{"type":"string","enum":["json","xml","txt"],"default":"xml"},"description":"Define the file type you want to export. For cyclonedx, either json or xml. For spdx, either json or txt."},{"in":"query","name":"version","required":false,"schema":{"type":"string","enum":["1.4","1.5","1.6","2.3"],"default":"1.6"},"description":"For cyclonedx, version can be 1.4, 1.5, or 1.6. For spdx, version is 2.3."},{"schema":{"type":"string","enum":["cyclonedx","spdx"],"default":"cyclonedx"},"in":"query","name":"format","required":false,"description":"Define the SBOM format."}],"responses":{"200":{"description":"Ok. The SBOM report was generated successfully. The response body is the raw SBOM file content streamed directly (not base64-encoded).","content":{"application/json":{"schema":{"type":"string","format":"byte","description":"Raw CycloneDX or SPDX XML or JSON file content, streamed directly in the response body."}}}}}}}}} ``` ## Get all SBOMs for the specified organization > Returns SBOM reports for \*\*all repositories\*\* belonging to the specified organization, bundled as a single downloadable ZIP file.\ > \ > \ > \*\*Downloading the ZIP file\*\*\ > \ > A successful \`200\` response returns the SBOMs as a \`.zip\` archive. How you save the file depends on your HTTP client.\ > \ > \*\*Using cURL\*\*\ > \ > Add the \`-o\` flag to save the response body directly to a local file:\ > \ > \`\`\`bash\ > curl --location '/public\_api/appsec/v1/sbom/organization?orgName=\\&fileType=xml\&version=1.6\&format=cyclonedx' \\\ > \--header 'Authorization: \' \\\ > \--header 'x-xdr-auth-id: \' \\\ > -o ./sbom-org-export.zip\ > \`\`\`\ > \ > This saves the ZIP archive as \`sbom-org-export.zip\` in the current directory.\ > \ > \*\*Using Postman\*\*\ > \ > After sending the request, click \*\*Send > Download Response\*\* to save the \`.zip\` file to your local system.\ > \ > \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.\
````json {"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"SBOM management","description":"APIs for managing SBOMs"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/sbom/organization":{"get":{"tags":["SBOM management"],"summary":"Get all SBOMs for the specified organization","description":"Returns SBOM reports for **all repositories** belonging to the specified organization, bundled as a single downloadable ZIP file.\n\n\n**Downloading the ZIP file**\n\nA successful `200` response returns the SBOMs as a `.zip` archive. How you save the file depends on your HTTP client.\n\n**Using cURL**\n\nAdd the `-o` flag to save the response body directly to a local file:\n\n```bash\ncurl --location 'https://api-/public_api/appsec/v1/sbom/organization?orgName=&fileType=xml&version=1.6&format=cyclonedx' \\\n --header 'Authorization: ' \\\n --header 'x-xdr-auth-id: ' \\\n -o ./sbom-org-export.zip\n```\n\nThis saves the ZIP archive as `sbom-org-export.zip` in the current directory.\n\n**Using Postman**\n\nAfter sending the request, click **Send > Download Response** to save the `.zip` file to your local system.\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.\n\n","operationId":"GetOrgSBOMReport","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"name":"orgName","in":"query","required":true,"schema":{"type":"string"},"description":"Name of the organization (asset owner) for which to retrieve all SBOM reports. To retrieve this value, call `GET /public_api/appsec/v1/repositories` and use the `owner` field from each repository object in the response."},{"name":"fileType","in":"query","description":"Define the file type you want to export. For cyclonedx, either json or xml. For spdx, either json or txt.","required":false,"schema":{"type":"string","enum":["json","xml","txt"],"default":"xml"}},{"name":"version","in":"query","description":"For cyclonedx, version can be 1.4, 1.5, or 1.6. For spdx, version is 2.3.","required":false,"schema":{"type":"string","enum":["1.4","1.5","1.6","2.3"],"default":"1.6"}},{"schema":{"type":"string","enum":["cyclonedx","spdx"],"default":"cyclonedx"},"in":"query","name":"format","description":"Define the SBOM format.","required":false}],"responses":{"200":{"description":"Ok. The SBOM bundle was generated successfully. The response body is a ZIP file containing the SBOM reports for all repositories in the specified organization.","content":{"application/zip":{"schema":{"type":"string","format":"byte","description":"Binary ZIP archive containing one SBOM file per repository in the organization."}}}}}}}}} ```` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://cortex-docs.paloaltonetworks.com/cortex-cloud-api/aspm-cicd-and-application-security/sbom-management.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.