Merge pull request #691 from PaloAltoNetworks/24.6.2

Cloud Security Public API Release 24.6.2

openapi-specs/cspm/AlertsMicroServices.json

@@ -1653,6 +1653,22 @@
           }
         }
       },
+      "CountDetails": {
+        "type": "object",
+        "description": "Total Count of Alerts and Policies returned",
+        "properties": {
+          "totalAlerts": {
+            "type": "integer",
+            "format": "int64",
+            "default": 100
+          },
+          "totalPolicies": {
+            "type": "integer",
+            "format": "int64",
+            "default": 30
+          }
+        }
+      },
       "TimeRangeConfigModel": {
         "required": [
           "type"
@@ -2176,6 +2192,9 @@
               "$ref": "#/components/schemas/PolicyVO"
             }
           },
+          "countDetails": {
+            "$ref": "#/components/schemas/CountDetails"
+          },
           "nextPageToken": {
             "type": "string",
             "description": "token to fetch the next page"
@@ -2390,6 +2409,9 @@
           "groupBy": {
             "type": "string"
           },
+          "countDetails": {
+            "$ref": "#/components/schemas/CountDetails"
+          },
           "nextPageToken": {
             "type": "string"
           }

openapi-specs/cspm/SearchMicroService.json

@@ -162,7 +162,7 @@
           "Search"
         ],
         "summary": "Perform Config Search by Query",
-        "description": "Returns the results of an RQL config query. With config queries, you can retrieve resource information, identify misconfigurations, gain operational insights, and uncover policy and compliance violations.",
+        "description": "Returns the results of an RQL config query. With config queries, you can retrieve resource information, identify misconfigurations, gain operational insights, and uncover policy and compliance violations.\n\nWhen a query returns over 100 results, use the value of `nextPageToken` as the request parameter `pageToken` in the [Get The Next Search Page](/prisma-cloud/api/cspm/search-config-page/) endpoint to retrieve the next page of search results.",
         "operationId": "search-config-by-query",
         "requestBody": {
           "description": "Config rule search by query request parameters model",
@@ -317,7 +317,7 @@
           "Search"
         ],
         "summary": "Perform Config Search V2",
-        "description": "* Returns the results of an RQL config query.\n* With config queries, you can retrieve resource information, identify misconfigurations, gain operational insights, and uncover policy and compliance violations. \n* The request specification now includes the startTime value, indicating the start time for the search. Additionally, the end time is implicitly set to the current system time. \n* The response has been updated to the transition of the value associated with 'resourceType' to newer  and more descriptive name. (Ex: Instance to \"EC2 Instance\" for config query to list  all EC2 instances). Additionally, A new field 'resourceTypeId' is introduced, which serves as a unique identifier for the resourceType",
+        "description": "* Returns the results of an RQL config query.\n* With config queries, you can retrieve resource information, identify misconfigurations, gain operational insights, and uncover policy and compliance violations. \n* The request specification now includes the startTime value, indicating the start time for the search. Additionally, the end time is implicitly set to the current system time. \n* The response has been updated to the transition of the value associated with 'resourceType' to newer  and more descriptive name. (Ex: Instance to \"EC2 Instance\" for config query to list  all EC2 instances). Additionally, A new field 'resourceTypeId' is introduced, which serves as a unique identifier for the resourceType.\n\nWhen a query returns over 100 results, use the value of `nextPageToken` as the request parameter `pageToken` in the [Get The Next Search Page](/prisma-cloud/api/cspm/search-config-page/) endpoint to retrieve the next page of search results.",
         "operationId": "search-config-v2",
         "requestBody": {
           "description": "Config rule search by query request parameters model",
@@ -626,7 +626,7 @@
           "Search"
         ],
         "summary": "Get The Next Config Search Page",
-        "description": "Returns the next page of search results, using a token provided from the previous page. Used for when there are over 100 search results for a given RQL query.",
+        "description": "Returns the next page of search results, using a token provided from the previous page. Used for when there are over 100 search results for a given RQL query.\n\nAn initial config search request will return `nextPageToken` that can be used for the request paramater `pageToken`.\n",
         "operationId": "search-config-page",
         "requestBody": {
           "description": "Config rule page parameters model",

openapi-specs/cspm/UVEDashboardMicroService.json

@@ -7,14 +7,14 @@
   "tags": [
     {
       "name": "Vulnerabilities Dashboard",
-      "description": "Vulnerabilities Dashboard(UVE) gives you a holistic graphical view of all the vulnerabilities across your Code to Cloud environment. The APIs in this section helps you to get the details that are displayed in the Vulnerabilities Dashboard widget based on various filters. You can asses the vulnerabilities and create request to remediate or mitigate the vulnerability. For more information about the Vulnerabilities Dashboard, see [Vulnerabilities Dashboard](https://docs.prismacloud.io/en/enterprise-edition/content-collections/dashboards/dashboards-vulnerabilities)."
+      "description": "Vulnerabilities Dashboard(UVE) gives you a holistic graphical view of all the vulnerabilities across your Code to Cloud environment. The APIs in this section helps you to get the details that are displayed in the Vulnerabilities Dashboard widget based on various filters. You can asses the vulnerabilities and create request to remediate or mitigate the vulnerability. For more information about the Vulnerabilities Dashboard, see [Vulnerabilities Dashboard](https://docs.prismacloud.io/en/enterprise-edition/content-collections/dashboards/dashboards-vulnerabilities). \n>**Note:** You need specific access permission to use the endpoints in this category. For details on the required permissions, see the respective endpoint description. "
     }
   ],
   "paths": {
     "/uve/api/v1/dashboard/vulnerabilities/overview": {
       "get": {
         "summary": "Get Vulnerability Overview",
-        "description": "Returns a summary of the total vulnerabilities in your environment which is further divided into Vulnerabilities by Asset and Vulnerabilities that have already been remediated.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns a summary of the total vulnerabilities in your environment which is further divided into Vulnerabilities by Asset and Vulnerabilities that have already been remediated.\n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -107,7 +107,7 @@
           }
         },
         "x-public": "true",
-        "x-ga": "24.1.1-darwin",
+        "x-ga": "24.1.1",
         "security": [
           {
             "x-redlock-auth": []
@@ -118,7 +118,7 @@
     "/uve/api/v2/dashboard/vulnerabilities/overview": {
       "get": {
         "summary": "Get Vulnerability Overview V2",
-        "description": "Returns a summary of the total runtime vulnerabilities in your environment which is further divided into runtime Vulnerabilities by Asset and Vulnerabilities that have already been remediated.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns a summary of the total runtime vulnerabilities in your environment which is further divided into runtime Vulnerabilities by Asset and Vulnerabilities that have already been remediated.\n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -176,7 +176,7 @@
           }
         },
         "x-public": "true",
-        "x-ga": "24.2.1-darwin",
+        "x-ga": "24.2.1",
         "security": [
           {
             "x-redlock-auth": []
@@ -187,7 +187,7 @@
     "/uve/api/v1/dashboard/vulnerabilities/prioritised": {
       "get": {
         "summary": "Get Prioritized Vulnerabilities",
-        "description": "Returns the top-priority vulnerabilities which are aggregated based on the most urgent, exploitable, patchable, and vulnerable packages in use\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns the top-priority vulnerabilities which are aggregated based on the most urgent, exploitable, patchable, and vulnerable packages in use. \n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -280,7 +280,7 @@
           }
         },
         "x-public": "true",
-        "x-ga": "24.1.1-darwin",
+        "x-ga": "24.1.1",
         "security": [
           {
             "x-redlock-auth": []
@@ -291,7 +291,7 @@
     "/uve/api/v2/dashboard/vulnerabilities/prioritised": {
       "get": {
         "summary": "Get Prioritized Vulnerabilities V2",
-        "description": "Returns the top-priority unique vulnerabilities which are aggregated based on the most urgent, exploitable, patchable, and vulnerable packages in use along with the number of assets they occur in\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns the top-priority unique vulnerabilities which are aggregated based on the most urgent, exploitable, patchable, and vulnerable packages in use along with the number of assets they occur in. \n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -395,7 +395,7 @@
     "/uve/api/v3/dashboard/vulnerabilities/prioritised": {
       "get": {
         "summary": "Get Prioritized Vulnerabilities V3",
-        "description": "Returns the top-priority unique vulnerabilities which are aggregated based on the most urgent, exploitable, patchable, and vulnerable packages in use along with the number of assets they occur in.\n This endpoint also returns vulnerabilities based on internet exposure, in addition to those from [Get Prioritized Vulnerabilities V2](https://pan.dev/prisma-cloud/api/cspm/prioritised-vulnerability-v-2/). ",
+        "description": "Returns the top-priority unique vulnerabilities which are aggregated based on the most urgent, exploitable, patchable, and vulnerable packages in use along with the number of assets they occur in.\n This endpoint also returns vulnerabilities based on internet exposure, in addition to those from [Get Prioritized Vulnerabilities V2](https://pan.dev/prisma-cloud/api/cspm/prioritised-vulnerability-v-2/). \n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled. ",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -498,7 +498,7 @@
     "/uve/api/v1/dashboard/vulnerabilities/impact-stage": {
       "get": {
         "summary": "Get Vulnerability Impact by Stage",
-        "description": "Returns a summary of vulnerability across app stages of your application lifecycle.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns a summary of vulnerability across app stages of your application lifecycle.\n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -606,7 +606,7 @@
           }
         },
         "x-public": "true",
-        "x-ga": "24.1.1-darwin",
+        "x-ga": "24.1.1",
         "security": [
           {
             "x-redlock-auth": []
@@ -617,7 +617,7 @@
     "/uve/api/v1/dashboard/vulnerabilities/prioritised-vuln": {
       "get": {
         "summary": "Get Top Impacting Vulnerabilities",
-        "description": "Returns the CVEs of top critical vulnerabilities in your environment based on the risk score. Each CVE includes risk factors, severity, CVSS, risk factors, and assets impacted.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Returns the CVEs of top critical vulnerabilities in your environment based on the risk score. Each CVE includes risk factors, severity, CVSS, risk factors, and assets impacted.\n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -715,7 +715,7 @@
     "/uve/api/v2/dashboard/vulnerabilities/prioritised-vuln": {
       "get": {
         "summary": "Get Top Impacting Vulnerabilities V2",
-        "description": "Returns the CVEs of top critical vulnerabilities in your environment based on the risk score. Each CVE includes risk factors, epssScore, severity, CVSS, risk factors, and assets impacted.\n This endpoint returns the epss score details in addition to those from [Get Top Impacting Vulnerabilities](https://pan.dev/prisma-cloud/api/cspm/top-prioritised-vulnerability/).",
+        "description": "Returns the CVEs of top critical vulnerabilities in your environment based on the risk score. Each CVE includes risk factors, epssScore, severity, CVSS, risk factors, and assets impacted.\n This endpoint returns the epss score details in addition to those from [Get Top Impacting Vulnerabilities](https://pan.dev/prisma-cloud/api/cspm/top-prioritised-vulnerability/). \n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -813,7 +813,7 @@
     "/uve/api/v1/dashboard/vulnerabilities/cve-overview": {
       "get": {
         "summary": "Get CVE Overview",
-        "description": "Get the overview of the CVE with its CVSS score, the impacted stages, severity, risk factors, the package name, and the distros affected by this CVE.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Get the overview of the CVE with its CVSS score, the impacted stages, severity, risk factors, the package name, and the distributions affected by this CVE.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -973,7 +973,7 @@
     "/uve/api/v2/dashboard/vulnerabilities/burndown": {
       "get": {
         "summary": "Get Vulnerabilities Burndown",
-        "description": "Get the data for burndown chart.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Get the data for burndown chart.\n>**Note:** You need 'vulnerabilityDashboard' feature with 'View' permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that **Dashboard > Vulnerability** is enabled.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],
@@ -1081,7 +1081,7 @@
           }
         },
         "x-public": "true",
-        "x-ga": "24.2.1-darwin",
+        "x-ga": "24.2.1",
         "security": [
           {
             "x-redlock-auth": []
@@ -1092,7 +1092,7 @@
     "/uve/api/v1/dashboard/vulnerabilities/vuln-assets": {
       "post": {
         "summary": "Get Vulnerable Assets by CVE",
-        "description": "Get the list of all the assets affected by the CVE.\n:::info\nThis endpoint is available on the Prisma Cloud Darwin release only.\n:::\n",
+        "description": "Get the list of all the assets affected by the CVE.",
         "tags": [
           "Vulnerabilities Dashboard"
         ],