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

Darwin 23.12.1 #543

Merged
merged 7 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,376 changes: 327 additions & 1,049 deletions openapi-specs/cspm/AssetExplorer.json

Large diffs are not rendered by default.

440 changes: 424 additions & 16 deletions openapi-specs/cspm/AssetInventory.json

Large diffs are not rendered by default.

1,348 changes: 1,348 additions & 0 deletions openapi-specs/cspm/AssetMicroService.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi-specs/cspm/CloudAccounts(AWS).json
Original file line number Diff line number Diff line change
Expand Up @@ -643,7 +643,7 @@
},
"/cas/v1/aws_account/{id}": {
"put": {
"description": "Update information related to aws cloud account.",
"description": "Update information related to aws cloud account.\n\n**Note:** To enable or disable a cloud account, use [Update Cloud Account Status](https://pan.dev/prisma-cloud/api/cspm/update-cloud-account-status/) API.",
"operationId": "update-aws-cloud-account",
"parameters": [
{
Expand Down
1,027 changes: 959 additions & 68 deletions openapi-specs/cspm/CompliancePosture.json

Large diffs are not rendered by default.

231 changes: 227 additions & 4 deletions openapi-specs/cspm/Reports.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,189 @@
}
]
},
"BaseReportGenerationConfigApiModel": {
"description": "Base Model for report generation configuration",
"properties": {
"cloudType": {
"description": "Cloud type",
"enum": [
"aws",
"azure",
"gcp",
"alibaba_cloud",
"oci"
],
"type": "string"
},
"complianceStandardDeleted": {
"description": "Compliance Standard Deleted",
"readOnly": true,
"type": "boolean"
},
"complianceStandardId": {
"description": "Compliance standard ID",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"counts": {
"allOf": [
{
"$ref": "#/components/schemas/ComplianceAggregateCount"
},
{
"description": "Model for compliance aggregate count",
"readOnly": true
}
]
},
"createdBy": {
"description": "User who created this report",
"readOnly": true,
"type": "string"
},
"createdOn": {
"description": "Report created on this timestamp",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"id": {
"description": "Report ID",
"readOnly": true,
"type": "string"
},
"lastModifiedBy": {
"description": "Last modified by",
"readOnly": true,
"type": "string"
},
"lastModifiedOn": {
"description": "Timestamp of last modification",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"lastScheduled": {
"description": "Timestamp of last generated report",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"locale": {
"description": "Locale of caller (e.g. en_us, jp). Default is en_us.",
"type": "string"
},
"name": {
"description": "Report name",
"type": "string"
},
"nextSchedule": {
"description": "Timestamp of next scheduled report",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"status": {
"description": "Report generation status",
"readOnly": true,
"type": "string"
},
"target": {
"allOf": [
{
"$ref": "#/components/schemas/BaseReportTargetModel"
},
{
"description": "Report definition"
}
]
},
"totalInstanceCount": {
"description": "Total number of reports for the report ID",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"type": {
"description": "Report type. Default is COMPLIANCE.",
"enum": [
"COMPLIANCE",
"RIS",
"INVENTORY_OVERVIEW",
"INVENTORY_DETAIL"
],
"type": "string"
}
},
"required": [
"cloudType",
"name"
],
"type": "object"
},
"BaseReportTargetModel": {
"description": "Model for base report target",
"properties": {
"accountGroups": {
"description": "List of cloud account groups",
"items": {
"type": "string"
},
"type": "array"
},
"accounts": {
"description": "List of cloud accounts",
"items": {
"type": "string"
},
"type": "array"
},
"complianceStandardIds": {
"description": "List of compliance Standard IDs",
"items": {
"type": "string"
},
"type": "array"
},
"compressionEnabled": {
"description": "Business unit detailed report compression enabled",
"type": "boolean"
},
"downloadNow": {
"description": "True = download now",
"type": "boolean"
},
"notificationTemplateId": {
"description": "Notification template id",
"readOnly": true,
"type": "string"
},
"notifyTo": {
"description": "List of email addresses to receive notification",
"items": {
"type": "string"
},
"type": "array"
},
"regions": {
"description": "List of regions",
"items": {
"type": "string"
},
"type": "array"
},
"schedule": {
"description": "Recurring report schedule in RRULE format",
"type": "string"
},
"scheduleEnabled": {
"description": "Report scheduling enabled",
"type": "boolean"
}
},
"type": "object"
},
"ComplianceAggregateCount": {
"description": "Model for compliance aggregate count",
"properties": {
Expand Down Expand Up @@ -476,8 +659,7 @@
},
"required": [
"cloudType",
"name",
"target"
"name"
],
"type": "object"
},
Expand Down Expand Up @@ -641,7 +823,7 @@
"operator": {
"description": "Operator",
"enum": [
"="
"tag:yaml.org,2002:value ="
],
"type": "string"
},
Expand Down Expand Up @@ -791,7 +973,7 @@
},
"post": {
"deprecated": true,
"description": "Creates a compliance report generation configuration based on the specified parameters. Report generation can be either one-time or recurring. \r\n\r\nYou can use the body parameters to specify whether the report is a one-time report \nor a recurring report. Specify a recurring report by providing a valid \n**target.schedule** body parameter.\n",
"description": "Creates a compliance report generation configuration based on the specified parameters. Report generation can be either one-time or recurring.\n:::info\n **Replacement  Endpoint: [Add Report Config V2](/prisma-cloud/api/cspm/save-report-v-2)**\n:::\n\n \r\n\r\nYou can use the body parameters to specify whether the report is a one-time report \nor a recurring report. Specify a recurring report by providing a valid \n**target.schedule** body parameter.\n",
"operationId": "save-report",
"requestBody": {
"content": {
Expand Down Expand Up @@ -830,6 +1012,47 @@
]
}
},
"/v2/report": {
"post": {
"description": "Creates a compliance report generation configuration based on the specified parameters. Report generation can be either one-time or recurring. \r\n\r\nYou can use the body parameters to specify whether the report is a one-time report \nor a recurring report. Specify a recurring report by providing a valid \n**target.schedule** body parameter. \n",
"operationId": "save-report-v2",
"requestBody": {
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/BaseReportGenerationConfigApiModel"
}
}
},
"description": "Model for report generation configuration",
"required": true
},
"responses": {
"200": {
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ReportGenerationConfigApiModel"
}
}
},
"description": "successful operation"
},
"400": {
"description": "missing_required_parameter / invalid_parameter_value"
}
},
"security": [
{
"x-redlock-auth": []
}
],
"summary": "Add Report Config V2",
"tags": [
"Reports"
]
}
},
"/report/type": {
"get": {
"description": "Returns a list of the compliance report types and identifies which report types are available for each cloud type.",
Expand Down
6 changes: 3 additions & 3 deletions openapi-specs/cspm/ResourceExplorer.json
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@
"/resource": {
"post": {
"deprecated": true,
"description": "\n:::info\n **Replacement  Endpoint: [Get Asset](/prisma-cloud/api/cspm/asset-2/#get-asset)**\n:::\n\n Returns detailed information for the resource with the given **rrn**. \r\n\r\nGenerally, the data field in the response object contains the raw JSON blob as is received from the \nsource cloud service provider API for the given resource.\n\nOnly the **rrn** parameter in the request body is used for this API. Ignore the **timelineItemId** and \n**findingType** fields for this API.\n\nAn example request body is:\n```\n{\n \"rrn\": \"rrn::storageBucket:us-east-1:123456789012:test-bucket\"\n}\n```\n",
"description": "\nReturns detailed information for the resource with the given **rrn**.\n:::info\n **Replacement  Endpoint: [Get Asset](/prisma-cloud/api/cspm/get-asset-details-by-id)**\n:::\n\r\n\r\nGenerally, the data field in the response object contains the raw JSON blob as is received from the \nsource cloud service provider API for the given resource.\n\nOnly the **rrn** parameter in the request body is used for this API. Ignore the **timelineItemId** and \n**findingType** fields for this API.\n\nAn example request body is:\n```\n{\n \"rrn\": \"rrn::storageBucket:us-east-1:123456789012:test-bucket\"\n}\n```\n",
"operationId": "get-resource",
"requestBody": {
"content": {
Expand Down Expand Up @@ -866,7 +866,7 @@
"/resource/timeline": {
"post": {
"deprecated": true,
"description": "\n:::info\n **Replacement  Endpoint: [Get Asset](/prisma-cloud/api/cspm/asset-2/#get-asset)**\n:::\n\n Returns a timeline of events and alerts for the given resource. \r\n\r\nOnly the **rrn** parameter in the request body is used for this API. Ignore the **timelineItemId** and \n**findingType** fields for this API.\n\nAn example request body is:\n```json\n{\n \"\"rrn\": \"rrn::instance:us-east-1:i-xxxxxxxxxx\"\n}\n```\n",
"description": "\n Returns a timeline of events and alerts for the given resource.\n:::info\n **Replacement  Endpoint: [Get Asset](/prisma-cloud/api/cspm/get-asset-details-by-id)**\n:::\n\n\r\n\r\nOnly the **rrn** parameter in the request body is used for this API. Ignore the **timelineItemId** and \n**findingType** fields for this API.\n\nAn example request body is:\n```json\n{\n \"\"rrn\": \"rrn::instance:us-east-1:i-xxxxxxxxxx\"\n}\n```\n",
"operationId": "get-timeline-for-resource",
"requestBody": {
"content": {
Expand Down Expand Up @@ -915,7 +915,7 @@
"/resource/raw": {
"post": {
"deprecated": true,
"description": "\n:::info\n **Replacement  Endpoint: [Get Asset](/prisma-cloud/api/cspm/asset-2/#get-asset)**\n:::\n\nReturns the raw metadata of the configuration of a resource at a given point in time. \r\n\r\nGenerally, the response object contains the raw JSON blob as is received from the \nsource cloud service provider API.\n\nOnly the **rrn** parameter in the request body is used for this API. Ignore the **findingType** \nfield for this API.\n\nYou can find the **timelineItemId** for your resource from the timeline results that \n[Get Resource Timeline](/prisma-cloud/api/cspm/get-timeline-for-resource)\nreturns.\n\nAn example request body is:\n```json\n{\n \"rrn\": \"rrn::instance:us-east-1:i-xxxxxxxxxx\",\n \"timelineItemId\": \"xxxxxxxxxxxxxx\"\n}\n```\n",
"description": "Returns the raw metadata of the configuration of a resource at a given point in time.\n:::info\n **Replacement  Endpoint: [Get Asset](/prisma-cloud/api/cspm/get-asset-details-by-id)**\n:::\n\n\r\n\r\nGenerally, the response object contains the raw JSON blob as is received from the \nsource cloud service provider API.\n\nOnly the **rrn** parameter in the request body is used for this API. Ignore the **findingType** \nfield for this API.\n\nYou can find the **timelineItemId** for your resource from the timeline results that \n[Get Resource Timeline](/prisma-cloud/api/cspm/get-timeline-for-resource)\nreturns.\n\nAn example request body is:\n```json\n{\n \"rrn\": \"rrn::instance:us-east-1:i-xxxxxxxxxx\",\n \"timelineItemId\": \"xxxxxxxxxxxxxx\"\n}\n```\n",
"operationId": "get-resource-raw",
"requestBody": {
"content": {
Expand Down
21 changes: 20 additions & 1 deletion openapi-specs/cspm/consolidated_spec/all_endpoints.csv
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@
"post","/filter/resource/scan_info/suggest","List Resource Info Filter Autocomplete Suggestions","get-resource-info-filter-options","Asset Explorer","Monolith"
"get","/resource/scan_info","Resource Scan Info - GET","get-resource-scan-info","Asset Explorer","Monolith"
"post","/resource/scan_info","Resource Scan Info - POST","post-resource-scan-info","Asset Explorer","Monolith"
"post","/uai/v1/asset","Get Asset","asset_2","Asset Explorer","Monolith"
"get","/v2/resource/scan_info","Resource Scan Info V2 - GET","get-resource-scan-info-v2","Asset Explorer","Monolith"
"post","/v2/resource/scan_info","Resource Scan Info V2 - POST","post-resource-scan-info-v2","Asset Explorer","Monolith"
"get","/filter/v2/inventory/suggest","List Inventory Filters V2","get-asset-inventory-v2-filters-and-options","Asset Inventory","Monolith"
"post","/filter/v2/inventory/suggest","List Inventory Dashboard Filter Autocomplete Suggestions V2","get-asset-inventory-v2-dashboard-filter-options","Asset Inventory","Monolith"
"get","/filter/inventory","List Saved Asset Inventory Filters","get-all-saved-asset-inventory-filters","Asset Inventory","Monolith"
Expand All @@ -79,6 +80,11 @@
"post","/v2/inventory","Asset Inventory View V2 - POST","post-method-for-asset-inventory-v2","Asset Inventory","Monolith"
"get","/v2/inventory/trend","Asset Inventory Trend View V2 - GET","asset-inventory-trend-v2","Asset Inventory","Monolith"
"post","/v2/inventory/trend","Asset Inventory Trend View V2 - POST","post-method-asset-inventory-trend-v2","Asset Inventory","Monolith"
"get","/v3/inventory","Asset Inventory View V3 - GET","asset-inventory-v3","Asset Inventory","Monolith"
"post","/v3/inventory","Asset Inventory View V3 - POST","post-method-for-asset-inventory-v3","Asset Inventory","Monolith"
"get","/v3/inventory/trend","Asset Inventory Trend View V3 - GET","asset-inventory-trend-v3","Asset Inventory","Monolith"
"post","/v3/inventory/trend","Asset Inventory Trend View V3 - POST","post-method-asset-inventory-trend-v3","Asset Inventory","Monolith"
"post","/uai/v1/asset","Get Asset","get-asset-details-by-id","Asset Explorer","AssetMicroService.json"
"get","/audit/redlock","Prisma Cloud Audit Logs","rl-audit-logs","Audit Logs","Monolith"
"post","/asm/api/v1/convert-cloud-account","Onboard Cloud Accounts","onboardCloudAccounts","Cloud Discovery and Exposure Management","CDEMMicroServices.json"
"post","/asm/api/v1/asset","Get Assets List","asset-inventory-for-l3","Cloud Discovery and Exposure Management","CDEMMicroServices.json"
Expand Down Expand Up @@ -170,6 +176,18 @@
"post","/compliance/posture/trend/{complianceId}/{requirementId}","Get Compliance Trend for Requirement ID - POST","post-compliance-posture-trend-for-requirement","Compliance Posture","Monolith"
"get","/filter/compliance/posture/suggest","Get Compliance Overview Filters and Options","get-compliance-posture-filters-and-options","Compliance Posture","Monolith"
"post","/filter/compliance/posture/suggest","List Compliance Overview Filter Autocomplete Suggestions","get-compliance-posture-filter-options","Compliance Posture","Monolith"
"get","/v2/compliance/posture","Get Compliance Statistics Breakdown V2 - GET","get-compliance-posture-v2","Compliance Posture","Monolith"
"post","/v2/compliance/posture","Get Compliance Statistics Breakdown V2 - POST","post-compliance-posture-v2","Compliance Posture","Monolith"
"get","/v2/compliance/posture/{complianceId}","Get Compliance Statistics for Standard ID V2 - GET","get-compliance-posture-for-standard-v2","Compliance Posture","Monolith"
"post","/v2/compliance/posture/{complianceId}","Get Compliance Statistics for Standard ID V2 - POST","post-compliance-posture-for-standard-v2","Compliance Posture","Monolith"
"get","/v2/compliance/posture/{complianceId}/{requirementId}","Get Compliance Statistics for Requirement ID V2 - GET","get-compliance-posture-for-requirement-v2","Compliance Posture","Monolith"
"post","/v2/compliance/posture/{complianceId}/{requirementId}","Get Compliance Statistics for Requirement ID V2 - POST","post-compliance-posture-for-requirement-v2","Compliance Posture","Monolith"
"get","/v2/compliance/posture/trend","Get Compliance Trend V2 - GET","get-compliance-posture-trend-v2","Compliance Posture","Monolith"
"post","/v2/compliance/posture/trend","Get Compliance Trend V2 - POST","post-compliance-posture-trend-v2","Compliance Posture","Monolith"
"get","/v2/compliance/posture/trend/{complianceId}","Get Compliance Trend for Standard ID V2 - GET","get-compliance-posture-trend-for-standard-v2","Compliance Posture","Monolith"
"post","/v2/compliance/posture/trend/{complianceId}","Get Compliance Trend for Standard ID V2 - POST","post-compliance-posture-trend-for-standard-v2","Compliance Posture","Monolith"
"get","/v2/compliance/posture/trend/{complianceId}/{requirementId}","Get Compliance Trend for Requirement ID V2 - GET","get-compliance-posture-trend-for-requirement-v2","Compliance Posture","Monolith"
"post","/v2/compliance/posture/trend/{complianceId}/{requirementId}","Get Compliance Trend for Requirement ID V2 - POST","post-compliance-posture-trend-for-requirement-v2","Compliance Posture","Monolith"
"get","/compliance","List Compliance Standards","get-all-standards","Compliance Standards","Monolith"
"post","/compliance","Add Compliance Standard","add-standard","Compliance Standards","Monolith"
"get","/compliance/{complianceId}","Get Compliance Standard by ID","get-standards-by-id","Compliance Standards","Monolith"
Expand Down Expand Up @@ -346,6 +364,7 @@
"post","/policy/rule/validate","Pre-validate Policy Rule","policy-rule-validate","Policy","Monolith"
"get","/report","List Report Configs","list-reports","Reports","Monolith"
"post","/report","Add Report Config","save-report","Reports","Monolith"
"post","/v2/report","Add Report Config V2","save-report-v2","Reports","Monolith"
"get","/report/type","Get Report Types","get-report-types","Reports","Monolith"
"get","/report/{id}","Get Report Config","get-specified-report","Reports","Monolith"
"put","/report/{id}","Update Report Config","update-report","Reports","Monolith"
Expand Down
Loading