Palo Alto Networks Waas API

openapi: 3.2.0
info:
  title: Palo Alto Networks Waas API
  version: '1.0'
  description: 'Operations tagged Waas 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: Waas
paths:
  /api/v34.03/waas/openapi-scans:
    post:
      description: 'Scan OpenAPI Specification File for WAAS Observations. POST /api/v34.03/waas/openapi-scans on the Waas API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waas.OpenAPIScan'
          description: OpenAPIScan represents the OpenAPI file scan
        default:
          description: ''
      tags:
      - Waas
      x-prisma-cloud-target-env:
        permission: monitorWAAS
      operationId: post-waas-openapi-scans
      summary: Scan OpenAPI Specification File for WAAS Observations
      x-description-source: desc/waas/openapi-scans_post.md
  /api/v34.04/waas/openapi-scans:
    post:
      description: 'Scan OpenAPI Specification File for WAAS Observations. POST /api/v34.04/waas/openapi-scans on the Waas API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waas.OpenAPIScan'
          description: OpenAPIScan represents the OpenAPI file scan
        default:
          description: ''
      tags:
      - Waas
      x-prisma-cloud-target-env:
        permission: monitorWAAS
      operationId: post-waas-openapi-scans
      summary: Scan OpenAPI Specification File for WAAS Observations
      x-description-source: desc/waas/openapi-scans_post.md
components:
  schemas:
    waas.OpenAPIScanIssuesSeverityDistribution:
      description: OpenAPIScanIssuesSeverityDistribution counts the number of issues per severity type
      properties:
        high:
          description: 'High is the high severity issues count.

            '
          type: integer
        info:
          description: 'Info is the info severity issues count.

            '
          type: integer
        low:
          description: 'Low is the low severity issues count.

            '
          type: integer
        medium:
          description: 'Medium is the medium severity issues count.

            '
          type: integer
      type: object
    waas.OpenAPIScanIssueSeverity:
      description: OpenAPIScanIssueSeverity is the OpenAPI spec file issue severity
      enum:
      - - INFO
        - LOW
        - MEDIUM
        - HIGH
      type: string
    byte:
      format: byte
      type: string
    waas.OpenAPISpecInfo:
      description: OpenAPISpecInfo is the OpenAPI spec info
      properties:
        content:
          description: 'Content is the OpenAPI spec content.

            '
          items:
            $ref: '#/components/schemas/byte'
          type: array
        contentType:
          description: 'ContentType is the OpenAPI spec file content type.

            '
          type: string
        fileName:
          description: 'FileName is the OpenAPI spec file name.

            '
          type: string
      type: object
    waas.OpenAPIScanIssueResult:
      description: 'OpenAPIScanIssueResult represents a specific issue result in the OpenAPI spec file

        Fields reflect the KICS rego queries result,

        Example: https://github.com/Checkmarx/kics/blob/master/assets/queries/openAPI/general/items_undefined/query.rego'
      properties:
        _id:
          description: 'ID is the issue result ID.

            '
          type: integer
        category:
          description: 'Category is the issue category.

            '
          type: string
        descriptionText:
          description: 'DescriptionText is the issue description.

            '
          type: string
        descriptionUrl:
          description: 'DescriptionURL is the issue information url.

            '
          type: string
        id:
          description: 'ID is the unique identifier of the issue metadata.

            '
          type: string
        override:
          additionalProperties:
            $ref: '#/components/schemas/waas.OpenAPIScanIssueMetadata'
          description: 'Override is the list of possible override fields by OpenAPI version.

            '
          type: object
        queryName:
          description: 'Name is the issue name.

            '
          type: string
        searchKey:
          description: 'SearchKey is the issue location in the spec file.

            '
          type: string
        severity:
          $ref: '#/components/schemas/waas.OpenAPIScanIssueSeverity'
        status:
          description: 'Status is the issue status.

            '
          type: string
      type: object
    waas.OpenAPIScan:
      description: OpenAPIScan represents the OpenAPI file scan
      properties:
        _id:
          description: 'ID is the scan identifier.

            '
          type: string
        issueResults:
          description: 'IssueResults are the scanned issues results.

            '
          items:
            $ref: '#/components/schemas/waas.OpenAPIScanIssueResult'
          type: array
        scanInfo:
          $ref: '#/components/schemas/waas.OpenAPIScanInfo'
        scanStartTime:
          description: 'ScanStartTime is the scan started.

            '
          format: date-time
          type: string
        severityDistribution:
          $ref: '#/components/schemas/waas.OpenAPIScanIssuesSeverityDistribution'
        specInfo:
          $ref: '#/components/schemas/waas.OpenAPISpecInfo'
      type: object
    waas.OpenAPIScanInfo:
      description: OpenAPIScanInfo is the OpenAPI scan info
      properties:
        appID:
          description: 'AppID is the WAAS app id the file was imported from.

            '
          type: string
        policyType:
          $ref: '#/components/schemas/common.PolicyType'
        ruleID:
          description: 'RuleID is the WAAS rule id the file was imported from.

            '
          type: string
        source:
          $ref: '#/components/schemas/waas.OpenAPIScanSource'
      type: object
    common.PolicyType:
      description: PolicyType represents the type of the policy
      enum:
      - - containerVulnerability
        - containerCompliance
        - ciImagesVulnerability
        - ciImagesCompliance
        - hostVulnerability
        - hostCompliance
        - vmVulnerability
        - vmCompliance
        - serverlessCompliance
        - ciServerlessCompliance
        - serverlessVulnerability
        - ciServerlessVulnerability
        - containerRuntime
        - appEmbeddedRuntime
        - containerAppFirewall
        - hostAppFirewall
        - outOfBandAppFirewall
        - agentlessAppFirewall
        - serverObserverAppFirewall
        - appEmbeddedAppFirewall
        - serverlessAppFirewall
        - networkFirewall
        - secrets
        - hostRuntime
        - serverlessRuntime
        - kubernetesAudit
        - trust
        - admission
        - codeRepoCompliance
        - ciCodeRepoCompliance
        - ciCodeRepoVulnerability
        - codeRepoVulnerability
      type: string
    waas.OpenAPIScanIssueMetadata:
      description: 'OpenAPIScanIssueMetadata represents the static metadata of an API definition issue

        Fields reflect the KICS metadata,

        Example: https://github.com/Checkmarx/kics/blob/master/assets/queries/openAPI/general/items_undefined/metadata.json'
      properties:
        category:
          description: 'Category is the issue category.

            '
          type: string
        descriptionText:
          description: 'DescriptionText is the issue description.

            '
          type: string
        descriptionUrl:
          description: 'DescriptionURL is the issue information url.

            '
          type: string
        id:
          description: 'ID is the unique identifier of the issue metadata.

            '
          type: string
        override:
          additionalProperties:
            $ref: '#/components/schemas/waas.OpenAPIScanIssueMetadata'
          description: 'Override is the list of possible override fields by OpenAPI version.

            '
          type: object
        queryName:
          description: 'Name is the issue name.

            '
          type: string
        severity:
          $ref: '#/components/schemas/waas.OpenAPIScanIssueSeverity'
      type: object
    waas.OpenAPIScanSource:
      description: OpenAPIScanSource is the scan trigger source
      enum:
      - - app
        - cli
        - manual
      type: string
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