openapi: 3.2.0 info: title: Palo Alto Networks SBOM API version: '1.0' description: 'Operations tagged SBOM across 5 of this provider''s published API definitions: palo-alto-code-sbom-openapi.json, palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: PATH_TO_CONSOLE tags: - name: SBOM paths: /code/api/v1/bom/getBOMReport/{repoId}: get: description: Get a BOM Report operationId: getBOMReport parameters: - in: path name: repoId required: true schema: type: string - in: query name: format required: true schema: enum: - csv - cyclonedx type: string - in: query name: material required: true schema: enum: - oss - iac - images - all type: string responses: '200': content: application/json: examples: Example 1: value: bomResponse: - format: csv reportLink: Presigned BOM Report Link schema: $ref: '#/components/schemas/GeneratedBOMReportResponse' description: Get BOM Report '401': description: Unauthorized to get the BOM report '422': description: Request arguments validation error '500': description: Failed to get BOM Report security: - CustomAuthorizer: [] summary: Get BOM Report tags: - SBOM x-bc-required-permissions: - CCSDevelopmentPipelinesCodeReviews_READ - CCSDevelopmentPipelinesProjects_READ - CCSSupplyChain_READ x-codeSamples: - lang: Python + Requests source: 'import requests url = "http://undefinedundefined/code/api/v1/bom/getBOMReport/{repoId}" querystring = {"format":"SOME_STRING_VALUE","material":"SOME_STRING_VALUE"} headers = {"authorization": "REPLACE_KEY_VALUE"} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text)' - lang: Shell + Curl source: "curl --request GET \\\n --url 'http://undefinedundefined/code/api/v1/bom/getBOMReport/{repoId}?format=SOME_STRING_VALUE&material=SOME_STRING_VALUE' \\\n --header 'authorization: REPLACE_KEY_VALUE'" /code/api/v1/sbom/dependencies: post: description: Get all open-source packages found in your organization's version control system (VCS). operationId: sbomDependencies parameters: - description: Page number to retrieve in: query name: page required: true schema: format: double type: number - description: Amount of dependencies to retrieve in: query name: limit required: true schema: format: double type: number requestBody: content: application/json: schema: properties: filters: $ref: '#/components/schemas/Filters' sortBy: $ref: '#/components/schemas/SortingOptions' sortDesc: type: boolean required: - filters type: object required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/DependencyRow' type: array description: Got dependencies list '422': description: Request arguments validation error security: - CustomAuthorizer: [] summary: Get Dependencies tags: - SBOM x-codeSamples: - lang: Python + Requests source: "import requests\n\nurl = \"http://undefinedundefined/code/api/v1/sbom/dependencies\"\n\nquerystring = {\"page\":\"SOME_NUMBER_VALUE\",\"limit\":\"SOME_NUMBER_VALUE\"}\n\npayload = {\n \"filters\": {\n \"cve\": [\"string\"],\n \"license\": [\"string\"],\n \"name\": \"string\",\n \"origin\": [\"string\"],\n \"repositoryId\": [\"string\"],\n \"riskFactors\": {\n \"attackComplexity\": [\"string\"],\n \"attackVector\": [\"string\"],\n \"containerRunningAsRoot\": True,\n \"doS\": True,\n \"exploitExists\": True,\n \"exploitInTheWild\": True,\n \"exploitPOC\": True,\n \"hasFix\": True,\n \"listeningPorts\": True,\n \"noMandatorySecurityProfileApplied\": True,\n \"packageInUse\": True,\n \"reachableFromInternet\": True,\n \"recentVulnerability\": True,\n \"remoteExecution\": True,\n \"runningAsPrivilegedContainer\": True\n },\n \"severity\": [\"string\"],\n \"sourceId\": [\"string\"],\n \"workspaceIds\": [\"string\"]\n },\n \"sortBy\": \"name\",\n \"sortDesc\": True\n}\nheaders = {\n \"content-type\": \"application/json\",\n \"authorization\": \"REPLACE_KEY_VALUE\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers, params=querystring)\n\nprint(response.text)" - lang: Shell + Curl source: "curl --request POST \\\n --url 'http://undefinedundefined/code/api/v1/sbom/dependencies?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE' \\\n --header 'authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"filters\":{\"cve\":[\"string\"],\"license\":[\"string\"],\"name\":\"string\",\"origin\":[\"string\"],\"repositoryId\":[\"string\"],\"riskFactors\":{\"attackComplexity\":[\"string\"],\"attackVector\":[\"string\"],\"containerRunningAsRoot\":true,\"doS\":true,\"exploitExists\":true,\"exploitInTheWild\":true,\"exploitPOC\":true,\"hasFix\":true,\"listeningPorts\":true,\"noMandatorySecurityProfileApplied\":true,\"packageInUse\":true,\"reachableFromInternet\":true,\"recentVulnerability\":true,\"remoteExecution\":true,\"runningAsPrivilegedContainer\":true},\"severity\":[\"string\"],\"sourceId\":[\"string\"],\"workspaceIds\":[\"string\"]},\"sortBy\":\"name\",\"sortDesc\":true}'" /api/v34.03/sbom/download/cli-images: get: description: 'Download SBOM CI Images. GET /api/v34.03/sbom/download/cli-images on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-cli-images summary: Download SBOM CI Images x-description-source: desc/sbom/download_ci_images_get.md /api/v34.03/sbom/download/cli-serverless: get: description: 'Download SBOM CLI Serverless. GET /api/v34.03/sbom/download/cli-serverless on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-cli-serverless summary: Download SBOM CLI Serverless x-description-source: desc/sbom/download_cli_serverless_get.md /api/v34.03/sbom/download/hosts: get: description: 'Download SBOM Hosts. GET /api/v34.03/sbom/download/hosts on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-hosts summary: Download SBOM Hosts x-description-source: desc/sbom/download_hosts_get.md /api/v34.03/sbom/download/images: get: description: 'Download SBOM Images. GET /api/v34.03/sbom/download/images on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-images summary: Download SBOM Images x-description-source: desc/sbom/download_images_get.md /api/v34.03/sbom/download/registry: get: description: 'Download SBOM Registry. GET /api/v34.03/sbom/download/registry on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-registry summary: Download SBOM Registry x-description-source: desc/sbom/download_registry_get.md /api/v34.03/sbom/download/serverless: get: description: 'Download SBOM Serverless. GET /api/v34.03/sbom/download/serverless on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-serverless summary: Download SBOM Serverless x-description-source: desc/sbom/download_serverless_get.md /api/v34.03/sbom/download/vms: get: description: 'Download SBOM VMs. GET /api/v34.03/sbom/download/vms on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-vms summary: Download SBOM VMs x-description-source: desc/sbom/download_vms_get.md /api/v34.04/sbom/download/cli-images: get: description: 'Download SBOM CI Images. GET /api/v34.04/sbom/download/cli-images on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-cli-images summary: Download SBOM CI Images x-description-source: desc/sbom/download_ci_images_get.md /api/v34.04/sbom/download/cli-serverless: get: description: 'Download SBOM CLI Serverless. GET /api/v34.04/sbom/download/cli-serverless on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-cli-serverless summary: Download SBOM CLI Serverless x-description-source: desc/sbom/download_cli_serverless_get.md /api/v34.04/sbom/download/hosts: get: description: 'Download SBOM Hosts. GET /api/v34.04/sbom/download/hosts on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-hosts summary: Download SBOM Hosts x-description-source: desc/sbom/download_hosts_get.md /api/v34.04/sbom/download/images: get: description: 'Download SBOM Images. GET /api/v34.04/sbom/download/images on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-images summary: Download SBOM Images x-description-source: desc/sbom/download_images_get.md /api/v34.04/sbom/download/registry: get: description: 'Download SBOM Registry. GET /api/v34.04/sbom/download/registry on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-registry summary: Download SBOM Registry x-description-source: desc/sbom/download_registry_get.md /api/v34.04/sbom/download/serverless: get: description: 'Download SBOM Serverless. GET /api/v34.04/sbom/download/serverless on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-serverless summary: Download SBOM Serverless x-description-source: desc/sbom/download_serverless_get.md /api/v34.04/sbom/download/vms: get: description: 'Download SBOM VMs. GET /api/v34.04/sbom/download/vms on the Sbom API. Takes 6 query parameters. Documented responses: 200.' parameters: - description: 'Offsets the result to a specific report count. Offset starts from 0. ' in: query name: offset schema: type: integer - description: 'Limit is the amount to fix. ' in: query name: limit schema: type: integer - description: 'Sorts the result using a key. ' in: query name: sort schema: type: string - description: 'Sorts the result in reverse order. ' in: query name: reverse schema: type: boolean - description: 'ID is the ID of the entity of which the SBOM is generated for. ' in: query name: id schema: description: 'ID is the ID of the entity of which the SBOM is generated for. ' items: $ref: '#/components/schemas/string' type: array - description: 'sbomFormat is the file format of the SBOM. ' in: query name: sbomFormat schema: type: string responses: '200': description: OK default: description: '' tags: - SBOM x-prisma-cloud-target-env: permission: monitorImages operationId: get-sbom-download-vms summary: Download SBOM VMs x-description-source: desc/sbom/download_vms_get.md components: schemas: SortingOptions: enum: - name - version - license - srcCount - cves - maxSeverity type: string GeneratedBOMReport: additionalProperties: false properties: format: $ref: '#/components/schemas/BOMReportFormat' reportLink: type: string required: - reportLink - format type: object CveRow: additionalProperties: false properties: cvss: format: double type: number cvssVectorString: type: string description: type: string fixedVersion: type: string id: type: string link: type: string publishedDate: format: date-time type: string riskFactors: $ref: '#/components/schemas/ParsedRiskFactors' severity: type: string summary: type: string required: - id - severity - link - description - publishedDate - cvss - cvssVectorString - riskFactors type: object DependencyRow: additionalProperties: false properties: cves: items: $ref: '#/components/schemas/CveRow' type: array id: type: string license: type: string maxSeverity: format: double type: number name: type: string origin: type: string srcCount: format: double type: number version: type: string required: - id - name - version - origin - license - srcCount - maxSeverity - cves type: object ParsedRiskFactors: additionalProperties: false properties: ContainerRunningAsRoot: type: boolean ExploitExists: type: boolean ExploitInTheWild: type: boolean ListeningPorts: type: boolean NoMandatorySecurityProfileApplied: type: boolean PackageInUse: type: boolean ReachableFromInternet: type: boolean RunningAsPrivilegedContainer: type: boolean attackComplexity: type: string attackVector: type: string doS: type: boolean exploitPOC: type: boolean recentVulnerability: type: boolean remoteExecution: type: boolean type: object BOMReportFormat: enum: - csv - cyclonedx type: string RiskFactorsFilters: additionalProperties: false properties: attackComplexity: items: type: string type: array attackVector: items: type: string type: array containerRunningAsRoot: type: boolean doS: type: boolean exploitExists: type: boolean exploitInTheWild: type: boolean exploitPOC: type: boolean hasFix: type: boolean listeningPorts: type: boolean noMandatorySecurityProfileApplied: type: boolean packageInUse: type: boolean reachableFromInternet: type: boolean recentVulnerability: type: boolean remoteExecution: type: boolean runningAsPrivilegedContainer: type: boolean type: object GeneratedBOMReportResponse: additionalProperties: false properties: bomResponse: items: $ref: '#/components/schemas/GeneratedBOMReport' type: array required: - bomResponse type: object Filters: additionalProperties: false properties: cve: description: CVE-ID items: type: string type: array license: description: License identifier items: type: string type: array name: description: Package name type: string origin: description: Package language framwork/ecosystem items: type: string type: array repositoryId: description: VCS repository ID items: type: string type: array riskFactors: $ref: '#/components/schemas/RiskFactorsFilters' description: CVE risk factors severity: description: CVE severiry based on CVSS score items: type: string type: array sourceId: items: type: string type: array workspaceIds: description: VCS workspace/integration ID items: type: string type: array type: object string: type: string securitySchemes: CustomAuthorizer: in: header name: authorization type: apiKey x-amazon-apigateway-authorizer: authorizerResultTtlInSeconds: 0 authorizerUri: arn:aws:apigateway:{Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:{Region}:{AccountId}:function:bc-authorization-v2-authorizer-{UniqueTag}{Alias}/invocations identitySource: method.request.header.authorization type: request x-amazon-apigateway-authtype: custom x-refined-from: - palo-alto-code-sbom-openapi.json - palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json - palo-alto-compute-openapi-34-04-145-sh-openapi.json - palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json - palo-alto-cwpp-openapi-34-04-145-saas-openapi.json