Palo Alto Networks Feeds API

{'$ref': 'desc/feeds/feeds.md'}

OpenAPI Specification

palo-alto-networks-feeds-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Palo Alto Networks Feeds API
  version: '1.0'
  description: 'Operations tagged Feeds across 4 of this provider''s published API definitions: 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: Feeds
  description: Feeds. 4 operations in this definition.
  x-description-source: desc/feeds/feeds.md
paths:
  /api/v34.03/feeds/custom/custom-vulnerabilities:
    get:
      description: 'Get Custom Vulnerability Feed. GET /api/v34.03/feeds/custom/custom-vulnerabilities on the Feeds API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vuln.CustomVulnerabilities'
          description: 'CustomVulnerabilities is a collection of custom vulnerabilities

            TBD: this storage usage is not best practice, should be migrate to a 1 document per vulnerability'
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: systemOperations
      operationId: get-feeds-custom-custom-vulnerabilities
      summary: Get Custom Vulnerability Feed
      x-description-source: desc/feeds/custom-vulnerabilities_get.md
    put:
      description: 'Update Custom Vulnerability Feed. PUT /api/v34.03/feeds/custom/custom-vulnerabilities on the Feeds API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vuln.CustomVulnerabilities'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: systemOperations
      operationId: put-feeds-custom-custom-vulnerabilities
      summary: Update Custom Vulnerability Feed
      x-description-source: desc/feeds/custom-vulnerabilities_put.md
  /api/v34.03/feeds/custom/malware:
    get:
      description: 'Get Custom Malware Feed. GET /api/v34.03/feeds/custom/malware on the Feeds API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared.CustomMalwareFeed'
          description: CustomMalwareFeed represent the custom malware
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: user
      operationId: get-feeds-custom-malware
      summary: Get Custom Malware Feed
      x-description-source: desc/feeds/malware_get.md
    put:
      description: 'Update Custom Malware Feed. PUT /api/v34.03/feeds/custom/malware on the Feeds API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shared.CustomMalwareFeed'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: systemOperations
      operationId: put-feeds-custom-malware
      summary: Update Custom Malware Feed
      x-description-source: desc/feeds/malware_put.md
  /api/v34.04/feeds/custom/custom-vulnerabilities:
    get:
      description: 'Get Custom Vulnerability Feed. GET /api/v34.04/feeds/custom/custom-vulnerabilities on the Feeds API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vuln.CustomVulnerabilities'
          description: 'CustomVulnerabilities is a collection of custom vulnerabilities

            TBD: this storage usage is not best practice, should be migrate to a 1 document per vulnerability'
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: systemOperations
      operationId: get-feeds-custom-custom-vulnerabilities
      summary: Get Custom Vulnerability Feed
      x-description-source: desc/feeds/custom-vulnerabilities_get.md
    put:
      description: 'Update Custom Vulnerability Feed. PUT /api/v34.04/feeds/custom/custom-vulnerabilities on the Feeds API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vuln.CustomVulnerabilities'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: systemOperations
      operationId: put-feeds-custom-custom-vulnerabilities
      summary: Update Custom Vulnerability Feed
      x-description-source: desc/feeds/custom-vulnerabilities_put.md
  /api/v34.04/feeds/custom/malware:
    get:
      description: 'Get Custom Malware Feed. GET /api/v34.04/feeds/custom/malware on the Feeds API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared.CustomMalwareFeed'
          description: CustomMalwareFeed represent the custom malware
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: user
      operationId: get-feeds-custom-malware
      summary: Get Custom Malware Feed
      x-description-source: desc/feeds/malware_get.md
    put:
      description: 'Update Custom Malware Feed. PUT /api/v34.04/feeds/custom/malware on the Feeds API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shared.CustomMalwareFeed'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Feeds
      x-prisma-cloud-target-env:
        permission: systemOperations
      operationId: put-feeds-custom-malware
      summary: Update Custom Malware Feed
      x-description-source: desc/feeds/malware_put.md
components:
  schemas:
    shared.Malware:
      description: Malware is an executable and its md5
      properties:
        allowed:
          description: 'Allowed indicates if this signature is on the allowed list.

            '
          type: boolean
        md5:
          description: '.

            '
          type: string
        modified:
          description: 'Modified is the time the malware was added to the DB.

            '
          format: int64
          type: integer
        name:
          description: '.

            '
          type: string
      type: object
    vuln.CustomVulnerabilities:
      description: 'CustomVulnerabilities is a collection of custom vulnerabilities

        TBD: this storage usage is not best practice, should be migrate to a 1 document per vulnerability'
      properties:
        _id:
          description: 'ID is the custom vulnerabilities feed ID.

            '
          type: string
        digest:
          description: 'Digest is the internal custom vulnerabilities feed digest.

            '
          type: string
        rules:
          description: 'Rules is the list of custom vulnerabilities rules.

            '
          items:
            $ref: '#/components/schemas/vuln.CustomVulnerability'
          type: array
      type: object
    shared.CustomMalwareFeed:
      description: CustomMalwareFeed represent the custom malware
      properties:
        _id:
          description: 'ID is the custom feed id.

            '
          type: string
        digest:
          description: 'Digest is an internal digest of the feed.

            '
          type: string
        feed:
          description: 'Feed is the list of custom malware signatures.

            '
          items:
            $ref: '#/components/schemas/shared.Malware'
          type: array
        modified:
          description: 'Modified is the last time the custom feed was modified.

            '
          format: date-time
          type: string
      type: object
    packages.Type:
      description: Type describes the package type
      enum:
      - - nodejs
        - gem
        - python
        - jar
        - package
        - windows
        - binary
        - nuget
        - go
        - app
        - unknown
      type: string
    vuln.CustomVulnerability:
      description: CustomVulnerability is a user customized vulnerability
      properties:
        _id:
          description: '.

            '
          type: string
        maxVersionInclusive:
          description: '.

            '
          type: string
        md5:
          description: '.

            '
          type: string
        minVersionInclusive:
          description: '.

            '
          type: string
        name:
          description: '.

            '
          type: string
        package:
          description: '.

            '
          type: string
        type:
          $ref: '#/components/schemas/packages.Type'
      type: object
x-refined-from:
- 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