Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Data Security Posture Management(DSPM) API Documentation #737

Merged
merged 16 commits into from
Nov 1, 2024
Merged
6 changes: 6 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -865,6 +865,12 @@ const config = {
sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "tag" },
hideSendButton: true,
},
dspm: {
specPath: "openapi-specs/dspm",
outputDir: "products/prisma-cloud/api/dspm",
sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "tag" },
hideSendButton: true,
},
compute: {
specPath: "openapi-specs/compute",
outputDir: "products/compute/api",
Expand Down
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/alerts/alerts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Alert Introduction
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/alerts/alerts_id_status_patch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update the status for a specific DDR alert to reflect the status of the investigation in Prisma Cloud DSPM. This call updates the status of a specific alert (specified by the alert ID) to one of the available statuses.
2 changes: 2 additions & 0 deletions openapi-specs/dspm/desc/alerts/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
List and filter Detection and Response (DDR) alerts to triage and prioritize real-time data security threats.
This call returns a list of alerts with the necessary data to triage and assign for investigation
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/assets/assets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Asset Introduction
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/assets/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
List and filter data assets to build out your data asset inventory. This call returns a list of assets that match the provided filters, with basic asset details. To get full asset details, use ‘/v1/assets/id’
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/assets/id_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Get full asset details on a specific asset to enrich decision making with threat model info and asset statistics. This call returns a comprehensive list of asset details, as is available in the Prisma Cloud DSPM console.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
List and filter through fields found on a specific database or analytics asset to investigate data findings. This call returns a list of all fields matching the supplied filters, enabling deeper investigations into data findings.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
List and filter through files found on a specific storage asset to investigate data findings. This call returns a list of all files matching the supplied filters, enabling deeper investigations into data findings.
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/classification/classification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Classification Introduction
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
List through all data types discovered in the environment. This call returns a list of all data types found in the environment, allowing for input validation for investigation concerning a specific data type.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Data Type Intro
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/data-type-findings/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
List through all data types found in the environment and their respective finding aggregations to construct the organizational data map. This call returns a list of all data types and the aggregated locations of where they were found, similar to the Data Type Inventory in the DSPM console.
14 changes: 14 additions & 0 deletions openapi-specs/dspm/desc/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

### What is DSPM?
Data security posture management (DSPM) is a set of practices and technologies used to assess, monitor, and reduce the risk related to data residing in cloud data stores – focusing on multi-cloud environments. DSPM is data-centric: it looks at the context and content of the data being protected, placing the focus on sensitive records such as PII or medical records. Thus, it enables the client to prioritize their data assets’ most critical configurations, risks, and usage by:
* Fixing data misconfigurations to lower the overall risk of an attack
* Tightening access permissions to reduce data exposure
* Accelerating assessments of how data security posture is enforced, thus involving data owners in decisions directly related to data access

### What is Prisma Cloud DSPM?
Prisma Cloud DSPM is an agentless, multi-cloud, data security platform that discovers, classifies, protects, and governs sensitive data. As more and more organizations shift to manage their data assets in the cloud, this process requires implementation of better data monitoring capabilities. Prisma Cloud DSPM provides organizations with such capabilities, which ensure complete visibility and real-time control over potential security risks to their data.

### Prisma Cloud DSPM APIs
The Prisma Cloud DSPM API enables organizations to customize and automate DSPM workflows for their specific needs. The DSPM API empowers organizations to adapt and scale Prisma Cloud DSPM to their unique cybersecurity requirements from handling threat alerts and configuring security policies, to integration with specialized tools.

For more details on DSPM overall architecture and threat management details, refer to [DSPM Documentation](https://docs.prismacloud.io/en/enterprise-edition/content-collections/data-security-posture-management/data-security-posture-management).
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/labels/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
List through all labels discovered in the environment. This call returns a list of all labels found in the environment, allowing for input validation for investigation concerning a specific label.
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/labels/labels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Label Introduction
2 changes: 2 additions & 0 deletions openapi-specs/dspm/desc/risk-findings/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Lists and filters DSPM Risk Findings to analyze and prioritize data security risks in the environment.
This API returns a list of Risk Findings with detailed information to help prioritize each security Risk Finding. To retrieve detailed information on each Risk Finding, see the /v1/risk-findings/id/{id}[Get a Risk finding by Id] API.
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/risk-findings/id_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Get full risk findings details to enable deeper investigation into data security risks. This call returns a comprehensive list of risk findings details, as is available in the Prisma Cloud DSPM console.
1 change: 1 addition & 0 deletions openapi-specs/dspm/desc/risk-findings/risk-findings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Risk Findings Intro
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update the status for a specific risk finding to reflect the status of the investigation in Prisma Cloud DSPM. This call allows for updating the status of a specific risk finding (specified by the finding ID) to one of the available statuses.
Loading
Loading