From 50e15e4467a6b28b2dcfe91860ff3d9828d533ee Mon Sep 17 00:00:00 2001 From: Manan Vaghasiya Date: Tue, 12 Nov 2024 11:07:38 +0530 Subject: [PATCH] Update reporting spec (#2370) * update reporting spec * update api spec generation pipeline --- .../apps/dashboard/api-spec-original.json | 16751 ++++++++++++++++ .../apps/dashboard/api-spec.json | 569 +- .../apps/dashboard/package.json | 5 +- .../dashboard/scripts/transformAPISpec.js | 44 + .../api/generated/.openapi-generator/FILES | 1 - .../api/generated/apis/CloudResourcesApi.ts | 103 - .../src/api/generated/apis/CloudScannerApi.ts | 122 - .../src/api/generated/apis/ComplianceApi.ts | 122 - .../src/api/generated/apis/MalwareScanApi.ts | 122 - .../src/api/generated/apis/SecretScanApi.ts | 122 - .../api/generated/apis/VulnerabilityApi.ts | 122 - .../dashboard/src/api/generated/apis/index.ts | 1 - .../models/IngestersCloudResource.ts | 8 + .../generated/models/UtilsReportFilters.ts | 4 +- .../data-component/downloadSBOMAction.tsx | 2 +- .../data-component/downloadScanAction.tsx | 2 +- .../integrations/components/ReportsTable.tsx | 5 +- .../integrations/pages/CreateReport.tsx | 2 +- 18 files changed, 16830 insertions(+), 1277 deletions(-) create mode 100644 deepfence_frontend/apps/dashboard/api-spec-original.json create mode 100644 deepfence_frontend/apps/dashboard/scripts/transformAPISpec.js delete mode 100644 deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudResourcesApi.ts diff --git a/deepfence_frontend/apps/dashboard/api-spec-original.json b/deepfence_frontend/apps/dashboard/api-spec-original.json new file mode 100644 index 0000000000..c0ea397214 --- /dev/null +++ b/deepfence_frontend/apps/dashboard/api-spec-original.json @@ -0,0 +1,16751 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Deepfence ThreatMapper", + "description": "Deepfence Runtime API provides programmatic control over Deepfence microservice securing your container, kubernetes and cloud deployments. The API abstracts away underlying infrastructure details like cloud provider, \ncontainer distros, container orchestrator and type of deployment. This is one uniform API to manage and control security alerts, policies and response to alerts for microservices running anywhere i.e. managed pure greenfield container deployments or a mix of containers, VMs and serverless paradigms like AWS Fargate.", + "termsOfService": "/tos", + "contact": { + "name": "Deepfence Support", + "url": "https://deepfence.io", + "email": "community@deepfence.io" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0" + }, + "version": "v2.5.0" + }, + "externalDocs": { + "description": "Deepfence Community", + "url": "https://community.deepfence.io" + }, + "tags": [ + { "name": "Authentication" }, + { "name": "Common" }, + { "name": "Compliance" }, + { "name": "Topology" }, + { "name": "Secret Scan" }, + { "name": "Malware Scan" }, + { "name": "Vulnerability" } + ], + "paths": { + "/deepfence/agent-deployment/binary/download-url": { + "get": { + "tags": ["Settings"], + "summary": "Get agent binary download url", + "description": "Get agent binary download url", + "operationId": "getAgentBinaryDownloadURL", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelGetAgentBinaryDownloadURLResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/api-token": { + "get": { + "tags": ["User"], + "summary": "Get User's API Tokens", + "description": "Get logged in user's API Tokens", + "operationId": "getApiTokens", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelAPITokenResponse" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/api-token/reset": { + "post": { + "tags": ["User"], + "summary": "Reset User's API Tokens", + "description": "Reset user's API Tokens", + "operationId": "resetApiTokens", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelAPITokenResponse" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/auth/token": { + "post": { + "tags": ["Authentication"], + "summary": "Get Access Token for API Token", + "description": "Get access token for programmatic API access, by providing API Token", + "operationId": "authToken", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAPIAuthRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelResponseAccessToken" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/auth/token/refresh": { + "post": { + "tags": ["Authentication"], + "summary": "Refresh access token", + "description": "Reissue access token using refresh token", + "operationId": "authTokenRefresh", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelResponseAccessToken" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/cloud-node/account": { + "post": { + "tags": ["Cloud Nodes"], + "summary": "Register Cloud Node Account", + "description": "Register Cloud Account", + "operationId": "registerCloudNodeAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelCloudNodeAccountRegisterReq" + } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/cloud-node/account/delete": { + "patch": { + "tags": ["Cloud Nodes"], + "summary": "Delete Cloud Node Account", + "description": "Delete Cloud Node Account and related resources", + "operationId": "deleteCloudNodeAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelCloudAccountDeleteReq" } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/cloud-node/account/refresh": { + "post": { + "tags": ["Cloud Nodes"], + "summary": "Refresh Cloud Account", + "description": "Refresh the cloud resources in a Cloud Account", + "operationId": "refreshCloudNodeAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelCloudAccountRefreshReq" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/cloud-node/list/accounts": { + "post": { + "tags": ["Cloud Nodes"], + "summary": "List Cloud Node Accounts", + "description": "List Cloud Node Accounts registered with the console", + "operationId": "listCloudNodeAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelCloudNodeAccountsListReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelCloudNodeAccountsListResp" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/cloud-node/list/providers": { + "get": { + "tags": ["Cloud Nodes"], + "summary": "List Cloud Node Providers", + "description": "List Cloud Node Providers registered with the console", + "operationId": "listCloudProviders", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelCloudNodeProvidersListResp" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/cloud-account": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for cloud account fields", + "description": "Complete cloud account info", + "operationId": "completeCloudAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/cloud-compliance": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for cloud compliance fields", + "description": "Complete cloud compliance info", + "operationId": "completeCloudCompliance", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/cloud-resources": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for cloud resources fields", + "description": "Complete cloud resources info", + "operationId": "completeCloudResources", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/compliance": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for compliance fields", + "description": "Complete compliance info", + "operationId": "completeComplianceInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/container": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for Container fields", + "description": "Complete Container info", + "operationId": "completeContainerInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/host": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for host fields", + "description": "Complete host info", + "operationId": "completeHostInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/pod": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for Pod fields", + "description": "Complete Pod info", + "operationId": "completePodInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/process": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for process fields", + "description": "Complete process info", + "operationId": "completeProcessInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/complete/vulnerability": { + "post": { + "tags": ["Completion"], + "summary": "Get Completion for vulnerability fields", + "description": "Complete vulnerability info", + "operationId": "completeVulnerabilityInfo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionCompletionNodeFieldRes" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/agent": { + "post": { + "tags": ["Controls"], + "summary": "Fetch Agent Actions", + "description": "Fetch actions for a given agent", + "operationId": "getAgentControls", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAgentID" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ControlsAgentControls" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/agent-init": { + "post": { + "tags": ["Controls"], + "summary": "Fetch Agent Init Actions", + "description": "Fetch initial actions for a given agent after it started", + "operationId": "getAgentInitControls", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelInitAgentReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ControlsAgentControls" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/agent-plugins/disable": { + "post": { + "tags": ["Controls"], + "summary": "Schedule new agent plugin version disabling", + "description": "Schedule agent plugin disable", + "operationId": "disableAgentPlugin", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAgentPluginDisable" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/agent-plugins/enable": { + "post": { + "tags": ["Controls"], + "summary": "Schedule new agent plugin version enabling", + "description": "Schedule agent plugin enable", + "operationId": "enableAgentPlugin", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAgentPluginEnable" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/agent-upgrade": { + "post": { + "tags": ["Controls"], + "summary": "Schedule new agent version upgrade", + "description": "Schedule new agent version upgrade", + "operationId": "upgradeAgentVersion", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAgentUpgrade" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/cloud-node": { + "post": { + "tags": ["Controls"], + "summary": "Fetch Cloud Node Controls", + "description": "Fetch controls for a cloud node", + "operationId": "getCloudNodeControls", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelCloudNodeControlReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelCloudNodeControlResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/cloud-node/disable": { + "post": { + "tags": ["Controls"], + "summary": "Disable Cloud Node Controls", + "description": "Disable controls for a cloud node", + "operationId": "disableCloudNodeControls", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelCloudNodeEnableDisableReq" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/cloud-node/enable": { + "post": { + "tags": ["Controls"], + "summary": "Enable Cloud Node Controls", + "description": "Enable controls for a cloud node", + "operationId": "enableCloudNodeControls", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelCloudNodeEnableDisableReq" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/controls/kubernetes-cluster": { + "post": { + "tags": ["Controls"], + "summary": "Fetch Kubernetes Cluster Actions", + "description": "Fetch actions for a given Kubernetes Cluster", + "operationId": "getKubernetesClusterControls", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAgentID" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ControlsAgentControls" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/database/malware": { + "put": { + "tags": ["Settings"], + "summary": "Upload Malware Rules", + "description": "Upload malware rules for use in malware scans", + "operationId": "uploadMalwareRules", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/FormDataThreatintelDBUploadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/database/posture": { + "put": { + "tags": ["Settings"], + "summary": "Upload Posture Controls", + "description": "Upload posture controls for use in posture scans", + "operationId": "uploadPostureControls", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/FormDataThreatintelDBUploadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/database/secret": { + "put": { + "tags": ["Settings"], + "summary": "Upload Secrets Rules", + "description": "Upload secrets rules for use in secrets scans", + "operationId": "uploadSecretsRules", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/FormDataThreatintelDBUploadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/database/vulnerability": { + "put": { + "tags": ["Settings"], + "summary": "Upload Vulnerability Database", + "description": "Upload Vulnerability Database for use in vulnerability scans", + "operationId": "uploadVulnerabilityDatabase", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/FormDataThreatintelDBUploadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diagnosis/agent-logs": { + "post": { + "tags": ["Diagnosis"], + "summary": "Generate Agent Diagnostic Logs", + "description": "Generate Agent Diagnostic Logs", + "operationId": "generateAgentDiagnosticLogs", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DiagnosisGenerateAgentDiagnosticLogsRequest" + } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diagnosis/agent-logs/status/{node_id}": { + "put": { + "tags": ["Diagnosis"], + "summary": "Update Agent Diagnostic Logs Status", + "description": "Update agent diagnostic logs status", + "operationId": "updateAgentDiagnosticLogsStatus", + "parameters": [ + { + "name": "node_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/DiagnosisDiagnosticLogsStatus" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diagnosis/cloud-scanner-logs": { + "post": { + "tags": ["Diagnosis"], + "summary": "Generate Cloud Scanner Diagnostic Logs", + "description": "Generate Cloud Scanner Diagnostic Logs", + "operationId": "generateCloudScannerDiagnosticLogs", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DiagnosisGenerateCloudScannerDiagnosticLogsRequest" + } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diagnosis/console-logs": { + "post": { + "tags": ["Diagnosis"], + "summary": "Generate Console Diagnostic Logs", + "description": "Generate Console Diagnostic Logs", + "operationId": "generateConsoleDiagnosticLogs", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DiagnosisGenerateConsoleDiagnosticLogsRequest" + } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diagnosis/diagnostic-logs": { + "get": { + "tags": ["Diagnosis"], + "summary": "Get Diagnostic Logs", + "description": "Get diagnostic logs download url links", + "operationId": "getDiagnosticLogs", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DiagnosisGetDiagnosticLogsResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diagnosis/notification": { + "get": { + "tags": ["Diagnosis"], + "summary": "Get Diagnostic Notification", + "description": "Get Diagnostic Notification", + "operationId": "diagnosticNotification", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DiagnosisDiagnosticNotification" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diff-add/cloud-compliance": { + "post": { + "tags": ["Diff Add"], + "summary": "Get Cloud Compliance Diff", + "description": "Get Cloud Compliance Diff between two scans", + "operationId": "diffAddCloudCompliance", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanCompareReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelCloudCompliance" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diff-add/compliance": { + "post": { + "tags": ["Diff Add"], + "summary": "Get Compliance Diff", + "description": "Get Compliance Diff between two scans", + "operationId": "diffAddCompliance", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanCompareReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelCompliance" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diff-add/malware": { + "post": { + "tags": ["Diff Add"], + "summary": "Get Malware Diff", + "description": "Get Malware Diff between two scans", + "operationId": "diffAddMalware", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanCompareReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelMalware" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diff-add/secret": { + "post": { + "tags": ["Diff Add"], + "summary": "Get Secret Diff", + "description": "Get Secret Diff between two scans", + "operationId": "diffAddSecret", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanCompareReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelSecret" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/diff-add/vulnerability": { + "post": { + "tags": ["Diff Add"], + "summary": "Get Vulnerability Diff", + "description": "Get Vulnerability Diff between two scans", + "operationId": "diffAddVulnerability", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanCompareReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelVulnerability" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/end-user-license-agreement": { + "get": { + "tags": ["Common"], + "summary": "Get End User License Agreement", + "description": "Get End User License Agreement", + "operationId": "eula", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/filters/cloud-compliance": { + "post": { + "tags": ["Search"], + "summary": "Get Cloud Compliance Filters", + "description": "Get all applicable filter values for cloud compliance", + "operationId": "getCloudComplianceFilters", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelFiltersReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelFiltersResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/filters/compliance": { + "post": { + "tags": ["Search"], + "summary": "Get Compliance Filters", + "description": "Get all applicable filter values for compliance", + "operationId": "getComplianceFilters", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelFiltersReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelFiltersResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration": { + "get": { + "tags": ["Generative AI"], + "summary": "List Generative AI Integrations", + "description": "List all the added Generative AI Integrations", + "operationId": "listGenerativeAiIntegration", + "parameters": [ + { + "name": "integration_type", + "in": "query", + "schema": { "enum": ["openai", "amazon-bedrock"], "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModelGenerativeAiIntegrationListResponse" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/auto-add": { + "post": { + "tags": ["Generative AI"], + "summary": "Automatically add Generative AI Integration", + "description": "Automatically add Generative AI Integrations using IAM role", + "operationId": "autoAddGenerativeAiIntegration", + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/bedrock": { + "post": { + "tags": ["Generative AI"], + "summary": "Add AWS Bedrock Generative AI Integration", + "description": "Add a new AWS Bedrock Generative AI Integration", + "operationId": "addGenerativeAiIntegrationBedrock", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelAddGenerativeAiBedrockIntegration" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/openai": { + "post": { + "tags": ["Generative AI"], + "summary": "Add OpenAI Generative AI Integration", + "description": "Add a new OpenAI Generative AI Integration", + "operationId": "addGenerativeAiIntegrationOpenAI", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelAddGenerativeAiOpenAIIntegration" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/query/cloud-posture": { + "post": { + "tags": ["Generative AI"], + "summary": "Send Cloud Posture query to Generative AI Integration", + "description": "Send Cloud Posture query to Generative AI Integration", + "operationId": "generativeAiIntegrationCloudPostureQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelGenerativeAiIntegrationCloudPostureRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { "application/json": { "schema": { "type": "string" } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/query/kubernetes-posture": { + "post": { + "tags": ["Generative AI"], + "summary": "Send Kubernetes Posture query to Generative AI Integration", + "description": "Send Kubernetes Posture query to Generative AI Integration", + "operationId": "generativeAiIntegrationKubernetesPostureQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelGenerativeAiIntegrationKubernetesPostureRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { "application/json": { "schema": { "type": "string" } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/query/linux-posture": { + "post": { + "tags": ["Generative AI"], + "summary": "Send Linux Posture query to Generative AI Integration", + "description": "Send Linux Posture query to Generative AI Integration", + "operationId": "generativeAiIntegrationLinuxPostureQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelGenerativeAiIntegrationLinuxPostureRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { "application/json": { "schema": { "type": "string" } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/query/malware": { + "post": { + "tags": ["Generative AI"], + "summary": "Send Malware query to Generative AI Integration", + "description": "Send Malware query to Generative AI Integration", + "operationId": "generativeAiIntegrationMalwareQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelGenerativeAiIntegrationMalwareRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { "application/json": { "schema": { "type": "string" } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/query/secret": { + "post": { + "tags": ["Generative AI"], + "summary": "Send Secret query to Generative AI Integration", + "description": "Send Secret query to Generative AI Integration", + "operationId": "generativeAiIntegrationSecretQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelGenerativeAiIntegrationSecretRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { "application/json": { "schema": { "type": "string" } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/query/vulnerability": { + "post": { + "tags": ["Generative AI"], + "summary": "Send Vulnerability query to Generative AI Integration", + "description": "Send Vulnerability query to Generative AI Integration", + "operationId": "generativeAiIntegrationVulnerabilityQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelGenerativeAiIntegrationVulnerabilityRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { "application/json": { "schema": { "type": "string" } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/{integration_id}": { + "delete": { + "tags": ["Generative AI"], + "summary": "Delete Generative AI Integration", + "description": "Delete Generative AI integration", + "operationId": "deleteGenerativeAiIntegration", + "parameters": [ + { + "name": "integration_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/generative-ai-integration/{integration_id}/default": { + "put": { + "tags": ["Generative AI"], + "summary": "Set Default Generative AI Integration", + "description": "Set Default Generative AI integration", + "operationId": "setDefaultGenerativeAiIntegration", + "parameters": [ + { + "name": "integration_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/threat": { + "post": { + "tags": ["Threat"], + "summary": "Get Threat Graph", + "description": "Retrieve the full threat graph associated with the account", + "operationId": "getThreatGraph", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GraphThreatFilters" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GraphThreatGraph" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/threat/individual": { + "post": { + "tags": ["Threat"], + "summary": "Get Vulnerability Threat Graph", + "description": "Retrieve threat graph associated with vulnerabilities", + "operationId": "getIndividualThreatGraph", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GraphIndividualThreatGraphRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/GraphIndividualThreatGraph" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/topology/": { + "post": { + "tags": ["Topology"], + "summary": "Get Topology Graph", + "description": "Retrieve the full topology graph associated with the account", + "operationId": "getTopologyGraph", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GraphTopologyFilters" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGraphResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/topology/containers": { + "post": { + "tags": ["Topology"], + "summary": "Get Containers Topology Graph", + "description": "Retrieve the full topology graph associated with the account from Containers", + "operationId": "getContainersTopologyGraph", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GraphTopologyFilters" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGraphResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/topology/delta": { + "post": { + "tags": ["Topology"], + "summary": "Get Topology Delta", + "description": "Retrieve addition or deletion toplogy deltas", + "operationId": "getTopologyDelta", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelTopologyDeltaReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelTopologyDeltaResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/topology/hosts": { + "post": { + "tags": ["Topology"], + "summary": "Get Hosts Topology Graph", + "description": "Retrieve the full topology graph associated with the account from Hosts", + "operationId": "getHostsTopologyGraph", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GraphTopologyFilters" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGraphResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/topology/kubernetes": { + "post": { + "tags": ["Topology"], + "summary": "Get Kubernetes Topology Graph", + "description": "Retrieve the full topology graph associated with the account from Kubernetes", + "operationId": "getKubernetesTopologyGraph", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GraphTopologyFilters" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGraphResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/graph/topology/pods": { + "post": { + "tags": ["Topology"], + "summary": "Get Pods Topology Graph", + "description": "Retrieve the full topology graph associated with the account from Pods", + "operationId": "getPodsTopologyGraph", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GraphTopologyFilters" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGraphResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/cloud-compliance": { + "post": { + "tags": ["Cloud Scanner"], + "summary": "Ingest Cloud Compliances", + "description": "Ingest Cloud compliances found while scanning cloud provider", + "operationId": "ingestCloudCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersCloudCompliance" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/cloud-compliance-status": { + "post": { + "tags": ["Cloud Scanner"], + "summary": "Ingest Cloud Compliances scan status", + "description": "Ingest Cloud compliances found while scanning cloud provider", + "operationId": "ingestCloudComplianceScanStatus", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IngestersCloudComplianceScanStatus" + }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/cloud-resources": { + "post": { + "tags": ["Cloud Resources"], + "summary": "Ingest Cloud resources", + "description": "Ingest Clouds Resources found while scanning cloud provider", + "operationId": "ingestCloudResources", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersCloudResource" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Ingest Compliances", + "description": "Ingest compliance issues found while scanning the agent", + "operationId": "ingestCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersCompliance" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/compliance-scan-logs": { + "post": { + "tags": ["Compliance"], + "summary": "Ingest Compliance Scan Status", + "description": "Ingest compliance issues found while scanning the agent", + "operationId": "ingestComplianceScanStatus", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersComplianceScanStatus" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/malware": { + "post": { + "tags": ["Malware Scan"], + "summary": "Ingest Malware", + "description": "Ingest malware found while scanning the agent", + "operationId": "ingestMalware", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersMalware" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/malware-scan-logs": { + "post": { + "tags": ["Malware Scan"], + "summary": "Ingest Malware Scan Status", + "description": "Ingest malware scan status from the agent", + "operationId": "ingestMalwareScanStatus", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersMalwareScanStatus" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/report": { + "post": { + "tags": ["Topology"], + "summary": "Ingest Topology Data", + "description": "Ingest data reported by one Agent", + "operationId": "ingestAgentReport", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ReportRawReport" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ControlsAgentBeat" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/sbom": { + "post": { + "tags": ["Vulnerability"], + "summary": "Ingest SBOM from Scan", + "description": "Ingest SBOM from Scan", + "operationId": "ingestSbom", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/UtilsScanSbomRequest" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/secret-scan-logs": { + "post": { + "tags": ["Secret Scan"], + "summary": "Ingest Secrets Scan Status", + "description": "Ingest secrets scan status from the agent", + "operationId": "ingestSecretScanStatus", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersSecretScanStatus" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/secrets": { + "post": { + "tags": ["Secret Scan"], + "summary": "Ingest Secrets", + "description": "Ingest secrets found while scanning the agent", + "operationId": "ingestSecrets", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersSecret" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/sync-report": { + "post": { + "tags": ["Topology"], + "summary": "Ingest Topology Data", + "description": "Ingest data reported by one Agent", + "operationId": "ingestSyncAgentReport", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/IngestersReportIngestionData" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/vulnerabilities": { + "post": { + "tags": ["Vulnerability"], + "summary": "Ingest Vulnerabilities", + "description": "Ingest vulnerabilities found while scanning the agent host or containers", + "operationId": "ingestVulnerabilities", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/IngestersVulnerability" }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/ingest/vulnerabilities-scan-logs": { + "post": { + "tags": ["Vulnerability"], + "summary": "Ingest Vulnerabilities Scan Status", + "description": "Ingest vulnerabilities scan status from agent", + "operationId": "ingestVulnerabilitiesScanStatus", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IngestersVulnerabilityScanStatus" + }, + "nullable": true + } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/integration": { + "get": { + "tags": ["Integration"], + "summary": "List Integrations", + "description": "List all the added Integrations", + "operationId": "listIntegration", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelIntegrationListResp" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "post": { + "tags": ["Integration"], + "summary": "Add Integration", + "description": "Add a new supported integration", + "operationId": "addIntegration", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelIntegrationAddReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/integration/delete": { + "patch": { + "tags": ["Integration"], + "summary": "Delete Integrations", + "description": "Delete integrations", + "operationId": "deleteIntegrations", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelDeleteIntegrationReq" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/integration/{integration_id}": { + "delete": { + "tags": ["Integration"], + "summary": "Delete Single Integration", + "description": "Delete single integration", + "operationId": "deleteIntegration", + "parameters": [ + { + "name": "integration_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "put": { + "tags": ["Integration"], + "summary": "Update Integration", + "description": "Update integration", + "operationId": "updateIntegration", + "parameters": [ + { + "name": "integration_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelIntegrationUpdateReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/internal/console-api-token": { + "get": { + "tags": ["Internal"], + "summary": "Get api-token for console agent", + "description": "Get api-token for console agent", + "operationId": "getConsoleApiToken", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAPIAuthRequest" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/license": { + "delete": { + "tags": ["Settings"], + "summary": "Delete License", + "description": "Delete license from the console database", + "operationId": "deleteLicense", + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "get": { + "tags": ["Settings"], + "summary": "Get License Details", + "description": "Get license status and expiry", + "operationId": "getLicense", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelLicense" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "post": { + "tags": ["Settings"], + "summary": "Register License", + "description": "Register new license key to the console and activate", + "operationId": "registerLicense", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegisterLicenseRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegisterLicenseResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/license/generate": { + "post": { + "tags": ["Settings"], + "summary": "Generate License Key", + "description": "Generate a new ThreatMapper license key", + "operationId": "generateLicense", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGenerateLicenseRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGenerateLicenseResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/cloud-compliances": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Cloud Compliances data", + "description": "Retrieve all the data associated with cloud-compliances", + "operationId": "getCloudCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudCompliance" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/cloud-resources": { + "post": { + "tags": ["Lookup"], + "summary": "Get Cloud Resources", + "description": "Retrieve the cloud resources", + "operationId": "getCloudResources", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudResource" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/compliance-controls": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Cloud Compliances Control data", + "description": "Retrieve all the data associated with cloud compliance controls", + "operationId": "getComplianceControls", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudComplianceControl" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/compliances": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Compliances data", + "description": "Retrieve all the data associated with compliances", + "operationId": "getCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCompliance" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/containerimages": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Container Images data", + "description": "Retrieve all the data associated with images", + "operationId": "getContainerImages", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainerImage" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/containers": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Containers data", + "description": "Retrieve all the data associated with containers", + "operationId": "getContainers", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainer" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/hosts": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Hosts data", + "description": "Retrieve all the data associated with hosts", + "operationId": "getHosts", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelHost" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/kubernetesclusters": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve K8s data", + "description": "Retrieve all the data associated with k8s clusters", + "operationId": "getKubernetesClusters", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelKubernetesCluster" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/malware-rules": { + "post": { + "tags": ["Lookup"], + "summary": "Get Malware Rules", + "description": "Retrieve malware rule resources", + "operationId": "getMalwareRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelMalwareRule" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/malwares": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Malwares data", + "description": "Retrieve all the data associated with malwares", + "operationId": "getMalwares", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelMalware" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/pods": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Pods data", + "description": "Retrieve all the data associated with pods", + "operationId": "getPods", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelPod" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/processes": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Processes data", + "description": "Retrieve all the data associated with processes", + "operationId": "getProcesses", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelProcess" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/registryaccount": { + "post": { + "tags": ["Lookup"], + "summary": "Get Images in Registry", + "description": "List all the images present in the given registry", + "operationId": "getRegistryAccount", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelRegistryAccount" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/secret-rules": { + "post": { + "tags": ["Lookup"], + "summary": "Get Secret Rules", + "description": "Retrieve secret rule resources", + "operationId": "getSecretRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelSecretRule" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/secrets": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Secrets data", + "description": "Retrieve all the data associated with secrets", + "operationId": "getSecrets", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelSecret" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/vulnerabilities": { + "post": { + "tags": ["Lookup"], + "summary": "Retrieve Vulnerabilities data", + "description": "Retrieve all the data associated with vulnerabilities", + "operationId": "getVulnerabilities", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelVulnerability" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/lookup/vulnerability-rules": { + "post": { + "tags": ["Lookup"], + "summary": "Get Vulnerability Rules", + "description": "Retrieve vulnerability rule resources", + "operationId": "getVulnerabilityRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/LookupLookupFilter" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelVulnerabilityRule" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount": { + "get": { + "tags": ["Registry"], + "summary": "List Registries", + "description": "List all the added Registries", + "operationId": "listRegistry", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelRegistryListResp" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "post": { + "tags": ["Registry"], + "summary": "Add Registry", + "description": "Add a new supported registry", + "operationId": "addRegistry", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryAddReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/count/images": { + "post": { + "tags": ["Registry"], + "summary": "Count Registry Images", + "description": "count of images from a given registry", + "operationId": "CountImages", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryImagesReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/count/stubs": { + "post": { + "tags": ["Registry"], + "summary": "Count Image Stubs", + "description": "count of image tags for a given image and registry", + "operationId": "CountImageStubs", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryImageStubsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/delete": { + "patch": { + "tags": ["Registry"], + "summary": "Batch Delete Registry", + "description": "Batch Delete registry", + "operationId": "deleteRegistryBulk", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelDeleteRegistryBulkReq" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/gcr": { + "post": { + "tags": ["Registry"], + "summary": "Add Google Container Registry", + "description": "Add a Google Container registry", + "operationId": "addRegistryGCR", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { "$ref": "#/components/schemas/FormDataModelRegistryGCRAddReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/images": { + "post": { + "tags": ["Registry"], + "summary": "List Registry Images", + "description": "list images from a given registry", + "operationId": "listImages", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryImagesReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainerImage" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/stubs": { + "post": { + "tags": ["Registry"], + "summary": "List Image Stubs", + "description": "list image tags for a given image and registry", + "operationId": "listImageStubs", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryImageStubsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelImageStub" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/summary": { + "get": { + "tags": ["Registry"], + "summary": "Get All Registries Summary By Type", + "description": "get summary of all registries scans, images and tags by registry type", + "operationId": "getSummaryAll", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistrySummaryAllResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/{registry_id}": { + "delete": { + "tags": ["Registry"], + "summary": "Delete Registry", + "description": "Delete registry", + "operationId": "deleteRegistry", + "parameters": [ + { + "name": "registry_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "put": { + "tags": ["Registry"], + "summary": "Update Registry", + "description": "Update registry", + "operationId": "updateRegistry", + "parameters": [ + { + "name": "registry_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegistryUpdateReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/{registry_id}/summary": { + "get": { + "tags": ["Registry"], + "summary": "Get Registry Summary", + "description": "get summary of registry scans, images and tags", + "operationId": "getRegistrySummary", + "parameters": [ + { + "name": "registry_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelSummary" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/{registry_id}/sync": { + "post": { + "tags": ["Registry"], + "summary": "Sync Registry", + "description": "synchronize registry images", + "operationId": "syncRegistry", + "parameters": [ + { + "name": "registry_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/registryaccount/{registry_type}/summary-by-type": { + "get": { + "tags": ["Registry"], + "summary": "Get Registry Summary By Type", + "description": "get summary of registries scans, images and tags by registry type", + "operationId": "getSummaryByType", + "parameters": [ + { + "name": "registry_type", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelSummary" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/reports": { + "get": { + "tags": ["Reports"], + "summary": "List Reports", + "description": "List all the available reports", + "operationId": "listReports", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelExportReport" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "post": { + "tags": ["Reports"], + "summary": "Generate Report", + "description": "generate report for given type and filters", + "operationId": "generateReport", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGenerateReportReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGenerateReportResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/reports/delete": { + "patch": { + "tags": ["Reports"], + "summary": "Bulk Delete Reports", + "description": "Bulk Delete reports", + "operationId": "bulkDeleteReports", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelBulkDeleteReportReq" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/reports/{report_id}": { + "delete": { + "tags": ["Reports"], + "summary": "Delete Report", + "description": "delete report for given report_id", + "operationId": "deleteReport", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "get": { + "tags": ["Reports"], + "summary": "Get Report", + "description": "get report by report_id", + "operationId": "getReport", + "parameters": [ + { + "name": "report_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelExportReport" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/rules/action/mask": { + "post": { + "tags": ["Rules"], + "summary": "mask Rules", + "description": "mask rules", + "operationId": "maskRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRulesActionRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/rules/action/unmask": { + "post": { + "tags": ["Rules"], + "summary": "Unmask Rules", + "description": "Unmask rules", + "operationId": "unmaskRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRulesActionRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/list/cloud-compliance": { + "post": { + "tags": ["Cloud Scanner"], + "summary": "Get Cloud Compliance Scans List", + "description": "Get Cloud Compliance Scans list for cloud node", + "operationId": "listCloudComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/list/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Get Compliance Scans List", + "description": "Get Compliance Scans list on agent or registry", + "operationId": "listComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/list/malware": { + "post": { + "tags": ["Malware Scan"], + "summary": "Get Malware Scans List", + "description": "Get Malware Scans list on agent or registry", + "operationId": "listMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/list/secret": { + "post": { + "tags": ["Secret Scan"], + "summary": "Get Secret Scans List", + "description": "Get Secret Scans list on agent or registry", + "operationId": "listSecretScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/list/vulnerability": { + "post": { + "tags": ["Vulnerability"], + "summary": "Get Vulnerability Scans List", + "description": "Get Vulnerability Scan list on agent or registry", + "operationId": "listVulnerabilityScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanListResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/nodes-in-result": { + "post": { + "tags": ["Scan Results"], + "summary": "Get all nodes in given scan result ids", + "description": "Get all nodes in given scan result ids", + "operationId": "getAllNodesInScanResults", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelNodesInScanResultRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelScanResultBasicNode" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/action/delete": { + "patch": { + "tags": ["Scan Results"], + "summary": "Delete selected scan results", + "description": "Delete selected scan results", + "operationId": "deleteScanResult", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsActionRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/action/mask": { + "post": { + "tags": ["Scan Results"], + "summary": "Mask Scans Results", + "description": "Mask scan results", + "operationId": "maskScanResult", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsMaskRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/action/notify": { + "post": { + "tags": ["Scan Results"], + "summary": "Notify Scans Results", + "description": "Notify scan results in connected integration channels", + "operationId": "notifyScanResult", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsActionRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/action/unmask": { + "post": { + "tags": ["Scan Results"], + "summary": "Unmask Scans Results", + "description": "Unmask scan results", + "operationId": "unmaskScanResult", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsMaskRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/cloud-compliance": { + "post": { + "tags": ["Cloud Scanner"], + "summary": "Get Cloud Compliance Scan Results", + "description": "Get Cloud Compliance Scan results for cloud node", + "operationId": "resultsCloudComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelCloudComplianceScanResult" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Get Compliance Scans Results", + "description": "Get Compliance Scans results on agent or registry", + "operationId": "resultsComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelComplianceScanResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/cloud-compliance": { + "post": { + "tags": ["Cloud Scanner"], + "summary": "Get Cloud Compliance Scan Results", + "description": "Get Cloud Compliance Scan results for cloud node", + "operationId": "countResultsCloudComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Get Compliance Scans Results", + "description": "Get Compliance Scans results on agent or registry", + "operationId": "countResultsComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/group/cloud-compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Count Cloud Compliance Results by Control ID", + "description": "Count Cloud Compliance Results grouped by Control ID", + "operationId": "groupResultsCloudCompliance", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelComplinaceScanResultsGroupReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelComplianceScanResultsGroupResp" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/group/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Count Compliance Results by Control ID", + "description": "Count Compliance Results grouped by Control ID", + "operationId": "groupResultsCompliance", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelComplinaceScanResultsGroupReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelComplianceScanResultsGroupResp" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/group/malware": { + "get": { + "tags": ["Malware Scan"], + "summary": "Group Malware Results", + "description": "Group Malware Scans results by severity/rule", + "operationId": "groupResultsMalwares", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchResultGroupResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/group/malware/class": { + "get": { + "tags": ["Malware Scan"], + "summary": "Group Malware Results By Class", + "description": "Group Malware Scans results by severity/class", + "operationId": "groupResultsMalwaresClass", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchResultGroupResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/group/secret": { + "get": { + "tags": ["Secret Scan"], + "summary": "Group Secret Results", + "description": "Group Secret Scans results by severity/rule", + "operationId": "groupResultsSecrets", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchResultGroupResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/malware": { + "post": { + "tags": ["Malware Scan"], + "summary": "Get Malware Scans Results", + "description": "Get Malware Scans results on agent or registry", + "operationId": "countResultsMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/secret": { + "post": { + "tags": ["Secret Scan"], + "summary": "Get Secret Scans Results", + "description": "Get Secret Scans results on agent or registry", + "operationId": "countResultsSecretScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/count/vulnerability": { + "post": { + "tags": ["Vulnerability"], + "summary": "Get Vulnerability Scans Results", + "description": "Get Vulnerability Scan results on agent or registry", + "operationId": "countResultsVulnerabilityScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/fields": { + "get": { + "tags": ["Common"], + "summary": "Get Scan Report Fields", + "description": "Get all the fields available in all the scan reports", + "operationId": "getScanReportFields", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanReportFieldsResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/malware": { + "post": { + "tags": ["Malware Scan"], + "summary": "Get Malware Scans Results", + "description": "Get Malware Scans results on agent or registry", + "operationId": "resultsMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMalwareScanResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/malware/class": { + "post": { + "tags": ["Malware Scan"], + "summary": "Get Malware Scans Results", + "description": "Get Malware Scans detected class names", + "operationId": "resultsClassMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMalwareScanResultClass" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/malware/rules": { + "post": { + "tags": ["Malware Scan"], + "summary": "Get Malware Scans Result Rules", + "description": "Get Malware Scans detected rules names", + "operationId": "resultsRulesMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMalwareScanResultRules" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/secret": { + "post": { + "tags": ["Secret Scan"], + "summary": "Get Secret Scans Results", + "description": "Get Secret Scans results on agent or registry", + "operationId": "resultsSecretScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelSecretScanResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/secret/rules": { + "post": { + "tags": ["Secret Scan"], + "summary": "Get Secret Scans Result Rules", + "description": "Get Secret Scans detected rules names", + "operationId": "resultsRulesSecretScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelSecretScanResultRules" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/results/vulnerability": { + "post": { + "tags": ["Vulnerability"], + "summary": "Get Vulnerability Scans Results", + "description": "Get Vulnerability Scan results on agent or registry", + "operationId": "resultsVulnerabilityScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanResultsReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelVulnerabilityScanResult" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/sbom": { + "post": { + "tags": ["Vulnerability"], + "summary": "Get SBOM for a node or scan id", + "description": "Get SBOM for a node or scan id", + "operationId": "getSBOM", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelSbomRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelSbomResponse" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/sbom/download": { + "post": { + "tags": ["Vulnerability"], + "summary": "Download SBOM for a node or scan id", + "description": "Download SBOM for a node or scan id", + "operationId": "downloadSBOM", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelSbomRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelDownloadReportResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/start/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Start Compliance Scan", + "description": "Start Compliance Scan on agent or registry", + "operationId": "startComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelComplianceScanTriggerReq" } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanTriggerResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/start/malware": { + "post": { + "tags": ["Malware Scan"], + "summary": "Start Malware Scan", + "description": "Start Malware Scan on agent or registry", + "operationId": "startMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMalwareScanTriggerReq" } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanTriggerResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/start/secret": { + "post": { + "tags": ["Secret Scan"], + "summary": "Start Secret Scan", + "description": "Start Secret Scan on agent or registry", + "operationId": "startSecretScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelSecretScanTriggerReq" } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanTriggerResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/start/vulnerability": { + "post": { + "tags": ["Vulnerability"], + "summary": "Start Vulnerability Scan", + "description": "Start Vulnerability Scan on agent or registry", + "operationId": "startVulnerabilityScan", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelVulnerabilityScanTriggerReq" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanTriggerResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/status/cloud-compliance": { + "post": { + "tags": ["Cloud Scanner"], + "summary": "Get Cloud Compliance Scan Status", + "description": "Get Cloud Compliance Scan Status on cloud node", + "operationId": "statusCloudComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelComplianceScanStatusResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/status/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Get Compliance Scan Status", + "description": "Get Compliance Scan Status on agent or registry", + "operationId": "statusComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/status/malware": { + "post": { + "tags": ["Malware Scan"], + "summary": "Get Malware Scan Status", + "description": "Get Malware Scan status on agent or registry", + "operationId": "statusMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/status/secret": { + "post": { + "tags": ["Secret Scan"], + "summary": "Get Secret Scan Status", + "description": "Get Secret Scan Status on agent or registry", + "operationId": "statusSecretScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/status/vulnerability": { + "post": { + "tags": ["Vulnerability"], + "summary": "Get Vulnerability Scan Status", + "description": "Get Vulnerability Scan Status on agent or registry", + "operationId": "statusVulnerabilityScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelScanStatusResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/stop/compliance": { + "post": { + "tags": ["Compliance"], + "summary": "Stop Compliance Scan", + "description": "Stop Compliance Scan on agent or registry", + "operationId": "stopComplianceScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelStopScanRequest" } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/stop/malware": { + "post": { + "tags": ["Malware Scan"], + "summary": "Stop Malware Scan", + "description": "Stop Malware Scan on agent or registry", + "operationId": "stopMalwareScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelStopScanRequest" } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/stop/secret": { + "post": { + "tags": ["Secret Scan"], + "summary": "Stop Secret Scan", + "description": "Stop Secret Scan on agent or registry", + "operationId": "stopSecretScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelStopScanRequest" } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/stop/vulnerability": { + "post": { + "tags": ["Vulnerability"], + "summary": "Stop Vulnerability Scan", + "description": "Stop Vulnerability Scan on agent or registry", + "operationId": "stopVulnerabilityScan", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelStopScanRequest" } + } + } + }, + "responses": { + "202": { "description": "Accepted" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/{scan_type}/{scan_id}": { + "delete": { + "tags": ["Scan Results"], + "summary": "Delete all scan results for a scan id", + "description": "Delete all scan results for a scan id", + "operationId": "deleteScanResultsForScanID", + "parameters": [ + { + "name": "scan_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "scan_type", + "in": "path", + "required": true, + "schema": { + "enum": [ + "SecretScan", + "VulnerabilityScan", + "MalwareScan", + "ComplianceScan", + "CloudComplianceScan" + ], + "type": "string" + } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scan/{scan_type}/{scan_id}/download": { + "get": { + "tags": ["Scan Results"], + "summary": "Download Scans Results", + "description": "Download scan results", + "operationId": "downloadScanResults", + "parameters": [ + { + "name": "scan_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "scan_type", + "in": "path", + "required": true, + "schema": { + "enum": [ + "SecretScan", + "VulnerabilityScan", + "MalwareScan", + "ComplianceScan", + "CloudComplianceScan" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ModelDownloadScanResultsResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scans/bulk/delete": { + "post": { + "tags": ["Scan Results"], + "summary": "Bulk Delete Scans", + "description": "Bulk delete scans along with their results for a particular scan type", + "operationId": "bulkDeleteScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelBulkDeleteScansRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scheduled-task": { + "get": { + "tags": ["Settings"], + "summary": "Get scheduled tasks", + "description": "Get scheduled tasks", + "operationId": "getScheduledTasks", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/PostgresqlDbScheduler" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "post": { + "tags": ["Settings"], + "summary": "Add scheduled task", + "description": "Add scheduled task", + "operationId": "addScheduledTask", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelAddScheduledTaskRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/scheduled-task/{id}": { + "delete": { + "tags": ["Settings"], + "summary": "Delete Custom Schedule task", + "description": "Delete Custom Schedule task", + "operationId": "deleteCustomScheduledTask", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "patch": { + "tags": ["Settings"], + "summary": "Update scheduled task", + "description": "Update scheduled task", + "operationId": "updateScheduledTask", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUpdateScheduledTaskRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/cloud-accounts": { + "post": { + "tags": ["Search"], + "summary": "Search Cloud Nodes", + "description": "Search across all the data associated with cloud nodes", + "operationId": "searchCloudAccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudNodeAccountInfo" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/cloud-compliance/scans": { + "post": { + "tags": ["Search"], + "summary": "Search Cloud Compliance Scan results", + "description": "Search across all the data associated with cloud-compliance scan", + "operationId": "searchCloudComplianceScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelScanInfo" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/cloud-compliances": { + "post": { + "tags": ["Search"], + "summary": "Search Cloud compliances", + "description": "Search across all the data associated with cloud-compliances", + "operationId": "searchCloudCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudCompliance" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/cloud-resources": { + "post": { + "tags": ["Search"], + "summary": "Search Cloud Resources", + "description": "Search across all data associated with CloudResources", + "operationId": "searchCloudResources", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudResource" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/compliance-rules": { + "post": { + "tags": ["Search"], + "summary": "Search Compliance Rules", + "description": "Search across all the data associated with compliance rules", + "operationId": "searchComplianceRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelComplianceRule" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/compliance/scans": { + "post": { + "tags": ["Search"], + "summary": "Search Compliance Scan results", + "description": "Search across all the data associated with compliance scan", + "operationId": "searchComplianceScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelScanInfo" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/compliances": { + "post": { + "tags": ["Search"], + "summary": "Search Compliances", + "description": "Search across all the data associated with compliances", + "operationId": "searchCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCompliance" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/containers": { + "post": { + "tags": ["Search"], + "summary": "Search Containers data", + "description": "Search across all data associated with containers", + "operationId": "searchContainers", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainer" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/cloud-accounts": { + "post": { + "tags": ["Search"], + "summary": "Count Cloud Nodes", + "description": "Search across all the data associated with cloud nodes", + "operationId": "countCloudAccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/cloud-compliance/scans": { + "post": { + "tags": ["Search"], + "summary": "Count Cloud Compliance Scan results", + "description": "Count across all the data associated with cloud-compliance scans", + "operationId": "countCloudComplianceScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/cloud-compliances": { + "post": { + "tags": ["Search"], + "summary": "Count Cloud compliances", + "description": "Count across all the data ssociated with cloud compliances", + "operationId": "countCloudCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/cloud-resources": { + "post": { + "tags": ["Search"], + "summary": "Count Cloud resources", + "description": "Count across all the data ssociated with cloud resources", + "operationId": "countCloudResources", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/compliance-rules": { + "post": { + "tags": ["Search"], + "summary": "Count Compliance Rules", + "description": "Count across all the data associated with compliance rules", + "operationId": "countComplianceRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/compliance/scans": { + "post": { + "tags": ["Search"], + "summary": "Count Compliance Scan results", + "description": "Count across all the data associated with compliance scans", + "operationId": "countComplianceScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/compliances": { + "post": { + "tags": ["Search"], + "summary": "Count Compliances", + "description": "Count across all the data associated with compliances", + "operationId": "countCompliances", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/containers": { + "post": { + "tags": ["Search"], + "summary": "Count Containers data", + "description": "Count across all the data associated with containers", + "operationId": "countContainers", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/hosts": { + "post": { + "tags": ["Search"], + "summary": "Count hosts", + "description": "Count across all the data associated with hosts", + "operationId": "countHosts", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/images": { + "post": { + "tags": ["Search"], + "summary": "Count Container images", + "description": "Count across all the data associated with container images", + "operationId": "countContainerImages", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/kubernetes-clusters": { + "post": { + "tags": ["Search"], + "summary": "Count Kubernetes clusters", + "description": "Count across all the data ssociated with kubernetes clusters", + "operationId": "countKubernetesClusters", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/malware-rules": { + "post": { + "tags": ["Search"], + "summary": "Count Malware Rules", + "description": "Count across all the data associated with malware rules", + "operationId": "countMalwareRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/malware/scans": { + "post": { + "tags": ["Search"], + "summary": "Count Malware Scan results", + "description": "Count across all the data associated with malware scans", + "operationId": "countMalwareScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/malwares": { + "post": { + "tags": ["Search"], + "summary": "Count Malwares", + "description": "Count across all the data associated with malwares", + "operationId": "countMalwares", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/nodes": { + "get": { + "tags": ["Search"], + "summary": "Count nodes", + "description": "Count hosts, containers, pods, k8s clusters, images", + "operationId": "countNodes", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchNodeCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/pods": { + "post": { + "tags": ["Search"], + "summary": "Count Pods", + "description": "Count across all the data associated with pods", + "operationId": "countPods", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/registry-accounts": { + "post": { + "tags": ["Search"], + "summary": "Count Registry Accounts", + "description": "Search across all the data associated with registry account", + "operationId": "countRegistryAccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/secret-rules": { + "post": { + "tags": ["Search"], + "summary": "Count Secret Rules", + "description": "Count across all the data associated with secret rules", + "operationId": "countSecretRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/secret/scans": { + "post": { + "tags": ["Search"], + "summary": "Count Secret Scan results", + "description": "Count across all the data associated with secret scans", + "operationId": "countSecretsScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/secrets": { + "post": { + "tags": ["Search"], + "summary": "Count Secrets", + "description": "Count across all the data associated with secrets", + "operationId": "countSecrets", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/vulnerabilities": { + "post": { + "tags": ["Search"], + "summary": "Count Vulnerabilities", + "description": "Search across all the data associated with vulnerabilities", + "operationId": "countVulnerabilities", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/vulnerability-rules": { + "post": { + "tags": ["Search"], + "summary": "Count Vulnerability Rules", + "description": "Count across all the data associated with vulnerability rules", + "operationId": "countVulnerabilityRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/count/vulnerability/scans": { + "post": { + "tags": ["Search"], + "summary": "Count Vulnerability Scan results", + "description": "Count across all the data associated with vulnerability scans", + "operationId": "countVulnerabilityScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/hosts": { + "post": { + "tags": ["Search"], + "summary": "Search hosts", + "description": "Search across all data associated with hosts", + "operationId": "searchHosts", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelHost" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/images": { + "post": { + "tags": ["Search"], + "summary": "Search Container images", + "description": "Search across all the data associated with container images", + "operationId": "searchContainerImages", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainerImage" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/kubernetes-clusters": { + "post": { + "tags": ["Search"], + "summary": "Search Kuberenetes Clusters", + "description": "Search across all data associated with kuberentes clusters", + "operationId": "searchKubernetesClusters", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelKubernetesCluster" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/malware-rules": { + "post": { + "tags": ["Search"], + "summary": "Search Malware Rules", + "description": "Search across all the data associated with malware rules", + "operationId": "searchMalwareRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelMalwareRule" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/malware/scans": { + "post": { + "tags": ["Search"], + "summary": "Search Malware Scan results", + "description": "Search across all the data associated with malwares scan", + "operationId": "searchMalwareScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelScanInfo" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/malwares": { + "post": { + "tags": ["Search"], + "summary": "Search Malwares", + "description": "Search across all the data associated with malwares", + "operationId": "searchMalwares", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelMalware" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/pods": { + "post": { + "tags": ["Search"], + "summary": "Search Pods", + "description": "Search across all the data associated with pods", + "operationId": "searchPods", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelPod" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/registry-accounts": { + "post": { + "tags": ["Search"], + "summary": "Search Registry Accounts", + "description": "Search across all the data associated with registry account", + "operationId": "searchRegistryAccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelRegistryAccount" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/secret-rules": { + "post": { + "tags": ["Search"], + "summary": "Search Secret Rules", + "description": "Search across all the data associated with secret rules", + "operationId": "searchSecretRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelSecretRule" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/secret/scans": { + "post": { + "tags": ["Search"], + "summary": "Search Secrets Scan results", + "description": "Search across all the data associated with secrets scan", + "operationId": "searchSecretsScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelScanInfo" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/secrets": { + "post": { + "tags": ["Search"], + "summary": "Search Secrets", + "description": "Search across all the data associated with secrets", + "operationId": "searchSecrets", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelSecret" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/vulnerabilities": { + "post": { + "tags": ["Search"], + "summary": "Search Vulnerabilities", + "description": "Search across all the data associated with vulnerabilities", + "operationId": "searchVulnerabilities", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelVulnerability" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/vulnerability-rules": { + "post": { + "tags": ["Search"], + "summary": "Search Vulnerability Rules", + "description": "Search across all the data associated with vulnerability rules", + "operationId": "searchVulnerabilityRules", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchNodeReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelVulnerabilityRule" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/search/vulnerability/scans": { + "post": { + "tags": ["Search"], + "summary": "Search Vulnerability Scan results", + "description": "Search across all the data associated with vulnerability scan", + "operationId": "searchVulnerabilityScans", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchScanReq" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelScanInfo" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/agent/version": { + "put": { + "tags": ["Settings"], + "summary": "Upload New agent version", + "description": "Upload Agent version", + "operationId": "uploadAgentVersion", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { "$ref": "#/components/schemas/FormDataModelBinUploadRequest" } + } + } + }, + "responses": { + "200": { "description": "OK" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/agent/versions": { + "get": { + "tags": ["Settings"], + "summary": "Get available agent versions", + "description": "Get available agent versions", + "operationId": "getAgentVersions", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelListAgentVersionResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/email": { + "get": { + "tags": ["Settings"], + "summary": "Get Email Configurations", + "description": "Get Email Smtp / ses Configurations in system", + "operationId": "getEmailConfiguration", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelEmailConfigurationResp" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "post": { + "tags": ["Settings"], + "summary": "Add Email Configuration", + "description": "This email configuration is used to send email notifications", + "operationId": "addEmailConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelEmailConfigurationAdd" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/email/test": { + "post": { + "tags": ["Settings"], + "summary": "Test Configured Email", + "description": "Test Configured Email", + "operationId": "testConfiguredEmail", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/email/test-unconfigured": { + "post": { + "tags": ["Settings"], + "summary": "Test Unconfigured Email", + "description": "Test Unconfigured Email", + "operationId": "testUnconfiguredEmail", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelEmailConfigurationAdd" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/email/{config_id}": { + "delete": { + "tags": ["Settings"], + "summary": "Delete Email Configurations", + "description": "Delete Email Smtp / ses Configurations in system", + "operationId": "deleteEmailConfiguration", + "parameters": [ + { + "name": "config_id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/global-settings": { + "get": { + "tags": ["Settings"], + "summary": "Get settings", + "description": "Get all settings", + "operationId": "getSettings", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/SettingSettingsResponse" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/global-settings/{id}": { + "patch": { + "tags": ["Settings"], + "summary": "Update setting", + "description": "Update setting", + "operationId": "updateSetting", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SettingSettingUpdateRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/user-audit-log": { + "post": { + "tags": ["Settings"], + "summary": "Get user audit logs", + "description": "Get audit logs for all users", + "operationId": "getUserAuditLogs", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelGetAuditLogsRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/PostgresqlDbGetAuditLogsRow" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/settings/user-audit-log/count": { + "get": { + "tags": ["Settings"], + "summary": "Get user audit logs count", + "description": "Get user audit logs count", + "operationId": "getUserAuditLogsCount", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/SearchSearchCountResp" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/user": { + "delete": { + "tags": ["User"], + "summary": "Delete Current User", + "description": "Delete logged in user", + "operationId": "deleteCurrentUser", + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "get": { + "tags": ["User"], + "summary": "Get Current User", + "description": "Get logged in user information", + "operationId": "getCurrentUser", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUser" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "put": { + "tags": ["User"], + "summary": "Update Current User", + "description": "Update logged in user information", + "operationId": "updateCurrentUser", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUpdateUserRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUser" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/user/invite": { + "post": { + "tags": ["User"], + "summary": "Invite User", + "description": "Invite a user", + "operationId": "inviteUser", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelInviteUserRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelInviteUserResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/user/invite/register": { + "post": { + "tags": ["User"], + "summary": "Register Invited User", + "description": "Register invited user", + "operationId": "registerInvitedUser", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelRegisterInvitedUserRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelLoginResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/user/login": { + "post": { + "tags": ["Authentication"], + "summary": "Login API", + "description": "Login API", + "operationId": "login", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelLoginRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelLoginResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/user/logout": { + "post": { + "tags": ["Authentication"], + "summary": "Logout API", + "description": "Logout API", + "operationId": "logout", + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/user/password": { + "put": { + "tags": ["User"], + "summary": "Update Password", + "description": "Update current user's password", + "operationId": "updatePassword", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUpdateUserPasswordRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/user/register": { + "post": { + "tags": ["User"], + "summary": "Register User", + "description": "First user registration. Further users needs to be invited.", + "operationId": "registerUser", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUserRegisterRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelLoginResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/user/reset-password/request": { + "post": { + "tags": ["User"], + "summary": "Reset Password Request", + "description": "Request for resetting the password", + "operationId": "resetPasswordRequest", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelPasswordResetRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelMessageResponse" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/user/reset-password/verify": { + "post": { + "tags": ["User"], + "summary": "Verify and Reset Password", + "description": "Verify code and reset the password", + "operationId": "verifyResetPasswordRequest", + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelPasswordResetVerifyRequest" } + } + } + }, + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + } + } + }, + "/deepfence/users": { + "get": { + "tags": ["User"], + "summary": "Get all users", + "description": "Get all users", + "operationId": "getUsers", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelUser" } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + }, + "/deepfence/users/{id}": { + "delete": { + "tags": ["User"], + "summary": "Delete User by User ID", + "description": "Delete User by User ID", + "operationId": "deleteUser", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "204": { "description": "No Content" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "get": { + "tags": ["User"], + "summary": "Get User by User ID", + "description": "Get User by User ID", + "operationId": "getUser", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUser" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + }, + "put": { + "tags": ["User"], + "summary": "Update User by User ID", + "description": "Update User by User ID", + "operationId": "updateUser", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUpdateUserIDRequest" } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ModelUser" } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } + } + } + }, + "401": { "description": "Unauthorized" }, + "403": { "description": "Forbidden" }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } + } + } + } + }, + "security": [{ "bearer_token": [] }] + } + } + }, + "components": { + "schemas": { + "ApiDocsBadRequestResponse": { + "type": "object", + "properties": { + "error_fields": { + "type": "object", + "additionalProperties": { "type": "string" }, + "nullable": true + }, + "error_index": { + "type": "object", + "additionalProperties": { "type": "array", "items": { "type": "integer" } }, + "nullable": true + }, + "message": { "type": "string" }, + "success": { "type": "boolean", "example": false } + } + }, + "ApiDocsFailureResponse": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "success": { "type": "boolean", "example": false } + } + }, + "CompletionCompletionNodeFieldReq": { + "required": ["completion", "field_name", "window"], + "type": "object", + "properties": { + "completion": { "type": "string" }, + "field_name": { "type": "string" }, + "filters": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "scan_id": { "type": "string" }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "CompletionCompletionNodeFieldRes": { + "required": ["possible_values"], + "type": "object", + "properties": { + "possible_values": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + } + } + }, + "ControlsAction": { + "required": ["id", "request_payload"], + "type": "object", + "properties": { + "id": { "type": "integer" }, + "request_payload": { "type": "string" } + } + }, + "ControlsAgentBeat": { + "required": ["beatrate"], + "type": "object", + "properties": { "beatrate": { "type": "integer" } } + }, + "ControlsAgentControls": { + "required": ["beatrate", "commands"], + "type": "object", + "properties": { + "beatrate": { "type": "integer" }, + "commands": { + "type": "array", + "items": { "$ref": "#/components/schemas/ControlsAction" }, + "nullable": true + } + } + }, + "DetailedConnectionSummary": { + "type": "object", + "properties": { "source": { "type": "string" }, "target": { "type": "string" } } + }, + "DetailedNodeSummaries": { + "type": "object", + "additionalProperties": { "$ref": "#/components/schemas/DetailedNodeSummary" } + }, + "DetailedNodeSummary": { + "type": "object", + "properties": { + "adjacency": { "$ref": "#/components/schemas/ReportIDList" }, + "id": { "type": "string" }, + "ids": { "type": "array", "items": { "type": "string" } }, + "immediate_parent_id": { "type": "string" }, + "label": { "type": "string" }, + "metadata": { "$ref": "#/components/schemas/ReportMetadata" }, + "type": { "type": "string" } + } + }, + "DetailedTopologyConnectionSummaries": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/DetailedConnectionSummary" + } + }, + "DiagnosisDiagnosticLogsLink": { + "type": "object", + "properties": { + "created_at": { "type": "string" }, + "label": { "type": "string" }, + "message": { "type": "string" }, + "type": { "type": "string" }, + "url_link": { "type": "string" } + } + }, + "DiagnosisDiagnosticLogsStatus": { + "required": ["status"], + "type": "object", + "properties": { "message": { "type": "string" }, "status": { "type": "string" } } + }, + "DiagnosisDiagnosticNotification": { + "type": "object", + "properties": { + "content": { "type": "string" }, + "expiry_in_secs": {}, + "follow_url": {}, + "source_application_id": { "type": "string" }, + "updated_at": { "type": "string" } + } + }, + "DiagnosisGenerateAgentDiagnosticLogsRequest": { + "required": ["node_ids", "tail"], + "type": "object", + "properties": { + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/DiagnosisNodeIdentifier" }, + "nullable": true + }, + "tail": { "type": "integer" } + } + }, + "DiagnosisGenerateCloudScannerDiagnosticLogsRequest": { + "required": ["node_ids", "tail"], + "type": "object", + "properties": { + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/DiagnosisNodeIdentifier" }, + "nullable": true + }, + "tail": { "type": "integer" } + } + }, + "DiagnosisGenerateConsoleDiagnosticLogsRequest": { + "required": ["tail"], + "type": "object", + "properties": { "tail": { "type": "integer" } } + }, + "DiagnosisGetDiagnosticLogsResponse": { + "type": "object", + "properties": { + "agent_logs": { + "type": "array", + "items": { "$ref": "#/components/schemas/DiagnosisDiagnosticLogsLink" }, + "nullable": true + }, + "console_logs": { + "type": "array", + "items": { "$ref": "#/components/schemas/DiagnosisDiagnosticLogsLink" }, + "nullable": true + } + } + }, + "DiagnosisNodeIdentifier": { + "required": ["node_id", "node_type"], + "type": "object", + "properties": { + "node_id": { "type": "string" }, + "node_type": { "enum": ["host", "cluster", "cloud_account"], "type": "string" } + } + }, + "FormDataModelBinUploadRequest": { + "required": ["tarball"], + "type": "object", + "properties": { "tarball": { "$ref": "#/components/schemas/MultipartFile" } } + }, + "FormDataModelRegistryGCRAddReq": { + "required": ["name", "registry_url", "service_account_json"], + "type": "object", + "properties": { + "name": { "type": "string" }, + "registry_url": { "type": "string" }, + "service_account_json": { "$ref": "#/components/schemas/MultipartFile" } + } + }, + "FormDataThreatintelDBUploadRequest": { + "required": ["database"], + "type": "object", + "properties": { "database": { "$ref": "#/components/schemas/MultipartFile" } } + }, + "GraphCloudProviderFilter": { + "required": ["account_ids"], + "type": "object", + "properties": { + "account_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + } + } + }, + "GraphIndividualThreatGraph": { + "type": "object", + "properties": { + "attack_path": { + "type": "array", + "items": { "type": "array", "items": { "type": "string" } }, + "nullable": true + }, + "cve_attack_vector": { "type": "string" }, + "cve_id": { "type": "array", "items": { "type": "string" }, "nullable": true }, + "ports": { "type": "array", "items": {}, "nullable": true } + } + }, + "GraphIndividualThreatGraphRequest": { + "required": ["graph_type", "issue_type"], + "type": "object", + "properties": { + "graph_type": { + "enum": [ + "most_vulnerable_attack_paths", + "direct_internet_exposure", + "indirect_internet_exposure" + ], + "type": "string" + }, + "issue_type": { + "enum": [ + "vulnerability", + "secret", + "malware", + "compliance", + "cloud_compliance" + ], + "type": "string" + }, + "node_ids": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "GraphNodeInfo": { + "required": [ + "node_id", + "name", + "vulnerability_count", + "exploitable_vulnerabilities_count", + "secrets_count", + "exploitable_secrets_count", + "compliance_count", + "cloud_compliance_count", + "warn_alarm_count", + "cloud_warn_alarm_count" + ], + "type": "object", + "properties": { + "cloud_compliance_count": { "type": "integer" }, + "cloud_warn_alarm_count": { "type": "integer" }, + "compliance_count": { "type": "integer" }, + "exploitable_secrets_count": { "type": "integer" }, + "exploitable_vulnerabilities_count": { "type": "integer" }, + "name": { "type": "string" }, + "node_id": { "type": "string" }, + "secrets_count": { "type": "integer" }, + "vulnerability_count": { "type": "integer" }, + "warn_alarm_count": { "type": "integer" } + } + }, + "GraphProviderThreatGraph": { + "required": [ + "resources", + "compliance_count", + "secrets_count", + "exploitable_secrets_count", + "vulnerability_count", + "exploitable_vulnerabilities_count", + "cloud_compliance_count", + "warn_alarm_count", + "cloud_warn_alarm_count" + ], + "type": "object", + "properties": { + "cloud_compliance_count": { "type": "integer" }, + "cloud_warn_alarm_count": { "type": "integer" }, + "compliance_count": { "type": "integer" }, + "exploitable_secrets_count": { "type": "integer" }, + "exploitable_vulnerabilities_count": { "type": "integer" }, + "resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/GraphThreatNodeInfo" }, + "nullable": true + }, + "secrets_count": { "type": "integer" }, + "vulnerability_count": { "type": "integer" }, + "warn_alarm_count": { "type": "integer" } + } + }, + "GraphThreatFilters": { + "required": [ + "aws_filter", + "gcp_filter", + "azure_filter", + "type", + "cloud_resource_only" + ], + "type": "object", + "properties": { + "aws_filter": { "$ref": "#/components/schemas/GraphCloudProviderFilter" }, + "azure_filter": { "$ref": "#/components/schemas/GraphCloudProviderFilter" }, + "cloud_resource_only": { "type": "boolean" }, + "gcp_filter": { "$ref": "#/components/schemas/GraphCloudProviderFilter" }, + "type": { + "enum": [ + "all", + "vulnerability", + "secret", + "malware", + "compliance", + "cloud_compliance" + ], + "type": "string" + } + } + }, + "GraphThreatGraph": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GraphProviderThreatGraph" + }, + "nullable": true + }, + "GraphThreatNodeInfo": { + "required": [ + "label", + "id", + "nodes", + "vulnerability_count", + "exploitable_vulnerabilities_count", + "secrets_count", + "exploitable_secrets_count", + "compliance_count", + "cloud_compliance_count", + "count", + "warn_alarm_count", + "cloud_warn_alarm_count", + "node_type", + "attack_path" + ], + "type": "object", + "properties": { + "attack_path": { + "type": "array", + "items": { "type": "array", "items": { "type": "string" } }, + "nullable": true + }, + "cloud_compliance_count": { "type": "integer" }, + "cloud_warn_alarm_count": { "type": "integer" }, + "compliance_count": { "type": "integer" }, + "count": { "type": "integer" }, + "exploitable_secrets_count": { "type": "integer" }, + "exploitable_vulnerabilities_count": { "type": "integer" }, + "id": { "type": "string" }, + "label": { "type": "string" }, + "node_type": { "type": "string" }, + "nodes": { + "type": "object", + "additionalProperties": { "$ref": "#/components/schemas/GraphNodeInfo" }, + "nullable": true + }, + "secrets_count": { "type": "integer" }, + "vulnerability_count": { "type": "integer" }, + "warn_alarm_count": { "type": "integer" } + } + }, + "GraphTopologyFilters": { + "required": [ + "cloud_filter", + "region_filter", + "kubernetes_filter", + "host_filter", + "pod_filter", + "container_filter", + "field_filters", + "skip_connections" + ], + "type": "object", + "properties": { + "cloud_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "container_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "field_filters": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "host_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "kubernetes_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "pod_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "region_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "skip_connections": { "type": "boolean" } + } + }, + "IngestersCloudCompliance": { + "type": "object", + "properties": { + "@timestamp": { "type": "string" }, + "account_id": { "type": "string" }, + "cloud_provider": { "type": "string" }, + "compliance_check_type": { "type": "string" }, + "control_id": { "type": "string" }, + "count": { "type": "integer" }, + "description": { "type": "string" }, + "doc_id": { "type": "string" }, + "group": { "type": "string" }, + "reason": { "type": "string" }, + "region": { "type": "string" }, + "resource": { "type": "string" }, + "scan_id": { "type": "string" }, + "service": { "type": "string" }, + "severity": { "type": "string" }, + "status": { "type": "string" }, + "title": { "type": "string" }, + "type": { "type": "string" } + } + }, + "IngestersCloudComplianceScanStatus": { + "type": "object", + "properties": { + "@timestamp": { "type": "string", "format": "date-time" }, + "compliance_check_types": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "result": { "$ref": "#/components/schemas/IngestersComplianceStats" }, + "scan_id": { "type": "string" }, + "scan_message": { "type": "string" }, + "scan_status": { "type": "string" }, + "total_checks": { "type": "integer" }, + "type": { "type": "string" } + } + }, + "IngestersCloudResource": { + "type": "object", + "properties": { + "access_level": { "type": "string" }, + "account_id": { "type": "string" }, + "action": { "type": "string" }, + "allow_blob_public_access": { "type": "boolean" }, + "arn": { "type": "string" }, + "attached_policy_arns": {}, + "block_public_acls": { "type": "boolean" }, + "block_public_policy": { "type": "boolean" }, + "bucket_policy_is_public": { "type": "boolean" }, + "cidr_ipv4": { "type": "string" }, + "cloud_provider": { "type": "string" }, + "cluster_arn": { "type": "string" }, + "cluster_name": { "type": "string" }, + "connectivity": { "type": "string" }, + "container_definitions": {}, + "containers": {}, + "create_date": { "type": "string" }, + "db_cluster_identifier": { "type": "string" }, + "description": { "type": "string" }, + "event_notification_configuration": {}, + "group": { "type": "string" }, + "group_id": { "type": "string" }, + "groups": {}, + "host_name": { "type": "string" }, + "iam_instance_profile_arn": { "type": "string" }, + "iam_instance_profile_id": { "type": "string" }, + "iam_policy": {}, + "id": { "type": "string" }, + "ignore_public_acls": { "type": "boolean" }, + "ingress_settings": { "type": "string" }, + "inline_policies": {}, + "instance_id": { "type": "string" }, + "instance_profile_arns": {}, + "instance_type": { "type": "string" }, + "instances": {}, + "ip_configuration": {}, + "is_egress": { "type": "boolean" }, + "last_status": { "type": "string" }, + "name": { "type": "string" }, + "network_configuration": {}, + "network_interfaces": {}, + "network_mode": { "type": "string" }, + "organization_id": { "type": "string" }, + "organization_master_account_arn": { "type": "string" }, + "organization_master_account_email": { "type": "string" }, + "path": { "type": "string" }, + "policy": {}, + "policy_std": {}, + "private_dns_name": { "type": "string" }, + "private_ip_address": { "type": "string" }, + "privilege": { "type": "string" }, + "public_access": { "type": "string" }, + "public_ip_address": { "type": "string" }, + "public_ips": {}, + "public_network_access": { "type": "string" }, + "region": { "type": "string" }, + "resource_group": { "type": "string" }, + "resource_id": { "type": "string" }, + "resource_vpc_config": {}, + "resources_vpc_config": {}, + "restrict_public_buckets": { "type": "boolean" }, + "scheme": { "type": "string" }, + "security_groups": {}, + "service_name": { "type": "string" }, + "storage_account_name": { "type": "string" }, + "tags": {}, + "target_group_arn": { "type": "string" }, + "target_health_descriptions": {}, + "task_arn": { "type": "string" }, + "task_definition": {}, + "task_definition_arn": { "type": "string" }, + "user-groups": {}, + "user_id": { "type": "string" }, + "users": {}, + "vpc_id": { "type": "string" }, + "vpc_options": {}, + "vpc_security_group_ids": {}, + "vpc_security_groups": {} + } + }, + "IngestersCompliance": { + "type": "object", + "properties": { + "compliance_check_type": { "type": "string" }, + "description": { "type": "string" }, + "node_id": { "type": "string" }, + "node_type": { "type": "string" }, + "remediation_ansible": { "type": "string" }, + "remediation_puppet": { "type": "string" }, + "remediation_script": { "type": "string" }, + "resource": { "type": "string" }, + "scan_id": { "type": "string" }, + "status": { "type": "string" }, + "test_category": { "type": "string" }, + "test_desc": { "type": "string" }, + "test_number": { "type": "string" }, + "test_rationale": { "type": "string" }, + "test_severity": { "type": "string" }, + "type": { "type": "string" } + } + }, + "IngestersComplianceScanStatus": { + "type": "object", + "properties": { + "scan_id": { "type": "string" }, + "scan_message": { "type": "string" }, + "scan_status": { "type": "string" } + } + }, + "IngestersComplianceStats": { + "type": "object", + "properties": { + "alarm": { "type": "integer" }, + "compliance_percentage": { "type": "number" }, + "error": { "type": "integer" }, + "info": { "type": "integer" }, + "ok": { "type": "integer" }, + "skip": { "type": "integer" } + } + }, + "IngestersMalware": { + "type": "object", + "properties": { + "class": { "type": "string" }, + "complete_filename": { "type": "string" }, + "file_sev_score": { "type": "number" }, + "file_severity": { "type": "string" }, + "image_layer_id": { "type": "string" }, + "meta": { "type": "array", "items": { "type": "string" }, "nullable": true }, + "meta_rules": { "$ref": "#/components/schemas/IngestersMetaRules" }, + "rule_name": { "type": "string" }, + "scan_id": { "type": "string" }, + "severity_score": { "type": "integer" }, + "strings_to_match": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "summary": { "type": "string" }, + "timestamp": { "type": "string", "format": "date-time" } + } + }, + "IngestersMalwareScanStatus": { + "type": "object", + "properties": { + "@timestamp": { "type": "string", "format": "date-time" }, + "scan_id": { "type": "string" }, + "scan_message": { "type": "string" }, + "scan_status": { "type": "string" } + } + }, + "IngestersMetaRules": { + "type": "object", + "properties": { + "author": { "type": "string" }, + "date": { "type": "string" }, + "description": { "type": "string" }, + "file_severity": { "type": "string" }, + "filetype": { "type": "string" }, + "info": { "type": "string" }, + "reference": { "type": "string" }, + "rule_id": { "type": "string" }, + "rule_name": { "type": "string" }, + "version": { "type": "string" } + } + }, + "IngestersReportIngestionData": { + "required": [ + "process_batch", + "host_batch", + "container_batch", + "pod_batch", + "container_image_batch", + "kubernetes_cluster_batch", + "process_edges_batch", + "container_edges_batch", + "container_process_edge_batch", + "pod_edges_batch", + "pod_host_edges_batch", + "endpoint_edges_batch", + "container_image_edge_batch", + "kubernetes_cluster_edge_batch", + "hosts", + "num_merged" + ], + "type": "object", + "properties": { + "container_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "container_edges_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "container_image_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "container_image_edge_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "container_process_edge_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "endpoint_edges_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "host_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "hosts": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "kubernetes_cluster_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "kubernetes_cluster_edge_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "num_merged": { "type": "integer" }, + "pod_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "pod_edges_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "pod_host_edges_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "process_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + }, + "process_edges_batch": { + "type": "array", + "items": { "type": "object", "additionalProperties": {} }, + "nullable": true + } + } + }, + "IngestersSecret": { + "type": "object", + "properties": { + "ImageLayerId": { "type": "string" }, + "Match": { + "type": "object", + "properties": { + "full_filename": { "type": "string" }, + "matched_content": { "type": "string" }, + "relative_ending_index": { "type": "integer" }, + "relative_starting_index": { "type": "integer" }, + "starting_index": { "type": "integer" } + } + }, + "Rule": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "name": { "type": "string" }, + "part": { "type": "string" }, + "signature_to_match": { "type": "string" } + } + }, + "Severity": { + "type": "object", + "properties": { "level": { "type": "string" }, "score": { "type": "number" } } + }, + "scan_id": { "type": "string" } + } + }, + "IngestersSecretScanStatus": { + "type": "object", + "properties": { + "scan_id": { "type": "string" }, + "scan_message": { "type": "string" }, + "scan_status": { "type": "string" } + } + }, + "IngestersVulnerability": { + "type": "object", + "properties": { + "cisa_kev": { "type": "boolean" }, + "cve_attack_vector": { "type": "string" }, + "cve_caused_by_package": { "type": "string" }, + "cve_caused_by_package_path": { "type": "string" }, + "cve_container_layer": { "type": "string" }, + "cve_cvss_score": { "type": "number" }, + "cve_description": { "type": "string" }, + "cve_fixed_in": { "type": "string" }, + "cve_id": { "type": "string" }, + "cve_link": { "type": "string" }, + "cve_overall_score": { "type": "number" }, + "cve_severity": { "type": "string" }, + "cve_type": { "type": "string" }, + "epss_score": { "type": "number" }, + "exploit_poc": { "type": "string" }, + "exploitability_score": { "type": "integer" }, + "has_live_connection": { "type": "boolean" }, + "init_exploitability_score": { "type": "integer" }, + "namespace": { "type": "string" }, + "parsed_attack_vector": { "type": "string" }, + "scan_id": { "type": "string" }, + "urls": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "IngestersVulnerabilityScanStatus": { + "type": "object", + "properties": { + "scan_id": { "type": "string" }, + "scan_message": { "type": "string" }, + "scan_status": { "type": "string" } + } + }, + "LookupLookupFilter": { + "required": ["in_field_filter", "node_ids", "window"], + "type": "object", + "properties": { + "in_field_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "node_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "ModelAPIAuthRequest": { + "required": ["api_token"], + "type": "object", + "properties": { "api_token": { "type": "string" } } + }, + "ModelAPITokenResponse": { + "type": "object", + "properties": { + "api_token": { "type": "string" }, + "company_id": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "created_by_user_id": { "type": "integer" }, + "id": { "type": "integer" }, + "name": { "type": "string" } + } + }, + "ModelAddGenerativeAiBedrockIntegration": { + "required": ["aws_region", "model_id"], + "type": "object", + "properties": { + "aws_access_key": { "type": "string" }, + "aws_region": { + "enum": [ + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2", + "af-south-1", + "ap-east-1", + "ap-south-1", + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "ap-southeast-1", + "ap-southeast-2", + "ap-southeast-3", + "ca-central-1", + "eu-central-1", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "eu-south-1", + "eu-north-1", + "me-south-1", + "me-central-1", + "sa-east-1", + "us-gov-east-1", + "us-gov-west-1" + ], + "type": "string" + }, + "aws_secret_key": { "type": "string" }, + "model_id": { + "enum": [ + "anthropic.claude-v2", + "anthropic.claude-instant-v1", + "amazon.titan-text-lite-v1", + "amazon.titan-text-express-v1", + "ai21.j2-ultra-v1", + "ai21.j2-mid-v1", + "meta.llama2-13b-chat-v1", + "cohere.command-text-v14", + "cohere.command-light-text-v14" + ], + "type": "string" + }, + "use_iam_role": { "type": "boolean" } + } + }, + "ModelAddGenerativeAiOpenAIIntegration": { + "required": ["api_key", "model_id"], + "type": "object", + "properties": { + "api_key": { "type": "string" }, + "model_id": { "enum": ["gpt-4"], "type": "string" } + } + }, + "ModelAddScheduledTaskRequest": { + "required": ["action", "node_ids", "filters", "scan_config", "benchmark_types"], + "type": "object", + "properties": { + "action": { + "enum": [ + "SecretScan", + "VulnerabilityScan", + "MalwareScan", + "ComplianceScan", + "CloudComplianceScan" + ], + "type": "string" + }, + "benchmark_types": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBenchmarkType" }, + "nullable": true + }, + "cron_expr": { "type": "string" }, + "deepfence_system_scan": { "type": "boolean" }, + "description": { "type": "string" }, + "filters": { "$ref": "#/components/schemas/ModelScanFilter" }, + "is_priority": { "type": "boolean" }, + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + }, + "scan_config": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModelVulnerabilityScanConfigLanguage" + }, + "nullable": true + } + } + }, + "ModelAgentID": { + "required": ["node_id", "available_workload"], + "type": "object", + "properties": { + "available_workload": { "type": "integer" }, + "node_id": { "type": "string" }, + "node_type": { "type": "string" } + } + }, + "ModelAgentPluginDisable": { + "required": ["plugin_name", "node_id"], + "type": "object", + "properties": { + "node_id": { "type": "string" }, + "plugin_name": { "type": "string" } + } + }, + "ModelAgentPluginEnable": { + "required": ["plugin_name", "version", "node_id"], + "type": "object", + "properties": { + "node_id": { "type": "string" }, + "plugin_name": { "type": "string" }, + "version": { "type": "string" } + } + }, + "ModelAgentUpgrade": { + "required": ["version", "node_ids"], + "type": "object", + "properties": { + "node_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "version": { "type": "string" } + } + }, + "ModelBasicNode": { + "required": ["node_id", "name", "node_type", "host_name"], + "type": "object", + "properties": { + "host_name": { "type": "string" }, + "name": { "type": "string" }, + "node_id": { "type": "string" }, + "node_type": { "type": "string" } + } + }, + "ModelBenchmarkType": { + "enum": [ + "hipaa", + "gdpr", + "pci", + "nist", + "cis", + "soc_2", + "nsa-cisa", + "aws_foundational_security" + ], + "type": "string" + }, + "ModelBulkDeleteReportReq": { + "required": ["report_ids"], + "type": "object", + "properties": { + "report_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + } + } + }, + "ModelBulkDeleteScansRequest": { + "required": ["scan_type", "filters"], + "type": "object", + "properties": { + "filters": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "scan_type": { + "enum": [ + "Secret", + "Vulnerability", + "Malware", + "Compliance", + "CloudCompliance" + ], + "type": "string" + } + } + }, + "ModelCloudAccountDeleteReq": { + "required": ["node_ids"], + "type": "object", + "properties": { + "node_ids": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelCloudAccountRefreshReq": { + "required": ["node_ids"], + "type": "object", + "properties": { + "node_ids": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelCloudCompliance": { + "required": [ + "count", + "reason", + "resource", + "status", + "region", + "account_id", + "group", + "service", + "title", + "compliance_check_type", + "cloud_provider", + "node_name", + "node_id", + "masked", + "updated_at", + "type", + "control_id", + "description", + "severity" + ], + "type": "object", + "properties": { + "account_id": { "type": "string" }, + "cloud_provider": { "type": "string" }, + "compliance_check_type": { + "enum": [ + "hipaa", + "gdpr", + "pci", + "nist", + "cis", + "soc_2", + "nsa-cisa", + "aws_foundational_security" + ], + "type": "string" + }, + "control_id": { "type": "string" }, + "count": { "type": "integer" }, + "description": { "type": "string" }, + "group": { "type": "string" }, + "masked": { "type": "boolean" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "reason": { "type": "string" }, + "region": { "type": "string" }, + "resource": { "type": "string" }, + "resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBasicNode" }, + "nullable": true + }, + "service": { "type": "string" }, + "severity": { "type": "string" }, + "status": { + "enum": ["alarm", "info", "ok", "skip", "delete"], + "type": "string" + }, + "title": { "type": "string" }, + "type": { "type": "string" }, + "updated_at": { "type": "integer" } + } + }, + "ModelCloudComplianceControl": { + "type": "object", + "properties": { + "active": { "type": "boolean" }, + "category": { "type": "string" }, + "category_hierarchy": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "category_hierarchy_short": { "type": "string" }, + "cloud_provider": { "type": "string" }, + "compliance_type": { "type": "string" }, + "control_id": { "type": "string" }, + "description": { "type": "string" }, + "disabled": { "type": "boolean" }, + "documentation": { "type": "string" }, + "executable": { "type": "boolean" }, + "node_id": { "type": "string" }, + "parent_control_hierarchy": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "service": { "type": "string" }, + "title": { "type": "string" } + } + }, + "ModelCloudComplianceScanResult": { + "required": [ + "docker_container_name", + "docker_image_name", + "host_name", + "kubernetes_cluster_name", + "node_id", + "node_name", + "node_type", + "scan_id", + "updated_at", + "created_at", + "cloud_account_id", + "benchmark_type", + "status_counts", + "compliance_percentage", + "compliances" + ], + "type": "object", + "properties": { + "benchmark_type": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cloud_account_id": { "type": "string" }, + "compliance_percentage": { "type": "number" }, + "compliances": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudCompliance" }, + "nullable": true + }, + "created_at": { "type": "integer", "format": "int64" }, + "docker_container_name": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "host_name": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "status_counts": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "updated_at": { "type": "integer", "format": "int64" } + } + }, + "ModelCloudNodeAccountInfo": { + "type": "object", + "properties": { + "account_name": { "type": "string" }, + "active": { "type": "boolean" }, + "cloud_provider": { + "enum": ["aws", "gcp", "azure", "aws_org", "gcp_org", "azure_org"], + "type": "string" + }, + "compliance_percentage": { "type": "number" }, + "host_node_id": { "type": "string" }, + "last_scan_id": { "type": "string" }, + "last_scan_status": { "type": "string" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "refresh_message": { "type": "string" }, + "refresh_metadata": { "type": "string" }, + "refresh_status": { "type": "string" }, + "refresh_status_map": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "scan_status_map": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "version": { "type": "string" } + } + }, + "ModelCloudNodeAccountRegisterReq": { + "required": [ + "node_id", + "host_node_id", + "account_id", + "cloud_provider", + "version", + "installation_id" + ], + "type": "object", + "properties": { + "account_id": { "type": "string" }, + "account_name": { "type": "string" }, + "cloud_provider": { "enum": ["aws", "gcp", "azure"], "type": "string" }, + "host_node_id": { "type": "string" }, + "initial_request": { "type": "boolean" }, + "installation_id": { "type": "string" }, + "is_organization_deployment": { "type": "boolean" }, + "monitored_accounts": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudNodeMonitoredAccount" }, + "nullable": true + }, + "node_id": { "type": "string" }, + "organization_account_id": { "type": "string" }, + "persistent_volume_supported": { "type": "boolean" }, + "version": { "type": "string" } + } + }, + "ModelCloudNodeAccountsListReq": { + "required": ["cloud_provider", "window"], + "type": "object", + "properties": { + "cloud_provider": { + "enum": [ + "aws", + "gcp", + "azure", + "linux", + "kubernetes", + "aws_org", + "gcp_org", + "azure_org" + ], + "type": "string" + }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "ModelCloudNodeAccountsListResp": { + "required": ["cloud_node_accounts_info", "total"], + "type": "object", + "properties": { + "cloud_node_accounts_info": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudNodeAccountInfo" }, + "nullable": true + }, + "total": { "type": "integer" } + } + }, + "ModelCloudNodeComplianceControl": { + "type": "object", + "properties": { + "category_hierarchy": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "category_hierarchy_short": { "type": "string" }, + "compliance_type": { "type": "string" }, + "control_id": { "type": "string" }, + "description": { "type": "string" }, + "enabled": { "type": "boolean" }, + "node_id": { "type": "string" }, + "problem_title": { "type": "string" }, + "service": { "type": "string" }, + "title": { "type": "string" } + } + }, + "ModelCloudNodeControlReq": { + "required": ["cloud_provider", "compliance_type"], + "type": "object", + "properties": { + "cloud_provider": { + "enum": ["aws", "gcp", "azure", "linux", "kubernetes"], + "type": "string" + }, + "compliance_type": { + "enum": [ + "hipaa", + "gdpr", + "pci", + "nist", + "cis", + "soc_2", + "nsa-cisa", + "aws_foundational_security" + ], + "type": "string" + }, + "node_id": { "type": "string" } + } + }, + "ModelCloudNodeControlResp": { + "type": "object", + "properties": { + "controls": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudNodeComplianceControl" }, + "nullable": true + } + } + }, + "ModelCloudNodeEnableDisableReq": { + "type": "object", + "properties": { + "control_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "node_id": { "type": "string" } + } + }, + "ModelCloudNodeMonitoredAccount": { + "required": ["node_id", "account_id"], + "type": "object", + "properties": { + "account_id": { "type": "string" }, + "account_name": { "type": "string" }, + "node_id": { "type": "string" } + } + }, + "ModelCloudNodeProvidersListResp": { + "required": ["providers"], + "type": "object", + "properties": { + "providers": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelPostureProvider" }, + "nullable": true + } + } + }, + "ModelCloudResource": { + "required": [ + "node_id", + "node_name", + "node_type", + "type_label", + "account_id", + "cloud_provider", + "cloud_region", + "cloud_compliances_count", + "cloud_warn_alarm_count", + "cloud_compliance_scan_status", + "cloud_compliance_latest_scan_id" + ], + "type": "object", + "properties": { + "account_id": { "type": "string" }, + "cloud_compliance_latest_scan_id": { "type": "string" }, + "cloud_compliance_scan_status": { "type": "string" }, + "cloud_compliances_count": { "type": "integer" }, + "cloud_provider": { "enum": ["aws", "gcp", "azure"], "type": "string" }, + "cloud_region": { "type": "string" }, + "cloud_warn_alarm_count": { "type": "integer" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "type_label": { "type": "string" } + } + }, + "ModelCompliance": { + "required": [ + "test_category", + "test_number", + "description", + "remediation_script", + "remediation_ansible", + "remediation_puppet", + "resource", + "test_rationale", + "test_severity", + "test_desc", + "status", + "compliance_check_type", + "node_id", + "node_type", + "masked", + "updated_at", + "rule_id" + ], + "type": "object", + "properties": { + "compliance_check_type": { + "enum": ["hipaa", "gdpr", "pci", "nist"], + "type": "string" + }, + "description": { "type": "string" }, + "masked": { "type": "boolean" }, + "node_id": { "type": "string" }, + "node_type": { "type": "string" }, + "remediation_ansible": { "type": "string" }, + "remediation_puppet": { "type": "string" }, + "remediation_script": { "type": "string" }, + "resource": { "type": "string" }, + "resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBasicNode" }, + "nullable": true + }, + "rule_id": { "type": "string" }, + "status": { "enum": ["pass", "warn", "info", "note"], "type": "string" }, + "test_category": { "type": "string" }, + "test_desc": { "type": "string" }, + "test_number": { "type": "string" }, + "test_rationale": { "type": "string" }, + "test_severity": { "type": "string" }, + "updated_at": { "type": "integer" } + } + }, + "ModelComplianceRule": { + "required": [ + "test_category", + "test_number", + "description", + "test_rationale", + "test_severity", + "test_desc", + "masked", + "updated_at" + ], + "type": "object", + "properties": { + "description": { "type": "string" }, + "masked": { "type": "boolean" }, + "test_category": { "type": "string" }, + "test_desc": { "type": "string" }, + "test_number": { "type": "string" }, + "test_rationale": { "type": "string" }, + "test_severity": { "type": "string" }, + "updated_at": { "type": "integer" } + } + }, + "ModelComplianceScanInfo": { + "required": [ + "scan_id", + "status", + "status_message", + "updated_at", + "created_at", + "node_id", + "node_type", + "severity_counts", + "node_name", + "benchmark_types", + "cloud_provider" + ], + "type": "object", + "properties": { + "benchmark_types": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cloud_provider": { "type": "string" }, + "created_at": { "type": "integer", "format": "int64" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "severity_counts": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "status": { + "enum": [ + "COMPLETE", + "STARTING", + "IN_PROGRESS", + "ERROR", + "CANCEL_PENDING", + "CANCELLING", + "CANCELLED", + "DELETE_PENDING" + ], + "type": "string" + }, + "status_message": { "type": "string" }, + "updated_at": { "type": "integer", "format": "int64" } + } + }, + "ModelComplianceScanResult": { + "required": [ + "docker_container_name", + "docker_image_name", + "host_name", + "kubernetes_cluster_name", + "node_id", + "node_name", + "node_type", + "scan_id", + "updated_at", + "created_at", + "cloud_account_id", + "benchmark_type", + "status_counts", + "compliance_percentage", + "compliances" + ], + "type": "object", + "properties": { + "benchmark_type": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cloud_account_id": { "type": "string" }, + "compliance_percentage": { "type": "number" }, + "compliances": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCompliance" }, + "nullable": true + }, + "created_at": { "type": "integer", "format": "int64" }, + "docker_container_name": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "host_name": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "status_counts": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "updated_at": { "type": "integer", "format": "int64" } + } + }, + "ModelComplianceScanResultControlGroup": { + "type": "object", + "properties": { + "benchmark_types": { "type": "array", "items": { "type": "string" } }, + "counts": { "type": "object", "additionalProperties": { "type": "integer" } }, + "problem_title": { "type": "string" } + } + }, + "ModelComplianceScanResultsGroupResp": { + "type": "object", + "properties": { + "groups": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ModelComplianceScanResultControlGroup" + }, + "nullable": true + } + } + }, + "ModelComplianceScanStatusResp": { + "required": ["statuses"], + "type": "object", + "properties": { + "statuses": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelComplianceScanInfo" }, + "nullable": true + } + } + }, + "ModelComplianceScanTriggerReq": { + "required": ["node_ids", "filters", "benchmark_types"], + "type": "object", + "properties": { + "benchmark_types": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBenchmarkType" }, + "nullable": true + }, + "deepfence_system_scan": { "type": "boolean" }, + "filters": { "$ref": "#/components/schemas/ModelScanFilter" }, + "is_priority": { "type": "boolean" }, + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + } + } + }, + "ModelComplinaceScanResultsGroupReq": { + "required": ["scan_id", "fields_filter"], + "type": "object", + "properties": { + "fields_filter": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "scan_id": { "type": "string" } + } + }, + "ModelConnection": { + "type": "object", + "properties": { + "count": { "type": "integer" }, + "ips": { "type": "array", "items": {}, "nullable": true }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" } + } + }, + "ModelContainer": { + "required": [ + "node_id", + "node_name", + "docker_container_name", + "image", + "processes", + "docker_labels", + "host_name", + "docker_container_command", + "docker_container_state", + "docker_container_state_human", + "docker_container_network_mode", + "docker_container_networks", + "docker_container_ips", + "docker_container_created", + "docker_container_ports", + "uptime", + "cpu_max", + "cpu_usage", + "memory_max", + "memory_usage", + "vulnerabilities_count", + "vulnerability_scan_status", + "vulnerability_latest_scan_id", + "secrets_count", + "secret_scan_status", + "secret_latest_scan_id", + "malwares_count", + "malware_scan_status", + "malware_latest_scan_id", + "kubernetes_cluster_name", + "kubernetes_cluster_id", + "kubernetes_namespace", + "is_deepfence_system" + ], + "type": "object", + "properties": { + "cpu_max": { "type": "number" }, + "cpu_usage": { "type": "number" }, + "docker_container_command": { "type": "string" }, + "docker_container_created": { "type": "string" }, + "docker_container_ips": { "type": "array", "items": {}, "nullable": true }, + "docker_container_name": { "type": "string" }, + "docker_container_network_mode": { "type": "string" }, + "docker_container_networks": { "type": "string" }, + "docker_container_ports": { "type": "string" }, + "docker_container_state": { "type": "string" }, + "docker_container_state_human": { "type": "string" }, + "docker_labels": { + "type": "object", + "additionalProperties": {}, + "nullable": true + }, + "host_name": { "type": "string" }, + "image": { "$ref": "#/components/schemas/ModelContainerImage" }, + "is_deepfence_system": { "type": "boolean" }, + "kubernetes_cluster_id": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "kubernetes_namespace": { "type": "string" }, + "malware_latest_scan_id": { "type": "string" }, + "malware_scan_status": { "type": "string" }, + "malwares_count": { "type": "integer" }, + "memory_max": { "type": "integer" }, + "memory_usage": { "type": "integer" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "processes": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelProcess" }, + "nullable": true + }, + "secret_latest_scan_id": { "type": "string" }, + "secret_scan_status": { "type": "string" }, + "secrets_count": { "type": "integer" }, + "uptime": { "type": "integer" }, + "vulnerabilities_count": { "type": "integer" }, + "vulnerability_latest_scan_id": { "type": "string" }, + "vulnerability_scan_status": { "type": "string" } + } + }, + "ModelContainerImage": { + "required": [ + "node_id", + "image_node_id", + "node_name", + "docker_image_name", + "docker_image_tag", + "docker_image_size", + "docker_image_created_at", + "docker_image_virtual_size", + "docker_image_id", + "docker_image_tag_list", + "vulnerabilities_count", + "vulnerability_scan_status", + "vulnerability_latest_scan_id", + "secrets_count", + "secret_scan_status", + "secret_latest_scan_id", + "malwares_count", + "malware_scan_status", + "malware_latest_scan_id", + "containers", + "is_deepfence_system" + ], + "type": "object", + "properties": { + "containers": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainer" }, + "nullable": true + }, + "docker_image_created_at": { "type": "string" }, + "docker_image_id": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "docker_image_size": { "type": "string" }, + "docker_image_tag": { "type": "string" }, + "docker_image_tag_list": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "docker_image_virtual_size": { "type": "string" }, + "image_node_id": { "type": "string" }, + "is_deepfence_system": { "type": "boolean" }, + "malware_latest_scan_id": { "type": "string" }, + "malware_scan_status": { "type": "string" }, + "malwares_count": { "type": "integer" }, + "metadata": { "type": "object", "additionalProperties": {}, "nullable": true }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "secret_latest_scan_id": { "type": "string" }, + "secret_scan_status": { "type": "string" }, + "secrets_count": { "type": "integer" }, + "vulnerabilities_count": { "type": "integer" }, + "vulnerability_latest_scan_id": { "type": "string" }, + "vulnerability_scan_status": { "type": "string" } + } + }, + "ModelDeleteIntegrationReq": { + "required": ["integration_ids"], + "type": "object", + "properties": { + "integration_ids": { + "type": "array", + "items": { "type": "integer" }, + "nullable": true + } + } + }, + "ModelDeleteRegistryBulkReq": { + "required": ["registry_ids"], + "type": "object", + "properties": { + "registry_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + } + } + }, + "ModelDownloadReportResponse": { + "type": "object", + "properties": { "url_link": { "type": "string" } } + }, + "ModelDownloadScanResultsResponse": { + "type": "object", + "properties": { + "scan_info": { "$ref": "#/components/schemas/ModelScanResultsCommon" }, + "scan_results": { "type": "array", "items": {}, "nullable": true } + } + }, + "ModelEmailConfigurationAdd": { + "type": "object", + "properties": { + "amazon_access_key": { "type": "string" }, + "amazon_secret_key": { "type": "string" }, + "apikey": { "type": "string" }, + "created_by_user_id": { "type": "integer" }, + "email_id": { "type": "string" }, + "email_provider": { "type": "string" }, + "password": { "type": "string" }, + "port": { "type": "string" }, + "ses_region": { "type": "string" }, + "smtp": { "type": "string" } + } + }, + "ModelEmailConfigurationResp": { + "type": "object", + "properties": { + "created_by_user_id": { "type": "integer" }, + "email_id": { "type": "string" }, + "email_provider": { "type": "string" }, + "id": { "type": "integer" }, + "port": { "type": "string" }, + "ses_region": { "type": "string" }, + "smtp": { "type": "string" } + } + }, + "ModelExportReport": { + "type": "object", + "properties": { + "created_at": { "type": "integer" }, + "filters": { "type": "string" }, + "from_timestamp": { "type": "integer" }, + "report_id": { "type": "string" }, + "status": { "type": "string" }, + "status_message": { "type": "string" }, + "storage_path": { "type": "string" }, + "to_timestamp": { "type": "integer" }, + "type": { "type": "string" }, + "updated_at": { "type": "integer" }, + "url": { "type": "string" } + } + }, + "ModelFetchWindow": { + "required": ["offset", "size"], + "type": "object", + "properties": { "offset": { "type": "integer" }, "size": { "type": "integer" } } + }, + "ModelFiltersReq": { + "required": ["filters"], + "type": "object", + "properties": { + "filters": { "type": "array", "items": { "type": "string" }, "nullable": true }, + "having": { "type": "object", "additionalProperties": {}, "nullable": true } + } + }, + "ModelFiltersResult": { + "required": ["filters"], + "type": "object", + "properties": { + "filters": { + "type": "object", + "additionalProperties": { "type": "array", "items": { "type": "string" } }, + "nullable": true + } + } + }, + "ModelGenerateLicenseRequest": { + "required": ["first_name", "last_name", "email", "company", "resend_email"], + "type": "object", + "properties": { + "company": { "type": "string" }, + "email": { "type": "string" }, + "first_name": { "type": "string" }, + "last_name": { "type": "string" }, + "resend_email": { "type": "boolean" } + } + }, + "ModelGenerateLicenseResponse": { + "required": ["message", "success"], + "type": "object", + "properties": { + "generate_license_link": { "type": "string" }, + "message": { "type": "string" }, + "success": { "type": "boolean" } + } + }, + "ModelGenerateReportReq": { + "required": ["report_type"], + "type": "object", + "properties": { + "filters": { "$ref": "#/components/schemas/UtilsReportFilters" }, + "from_timestamp": { "type": "integer" }, + "options": { "$ref": "#/components/schemas/UtilsReportOptions" }, + "report_type": { "enum": ["pdf", "xlsx", "sbom"], "type": "string" }, + "to_timestamp": { "type": "integer" }, + "zipped_report": { "type": "boolean" } + } + }, + "ModelGenerateReportResp": { + "type": "object", + "properties": { "report_id": { "type": "string" } } + }, + "ModelGenerativeAiIntegrationCloudPostureRequest": { + "required": [ + "query_type", + "remediation_format", + "title", + "compliance_check_type", + "cloud_provider" + ], + "type": "object", + "properties": { + "cloud_provider": { "type": "string" }, + "compliance_check_type": { "type": "string" }, + "group": { "type": "string" }, + "integration_id": { "type": "integer" }, + "query_type": { "enum": ["remediation"], "type": "string" }, + "remediation_format": { + "enum": ["all", "cli", "pulumi", "terraform"], + "type": "string" + }, + "service": { "type": "string" }, + "title": { "type": "string" } + } + }, + "ModelGenerativeAiIntegrationKubernetesPostureRequest": { + "required": [ + "query_type", + "remediation_format", + "description", + "compliance_check_type" + ], + "type": "object", + "properties": { + "compliance_check_type": { "type": "string" }, + "description": { "type": "string" }, + "integration_id": { "type": "integer" }, + "query_type": { "enum": ["remediation"], "type": "string" }, + "remediation_format": { + "enum": ["all", "cli", "pulumi", "terraform"], + "type": "string" + } + } + }, + "ModelGenerativeAiIntegrationLinuxPostureRequest": { + "required": [ + "query_type", + "remediation_format", + "description", + "test_number", + "compliance_check_type" + ], + "type": "object", + "properties": { + "compliance_check_type": { "type": "string" }, + "description": { "type": "string" }, + "integration_id": { "type": "integer" }, + "query_type": { "enum": ["remediation"], "type": "string" }, + "remediation_format": { + "enum": ["all", "cli", "pulumi", "terraform"], + "type": "string" + }, + "test_number": { "type": "string" } + } + }, + "ModelGenerativeAiIntegrationListResponse": { + "type": "object", + "properties": { + "default_integration": { "type": "boolean" }, + "id": { "type": "integer" }, + "integration_type": { "type": "string" }, + "label": { "type": "string" }, + "last_error_msg": { "type": "string" } + } + }, + "ModelGenerativeAiIntegrationMalwareRequest": { + "required": ["query_type", "rule_name", "info"], + "type": "object", + "properties": { + "info": { "type": "string" }, + "integration_id": { "type": "integer" }, + "query_type": { "enum": ["remediation"], "type": "string" }, + "rule_name": { "type": "string" } + } + }, + "ModelGenerativeAiIntegrationSecretRequest": { + "required": ["query_type", "name"], + "type": "object", + "properties": { + "integration_id": { "type": "integer" }, + "name": { "type": "string" }, + "query_type": { "enum": ["remediation"], "type": "string" } + } + }, + "ModelGenerativeAiIntegrationVulnerabilityRequest": { + "required": [ + "query_type", + "remediation_format", + "cve_id", + "cve_type", + "cve_caused_by_package" + ], + "type": "object", + "properties": { + "cve_caused_by_package": { "type": "string" }, + "cve_id": { "type": "string" }, + "cve_type": { "type": "string" }, + "integration_id": { "type": "integer" }, + "query_type": { "enum": ["remediation"], "type": "string" }, + "remediation_format": { + "enum": ["all", "cli", "pulumi", "terraform"], + "type": "string" + } + } + }, + "ModelGetAgentBinaryDownloadURLResponse": { + "type": "object", + "properties": { + "agent_binary_amd64_download_url": { "type": "string" }, + "agent_binary_arm64_download_url": { "type": "string" }, + "start_agent_script_download_url": { "type": "string" }, + "uninstall_agent_script_download_url": { "type": "string" } + } + }, + "ModelGetAuditLogsRequest": { + "required": ["window"], + "type": "object", + "properties": { "window": { "$ref": "#/components/schemas/ModelFetchWindow" } } + }, + "ModelGraphResult": { + "required": ["nodes", "edges"], + "type": "object", + "properties": { + "edges": { "$ref": "#/components/schemas/DetailedTopologyConnectionSummaries" }, + "nodes": { "$ref": "#/components/schemas/DetailedNodeSummaries" } + } + }, + "ModelHost": { + "required": [ + "node_id", + "host_name", + "node_name", + "containers", + "processes", + "pods", + "container_images", + "kernel_version", + "uptime", + "version", + "agent_running", + "is_console_vm", + "local_cidr", + "os", + "local_networks", + "instance_id", + "cloud_provider", + "cloud_account_id", + "instance_type", + "public_ip", + "private_ip", + "availability_zone", + "kernel_id", + "cloud_region", + "resource_group", + "cpu_max", + "cpu_usage", + "memory_max", + "memory_usage", + "vulnerabilities_count", + "vulnerability_scan_status", + "vulnerability_latest_scan_id", + "secrets_count", + "secret_scan_status", + "secret_latest_scan_id", + "malwares_count", + "malware_scan_status", + "malware_latest_scan_id", + "compliances_count", + "compliance_scan_status", + "compliance_latest_scan_id", + "exploitable_vulnerabilities_count", + "exploitable_secrets_count", + "exploitable_malwares_count", + "warn_alarm_count", + "cloud_warn_alarm_count", + "inbound_connections", + "outbound_connections" + ], + "type": "object", + "properties": { + "agent_running": { "type": "boolean" }, + "availability_zone": { "type": "string" }, + "cloud_account_id": { "type": "string" }, + "cloud_provider": { "type": "string" }, + "cloud_region": { "type": "string" }, + "cloud_warn_alarm_count": { "type": "integer" }, + "compliance_latest_scan_id": { "type": "string" }, + "compliance_scan_status": { "type": "string" }, + "compliances_count": { "type": "integer" }, + "container_images": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainerImage" }, + "nullable": true + }, + "containers": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainer" }, + "nullable": true + }, + "cpu_max": { "type": "number" }, + "cpu_usage": { "type": "number" }, + "exploitable_malwares_count": { "type": "integer" }, + "exploitable_secrets_count": { "type": "integer" }, + "exploitable_vulnerabilities_count": { "type": "integer" }, + "host_name": { "type": "string" }, + "inbound_connections": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelConnection" }, + "nullable": true + }, + "instance_id": { "type": "string" }, + "instance_type": { "type": "string" }, + "is_console_vm": { "type": "boolean" }, + "kernel_id": { "type": "string" }, + "kernel_version": { "type": "string" }, + "local_cidr": { "type": "array", "items": {}, "nullable": true }, + "local_networks": { "type": "array", "items": {}, "nullable": true }, + "malware_latest_scan_id": { "type": "string" }, + "malware_scan_status": { "type": "string" }, + "malwares_count": { "type": "integer" }, + "memory_max": { "type": "integer" }, + "memory_usage": { "type": "integer" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "os": { "type": "string" }, + "outbound_connections": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelConnection" }, + "nullable": true + }, + "pods": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelPod" }, + "nullable": true + }, + "private_ip": { "type": "array", "items": {}, "nullable": true }, + "processes": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelProcess" }, + "nullable": true + }, + "public_ip": { "type": "array", "items": {}, "nullable": true }, + "resource_group": { "type": "string" }, + "secret_latest_scan_id": { "type": "string" }, + "secret_scan_status": { "type": "string" }, + "secrets_count": { "type": "integer" }, + "uptime": { "type": "integer" }, + "version": { "type": "string" }, + "vulnerabilities_count": { "type": "integer" }, + "vulnerability_latest_scan_id": { "type": "string" }, + "vulnerability_scan_status": { "type": "string" }, + "warn_alarm_count": { "type": "integer" } + } + }, + "ModelImageStub": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "images": { "type": "integer" }, + "name": { "type": "string" }, + "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelInitAgentReq": { + "required": ["node_id", "available_workload", "version", "node_type"], + "type": "object", + "properties": { + "available_workload": { "type": "integer" }, + "node_id": { "type": "string" }, + "node_type": { "type": "string" }, + "version": { "type": "string" } + } + }, + "ModelIntegrationAddReq": { + "required": ["integration_type", "notification_type"], + "type": "object", + "properties": { + "config": { "type": "object", "additionalProperties": {}, "nullable": true }, + "filters": { "$ref": "#/components/schemas/ModelIntegrationFilters" }, + "integration_type": { "type": "string" }, + "notification_type": { "type": "string" }, + "send_summary": { "type": "boolean" } + } + }, + "ModelIntegrationFilters": { + "required": ["node_ids"], + "type": "object", + "properties": { + "cloud_provider": { "type": "string" }, + "container_names": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "fields_filters": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + } + } + }, + "ModelIntegrationListResp": { + "type": "object", + "properties": { + "config": { "type": "object", "additionalProperties": {}, "nullable": true }, + "filters": { "$ref": "#/components/schemas/ModelIntegrationFilters" }, + "id": { "type": "integer" }, + "integration_type": { "type": "string" }, + "last_error_msg": { "type": "string" }, + "notification_type": { "type": "string" } + } + }, + "ModelIntegrationUpdateReq": { + "type": "object", + "properties": { + "config": { "type": "object", "additionalProperties": {}, "nullable": true }, + "filters": { "$ref": "#/components/schemas/ModelIntegrationFilters" }, + "id": { "type": "integer" }, + "integration_type": { "type": "string" }, + "notification_type": { "type": "string" }, + "send_summary": { "type": "boolean" } + } + }, + "ModelInviteUserRequest": { + "required": ["email", "role", "action"], + "type": "object", + "properties": { + "action": { + "enum": ["send-invite-email", "get-invite-link"], + "type": "string" + }, + "email": { "type": "string" }, + "role": { + "enum": ["admin", "standard-user", "read-only-user"], + "type": "string" + } + } + }, + "ModelInviteUserResponse": { + "type": "object", + "properties": { + "invite_expiry_hours": { "type": "integer" }, + "invite_url": { "type": "string" }, + "message": { "type": "string" } + } + }, + "ModelKubernetesCluster": { + "required": ["node_id", "node_name", "agent_running", "hosts"], + "type": "object", + "properties": { + "agent_running": { "type": "boolean" }, + "hosts": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelHost" }, + "nullable": true + }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" } + } + }, + "ModelLicense": { + "type": "object", + "properties": { + "current_hosts": { "type": "integer" }, + "deepfence_support_email": { "type": "string" }, + "description": { "type": "string" }, + "end_date": { "type": "string" }, + "is_active": { "type": "boolean" }, + "key": { "type": "string" }, + "license_email": { "type": "string" }, + "license_email_domain": { "type": "string" }, + "license_type": { "type": "string" }, + "message": { "type": "string" }, + "no_of_cloud_accounts": { "type": "integer" }, + "no_of_hosts": { "type": "integer" }, + "no_of_images_in_registry": { "type": "integer" }, + "no_of_registries": { "type": "integer" }, + "notification_threshold_percentage": { "type": "integer" }, + "notification_threshold_updated_at": { "type": "integer" }, + "registry_credentials": { + "$ref": "#/components/schemas/ModelRegistryCredentials" + }, + "start_date": { "type": "string" } + } + }, + "ModelListAgentVersionResp": { + "required": ["versions"], + "type": "object", + "properties": { + "versions": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelLoginRequest": { + "required": ["email", "password"], + "type": "object", + "properties": { "email": { "type": "string" }, "password": { "type": "string" } } + }, + "ModelLoginResponse": { + "required": [ + "access_token", + "refresh_token", + "onboarding_required", + "password_invalidated", + "license_registered", + "license_key", + "email_domain" + ], + "type": "object", + "properties": { + "access_token": { "type": "string" }, + "email_domain": { "type": "string" }, + "license_key": { "type": "string" }, + "license_registered": { "type": "boolean" }, + "onboarding_required": { "type": "boolean" }, + "password_invalidated": { "type": "boolean" }, + "refresh_token": { "type": "string" } + } + }, + "ModelMalware": { + "required": [ + "class", + "complete_filename", + "file_sev_score", + "file_severity", + "image_layer_id", + "node_id", + "rule_id", + "rule_name", + "masked" + ], + "type": "object", + "properties": { + "author": { "type": "string" }, + "class": { "type": "string" }, + "complete_filename": { "type": "string" }, + "date": { "type": "string" }, + "description": { "type": "string" }, + "file_sev_score": { "type": "integer" }, + "file_severity": { + "enum": ["critical", "high", "medium", "low", "unknown"], + "type": "string" + }, + "filetype": { "type": "string" }, + "image_layer_id": { "type": "string" }, + "info": { "type": "string" }, + "masked": { "type": "boolean" }, + "node_id": { "type": "string" }, + "resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBasicNode" }, + "nullable": true + }, + "rule_id": { "type": "string" }, + "rule_name": { "type": "string" }, + "severity_score": { "type": "integer" }, + "strings_to_match": { "type": "array", "items": {}, "nullable": true }, + "summary": { "type": "string" }, + "version": { "type": "string" } + } + }, + "ModelMalwareRule": { + "required": ["masked", "payload", "severity", "summary", "updated_at"], + "type": "object", + "properties": { + "author": { "type": "string" }, + "date": { "type": "string" }, + "description": { "type": "string" }, + "file_severity": { "type": "string" }, + "filetype": { "type": "string" }, + "info": { "type": "string" }, + "masked": { "type": "boolean" }, + "payload": { "type": "string" }, + "reference": { "type": "string" }, + "rule_id": { "type": "string" }, + "rule_name": { "type": "string" }, + "severity": { "type": "string" }, + "summary": { "type": "string" }, + "updated_at": { "type": "integer" }, + "version": { "type": "string" } + } + }, + "ModelMalwareScanResult": { + "required": [ + "docker_container_name", + "docker_image_name", + "host_name", + "kubernetes_cluster_name", + "node_id", + "node_name", + "node_type", + "scan_id", + "updated_at", + "created_at", + "cloud_account_id", + "malwares", + "severity_counts" + ], + "type": "object", + "properties": { + "cloud_account_id": { "type": "string" }, + "created_at": { "type": "integer", "format": "int64" }, + "docker_container_name": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "host_name": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "malwares": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelMalware" }, + "nullable": true + }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "severity_counts": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "updated_at": { "type": "integer", "format": "int64" } + } + }, + "ModelMalwareScanResultClass": { + "required": ["class"], + "type": "object", + "properties": { + "class": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelMalwareScanResultRules": { + "required": ["rules"], + "type": "object", + "properties": { + "rules": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelMalwareScanTriggerReq": { + "required": ["node_ids", "filters"], + "type": "object", + "properties": { + "deepfence_system_scan": { "type": "boolean" }, + "filters": { "$ref": "#/components/schemas/ModelScanFilter" }, + "is_priority": { "type": "boolean" }, + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + } + } + }, + "ModelMessageResponse": { + "required": ["message"], + "type": "object", + "properties": { "message": { "type": "string" } } + }, + "ModelNodeIdentifier": { + "required": ["node_id", "node_type"], + "type": "object", + "properties": { + "node_id": { "type": "string" }, + "node_type": { + "enum": [ + "image", + "host", + "container", + "cloud_account", + "cluster", + "registry", + "pod" + ], + "type": "string" + } + } + }, + "ModelNodesInScanResultRequest": { + "required": ["result_ids", "scan_type"], + "type": "object", + "properties": { + "result_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "scan_type": { + "enum": [ + "SecretScan", + "VulnerabilityScan", + "MalwareScan", + "ComplianceScan", + "CloudComplianceScan" + ], + "type": "string" + } + } + }, + "ModelPasswordResetRequest": { + "required": ["email"], + "type": "object", + "properties": { "email": { "type": "string" } } + }, + "ModelPasswordResetVerifyRequest": { + "required": ["namespace", "code", "password"], + "type": "object", + "properties": { + "code": { "type": "string" }, + "namespace": { "type": "string" }, + "password": { "type": "string" } + } + }, + "ModelPod": { + "required": [ + "node_id", + "node_name", + "kubernetes_namespace", + "pod_name", + "host_name", + "containers", + "processes", + "kubernetes_cluster_name", + "kubernetes_cluster_id", + "kubernetes_state", + "kubernetes_ip", + "kubernetes_is_in_host_network", + "kubernetes_labels", + "kubernetes_created", + "malware_scan_status", + "secret_scan_status", + "vulnerability_scan_status", + "is_deepfence_system" + ], + "type": "object", + "properties": { + "containers": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainer" }, + "nullable": true + }, + "host_name": { "type": "string" }, + "is_deepfence_system": { "type": "boolean" }, + "kubernetes_cluster_id": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "kubernetes_created": { "type": "string" }, + "kubernetes_ip": { "type": "string" }, + "kubernetes_is_in_host_network": { "type": "boolean" }, + "kubernetes_labels": { + "type": "object", + "additionalProperties": {}, + "nullable": true + }, + "kubernetes_namespace": { "type": "string" }, + "kubernetes_state": { "type": "string" }, + "malware_scan_status": { "type": "string" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "pod_name": { "type": "string" }, + "processes": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelProcess" }, + "nullable": true + }, + "secret_scan_status": { "type": "string" }, + "vulnerability_scan_status": { "type": "string" } + } + }, + "ModelPostureProvider": { + "type": "object", + "properties": { + "compliance_percentage": { "type": "number" }, + "name": { "type": "string" }, + "node_count": { "type": "integer" }, + "node_count_inactive": { "type": "integer" }, + "node_label": { "type": "string" }, + "resource_count": { "type": "integer" }, + "scan_count": { "type": "integer" } + } + }, + "ModelProcess": { + "required": [ + "node_id", + "node_name", + "short_name", + "pid", + "cmdline", + "ppid", + "threads", + "cpu_max", + "cpu_usage", + "memory_max", + "memory_usage", + "open_files_count" + ], + "type": "object", + "properties": { + "cmdline": { "type": "string" }, + "cpu_max": { "type": "number" }, + "cpu_usage": { "type": "number" }, + "memory_max": { "type": "integer" }, + "memory_usage": { "type": "integer" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "open_files_count": { "type": "integer" }, + "pid": { "type": "integer" }, + "ppid": { "type": "integer" }, + "short_name": { "type": "string" }, + "threads": { "type": "integer" } + } + }, + "ModelRegisterInvitedUserRequest": { + "required": ["namespace", "first_name", "last_name", "password", "code"], + "type": "object", + "properties": { + "code": { "type": "string" }, + "first_name": { "type": "string" }, + "is_temporary_password": { "type": "boolean" }, + "last_name": { "type": "string" }, + "namespace": { "type": "string" }, + "password": { "type": "string" } + } + }, + "ModelRegisterLicenseRequest": { + "required": ["license_key"], + "type": "object", + "properties": { + "email": { "type": "string" }, + "license_key": { "type": "string" } + } + }, + "ModelRegisterLicenseResponse": { + "required": ["license_key", "email_domain"], + "type": "object", + "properties": { + "email_domain": { "type": "string" }, + "license_key": { "type": "string" } + } + }, + "ModelRegistryAccount": { + "required": ["node_id", "name", "container_images", "registry_type", "syncing"], + "type": "object", + "properties": { + "container_images": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelContainerImage" }, + "nullable": true + }, + "name": { "type": "string" }, + "node_id": { "type": "string" }, + "registry_type": { "type": "string" }, + "syncing": { "type": "boolean" } + } + }, + "ModelRegistryAddReq": { + "required": ["name", "registry_type"], + "type": "object", + "properties": { + "extras": { "type": "object", "additionalProperties": {}, "nullable": true }, + "name": { "type": "string" }, + "non_secret": { + "type": "object", + "additionalProperties": {}, + "nullable": true + }, + "registry_type": { "type": "string" }, + "secret": { "type": "object", "additionalProperties": {}, "nullable": true } + } + }, + "ModelRegistryCountResp": { + "type": "object", + "properties": { "count": { "type": "integer" } } + }, + "ModelRegistryCredentials": { + "type": "object", + "properties": { + "password": { "type": "string" }, + "registry_url": { "type": "string" }, + "username": { "type": "string" } + } + }, + "ModelRegistryImageStubsReq": { + "required": ["registry_id", "image_filter", "window"], + "type": "object", + "properties": { + "image_filter": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "registry_id": { "type": "string" }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "ModelRegistryImagesReq": { + "required": ["registry_id", "image_filter", "image_stub_filter", "window"], + "type": "object", + "properties": { + "image_filter": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "image_stub_filter": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "registry_id": { "type": "string" }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "ModelRegistryListResp": { + "type": "object", + "properties": { + "created_at": { "type": "integer" }, + "id": { "type": "integer" }, + "is_syncing": { "type": "boolean" }, + "name": { "type": "string" }, + "node_id": { "type": "string" }, + "non_secret": {}, + "registry_type": { "type": "string" }, + "updated_at": { "type": "integer" } + } + }, + "ModelRegistrySummaryAllResp": { + "type": "object", + "additionalProperties": { "$ref": "#/components/schemas/ModelSummary" }, + "nullable": true + }, + "ModelRegistryUpdateReq": { + "required": ["name", "registry_type"], + "type": "object", + "properties": { + "extras": { "type": "object", "additionalProperties": {}, "nullable": true }, + "name": { "type": "string" }, + "non_secret": { + "type": "object", + "additionalProperties": {}, + "nullable": true + }, + "registry_type": { "type": "string" }, + "secret": { "type": "object", "additionalProperties": {}, "nullable": true } + } + }, + "ModelResponseAccessToken": { + "required": ["access_token", "refresh_token"], + "type": "object", + "properties": { + "access_token": { "type": "string" }, + "refresh_token": { "type": "string" } + } + }, + "ModelRulesActionRequest": { + "required": ["rule_ids"], + "type": "object", + "properties": { + "rule_ids": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelSbomRequest": { + "required": ["scan_id"], + "type": "object", + "properties": { "scan_id": { "type": "string" } } + }, + "ModelSbomResponse": { + "type": "object", + "properties": { + "cve_id": { "type": "string" }, + "cve_node_id": { "type": "string" }, + "licenses": { "type": "array", "items": { "type": "string" } }, + "locations": { "type": "array", "items": { "type": "string" } }, + "package_name": { "type": "string" }, + "severity": { "type": "string" }, + "version": { "type": "string" } + } + }, + "ModelScanCompareReq": { + "required": ["base_scan_id", "to_scan_id", "fields_filter", "window"], + "type": "object", + "properties": { + "base_scan_id": { "type": "string" }, + "fields_filter": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "to_scan_id": { "type": "string" }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelCloudCompliance": { + "required": ["new"], + "type": "object", + "properties": { + "new": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCloudCompliance" }, + "nullable": true + } + } + }, + "ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelCompliance": { + "required": ["new"], + "type": "object", + "properties": { + "new": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelCompliance" }, + "nullable": true + } + } + }, + "ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelMalware": { + "required": ["new"], + "type": "object", + "properties": { + "new": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelMalware" }, + "nullable": true + } + } + }, + "ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelSecret": { + "required": ["new"], + "type": "object", + "properties": { + "new": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelSecret" }, + "nullable": true + } + } + }, + "ModelScanCompareResGithubComDeepfenceThreatMapperDeepfenceServerModelVulnerability": { + "required": ["new"], + "type": "object", + "properties": { + "new": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelVulnerability" }, + "nullable": true + } + } + }, + "ModelScanFilter": { + "required": [ + "image_scan_filter", + "container_scan_filter", + "host_scan_filter", + "cloud_account_scan_filter", + "kubernetes_cluster_scan_filter" + ], + "type": "object", + "properties": { + "cloud_account_scan_filter": { + "$ref": "#/components/schemas/ReportersContainsFilter" + }, + "container_scan_filter": { + "$ref": "#/components/schemas/ReportersContainsFilter" + }, + "host_scan_filter": { "$ref": "#/components/schemas/ReportersContainsFilter" }, + "image_scan_filter": { "$ref": "#/components/schemas/ReportersContainsFilter" }, + "kubernetes_cluster_scan_filter": { + "$ref": "#/components/schemas/ReportersContainsFilter" + } + } + }, + "ModelScanInfo": { + "required": [ + "scan_id", + "status", + "status_message", + "updated_at", + "created_at", + "node_id", + "node_type", + "severity_counts", + "node_name" + ], + "type": "object", + "properties": { + "created_at": { "type": "integer", "format": "int64" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "severity_counts": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "status": { + "enum": [ + "COMPLETE", + "STARTING", + "IN_PROGRESS", + "ERROR", + "CANCEL_PENDING", + "CANCELLING", + "CANCELLED", + "DELETE_PENDING" + ], + "type": "string" + }, + "status_message": { "type": "string" }, + "updated_at": { "type": "integer", "format": "int64" } + } + }, + "ModelScanListReq": { + "required": ["node_ids", "fields_filter", "window"], + "type": "object", + "properties": { + "fields_filter": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "ModelScanListResp": { + "required": ["scans_info"], + "type": "object", + "properties": { + "scans_info": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelScanInfo" }, + "nullable": true + } + } + }, + "ModelScanReportFieldsResponse": { + "type": "object", + "properties": { + "compliance": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "malware": { "type": "array", "items": { "type": "string" }, "nullable": true }, + "secret": { "type": "array", "items": { "type": "string" }, "nullable": true }, + "vulnerability": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + } + } + }, + "ModelScanResultBasicNode": { + "required": ["result_id", "basic_nodes"], + "type": "object", + "properties": { + "basic_nodes": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBasicNode" }, + "nullable": true + }, + "result_id": { "type": "string" } + } + }, + "ModelScanResultsActionRequest": { + "required": ["scan_id", "result_ids", "scan_type"], + "type": "object", + "properties": { + "integration_ids": { + "type": "array", + "items": { "type": "integer" }, + "nullable": true + }, + "notify_individual": { "type": "boolean" }, + "result_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "scan_id": { "type": "string" }, + "scan_type": { + "enum": [ + "SecretScan", + "VulnerabilityScan", + "MalwareScan", + "ComplianceScan", + "CloudComplianceScan" + ], + "type": "string" + } + } + }, + "ModelScanResultsCommon": { + "required": [ + "docker_container_name", + "docker_image_name", + "host_name", + "kubernetes_cluster_name", + "node_id", + "node_name", + "node_type", + "scan_id", + "updated_at", + "created_at", + "cloud_account_id" + ], + "type": "object", + "properties": { + "cloud_account_id": { "type": "string" }, + "created_at": { "type": "integer", "format": "int64" }, + "docker_container_name": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "host_name": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "updated_at": { "type": "integer", "format": "int64" } + } + }, + "ModelScanResultsMaskRequest": { + "required": ["scan_id", "result_ids", "scan_type", "mask_action"], + "type": "object", + "properties": { + "mask_action": { + "enum": [ + "mask_global", + "mask_all_image_tag", + "mask_entity", + "mask_image_tag" + ], + "type": "string" + }, + "result_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "scan_id": { "type": "string" }, + "scan_type": { + "enum": [ + "SecretScan", + "VulnerabilityScan", + "MalwareScan", + "ComplianceScan", + "CloudComplianceScan" + ], + "type": "string" + } + } + }, + "ModelScanResultsReq": { + "required": ["scan_id", "fields_filter", "window"], + "type": "object", + "properties": { + "fields_filter": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "scan_id": { "type": "string" }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "ModelScanStatusReq": { + "required": ["scan_ids", "bulk_scan_id"], + "type": "object", + "properties": { + "bulk_scan_id": { "type": "string" }, + "scan_ids": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelScanStatusResp": { + "required": ["statuses"], + "type": "object", + "properties": { + "statuses": { + "type": "object", + "additionalProperties": { "$ref": "#/components/schemas/ModelScanInfo" }, + "nullable": true + } + } + }, + "ModelScanTriggerResp": { + "required": ["scan_ids", "bulk_scan_id"], + "type": "object", + "properties": { + "bulk_scan_id": { "type": "string" }, + "scan_ids": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelSecret": { + "required": [ + "node_id", + "starting_index", + "full_filename", + "matched_content", + "masked", + "updated_at", + "level", + "score", + "rule_id" + ], + "type": "object", + "properties": { + "full_filename": { "type": "string" }, + "level": { + "enum": ["critical", "high", "medium", "low", "unknown"], + "type": "string" + }, + "masked": { "type": "boolean" }, + "matched_content": { "type": "string" }, + "node_id": { "type": "string" }, + "resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBasicNode" }, + "nullable": true + }, + "rule_id": { "type": "string" }, + "score": { "type": "number" }, + "starting_index": { "type": "integer" }, + "updated_at": { "type": "integer" } + } + }, + "ModelSecretRule": { + "required": ["level", "masked", "summary", "payload", "severity", "updated_at"], + "type": "object", + "properties": { + "level": { "type": "string" }, + "masked": { "type": "boolean" }, + "part": { "type": "string" }, + "payload": { "type": "string" }, + "rule_id": { "type": "string" }, + "severity": { "type": "string" }, + "signature_to_match": { "type": "string" }, + "summary": { "type": "string" }, + "updated_at": { "type": "integer" } + } + }, + "ModelSecretScanResult": { + "required": [ + "docker_container_name", + "docker_image_name", + "host_name", + "kubernetes_cluster_name", + "node_id", + "node_name", + "node_type", + "scan_id", + "updated_at", + "created_at", + "cloud_account_id", + "secrets", + "severity_counts" + ], + "type": "object", + "properties": { + "cloud_account_id": { "type": "string" }, + "created_at": { "type": "integer", "format": "int64" }, + "docker_container_name": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "host_name": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "secrets": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelSecret" }, + "nullable": true + }, + "severity_counts": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "updated_at": { "type": "integer", "format": "int64" } + } + }, + "ModelSecretScanResultRules": { + "required": ["rules"], + "type": "object", + "properties": { + "rules": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelSecretScanTriggerReq": { + "required": ["node_ids", "filters"], + "type": "object", + "properties": { + "deepfence_system_scan": { "type": "boolean" }, + "filters": { "$ref": "#/components/schemas/ModelScanFilter" }, + "is_priority": { "type": "boolean" }, + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + } + } + }, + "ModelStopScanRequest": { + "required": ["scan_ids", "scan_type"], + "type": "object", + "properties": { + "scan_ids": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "scan_type": { + "enum": [ + "SecretScan", + "VulnerabilityScan", + "MalwareScan", + "ComplianceScan", + "CloudComplianceScan" + ], + "type": "string" + } + } + }, + "ModelSummary": { + "type": "object", + "properties": { + "images": { "type": "integer" }, + "registries": { "type": "integer" }, + "repositories": { "type": "integer" }, + "scans_complete": { "type": "integer" }, + "scans_in_progress": { "type": "integer" }, + "scans_total": { "type": "integer" } + } + }, + "ModelTopologyDeltaReq": { + "required": [ + "addition_timestamp", + "deletion_timestamp", + "addition", + "deletion", + "entity_types" + ], + "type": "object", + "properties": { + "addition": { "type": "boolean" }, + "addition_timestamp": { "type": "integer", "format": "int64" }, + "deletion": { "type": "boolean" }, + "deletion_timestamp": { "type": "integer", "format": "int64" }, + "entity_types": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + } + } + }, + "ModelTopologyDeltaResponse": { + "type": "object", + "properties": { + "addition_timestamp": { "type": "integer", "format": "int64" }, + "additons": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + }, + "deletion_timestamp": { "type": "integer", "format": "int64" }, + "deletions": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + } + } + }, + "ModelUpdateScheduledTaskRequest": { + "required": ["is_enabled"], + "type": "object", + "properties": { "is_enabled": { "type": "boolean" } } + }, + "ModelUpdateUserIDRequest": { + "type": "object", + "properties": { + "first_name": { "type": "string" }, + "is_active": { "type": "boolean" }, + "last_name": { "type": "string" }, + "role": { + "enum": ["admin", "standard-user", "read-only-user"], + "type": "string" + } + } + }, + "ModelUpdateUserPasswordRequest": { + "required": ["old_password", "new_password"], + "type": "object", + "properties": { + "new_password": { "type": "string" }, + "old_password": { "type": "string" } + } + }, + "ModelUpdateUserRequest": { + "type": "object", + "properties": { + "first_name": { "type": "string" }, + "is_active": { "type": "boolean" }, + "last_name": { "type": "string" }, + "role": { + "enum": ["admin", "standard-user", "read-only-user"], + "type": "string" + } + } + }, + "ModelUser": { + "required": ["first_name", "last_name", "email", "company"], + "type": "object", + "properties": { + "company": { "type": "string" }, + "company_id": { "type": "integer" }, + "current_user": { "type": "boolean", "nullable": true }, + "email": { "type": "string" }, + "first_name": { "type": "string" }, + "groups": { + "type": "object", + "additionalProperties": { "type": "string" }, + "nullable": true + }, + "id": { "type": "integer" }, + "is_active": { "type": "boolean" }, + "last_name": { "type": "string" }, + "password_invalidated": { "type": "boolean" }, + "role": { + "enum": ["admin", "standard-user", "read-only-user"], + "type": "string" + }, + "role_id": { "type": "integer" } + } + }, + "ModelUserRegisterRequest": { + "required": [ + "first_name", + "last_name", + "email", + "company", + "password", + "console_url" + ], + "type": "object", + "properties": { + "company": { "type": "string" }, + "console_url": { "type": "string" }, + "email": { "type": "string" }, + "first_name": { "type": "string" }, + "is_temporary_password": { "type": "boolean" }, + "last_name": { "type": "string" }, + "password": { "type": "string" } + } + }, + "ModelVulnerability": { + "required": [ + "node_id", + "cve_id", + "cve_severity", + "cve_caused_by_package", + "cve_caused_by_package_path", + "cve_container_layer", + "cve_link", + "masked", + "updated_at", + "has_live_connection", + "cve_type", + "cve_fixed_in", + "cve_description", + "cve_cvss_score", + "cve_overall_score", + "cve_attack_vector", + "urls", + "exploit_poc", + "parsed_attack_vector", + "rule_id", + "namespace", + "cisa_kev", + "epss_score" + ], + "type": "object", + "properties": { + "cisa_kev": { "type": "boolean" }, + "cve_attack_vector": { "type": "string" }, + "cve_caused_by_package": { "type": "string" }, + "cve_caused_by_package_path": { "type": "string" }, + "cve_container_layer": { "type": "string" }, + "cve_cvss_score": { "type": "number" }, + "cve_description": { "type": "string" }, + "cve_fixed_in": { "type": "string" }, + "cve_id": { "type": "string" }, + "cve_link": { "type": "string" }, + "cve_overall_score": { "type": "number" }, + "cve_severity": { + "enum": ["critical", "high", "medium", "low", "unknown"], + "type": "string" + }, + "cve_type": { "type": "string" }, + "epss_score": { "type": "number" }, + "exploit_poc": { "type": "string" }, + "has_live_connection": { "type": "boolean" }, + "masked": { "type": "boolean" }, + "namespace": { "type": "string" }, + "node_id": { "type": "string" }, + "parsed_attack_vector": { "type": "string" }, + "resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBasicNode" }, + "nullable": true + }, + "rule_id": { "type": "string" }, + "updated_at": { "type": "integer" }, + "urls": { "type": "array", "items": {}, "nullable": true } + } + }, + "ModelVulnerabilityRule": { + "required": [ + "node_id", + "cve_id", + "cve_types", + "cve_severities", + "cve_fixed_ins", + "cve_links", + "cve_descriptions", + "cve_cvss_scores", + "cve_overall_scores", + "cve_attack_vectors", + "urls", + "exploit_pocs", + "masked", + "updated_at", + "package_names", + "parsed_attack_vectors", + "cisa_kev", + "epss_score", + "namespaces" + ], + "type": "object", + "properties": { + "cisa_kev": { "type": "boolean" }, + "cve_attack_vectors": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cve_cvss_scores": { "type": "array", "items": {}, "nullable": true }, + "cve_descriptions": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cve_fixed_ins": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cve_id": { "type": "string" }, + "cve_links": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cve_overall_scores": { "type": "array", "items": {}, "nullable": true }, + "cve_severities": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "cve_types": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "epss_score": { "type": "number" }, + "exploit_pocs": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "masked": { "type": "boolean" }, + "namespaces": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "node_id": { "type": "string" }, + "package_names": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "parsed_attack_vectors": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelBasicNode" }, + "nullable": true + }, + "updated_at": { "type": "integer" }, + "urls": { "type": "array", "items": { "type": "string" }, "nullable": true } + } + }, + "ModelVulnerabilityScanConfigLanguage": { + "required": ["language"], + "type": "object", + "properties": { + "language": { + "enum": [ + "base", + "ruby", + "python", + "javascript", + "php", + "golang", + "golang-binary", + "java", + "rust", + "rust-binary", + "dotnet" + ], + "type": "string" + } + } + }, + "ModelVulnerabilityScanResult": { + "required": [ + "docker_container_name", + "docker_image_name", + "host_name", + "kubernetes_cluster_name", + "node_id", + "node_name", + "node_type", + "scan_id", + "updated_at", + "created_at", + "cloud_account_id", + "vulnerabilities", + "severity_counts" + ], + "type": "object", + "properties": { + "cloud_account_id": { "type": "string" }, + "created_at": { "type": "integer", "format": "int64" }, + "docker_container_name": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "host_name": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "scan_id": { "type": "string" }, + "severity_counts": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "updated_at": { "type": "integer", "format": "int64" }, + "vulnerabilities": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelVulnerability" }, + "nullable": true + } + } + }, + "ModelVulnerabilityScanTriggerReq": { + "required": ["node_ids", "filters", "scan_config"], + "type": "object", + "properties": { + "deepfence_system_scan": { "type": "boolean" }, + "filters": { "$ref": "#/components/schemas/ModelScanFilter" }, + "is_priority": { "type": "boolean" }, + "node_ids": { + "type": "array", + "items": { "$ref": "#/components/schemas/ModelNodeIdentifier" }, + "nullable": true + }, + "scan_config": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ModelVulnerabilityScanConfigLanguage" + }, + "nullable": true + } + } + }, + "MultipartFile": { "type": "string", "format": "binary" }, + "PostgresqlDbGetAuditLogsRow": { + "type": "object", + "properties": { + "action": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "email": { "type": "string" }, + "event": { "type": "string" }, + "resources": { "type": "string" }, + "role": { "type": "string" }, + "success": { "type": "boolean" } + } + }, + "PostgresqlDbScheduler": { + "type": "object", + "properties": { + "action": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "cron_expr": { "type": "string" }, + "description": { "type": "string" }, + "id": { "type": "integer" }, + "is_enabled": { "type": "boolean" }, + "is_system": { "type": "boolean" }, + "last_ran_at": { "$ref": "#/components/schemas/SqlNullTime" }, + "payload": {}, + "status": { "type": "string" }, + "updated_at": { "type": "string", "format": "date-time" } + } + }, + "ReportIDList": { "type": "array", "items": { "type": "string" } }, + "ReportMetadata": { + "type": "object", + "properties": { + "agent_running": { "type": "boolean" }, + "availability_zone": { "type": "string" }, + "cloud_account_id": { "type": "string" }, + "cloud_provider": { "type": "string" }, + "cloud_region": { "type": "string" }, + "cmdline": { "type": "string" }, + "connection_count": { "type": "integer" }, + "copy_of": { "type": "string" }, + "cpu_max": { "type": "number" }, + "cpu_usage": { "type": "number" }, + "docker_container_command": { "type": "string" }, + "docker_container_created": { "type": "string" }, + "docker_container_ips": { "type": "array", "items": { "type": "string" } }, + "docker_container_name": { "type": "string" }, + "docker_container_network_mode": { "type": "string" }, + "docker_container_networks": { "type": "string" }, + "docker_container_ports": { "type": "string" }, + "docker_container_state": { "type": "string" }, + "docker_container_state_human": { "type": "string" }, + "docker_env": { "type": "string" }, + "docker_image_created_at": { "type": "string" }, + "docker_image_id": { "type": "string" }, + "docker_image_name": { "type": "string" }, + "docker_image_name_with_tag": { "type": "string" }, + "docker_image_size": { "type": "string" }, + "docker_image_tag": { "type": "string" }, + "docker_image_virtual_size": { "type": "string" }, + "docker_label": { "type": "string" }, + "host_name": { "type": "string" }, + "instance_id": { "type": "string" }, + "instance_type": { "type": "string" }, + "interface_ip_map": { "type": "string" }, + "interface_ips": { "type": "array", "items": { "type": "string" } }, + "interface_names": { "type": "array", "items": { "type": "string" } }, + "is_console_vm": { "type": "boolean" }, + "is_deepfence_system": { "type": "boolean" }, + "kernel_id": { "type": "string" }, + "kernel_version": { "type": "string" }, + "kubernetes_cluster_id": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "kubernetes_created": { "type": "string" }, + "kubernetes_ingress_ip": { "type": "array", "items": { "type": "string" } }, + "kubernetes_ip": { "type": "string" }, + "kubernetes_is_in_host_network": { "type": "boolean" }, + "kubernetes_labels": { "type": "string" }, + "kubernetes_namespace": { "type": "string" }, + "kubernetes_ports": { "type": "array", "items": { "type": "string" } }, + "kubernetes_public_ip": { "type": "string" }, + "kubernetes_state": { "type": "string" }, + "kubernetes_type": { "type": "string" }, + "local_cidr": { "type": "array", "items": { "type": "string" } }, + "local_networks": { "type": "array", "items": { "type": "string" } }, + "memory_max": { "type": "integer" }, + "memory_usage": { "type": "integer" }, + "node_id": { "type": "string" }, + "node_name": { "type": "string" }, + "node_type": { "type": "string" }, + "open_files": { "type": "array", "items": { "type": "string" } }, + "open_files_count": { "type": "integer" }, + "os": { "type": "string" }, + "pid": { "type": "integer" }, + "pod_id": { "type": "string" }, + "pod_name": { "type": "string" }, + "ppid": { "type": "integer" }, + "private_ip": { "type": "array", "items": { "type": "string" } }, + "pseudo": { "type": "boolean" }, + "public_ip": { "type": "array", "items": { "type": "string" } }, + "resource_group": { "type": "string" }, + "short_name": { "type": "string" }, + "tags": { "type": "array", "items": { "type": "string" } }, + "threads": { "type": "integer" }, + "timestamp": { "type": "string" }, + "uptime": { "type": "integer" }, + "user_defined_tags": { "type": "array", "items": { "type": "string" } }, + "version": { "type": "string" } + } + }, + "ReportRawReport": { + "required": ["payload"], + "type": "object", + "properties": { "payload": { "type": "string" } } + }, + "ReportersCompareFilter": { + "required": ["field_name", "field_value", "greater_than"], + "type": "object", + "properties": { + "field_name": { "type": "string" }, + "field_value": {}, + "greater_than": { "type": "boolean" } + } + }, + "ReportersContainsFilter": { + "required": ["filter_in"], + "type": "object", + "properties": { + "filter_in": { + "type": "object", + "additionalProperties": { "type": "array", "items": {} }, + "nullable": true + } + } + }, + "ReportersFieldsFilters": { + "required": ["contains_filter", "match_filter", "order_filter", "compare_filter"], + "type": "object", + "properties": { + "compare_filter": { + "type": "array", + "items": { "$ref": "#/components/schemas/ReportersCompareFilter" }, + "nullable": true + }, + "contains_filter": { "$ref": "#/components/schemas/ReportersContainsFilter" }, + "contains_in_array_filter": { + "$ref": "#/components/schemas/ReportersContainsFilter" + }, + "match_filter": { "$ref": "#/components/schemas/ReportersMatchFilter" }, + "match_in_array_filter": { + "$ref": "#/components/schemas/ReportersMatchFilter" + }, + "not_contains_filter": { + "$ref": "#/components/schemas/ReportersContainsFilter" + }, + "order_filter": { "$ref": "#/components/schemas/ReportersOrderFilter" } + } + }, + "ReportersMatchFilter": { + "required": ["filter_in"], + "type": "object", + "properties": { + "filter_in": { + "type": "object", + "additionalProperties": { "type": "array", "items": {} }, + "nullable": true + } + } + }, + "ReportersOrderFilter": { + "required": ["order_fields"], + "type": "object", + "properties": { + "order_fields": { + "type": "array", + "items": { "$ref": "#/components/schemas/ReportersOrderSpec" }, + "nullable": true + } + } + }, + "ReportersOrderSpec": { + "required": ["field_name", "descending"], + "type": "object", + "properties": { + "descending": { "type": "boolean" }, + "field_name": { "type": "string" }, + "size": { "type": "integer" } + } + }, + "SearchChainedSearchFilter": { + "required": ["node_filter", "relation_ship"], + "type": "object", + "properties": { + "next_filter": { "$ref": "#/components/schemas/SearchChainedSearchFilter" }, + "node_filter": { "$ref": "#/components/schemas/SearchSearchFilter" }, + "relation_ship": { "type": "string" } + } + }, + "SearchNodeCountResp": { + "required": [ + "cloud_provider", + "host", + "container", + "container_image", + "pod", + "kubernetes_cluster", + "namespace" + ], + "type": "object", + "properties": { + "cloud_provider": { "type": "integer" }, + "container": { "type": "integer" }, + "container_image": { "type": "integer" }, + "host": { "type": "integer" }, + "kubernetes_cluster": { "type": "integer" }, + "namespace": { "type": "integer" }, + "pod": { "type": "integer" } + } + }, + "SearchResultGroup": { + "type": "object", + "properties": { + "count": { "type": "integer" }, + "name": { "type": "string" }, + "severity": { "type": "string" } + } + }, + "SearchResultGroupResp": { + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { "$ref": "#/components/schemas/SearchResultGroup" }, + "nullable": true + } + } + }, + "SearchSearchCountResp": { + "required": ["count", "categories"], + "type": "object", + "properties": { + "categories": { + "type": "object", + "additionalProperties": { "type": "integer" }, + "nullable": true + }, + "count": { "type": "integer" } + } + }, + "SearchSearchFilter": { + "required": ["in_field_filter", "filters", "window"], + "type": "object", + "properties": { + "filters": { "$ref": "#/components/schemas/ReportersFieldsFilters" }, + "in_field_filter": { + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "SearchSearchNodeReq": { + "required": ["node_filter", "window"], + "type": "object", + "properties": { + "extended_node_filter": { "$ref": "#/components/schemas/SearchSearchFilter" }, + "node_filter": { "$ref": "#/components/schemas/SearchSearchFilter" }, + "related_node_filter": { + "$ref": "#/components/schemas/SearchChainedSearchFilter" + }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "SearchSearchScanReq": { + "required": ["scan_filters", "node_filters", "window"], + "type": "object", + "properties": { + "node_filters": { "$ref": "#/components/schemas/SearchSearchFilter" }, + "related_node_filter": { + "$ref": "#/components/schemas/SearchChainedSearchFilter" + }, + "scan_filters": { "$ref": "#/components/schemas/SearchSearchFilter" }, + "window": { "$ref": "#/components/schemas/ModelFetchWindow" } + } + }, + "SettingSettingUpdateRequest": { + "required": ["key", "value"], + "type": "object", + "properties": { + "key": { + "enum": ["console_url", "file_server_url", "inactive_delete_scan_results"], + "type": "string" + }, + "value": { "type": "string" } + } + }, + "SettingSettingsResponse": { + "required": ["id", "key", "label", "value", "description"], + "type": "object", + "properties": { + "description": { "type": "string" }, + "id": { "type": "integer" }, + "key": { "type": "string" }, + "label": { "type": "string" }, + "value": {} + } + }, + "SqlNullTime": { "type": "object" }, + "UtilsAdvancedReportFilters": { + "type": "object", + "properties": { + "container_name": { "type": "array", "items": { "type": "string" } }, + "host_name": { "type": "array", "items": { "type": "string" } }, + "image_name": { "type": "array", "items": { "type": "string" } }, + "kubernetes_cluster_name": { "type": "array", "items": { "type": "string" } }, + "masked": { "type": "array", "items": { "type": "boolean" } }, + "node_id": { "type": "array", "items": { "type": "string" } }, + "pod_name": { "type": "array", "items": { "type": "string" } }, + "scan_status": { "type": "array", "items": { "type": "string" } } + } + }, + "UtilsReportFilters": { + "required": ["scan_type", "node_type"], + "type": "object", + "properties": { + "advanced_report_filters": { + "$ref": "#/components/schemas/UtilsAdvancedReportFilters" + }, + "include_dead_nodes": { "type": "boolean" }, + "most_exploitable_report": { "type": "boolean" }, + "node_type": { + "enum": [ + "host", + "container", + "container_image", + "linux", + "cluster", + "aws", + "gcp", + "azure" + ], + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "scan_id": { "type": "string" }, + "scan_type": { + "enum": [ + "vulnerability", + "secret", + "malware", + "compliance", + "cloud_compliance" + ], + "type": "string" + }, + "severity_or_check_type": { + "enum": [ + "critical", + "high", + "medium", + "low", + "cis", + "gdpr", + "nist", + "hipaa", + "pci", + "soc_2", + "aws_foundational_security" + ], + "type": "array", + "items": { "type": "string" }, + "nullable": true + } + } + }, + "UtilsReportOptions": { + "type": "object", + "properties": { + "sbom_format": { + "enum": ["syft-json", "cyclonedx-json@1.5", "spdx-json@2.2", "spdx-json@2.3"], + "type": "string" + } + } + }, + "UtilsScanSbomRequest": { + "required": ["scan_id", "sbom"], + "type": "object", + "properties": { + "container_name": { "type": "string" }, + "host_name": { "type": "string" }, + "image_id": { "type": "string" }, + "image_name": { "type": "string" }, + "kubernetes_cluster_name": { "type": "string" }, + "mode": { "type": "string" }, + "node_id": { "type": "string" }, + "node_type": { "type": "string" }, + "registry_id": { "type": "string" }, + "sbom": { "type": "string" }, + "sbom_file_path": { "type": "string" }, + "scan_id": { "type": "string" }, + "scan_type": { "type": "string" }, + "skip_scan": { "type": "boolean" } + } + } + }, + "securitySchemes": { + "bearer_token": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT", + "description": "RW Access" + } + } + } +} diff --git a/deepfence_frontend/apps/dashboard/api-spec.json b/deepfence_frontend/apps/dashboard/api-spec.json index f6809127cb..c4321ac11f 100644 --- a/deepfence_frontend/apps/dashboard/api-spec.json +++ b/deepfence_frontend/apps/dashboard/api-spec.json @@ -3384,351 +3384,6 @@ "security": [{ "bearer_token": [] }] } }, - "/deepfence/ingest/cloud-compliance": { - "post": { - "tags": ["Cloud Scanner"], - "summary": "Ingest Cloud Compliances", - "description": "Ingest Cloud compliances found while scanning cloud provider", - "operationId": "ingestCloudCompliances", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersCloudCompliance" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/cloud-compliance-status": { - "post": { - "tags": ["Cloud Scanner"], - "summary": "Ingest Cloud Compliances scan status", - "description": "Ingest Cloud compliances found while scanning cloud provider", - "operationId": "ingestCloudComplianceScanStatus", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IngestersCloudComplianceScanStatus" - }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/cloud-resources": { - "post": { - "tags": ["Cloud Resources"], - "summary": "Ingest Cloud resources", - "description": "Ingest Clouds Resources found while scanning cloud provider", - "operationId": "ingestCloudResources", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersCloudResource" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/compliance": { - "post": { - "tags": ["Compliance"], - "summary": "Ingest Compliances", - "description": "Ingest compliance issues found while scanning the agent", - "operationId": "ingestCompliances", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersCompliance" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/compliance-scan-logs": { - "post": { - "tags": ["Compliance"], - "summary": "Ingest Compliance Scan Status", - "description": "Ingest compliance issues found while scanning the agent", - "operationId": "ingestComplianceScanStatus", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersComplianceScanStatus" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/malware": { - "post": { - "tags": ["Malware Scan"], - "summary": "Ingest Malware", - "description": "Ingest malware found while scanning the agent", - "operationId": "ingestMalware", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersMalware" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/malware-scan-logs": { - "post": { - "tags": ["Malware Scan"], - "summary": "Ingest Malware Scan Status", - "description": "Ingest malware scan status from the agent", - "operationId": "ingestMalwareScanStatus", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersMalwareScanStatus" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, "/deepfence/ingest/report": { "post": { "tags": ["Topology"], @@ -3826,104 +3481,6 @@ "security": [{ "bearer_token": [] }] } }, - "/deepfence/ingest/secret-scan-logs": { - "post": { - "tags": ["Secret Scan"], - "summary": "Ingest Secrets Scan Status", - "description": "Ingest secrets scan status from the agent", - "operationId": "ingestSecretScanStatus", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersSecretScanStatus" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/secrets": { - "post": { - "tags": ["Secret Scan"], - "summary": "Ingest Secrets", - "description": "Ingest secrets found while scanning the agent", - "operationId": "ingestSecrets", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersSecret" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, "/deepfence/ingest/sync-report": { "post": { "tags": ["Topology"], @@ -3969,106 +3526,6 @@ "security": [{ "bearer_token": [] }] } }, - "/deepfence/ingest/vulnerabilities": { - "post": { - "tags": ["Vulnerability"], - "summary": "Ingest Vulnerabilities", - "description": "Ingest vulnerabilities found while scanning the agent host or containers", - "operationId": "ingestVulnerabilities", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { "$ref": "#/components/schemas/IngestersVulnerability" }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, - "/deepfence/ingest/vulnerabilities-scan-logs": { - "post": { - "tags": ["Vulnerability"], - "summary": "Ingest Vulnerabilities Scan Status", - "description": "Ingest vulnerabilities scan status from agent", - "operationId": "ingestVulnerabilitiesScanStatus", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IngestersVulnerabilityScanStatus" - }, - "nullable": true - } - } - } - }, - "responses": { - "200": { "description": "OK" }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsBadRequestResponse" } - } - } - }, - "401": { "description": "Unauthorized" }, - "403": { "description": "Forbidden" }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ApiDocsFailureResponse" } - } - } - } - }, - "security": [{ "bearer_token": [] }] - } - }, "/deepfence/integration": { "get": { "tags": ["Integration"], @@ -13283,6 +12740,7 @@ "public_ips": {}, "public_network_access": { "type": "string" }, "region": { "type": "string" }, + "resource_group": { "type": "string" }, "resource_id": { "type": "string" }, "resource_vpc_config": {}, "resources_vpc_config": {}, @@ -16663,17 +16121,20 @@ "include_dead_nodes": { "type": "boolean" }, "most_exploitable_report": { "type": "boolean" }, "node_type": { - "enum": [ - "host", - "container", - "container_image", - "linux", - "cluster", - "aws", - "gcp", - "azure" - ], - "type": "string" + "type": "array", + "items": { + "enum": [ + "host", + "container", + "container_image", + "linux", + "cluster", + "aws", + "gcp", + "azure" + ] + }, + "nullable": true }, "scan_id": { "type": "string" }, "scan_type": { diff --git a/deepfence_frontend/apps/dashboard/package.json b/deepfence_frontend/apps/dashboard/package.json index 69e8f3768d..e97b9639d0 100644 --- a/deepfence_frontend/apps/dashboard/package.json +++ b/deepfence_frontend/apps/dashboard/package.json @@ -11,8 +11,9 @@ "lint:fix": "eslint ./src --ext .jsx,.js,.ts,.tsx --quiet --fix --ignore-path ./.gitignore", "test": "vitest", "coverage": "vitest run --coverage", - "codegen": "pnpm run codegen:clean && openapi-generator-cli generate", - "codegen:clean": "rm -rf ./src/api/generated" + "codegen": "pnpm run codegen:clean && pnpm run transform-api-spec && openapi-generator-cli generate", + "codegen:clean": "rm -rf ./src/api/generated", + "transform-api-spec": "node scripts/transformAPISpec.js" }, "dependencies": { "@antv/g6": "^4.8.24", diff --git a/deepfence_frontend/apps/dashboard/scripts/transformAPISpec.js b/deepfence_frontend/apps/dashboard/scripts/transformAPISpec.js new file mode 100644 index 0000000000..5bac6319d7 --- /dev/null +++ b/deepfence_frontend/apps/dashboard/scripts/transformAPISpec.js @@ -0,0 +1,44 @@ +import fs from 'fs'; +import path from 'path'; +import * as prettier from 'prettier'; + +(async () => { + const apiSpec = JSON.parse( + fs.readFileSync(path.resolve('./api-spec-original.json'), 'utf8'), + ); + + // BEGIN: Transform UtilsReportFilters node_type + delete apiSpec.components.schemas.UtilsReportFilters.properties.node_type.items.type; + apiSpec.components.schemas.UtilsReportFilters.properties.node_type.items.enum = + apiSpec.components.schemas.UtilsReportFilters.properties.node_type.enum; + delete apiSpec.components.schemas.UtilsReportFilters.properties.node_type.enum; + // END + + // BEGIN INGEST API ISSUE FIXES + const routes = [ + '/deepfence/ingest/cloud-resources', + '/deepfence/ingest/cloud-compliance-status', + '/deepfence/ingest/cloud-compliance', + '/deepfence/ingest/compliance-scan-logs', + '/deepfence/ingest/compliance', + '/deepfence/ingest/malware', + '/deepfence/ingest/malware-scan-logs', + '/deepfence/ingest/secret-scan-logs', + '/deepfence/ingest/secrets', + '/deepfence/ingest/vulnerabilities', + '/deepfence/ingest/vulnerabilities-scan-logs', + ]; + + routes.forEach((route) => { + delete apiSpec.paths[route]; + }); + + // END + + const prettierrc = fs.readFileSync(path.resolve('./../../.prettierrc.json'), 'utf-8'); + const fileContent = await prettier.format(JSON.stringify(apiSpec), { + ...JSON.parse(prettierrc), + parser: 'json', + }); + fs.writeFileSync(path.resolve('./api-spec.json'), fileContent, 'utf8'); +})(); diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/.openapi-generator/FILES b/deepfence_frontend/apps/dashboard/src/api/generated/.openapi-generator/FILES index b0a0e4d632..701eabbfb7 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/.openapi-generator/FILES +++ b/deepfence_frontend/apps/dashboard/src/api/generated/.openapi-generator/FILES @@ -1,7 +1,6 @@ .openapi-generator-ignore apis/AuthenticationApi.ts apis/CloudNodesApi.ts -apis/CloudResourcesApi.ts apis/CloudScannerApi.ts apis/CommonApi.ts apis/CompletionApi.ts diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudResourcesApi.ts b/deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudResourcesApi.ts deleted file mode 100644 index 3bcfc433f0..0000000000 --- a/deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudResourcesApi.ts +++ /dev/null @@ -1,103 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Deepfence ThreatMapper - * Deepfence Runtime API provides programmatic control over Deepfence microservice securing your container, kubernetes and cloud deployments. The API abstracts away underlying infrastructure details like cloud provider, container distros, container orchestrator and type of deployment. This is one uniform API to manage and control security alerts, policies and response to alerts for microservices running anywhere i.e. managed pure greenfield container deployments or a mix of containers, VMs and serverless paradigms like AWS Fargate. - * - * The version of the OpenAPI document: v2.5.0 - * Contact: community@deepfence.io - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import * as runtime from '../runtime'; -import type { - ApiDocsBadRequestResponse, - ApiDocsFailureResponse, - IngestersCloudResource, -} from '../models'; -import { - ApiDocsBadRequestResponseFromJSON, - ApiDocsBadRequestResponseToJSON, - ApiDocsFailureResponseFromJSON, - ApiDocsFailureResponseToJSON, - IngestersCloudResourceFromJSON, - IngestersCloudResourceToJSON, -} from '../models'; - -export interface IngestCloudResourcesRequest { - ingestersCloudResource?: Array | null; -} - -/** - * CloudResourcesApi - interface - * - * @export - * @interface CloudResourcesApiInterface - */ -export interface CloudResourcesApiInterface { - /** - * Ingest Clouds Resources found while scanning cloud provider - * @summary Ingest Cloud resources - * @param {Array} [ingestersCloudResource] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CloudResourcesApiInterface - */ - ingestCloudResourcesRaw(requestParameters: IngestCloudResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest Clouds Resources found while scanning cloud provider - * Ingest Cloud resources - */ - ingestCloudResources(requestParameters: IngestCloudResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - -} - -/** - * - */ -export class CloudResourcesApi extends runtime.BaseAPI implements CloudResourcesApiInterface { - - /** - * Ingest Clouds Resources found while scanning cloud provider - * Ingest Cloud resources - */ - async ingestCloudResourcesRaw(requestParameters: IngestCloudResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/cloud-resources`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersCloudResource?.map(IngestersCloudResourceToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest Clouds Resources found while scanning cloud provider - * Ingest Cloud resources - */ - async ingestCloudResources(requestParameters: IngestCloudResourcesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestCloudResourcesRaw(requestParameters, initOverrides); - } - -} diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudScannerApi.ts b/deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudScannerApi.ts index f3ac9036ac..520136369d 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudScannerApi.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/apis/CloudScannerApi.ts @@ -17,8 +17,6 @@ import * as runtime from '../runtime'; import type { ApiDocsBadRequestResponse, ApiDocsFailureResponse, - IngestersCloudCompliance, - IngestersCloudComplianceScanStatus, ModelCloudComplianceScanResult, ModelComplianceScanStatusResp, ModelScanListReq, @@ -32,10 +30,6 @@ import { ApiDocsBadRequestResponseToJSON, ApiDocsFailureResponseFromJSON, ApiDocsFailureResponseToJSON, - IngestersCloudComplianceFromJSON, - IngestersCloudComplianceToJSON, - IngestersCloudComplianceScanStatusFromJSON, - IngestersCloudComplianceScanStatusToJSON, ModelCloudComplianceScanResultFromJSON, ModelCloudComplianceScanResultToJSON, ModelComplianceScanStatusRespFromJSON, @@ -56,14 +50,6 @@ export interface CountResultsCloudComplianceScanRequest { modelScanResultsReq?: ModelScanResultsReq; } -export interface IngestCloudComplianceScanStatusRequest { - ingestersCloudComplianceScanStatus?: Array | null; -} - -export interface IngestCloudCompliancesRequest { - ingestersCloudCompliance?: Array | null; -} - export interface ListCloudComplianceScanRequest { modelScanListReq?: ModelScanListReq; } @@ -99,38 +85,6 @@ export interface CloudScannerApiInterface { */ countResultsCloudComplianceScan(requestParameters: CountResultsCloudComplianceScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** - * Ingest Cloud compliances found while scanning cloud provider - * @summary Ingest Cloud Compliances scan status - * @param {Array} [ingestersCloudComplianceScanStatus] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CloudScannerApiInterface - */ - ingestCloudComplianceScanStatusRaw(requestParameters: IngestCloudComplianceScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest Cloud compliances found while scanning cloud provider - * Ingest Cloud Compliances scan status - */ - ingestCloudComplianceScanStatus(requestParameters: IngestCloudComplianceScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - - /** - * Ingest Cloud compliances found while scanning cloud provider - * @summary Ingest Cloud Compliances - * @param {Array} [ingestersCloudCompliance] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CloudScannerApiInterface - */ - ingestCloudCompliancesRaw(requestParameters: IngestCloudCompliancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest Cloud compliances found while scanning cloud provider - * Ingest Cloud Compliances - */ - ingestCloudCompliances(requestParameters: IngestCloudCompliancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** * Get Cloud Compliance Scans list for cloud node * @summary Get Cloud Compliance Scans List @@ -225,82 +179,6 @@ export class CloudScannerApi extends runtime.BaseAPI implements CloudScannerApiI return await response.value(); } - /** - * Ingest Cloud compliances found while scanning cloud provider - * Ingest Cloud Compliances scan status - */ - async ingestCloudComplianceScanStatusRaw(requestParameters: IngestCloudComplianceScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/cloud-compliance-status`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersCloudComplianceScanStatus?.map(IngestersCloudComplianceScanStatusToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest Cloud compliances found while scanning cloud provider - * Ingest Cloud Compliances scan status - */ - async ingestCloudComplianceScanStatus(requestParameters: IngestCloudComplianceScanStatusRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestCloudComplianceScanStatusRaw(requestParameters, initOverrides); - } - - /** - * Ingest Cloud compliances found while scanning cloud provider - * Ingest Cloud Compliances - */ - async ingestCloudCompliancesRaw(requestParameters: IngestCloudCompliancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/cloud-compliance`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersCloudCompliance?.map(IngestersCloudComplianceToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest Cloud compliances found while scanning cloud provider - * Ingest Cloud Compliances - */ - async ingestCloudCompliances(requestParameters: IngestCloudCompliancesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestCloudCompliancesRaw(requestParameters, initOverrides); - } - /** * Get Cloud Compliance Scans list for cloud node * Get Cloud Compliance Scans List diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/apis/ComplianceApi.ts b/deepfence_frontend/apps/dashboard/src/api/generated/apis/ComplianceApi.ts index 5b04e8d504..eb1417ce52 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/apis/ComplianceApi.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/apis/ComplianceApi.ts @@ -17,8 +17,6 @@ import * as runtime from '../runtime'; import type { ApiDocsBadRequestResponse, ApiDocsFailureResponse, - IngestersCompliance, - IngestersComplianceScanStatus, ModelComplianceScanResult, ModelComplianceScanResultsGroupResp, ModelComplianceScanTriggerReq, @@ -37,10 +35,6 @@ import { ApiDocsBadRequestResponseToJSON, ApiDocsFailureResponseFromJSON, ApiDocsFailureResponseToJSON, - IngestersComplianceFromJSON, - IngestersComplianceToJSON, - IngestersComplianceScanStatusFromJSON, - IngestersComplianceScanStatusToJSON, ModelComplianceScanResultFromJSON, ModelComplianceScanResultToJSON, ModelComplianceScanResultsGroupRespFromJSON, @@ -79,14 +73,6 @@ export interface GroupResultsComplianceRequest { modelComplinaceScanResultsGroupReq?: ModelComplinaceScanResultsGroupReq; } -export interface IngestComplianceScanStatusRequest { - ingestersComplianceScanStatus?: Array | null; -} - -export interface IngestCompliancesRequest { - ingestersCompliance?: Array | null; -} - export interface ListComplianceScanRequest { modelScanListReq?: ModelScanListReq; } @@ -162,38 +148,6 @@ export interface ComplianceApiInterface { */ groupResultsCompliance(requestParameters: GroupResultsComplianceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** - * Ingest compliance issues found while scanning the agent - * @summary Ingest Compliance Scan Status - * @param {Array} [ingestersComplianceScanStatus] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ComplianceApiInterface - */ - ingestComplianceScanStatusRaw(requestParameters: IngestComplianceScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest compliance issues found while scanning the agent - * Ingest Compliance Scan Status - */ - ingestComplianceScanStatus(requestParameters: IngestComplianceScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - - /** - * Ingest compliance issues found while scanning the agent - * @summary Ingest Compliances - * @param {Array} [ingestersCompliance] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ComplianceApiInterface - */ - ingestCompliancesRaw(requestParameters: IngestCompliancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest compliance issues found while scanning the agent - * Ingest Compliances - */ - ingestCompliances(requestParameters: IngestCompliancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** * Get Compliance Scans list on agent or registry * @summary Get Compliance Scans List @@ -398,82 +352,6 @@ export class ComplianceApi extends runtime.BaseAPI implements ComplianceApiInter return await response.value(); } - /** - * Ingest compliance issues found while scanning the agent - * Ingest Compliance Scan Status - */ - async ingestComplianceScanStatusRaw(requestParameters: IngestComplianceScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/compliance-scan-logs`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersComplianceScanStatus?.map(IngestersComplianceScanStatusToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest compliance issues found while scanning the agent - * Ingest Compliance Scan Status - */ - async ingestComplianceScanStatus(requestParameters: IngestComplianceScanStatusRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestComplianceScanStatusRaw(requestParameters, initOverrides); - } - - /** - * Ingest compliance issues found while scanning the agent - * Ingest Compliances - */ - async ingestCompliancesRaw(requestParameters: IngestCompliancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/compliance`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersCompliance?.map(IngestersComplianceToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest compliance issues found while scanning the agent - * Ingest Compliances - */ - async ingestCompliances(requestParameters: IngestCompliancesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestCompliancesRaw(requestParameters, initOverrides); - } - /** * Get Compliance Scans list on agent or registry * Get Compliance Scans List diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/apis/MalwareScanApi.ts b/deepfence_frontend/apps/dashboard/src/api/generated/apis/MalwareScanApi.ts index 2c738c4487..8b4d9b5ae5 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/apis/MalwareScanApi.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/apis/MalwareScanApi.ts @@ -17,8 +17,6 @@ import * as runtime from '../runtime'; import type { ApiDocsBadRequestResponse, ApiDocsFailureResponse, - IngestersMalware, - IngestersMalwareScanStatus, ModelMalwareScanResult, ModelMalwareScanResultClass, ModelMalwareScanResultRules, @@ -38,10 +36,6 @@ import { ApiDocsBadRequestResponseToJSON, ApiDocsFailureResponseFromJSON, ApiDocsFailureResponseToJSON, - IngestersMalwareFromJSON, - IngestersMalwareToJSON, - IngestersMalwareScanStatusFromJSON, - IngestersMalwareScanStatusToJSON, ModelMalwareScanResultFromJSON, ModelMalwareScanResultToJSON, ModelMalwareScanResultClassFromJSON, @@ -74,14 +68,6 @@ export interface CountResultsMalwareScanRequest { modelScanResultsReq?: ModelScanResultsReq; } -export interface IngestMalwareRequest { - ingestersMalware?: Array | null; -} - -export interface IngestMalwareScanStatusRequest { - ingestersMalwareScanStatus?: Array | null; -} - export interface ListMalwareScanRequest { modelScanListReq?: ModelScanListReq; } @@ -163,38 +149,6 @@ export interface MalwareScanApiInterface { */ groupResultsMalwaresClass(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** - * Ingest malware found while scanning the agent - * @summary Ingest Malware - * @param {Array} [ingestersMalware] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof MalwareScanApiInterface - */ - ingestMalwareRaw(requestParameters: IngestMalwareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest malware found while scanning the agent - * Ingest Malware - */ - ingestMalware(requestParameters: IngestMalwareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - - /** - * Ingest malware scan status from the agent - * @summary Ingest Malware Scan Status - * @param {Array} [ingestersMalwareScanStatus] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof MalwareScanApiInterface - */ - ingestMalwareScanStatusRaw(requestParameters: IngestMalwareScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest malware scan status from the agent - * Ingest Malware Scan Status - */ - ingestMalwareScanStatus(requestParameters: IngestMalwareScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** * Get Malware Scans list on agent or registry * @summary Get Malware Scans List @@ -425,82 +379,6 @@ export class MalwareScanApi extends runtime.BaseAPI implements MalwareScanApiInt return await response.value(); } - /** - * Ingest malware found while scanning the agent - * Ingest Malware - */ - async ingestMalwareRaw(requestParameters: IngestMalwareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/malware`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersMalware?.map(IngestersMalwareToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest malware found while scanning the agent - * Ingest Malware - */ - async ingestMalware(requestParameters: IngestMalwareRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestMalwareRaw(requestParameters, initOverrides); - } - - /** - * Ingest malware scan status from the agent - * Ingest Malware Scan Status - */ - async ingestMalwareScanStatusRaw(requestParameters: IngestMalwareScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/malware-scan-logs`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersMalwareScanStatus?.map(IngestersMalwareScanStatusToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest malware scan status from the agent - * Ingest Malware Scan Status - */ - async ingestMalwareScanStatus(requestParameters: IngestMalwareScanStatusRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestMalwareScanStatusRaw(requestParameters, initOverrides); - } - /** * Get Malware Scans list on agent or registry * Get Malware Scans List diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/apis/SecretScanApi.ts b/deepfence_frontend/apps/dashboard/src/api/generated/apis/SecretScanApi.ts index cfdea09e92..37a2b8a4c0 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/apis/SecretScanApi.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/apis/SecretScanApi.ts @@ -17,8 +17,6 @@ import * as runtime from '../runtime'; import type { ApiDocsBadRequestResponse, ApiDocsFailureResponse, - IngestersSecret, - IngestersSecretScanStatus, ModelScanListReq, ModelScanListResp, ModelScanResultsReq, @@ -37,10 +35,6 @@ import { ApiDocsBadRequestResponseToJSON, ApiDocsFailureResponseFromJSON, ApiDocsFailureResponseToJSON, - IngestersSecretFromJSON, - IngestersSecretToJSON, - IngestersSecretScanStatusFromJSON, - IngestersSecretScanStatusToJSON, ModelScanListReqFromJSON, ModelScanListReqToJSON, ModelScanListRespFromJSON, @@ -71,14 +65,6 @@ export interface CountResultsSecretScanRequest { modelScanResultsReq?: ModelScanResultsReq; } -export interface IngestSecretScanStatusRequest { - ingestersSecretScanStatus?: Array | null; -} - -export interface IngestSecretsRequest { - ingestersSecret?: Array | null; -} - export interface ListSecretScanRequest { modelScanListReq?: ModelScanListReq; } @@ -141,38 +127,6 @@ export interface SecretScanApiInterface { */ groupResultsSecrets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** - * Ingest secrets scan status from the agent - * @summary Ingest Secrets Scan Status - * @param {Array} [ingestersSecretScanStatus] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SecretScanApiInterface - */ - ingestSecretScanStatusRaw(requestParameters: IngestSecretScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest secrets scan status from the agent - * Ingest Secrets Scan Status - */ - ingestSecretScanStatus(requestParameters: IngestSecretScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - - /** - * Ingest secrets found while scanning the agent - * @summary Ingest Secrets - * @param {Array} [ingestersSecret] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SecretScanApiInterface - */ - ingestSecretsRaw(requestParameters: IngestSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest secrets found while scanning the agent - * Ingest Secrets - */ - ingestSecrets(requestParameters: IngestSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** * Get Secret Scans list on agent or registry * @summary Get Secret Scans List @@ -351,82 +305,6 @@ export class SecretScanApi extends runtime.BaseAPI implements SecretScanApiInter return await response.value(); } - /** - * Ingest secrets scan status from the agent - * Ingest Secrets Scan Status - */ - async ingestSecretScanStatusRaw(requestParameters: IngestSecretScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/secret-scan-logs`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersSecretScanStatus?.map(IngestersSecretScanStatusToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest secrets scan status from the agent - * Ingest Secrets Scan Status - */ - async ingestSecretScanStatus(requestParameters: IngestSecretScanStatusRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestSecretScanStatusRaw(requestParameters, initOverrides); - } - - /** - * Ingest secrets found while scanning the agent - * Ingest Secrets - */ - async ingestSecretsRaw(requestParameters: IngestSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/secrets`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersSecret?.map(IngestersSecretToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest secrets found while scanning the agent - * Ingest Secrets - */ - async ingestSecrets(requestParameters: IngestSecretsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestSecretsRaw(requestParameters, initOverrides); - } - /** * Get Secret Scans list on agent or registry * Get Secret Scans List diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/apis/VulnerabilityApi.ts b/deepfence_frontend/apps/dashboard/src/api/generated/apis/VulnerabilityApi.ts index 3d5c008055..b844d72d4a 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/apis/VulnerabilityApi.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/apis/VulnerabilityApi.ts @@ -17,8 +17,6 @@ import * as runtime from '../runtime'; import type { ApiDocsBadRequestResponse, ApiDocsFailureResponse, - IngestersVulnerability, - IngestersVulnerabilityScanStatus, ModelDownloadReportResponse, ModelSbomRequest, ModelSbomResponse, @@ -39,10 +37,6 @@ import { ApiDocsBadRequestResponseToJSON, ApiDocsFailureResponseFromJSON, ApiDocsFailureResponseToJSON, - IngestersVulnerabilityFromJSON, - IngestersVulnerabilityToJSON, - IngestersVulnerabilityScanStatusFromJSON, - IngestersVulnerabilityScanStatusToJSON, ModelDownloadReportResponseFromJSON, ModelDownloadReportResponseToJSON, ModelSbomRequestFromJSON, @@ -89,14 +83,6 @@ export interface IngestSbomRequest { utilsScanSbomRequest?: UtilsScanSbomRequest; } -export interface IngestVulnerabilitiesRequest { - ingestersVulnerability?: Array | null; -} - -export interface IngestVulnerabilitiesScanStatusRequest { - ingestersVulnerabilityScanStatus?: Array | null; -} - export interface ListVulnerabilityScansRequest { modelScanListReq?: ModelScanListReq; } @@ -188,38 +174,6 @@ export interface VulnerabilityApiInterface { */ ingestSbom(requestParameters: IngestSbomRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** - * Ingest vulnerabilities found while scanning the agent host or containers - * @summary Ingest Vulnerabilities - * @param {Array} [ingestersVulnerability] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof VulnerabilityApiInterface - */ - ingestVulnerabilitiesRaw(requestParameters: IngestVulnerabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest vulnerabilities found while scanning the agent host or containers - * Ingest Vulnerabilities - */ - ingestVulnerabilities(requestParameters: IngestVulnerabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - - /** - * Ingest vulnerabilities scan status from agent - * @summary Ingest Vulnerabilities Scan Status - * @param {Array} [ingestersVulnerabilityScanStatus] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof VulnerabilityApiInterface - */ - ingestVulnerabilitiesScanStatusRaw(requestParameters: IngestVulnerabilitiesScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; - - /** - * Ingest vulnerabilities scan status from agent - * Ingest Vulnerabilities Scan Status - */ - ingestVulnerabilitiesScanStatus(requestParameters: IngestVulnerabilitiesScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; - /** * Get Vulnerability Scan list on agent or registry * @summary Get Vulnerability Scans List @@ -462,82 +416,6 @@ export class VulnerabilityApi extends runtime.BaseAPI implements VulnerabilityAp await this.ingestSbomRaw(requestParameters, initOverrides); } - /** - * Ingest vulnerabilities found while scanning the agent host or containers - * Ingest Vulnerabilities - */ - async ingestVulnerabilitiesRaw(requestParameters: IngestVulnerabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/vulnerabilities`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersVulnerability?.map(IngestersVulnerabilityToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest vulnerabilities found while scanning the agent host or containers - * Ingest Vulnerabilities - */ - async ingestVulnerabilities(requestParameters: IngestVulnerabilitiesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestVulnerabilitiesRaw(requestParameters, initOverrides); - } - - /** - * Ingest vulnerabilities scan status from agent - * Ingest Vulnerabilities Scan Status - */ - async ingestVulnerabilitiesScanStatusRaw(requestParameters: IngestVulnerabilitiesScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { - const queryParameters: any = {}; - - const headerParameters: runtime.HTTPHeaders = {}; - - headerParameters['Content-Type'] = 'application/json'; - - if (this.configuration && this.configuration.accessToken) { - const token = this.configuration.accessToken; - const tokenString = await token("bearer_token", []); - - if (tokenString) { - headerParameters["Authorization"] = `Bearer ${tokenString}`; - } - } - const response = await this.request({ - path: `/deepfence/ingest/vulnerabilities-scan-logs`, - method: 'POST', - headers: headerParameters, - query: queryParameters, - body: requestParameters.ingestersVulnerabilityScanStatus?.map(IngestersVulnerabilityScanStatusToJSON), - }, initOverrides); - - return new runtime.VoidApiResponse(response); - } - - /** - * Ingest vulnerabilities scan status from agent - * Ingest Vulnerabilities Scan Status - */ - async ingestVulnerabilitiesScanStatus(requestParameters: IngestVulnerabilitiesScanStatusRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { - await this.ingestVulnerabilitiesScanStatusRaw(requestParameters, initOverrides); - } - /** * Get Vulnerability Scan list on agent or registry * Get Vulnerability Scans List diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/apis/index.ts b/deepfence_frontend/apps/dashboard/src/api/generated/apis/index.ts index caa6da4f80..f3668d6253 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/apis/index.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/apis/index.ts @@ -2,7 +2,6 @@ /* eslint-disable */ export * from './AuthenticationApi'; export * from './CloudNodesApi'; -export * from './CloudResourcesApi'; export * from './CloudScannerApi'; export * from './CommonApi'; export * from './CompletionApi'; diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/models/IngestersCloudResource.ts b/deepfence_frontend/apps/dashboard/src/api/generated/models/IngestersCloudResource.ts index 442ab35141..c5edf681e0 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/models/IngestersCloudResource.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/models/IngestersCloudResource.ts @@ -355,6 +355,12 @@ export interface IngestersCloudResource { * @memberof IngestersCloudResource */ region?: string; + /** + * + * @type {string} + * @memberof IngestersCloudResource + */ + resource_group?: string; /** * * @type {string} @@ -558,6 +564,7 @@ export function IngestersCloudResourceFromJSONTyped(json: any, ignoreDiscriminat 'public_ips': !exists(json, 'public_ips') ? undefined : json['public_ips'], 'public_network_access': !exists(json, 'public_network_access') ? undefined : json['public_network_access'], 'region': !exists(json, 'region') ? undefined : json['region'], + 'resource_group': !exists(json, 'resource_group') ? undefined : json['resource_group'], 'resource_id': !exists(json, 'resource_id') ? undefined : json['resource_id'], 'resource_vpc_config': !exists(json, 'resource_vpc_config') ? undefined : json['resource_vpc_config'], 'resources_vpc_config': !exists(json, 'resources_vpc_config') ? undefined : json['resources_vpc_config'], @@ -647,6 +654,7 @@ export function IngestersCloudResourceToJSON(value?: IngestersCloudResource | nu 'public_ips': value.public_ips, 'public_network_access': value.public_network_access, 'region': value.region, + 'resource_group': value.resource_group, 'resource_id': value.resource_id, 'resource_vpc_config': value.resource_vpc_config, 'resources_vpc_config': value.resources_vpc_config, diff --git a/deepfence_frontend/apps/dashboard/src/api/generated/models/UtilsReportFilters.ts b/deepfence_frontend/apps/dashboard/src/api/generated/models/UtilsReportFilters.ts index 8680d42c7a..d89bab7560 100644 --- a/deepfence_frontend/apps/dashboard/src/api/generated/models/UtilsReportFilters.ts +++ b/deepfence_frontend/apps/dashboard/src/api/generated/models/UtilsReportFilters.ts @@ -46,10 +46,10 @@ export interface UtilsReportFilters { most_exploitable_report?: boolean; /** * - * @type {string} + * @type {Array} * @memberof UtilsReportFilters */ - node_type: UtilsReportFiltersNodeTypeEnum; + node_type: Array; /** * * @type {string} diff --git a/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadSBOMAction.tsx b/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadSBOMAction.tsx index 199571a622..e6394b4d85 100644 --- a/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadSBOMAction.tsx +++ b/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadSBOMAction.tsx @@ -35,7 +35,7 @@ export const action = async ({ request }: ActionFunctionArgs): Promise => const getReportIdApiResponse = await getReportIdApi({ modelGenerateReportReq: { filters: { - node_type: nodeType, + node_type: [nodeType], scan_type: scanType, scan_id: scanId, }, diff --git a/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadScanAction.tsx b/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadScanAction.tsx index 72625995bb..0c841114bf 100644 --- a/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadScanAction.tsx +++ b/deepfence_frontend/apps/dashboard/src/features/common/data-component/downloadScanAction.tsx @@ -34,7 +34,7 @@ export const action = async ({ request }: ActionFunctionArgs): Promise => const getReportIdApiResponse = await getReportIdApi({ modelGenerateReportReq: { filters: { - node_type: nodeType, + node_type: [nodeType], scan_type: scanType, scan_id: scanId, }, diff --git a/deepfence_frontend/apps/dashboard/src/features/integrations/components/ReportsTable.tsx b/deepfence_frontend/apps/dashboard/src/features/integrations/components/ReportsTable.tsx index c3c703ea89..54c51e3355 100644 --- a/deepfence_frontend/apps/dashboard/src/features/integrations/components/ReportsTable.tsx +++ b/deepfence_frontend/apps/dashboard/src/features/integrations/components/ReportsTable.tsx @@ -154,7 +154,10 @@ export const ReportTable = ({ } if ( nodeTypeFilter?.length && - (!nodeTypeFilter.includes(filters?.node_type) || isNil(filters?.node_type)) + (!nodeTypeFilter.some((filter) => + filters?.node_type?.includes(filter as UtilsReportFiltersNodeTypeEnum), + ) || + isNil(filters?.node_type)) ) { return false; } diff --git a/deepfence_frontend/apps/dashboard/src/features/integrations/pages/CreateReport.tsx b/deepfence_frontend/apps/dashboard/src/features/integrations/pages/CreateReport.tsx index 35afaefcbb..300a909174 100644 --- a/deepfence_frontend/apps/dashboard/src/features/integrations/pages/CreateReport.tsx +++ b/deepfence_frontend/apps/dashboard/src/features/integrations/pages/CreateReport.tsx @@ -147,7 +147,7 @@ const action = async ({ request }: ActionFunctionArgs): Promise => { filters: { advanced_report_filters: advanced_report_filters, include_dead_nodes: body.deadNodes === 'on', - node_type: _nodeType, + node_type: [_nodeType], scan_type: _resource, severity_or_check_type: severitiesOrCheckTypes as UtilsReportFiltersSeverityOrCheckTypeEnum,