openapi: 3.2.0 info: title: Palo Alto Networks Data Security Settings API version: '1.0' description: 'Operations tagged Data Security Settings across 3 of this provider''s published API definitions: palo-alto-cspm-consolidated-spec-cspm-spec-openapi.json, palo-alto-cspm-datasecurityonboardingmicroservice-openapi.json, palo-alto-cspm-datasecuritysettings-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: "Prisma Cloud Data Security enables you to discover and classify data stored \nin AWS S3 buckets and protect accidental exposure, misuse, or sharing of sensitive data. You can use\nthe data security settings APIs to manage data profiles, data patterns, and snippets.\n\n### Error Handling\n\nAs with other Prisma Cloud public API requests, Data Security Settings API requests return standard \nHTTP response codes. When more details are available, the error response includes the following:\n\nProperty | Type | Description \n-----------| ---- | ----------- \nmessage | string | Error message\nname | string | Exception name\ndetail | string | Exception details \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 Settings paths: /dlp/api/v1/resource-inventory/resources: get: description: Lists all AWS S3 bucket resources for your onboarded cloud account(s). The response indicates the amount of data eligible for sensitive data scans, malware scans, or both based on the supported file types and file size. operationId: get-resource-inventory responses: '200': content: '*/*': schema: $ref: '#/components/schemas/ResourceInventory' description: success '400': content: '*/*': schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: List Data Resources tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/config/v2/resource: put: description: Updates the data security scan settings configuration for the listed resources. operationId: update-resource-config requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/UpdateResourceConfig' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Update Data Scan Config tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/data-pattern: put: description: Lists all data patterns that satisfy the request filters. operationId: get-all-data-patterns requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/GetDataPatternFilterRequest' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DataPatternList' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: List Data Patterns tags: - Data Security Settings post: description: Creates a data pattern. operationId: add-data-pattern requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/CreateDataPatternRequest' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '500': description: internal_error security: - x-redlock-auth: [] summary: Add Data Pattern tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/data-pattern/clone: post: description: Clones a data pattern. operationId: clone-data-pattern requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DataPatternModel' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Clone Data Pattern tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/data-pattern/id/{patternId}: get: description: Returns the data pattern details for the specified ID. operationId: get-data-pattern-details parameters: - description: Data pattern ID in: path name: patternId required: true schema: type: string responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DataPatternDetails' description: success '500': description: internal_error security: - x-redlock-auth: [] summary: Get Data Pattern Details tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/data-pattern/name: get: description: Lists of all data pattern names with their supported confidence levels. operationId: get-data-pattern-name responses: '200': content: application/json; charset=UTF-8: schema: items: $ref: '#/components/schemas/DataPatternConfidenceLevel' type: array description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Get Data Pattern By Name tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/data-pattern/{patternId}: put: description: Updates a data pattern. operationId: update-data-pattern parameters: - description: Data pattern ID in: path name: patternId required: true schema: type: string requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/CreateDataPatternRequest' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Update Data Pattern tags: - Data Security Settings delete: description: Deletes a data pattern. operationId: delete-data-pattern parameters: - description: Data pattern ID in: path name: patternId required: true schema: type: string responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Delete Data Pattern tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/data-profile: get: description: Lists all data profiles for your tenant. operationId: get-data-profiles responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DSSDataProfiles' description: success '500': description: internal_error security: - x-redlock-auth: [] summary: List Data Profiles tags: - Data Security Settings post: description: Creates a data profile. operationId: add-data-profile requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DataProfile' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Add Data Profile tags: - Data Security Settings put: description: Enables or disables one or more data profiles. operationId: enable-disable-data-profiles requestBody: content: application/json; charset=UTF-8: schema: items: $ref: '#/components/schemas/DSSProfile' type: array responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '500': description: internal_error security: - x-redlock-auth: [] summary: Update Data Profile Status tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/data-profile/id/{profileId}: get: description: Returns data profile details for the specified profile ID. operationId: get-data-profile-details parameters: - description: Data profile ID in: path name: profileId required: true schema: type: string responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DataProfileDetails' description: success '500': description: internal_error security: - x-redlock-auth: [] summary: Get Data Profile Details tags: - Data Security Settings put: description: Updates a data profile. operationId: update-data-profile parameters: - description: Data profile ID in: path name: profileId required: true schema: type: string requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DataProfile' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Update Data Profile tags: - Data Security Settings post: description: Clones a data profile. operationId: clone-data-profile parameters: - description: Data profile ID in: path name: profileId required: true schema: type: string responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Clone Data Profile tags: - Data Security Settings delete: description: Deletes a data profile. operationId: delete-data-profile parameters: - description: Data profile ID in: path name: profileId required: true schema: type: string responses: '200': description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Delete Data Profile tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /dlp/api/v1/dss-api/snippets: get: description: Returns the snippet masking configuration for your tenant. operationId: get-snippets-config responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DssSnippetConfig' description: success '400': description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Get Snippet Configuration tags: - Data Security Settings post: description: Updates the snippet masking configuration for your tenant. operationId: update-snippets requestBody: content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DssSnippetConfig' responses: '200': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: success '400': content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/DLPAPIResponse' description: bad_request '500': description: internal_error security: - x-redlock-auth: [] summary: Update Snippet Configuration tags: - Data Security Settings servers: - url: https://api.prismacloud.io - url: https://api2.prismacloud.io - url: https://api3.prismacloud.io - url: https://api4.prismacloud.io /config/v3/dss-api/data-pattern/clone/dssTenantId/{dssTenantId}: post: summary: Clone Data Pattern description: Clones a data pattern. operationId: clone-dss-data-pattern parameters: - name: dssTenantId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JsonNode' responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/dss-api/data-pattern/dssTenantId/{dssTenantId}: get: summary: List Data Patterns description: Lists all data patterns. operationId: get-all-dss-data-patterns parameters: - name: dssTenantId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings post: summary: Add Data Pattern description: Creates a data pattern. operationId: add-dss-data-pattern parameters: - name: dssTenantId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JsonNode' responses: '200': description: success content: application/json: {} x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/dss-api/data-pattern/dssTenantId/{dssTenantId}/pattern-id/{patternId}: put: summary: Update Data Pattern description: Updates a data pattern. operationId: update-dss-data-pattern parameters: - name: dssTenantId in: path required: true schema: type: string - name: patternId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JsonNode' responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings delete: summary: Delete Data Pattern description: Deletes a data pattern. operationId: delete-dss-data-pattern parameters: - name: dssTenantId in: path required: true schema: type: string - name: patternId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/dss-api/data-pattern/name/dssTenantId/{dssTenantId}: get: summary: Get Data Pattern By Name description: Lists of all data pattern names with their supported confidence levels. operationId: get-dss-data-pattern-name parameters: - name: dssTenantId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/dss-api/data-profile/dssTenantId/{dssTenantId}: get: summary: List Data Profiles description: Lists all data profiles for your tenant. operationId: get-dss-data-profiles parameters: - name: dssTenantId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings put: summary: Update Data Profile Status description: Enables or disables one or more data profiles. operationId: enable-disable-dss-data-profiles parameters: - name: dssTenantId in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DSSProfileStatus' responses: '200': description: success content: application/json: {} x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings post: summary: Add Data Profile description: Creates a data profile. operationId: add-dss-data-profile parameters: - name: dssTenantId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DSSUserDataProfile' responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/dss-api/data-profile/dssTenantId/{dssTenantId}/id/{profileId}: get: summary: Get Data Profile Details description: Returns data profile details for the specified profile ID. operationId: get-dss-data-profile-details parameters: - name: dssTenantId in: path required: true schema: type: string - name: profileId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings put: summary: Update Data Profile description: Updates a data profile. operationId: update-dss-data-profile parameters: - name: dssTenantId in: path required: true schema: type: string - name: profileId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DSSUserDataProfile' responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings post: summary: Clone Data Profile description: Clones a data profile. operationId: clone-dss-data-profile parameters: - name: dssTenantId in: path required: true schema: type: string - name: profileId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings delete: summary: Delete Data Profile description: Deletes a data profile. operationId: delete-dss-data-profile parameters: - name: dssTenantId in: path required: true schema: type: string - name: profileId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/dss-api/snippets/dssTenantId/{dssTenantId}: get: summary: Get Snippet Configuration description: Returns the snippet masking configuration for your tenant. operationId: get-dss-snippets-config parameters: - name: dssTenantId in: path required: true schema: type: string responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings post: summary: Update Snippet Configuration description: Updates the snippet masking configuration for your tenant. operationId: update-dss-snippets-config parameters: - name: dssTenantId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SnippetsForUI' responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/estimated-credits: post: summary: Perform a Credit Estimation For The Specified Resources. description: Returns the total data volume size of all the requested resources and equivalent credits of data volume. operationId: getCreditEstimation requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditEstimationRequest' responses: '200': description: success content: application/json: {} '400': description: bad_request '403': description: unauthorized_access x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/resource/configure: put: summary: Update the Resources Scan Config description: Returns the resource scan configs for those that have been updated. operationId: configureResources requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourcesConfigRequest' responses: '200': description: success content: application/json: {} '400': description: bad_request '403': description: unauthorized_access '204': description: no_content x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/resources: get: summary: Fetch All Resources For The Given PCDS Tenant description: Returns details for all resources tied to the PCDS Tenant which is extracted from the access token. operationId: getResources responses: '200': description: success content: application/json: {} '400': description: bad_request '403': description: unauthorized_access x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/tenant/acl-script: get: summary: Generate an Azure Terraform Script for all Azure accounts under the specified PCDS Tenant. description: Returns an Azure Network ACL script for all accounts under the given PCDS Tenant ID that should fix all network connectivity issues. operationId: generateNetworkAclScriptByTenantID responses: '200': description: success content: application/octet-stream: {} x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/tenant/config: get: summary: Fetch The Tenant Config For The Given PCDS Tenant description: Returns tenant config details for the specified PCDS Tenant which is extracted from the access token. operationId: getTenantConfig parameters: - name: tenantId in: query schema: default: '' type: string responses: '200': description: success content: application/json: {} '400': description: bad_request x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 /config/v3/tenant/resource/sizing/configure: put: summary: Update the PCDS Tenant Resource Report Frequency description: Update the size reporting frequency at global for all tenant resources. operationId: updateReportFrequency requestBody: content: application/json: schema: $ref: '#/components/schemas/TenantResourcesReportFrequency' responses: '204': description: no_content '400': description: bad_request '403': description: unauthorized_access '401': description: unauthenticated_access x-public: 'true' security: - x-redlock-auth: [] tags: - Data Security Settings 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 components: schemas: DLPAPIResponse: description: Model for response from API properties: detail: description: Exception details type: string message: description: API response type: string name: description: Exception name type: string type: object DSSProfile: description: Model for Enable/Disable Data Profiles properties: id: description: Profile Id type: string profileStatus: description: Profile Status (active or disabled) type: string required: - id - profileStatus type: object StorageSize: properties: dssAndWildfireEligibleSize: description: Total size eligible for both Data Security scan and Wildfire format: int64 type: integer dssEligibleSize: description: Total size eligible for Data Security scan format: int64 type: integer isInventoryConfigured: description: Status of inventory configuration for current bucket. true = inventory configured type: boolean isScanComplete: description: Status of size estimation. true = scan complete type: boolean sensitiveEligiblePubliclyExposed: description: Total size for publicly exposed files eligible for DSS scan format: int64 type: integer size: description: Total size format: int64 type: integer wildfireEligibleSize: description: Total size eligible for Wildfire format: int64 type: integer type: object DataPatternRules: description: Data Pattern rules properties: confidencLevel: description: Confidence level type: string detectionTechnique: description: Detection technique type: string id: description: Pattern id type: string matchType: description: Match type type: string name: description: Pattern name type: string occurrenceCount: description: Occurrence count format: int32 type: integer occurrenceHigh: description: High Occurrence value format: int32 type: integer occurrenceLow: description: Low Occurrence value format: int32 type: integer occurrenceOperatorType: description: Occurrence type type: string supportedConfidenceLevels: description: List of supported confidence levels items: type: string type: array type: object CreateDataPatternRequest: description: Create/Update Pattern Model with limited input properties: delimiter: description: Delimiter type: string description: description: Pattern description type: string detectionTechnique: description: Detection technique type: string entity: description: Entity value type: string grammar: description: Grammar value type: string name: description: Pattern name type: string parentId: description: Parent ID type: string proximityKeywords: description: List of proximity keywords items: type: string type: array regexes: description: List of regexes items: $ref: '#/components/schemas/Regexes' type: array rootType: description: Root type type: string s3Path: description: S3 path type: string required: - delimiter - description - detectionTechnique - entity - grammar - name - parentId - rootType - s3Path 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 DataProfileDetails: description: DataProfile Model class properties: createdAt: description: Created at (unix time) type: string createdBy: description: Created by type: string dataPatternsRulesOne: allOf: - $ref: '#/components/schemas/DataPatternRulesOne' - description: Pattern rules description: description: Description type: string id: description: DataProfile id type: string name: description: DataProfile name type: string profileStatus: description: Profile status type: string profileType: description: DataProfile type type: string status: description: Status type: string tenantId: description: Tenant Id type: string types: description: Type type: string updatedAt: description: Updated at (unix time) type: string updatedBy: description: Updated by type: string 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 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 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 DataPatternConfidenceLevel: properties: name: description: Pattern name type: string supportedConfidenceLevels: description: List of confidence level items: type: string type: array type: object ResourceInventory: description: Data resource inventory model properties: resources: description: List of storage resources items: $ref: '#/components/schemas/StorageResource' type: array sizeReportingFrequency: description: Frequency of the s3 inventory configuration type: string totalRecords: description: Total resources format: int32 type: integer type: object DSSDataProfiles: description: Model for DLP Data Profiles properties: profiles: description: Data profiles items: $ref: '#/components/schemas/Profiles' type: array type: object Profiles: description: Model for Profiles properties: createdBy: description: Profile created by service type: string id: description: Profile id type: string name: description: Profile name type: string status: description: Profile status type: string type: description: Profile Type type: string updatedAt: description: Profile Updated time format: date-time type: string updatedBy: description: Profile updated by service type: string type: object UpdateResourceConfig: description: Model for Data Security resource scan config properties: enableScanning: description: Scan status. true = enable scans. false = disable scans type: boolean resources: description: List of storage resources items: $ref: '#/components/schemas/StorageResource' type: array scanOption: description: 'Scan option. Required if **enableScanning** is true. 0 = Exposure only, 2 = All ' enum: - 0 - 2 format: int32 type: integer scanType: description: Scan type. Required if **enableScanning** is true. 1 = forward and backward, 2 = forward enum: - 1 - 2 format: int32 type: integer required: - enableScanning - resources type: object DataProfile: description: Model class for Create and Update Data Profile properties: dataPatternsRule1: allOf: - $ref: '#/components/schemas/DataPatternRulesOne' - description: Profile patterns description: description: Profile description type: string id: description: Profile id (required during update format: int32 type: integer name: description: Profile name type: string profileStatus: description: Profile status type: string profileType: description: Profile Type (custom or system) type: string status: description: Status type: string types: description: Type (basic or advance) type: string required: - dataPatternsRule1 - name - profileStatus - profileType - status - types type: object DataPatternDetails: description: DataPatternDetails Model class properties: confidenceLevels: description: List of confidence level items: type: string type: array description: description: Pattern description type: string detectionTechnique: description: Pattern technique type: string id: description: Pattern id type: string name: description: Pattern name type: string proximityKeywords: description: Proximity keywords items: type: string type: array status: description: Pattern status type: string type: object ResourceConfigurationStatus: properties: code: description: Configuration Status Code format: int32 type: integer isKMSEncrypted: description: KMS Encryption Enabled type: boolean message: description: Status message items: type: string type: array type: object DataPatternList: description: DataPattern List with Filters for UI properties: lastUpdatedByFilter: description: Last Updated By Filter items: type: string type: array modeFilter: description: Mode Filter items: type: string type: array patterns: description: Pattern List items: $ref: '#/components/schemas/DataPatternModel' type: array type: object GetDataPatternFilterRequest: description: Get data pattern with filters on mode, updatedBy and time range properties: modeFilter: description: Mode filter list items: type: string type: array timeRange: allOf: - $ref: '#/components/schemas/TimeRangeConfigModel' - description: Time Range updatedByFilter: description: Updated By list items: type: string type: array type: object DataPatternRulesOne: description: DataProfile Rules properties: dataPatternRules: description: Pattern rules items: $ref: '#/components/schemas/DataPatternRules' type: array operatorType: description: Pattern operator type type: string type: object DataPatternModel: description: Data Pattern Model properties: confidenceLevels: description: List of confidence levels items: type: string type: array createdBy: description: Created By readOnly: true type: string delimiter: description: Delimiter to separate the regex and weight in UI type: string description: description: Pattern Description type: string detectionTechnique: description: Detection technique type: string entity: description: Entity type: string grammar: description: Grammar type: string id: description: Pattern id type: string isEditable: description: Is Editable readOnly: true type: boolean mode: description: Mode (custom/predefined) type: string name: description: Pattern Name type: string parentId: description: Parent ID type: string proximityKeywords: description: List of Proximity Keywords items: type: string type: array regexes: description: List of regexes items: $ref: '#/components/schemas/Regexes' type: array rootType: description: Root Type type: string s3Path: description: S3 Path to the grammar type: string status: description: Pattern status type: string updatedAt: description: Last updated At format: int64 readOnly: true type: integer updatedBy: description: Updated By readOnly: true type: string required: - confidenceLevels - description - detectionTechnique - id - name - proximityKeywords - regexes - status type: object DssSnippetConfig: description: Update Snippets Configuration properties: maskLevel: description: Mask Value enum: - no_mask - partial_mask - full_mask type: string snippetsEnabled: description: Enable/Disable snippets type: boolean required: - maskLevel - snippetsEnabled type: object Regexes: description: Model for regex properties: regex: description: Regex type: string weight: description: Weight format: int32 type: integer type: object StorageResource: description: Storage resource model properties: accountId: description: Account number type: string accountName: description: Account name readOnly: true type: string assetId: description: Unified Asset Id type: string cloudType: description: Cloud type readOnly: true type: string configurationStatus: allOf: - $ref: '#/components/schemas/ResourceConfigurationStatus' - description: Resource Configuration Status isConfigurable: description: Configurable status readOnly: true type: boolean lastEstimate: description: Size updated on format: int64 readOnly: true type: integer redlockAccountId: description: Prisma Cloud account ID format: int32 readOnly: true type: integer resourceName: description: Resource name type: string resourceRrn: description: Resource RRN to link to resource page readOnly: true type: string scanOption: description: Scan option exposure only, all format: int32 readOnly: true type: integer scanStatus: description: Scan status readOnly: true type: boolean scanType: description: Scan type format: int32 readOnly: true type: integer serviceName: description: Service name type: string storageSize: allOf: - $ref: '#/components/schemas/StorageSize' - description: Storage size readOnly: true required: - accountId - resourceName - serviceName 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 DSSUserDataProfile: type: object properties: id: type: string name: type: string type: type: string description: type: string profile_type: type: string status: type: string profile_status: type: string data_patterns_rule_1: $ref: '#/components/schemas/DataPatternRulesOne_2' created_by: type: string updated_by: type: string CreditEstimationRequest: type: object properties: scanOption: $ref: '#/components/schemas/ResourceScanOption' scanType: $ref: '#/components/schemas/ResourceScanType' resources: type: array items: $ref: '#/components/schemas/ResourceInfo' ResourceRetrievalFrequency: enum: - None - Daily - Weekly type: string ResourceInfo: type: object properties: resourceName: type: string resourceGroup: type: string accountId: type: string cloudType: $ref: '#/components/schemas/CloudType' DataPatternRulesOne_2: type: object properties: operator_type: type: string data_pattern_rules: type: array items: $ref: '#/components/schemas/DataPatternRules_2' SnippetsForUI: type: object properties: snippetsEnabled: type: boolean maskLevel: type: string CloudType: enum: - aws - gcp - azure type: string DSSProfileStatus: type: object properties: id: type: string profile_status: type: string updated_by: type: string ResourceScanType: enum: - not_selected - backwardForward - forward - na - systemResources type: string ResourceScanOption: enum: - exposure_only - sensitive_in_publicly_exposed - all - resource_level type: string TenantResourcesReportFrequency: type: object properties: sizeReportingFrequency: $ref: '#/components/schemas/ResourceRetrievalFrequency' DataPatternRules_2: type: object properties: name: type: string detection_technique: type: string match_type: type: string occurrence_operator_type: type: string occurrence_count: format: int32 type: integer occurrence_low: format: int32 type: integer occurrence_high: format: int32 type: integer confidence_level: type: string supported_confidence_levels: type: array items: type: string ResourcesConfigRequest: type: object properties: enableScanning: type: boolean scanType: enum: - not_selected - backwardForward - forward - na - systemResources type: - string - 'null' scanOption: enum: - exposure_only - sensitive_in_publicly_exposed - all - resource_level type: - string - 'null' resources: type: array items: $ref: '#/components/schemas/ResourceInfo' JsonNode: type: array 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-datasecurityonboardingmicroservice-openapi.json - palo-alto-cspm-datasecuritysettings-openapi.json