openapi: 3.2.0
info:
  title: Palo Alto Networks Data Security Dashboard API
  version: Latest
  contact: {}
  description: 'Operations tagged Data Security Dashboard across 2 of this provider''s published API definitions: palo-alto-cspm-consolidated-spec-cspm-spec-openapi.json, palo-alto-cspm-datasecuritydashboard-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.prismacloud.io
- url: https://api2.prismacloud.io
- url: https://api3.prismacloud.io
- url: https://api4.prismacloud.io
- url: https://api.anz.prismacloud.io
- url: https://api.eu.prismacloud.io
- url: https://api2.eu.prismacloud.io
- url: https://api.gov.prismacloud.io
- url: https://api.prismacloud.cn
- url: https://api.ca.prismacloud.io
- url: https://api.sg.prismacloud.io
- url: https://api.uk.prismacloud.io
- url: https://api.ind.prismacloud.io
- url: https://api.jp.prismacloud.io
- url: https://api.fr.prismacloud.io
tags:
- description: "The Data Security capabilities on Prisma Cloud enable you to discover and classify data stored \nin AWS S3 buckets and protect accidental exposure, misuse, or sharing of sensitive data. The \ndata dashboard provides visibility into your S3 storage. \n\nTo get started with data security, see \n[Prisma Cloud Data Security](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin/prisma-cloud-data-security.html).\n"
  name: Data Security Dashboard
paths:
  /dlp/api/v1/dashboard/alerts/aggregate:
    post:
      description: Returns counts of total objects, public objects, sensitive objects, and malware.
      operationId: get-dashboard-alerts
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/DLPDashboardFilterModel'
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                items:
                  $ref: '#/components/schemas/KeyAndCountPair'
                type: array
          description: success
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Get Dashboard Alerts
      tags:
      - Data Security Dashboard
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
  /dlp/api/v1/dashboard/objects/aggregate/by-classification:
    post:
      description: Returns the top public object counts by classification, where the data profiles determine classification. The limit that you specify determines the number of objects.
      operationId: get-dashboard-object-by-classification
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/DLPDashboardFilterModel'
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                items:
                  $ref: '#/components/schemas/KeyAndCountPair'
                type: array
          description: success
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Get Dashboard Objects By Classification
      tags:
      - Data Security Dashboard
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
  /dlp/api/v1/dashboard/objects/aggregate/by-owner:
    post:
      description: Returns object counts by exposure for each owner.
      operationId: get-dashboard-object-by-owner
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/DLPDashboardFilterModel'
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                items:
                  $ref: '#/components/schemas/DLPTopNObjectsByOwnerViewModel'
                type: array
          description: success
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Get Dashboard Objects By Owner
      tags:
      - Data Security Dashboard
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
  /dlp/api/v1/dashboard/objects/aggregate/by-region:
    post:
      description: Lists regions with object counts and identifies object counts by classification. Data profiles determine classification.
      operationId: get-dashboard-object-by-region
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/DLPDashboardFilterModel'
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                items:
                  $ref: '#/components/schemas/DLPTopNObjectsByRegionViewModel'
                type: array
          description: success
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Get Dashboard Objects By Region
      tags:
      - Data Security Dashboard
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
  /dlp/api/v1/dashboard/objects/aggregate/sensitive-exposed:
    post:
      description: Lists object counts filtered by exposure and sensitivity.
      operationId: get-dashboard-object-sensitive
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/DLPDashboardFilterModel'
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/DLPTotalSensitiveExposedObjectsViewModel'
          description: success
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Get Dashboard Sensitive Objects
      tags:
      - Data Security Dashboard
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
  /dlp/api/v1/dashboard/resources/aggregate/by-exposure:
    post:
      description: Returns the total number of resources as well as object counts filtered by exposure.
      operationId: get-dashboard-resource-by-exposure
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/DLPDashboardFilterModel'
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/DLPTotalResourceByExposureViewModel'
          description: success
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Get Dashboard Resource Aggregate By Exposure
      tags:
      - Data Security Dashboard
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
  /dlp/api/v1/dashboard/violations/aggregate:
    post:
      description: List violations for the dashboard.
      operationId: get-dashboard-violations
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/DLPDashboardFilterModel'
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                items:
                  $ref: '#/components/schemas/KeyAndCountPair'
                type: array
          description: success
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Get Dashboard Violations
      tags:
      - Data Security Dashboard
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
components:
  schemas:
    DLPTotalSensitiveExposedObjectsViewModel:
      description: Model for Sensitive Exposed Objects
      properties:
        objects:
          allOf:
          - $ref: '#/components/schemas/DLPObject'
          - description: DLP Object data
      type: object
    RelativeTimeRangeConfigModel:
      allOf:
      - $ref: '#/components/schemas/TimeRangeConfigModel'
      - description: Model for RelativeTimeRangeConfig
        properties:
          relativeTimeType:
            description: Direction in which to count time. Default = BACKWARD
            enum:
            - BACKWARD
            - FORWARD
            type: string
          type:
            example: relative
            type: string
          value:
            allOf:
            - $ref: '#/components/schemas/RelativeTimeDurationModel'
            - description: Time range object
        required:
        - value
        type: object
    ToNowTimeRangeConfigModel:
      allOf:
      - $ref: '#/components/schemas/TimeRangeConfigModel'
      - description: Model for ToNowTimeRangeConfig
        properties:
          value:
            description: Time range object
            enum:
            - MINUTE
            - HOUR
            - DAY
            - WEEK
            - MONTH
            - YEAR
            - EPOCH
            - LOGIN
            type: string
        type: object
    TimeRangeConfigModel:
      description: 'See the [Time Range Model](/prisma-cloud/api/cspm/api-time-range-model) for details.

        '
      discriminator:
        mapping:
          absolute: '#/components/schemas/AbsoluteTimeRangeConfigModel'
          relative: '#/components/schemas/RelativeTimeRangeConfigModel'
          to_now: '#/components/schemas/ToNowTimeRangeConfigModel'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/RelativeTimeRangeConfigModel'
      - $ref: '#/components/schemas/AbsoluteTimeRangeConfigModel'
      - $ref: '#/components/schemas/ToNowTimeRangeConfigModel'
      properties:
        type:
          description: Time type
          type: string
      required:
      - type
      type: object
    RelativeTimeDurationModel:
      description: Model for RelativeTimeDuration
      properties:
        amount:
          description: Number of time units
          format: int32
          type: integer
        unit:
          description: Time unit
          enum:
          - minute
          - hour
          - day
          - week
          - month
          - year
          type: string
      type: object
    AbsoluteTimeRangeConfigModel:
      allOf:
      - $ref: '#/components/schemas/TimeRangeConfigModel'
      - description: Model for AbsoluteTimeRangeConfig
        properties:
          type:
            example: absolute
            type: string
          value:
            allOf:
            - $ref: '#/components/schemas/TimeModel'
            - description: Time range object
        required:
        - value
        type: object
    DLPTotalResourceByExposureViewModel:
      description: Model for DLP Resource Exposure
      properties:
        resources:
          allOf:
          - $ref: '#/components/schemas/DLPResource'
          - description: Resource Data
      type: object
    DLPDashboardFilterModel:
      description: Model for DLP Dashboard filters
      properties:
        accountGroupIds:
          description: List of cloud account group ids
          items:
            type: string
          type: array
        accountGroupNames:
          description: List of AWS account group names
          items:
            type: string
          type: array
        accountIds:
          description: List of cloud account ids
          items:
            type: string
          type: array
        classifications:
          description: List of Data classifications
          items:
            type: string
          type: array
        limit:
          description: Limit the records returned
          format: int32
          type: integer
        timeRange:
          allOf:
          - $ref: '#/components/schemas/TimeRangeConfigModel'
          - description: Time Range
      required:
      - accountGroupIds
      - accountGroupNames
      - accountIds
      - classifications
      - limit
      - timeRange
      type: object
    DLPTopNObjectsByRegionViewModel:
      description: Model for DLP Object Region
      properties:
        classification:
          description: List of classification
          items:
            $ref: '#/components/schemas/KeyAndCountPair'
          type: array
        cloudType:
          description: Cloud Type
          type: string
        latitude:
          description: Latitude
          format: double
          type: number
        longitude:
          description: Longitude
          format: double
          type: number
        regionCode:
          description: Cloud region
          type: string
        regionName:
          description: Cloud region name
          type: string
      type: object
    DLPResource:
      description: Model for DLP Resource
      properties:
        exposure:
          description: List of exposures and count
          items:
            $ref: '#/components/schemas/KeyAndCountPair'
          type: array
        total:
          description: Total number of resources
          format: int32
          type: integer
      type: object
    TimeModel:
      description: Model for Time
      properties:
        endTime:
          description: End timestamp
          format: int64
          type: integer
        startTime:
          description: Start timestamp
          format: int64
          type: integer
      type: object
    KeyAndCountPair:
      description: Model for Exposure
      properties:
        count:
          description: Count
          format: int32
          type: integer
        name:
          description: Name
          type: string
      type: object
    DLPTopNObjectsByOwnerViewModel:
      description: Model for DLP Object Owner
      properties:
        exposure:
          allOf:
          - $ref: '#/components/schemas/CountByExposure'
          - description: Object Exposure
        name:
          description: Object Name
          type: string
      type: object
    CountByExposure:
      description: Model for DLP Exposure count
      properties:
        conditional:
          description: Conditional exposure count
          format: int64
          type: integer
        private:
          description: Private exposure count
          format: int64
          type: integer
        public:
          description: Public exposure count
          format: int64
          type: integer
      type: object
    DLPObject:
      description: Model for DLPObject
      properties:
        classification:
          description: Key and count data
          items:
            $ref: '#/components/schemas/KeyAndCountPair'
          type: array
        total:
          description: Total
          format: int32
          type: integer
      type: object
  securitySchemes:
    x-redlock-auth:
      description: The x-redlock-auth value is a JSON Web Token (JWT).
      in: header
      name: x-redlock-auth
      type: apiKey
x-refined-from:
- palo-alto-cspm-consolidated-spec-cspm-spec-openapi.json
- palo-alto-cspm-datasecuritydashboard-openapi.json