Panoptica API Reference

REST API Quick Start Guide

Panoptica API Specification

API Security Inventory
API Security Access Control Posture
API Security Findings
API Security Sensitive Data
API Security Controllers
API Security Dashboard
API Security Trace Sources
Platform
Panoptica Onboarding
- /api/settings/get_onboarded_environment_details/get
- /api/settings/get_onboarded_environments/get
CSPM Assets
CSPM Attack Path
CSPM Security Findings
- /cspm/security_findings/related_assets/{matched_agg_id}get
- /cspm/security_findings/{type}get
CSPM Security Posture
CSPM Vulnerabilities
CSPM Discovery Graph
Panoptica Integrations
Panoptica Releases
Policy Frameworks
Policy Categories
Policy Rules

Panoptica API Reference

REST API Quick Start Guide

Panoptica API Specification

API Security Inventory
API Security Access Control Posture
API Security Findings
API Security Sensitive Data
API Security Controllers
API Security Dashboard
API Security Trace Sources
Platform
Panoptica Onboarding
- /api/settings/get_onboarded_environment_details/get
- /api/settings/get_onboarded_environments/get
CSPM Assets
CSPM Attack Path
CSPM Security Findings
- /cspm/security_findings/related_assets/{matched_agg_id}get
- /cspm/security_findings/{type}get
CSPM Security Posture
CSPM Vulnerabilities
CSPM Discovery Graph
Panoptica Integrations
Panoptica Releases
Policy Frameworks
Policy Categories
Policy Rules

/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentConfiguration

head https://api.{location}.console.panoptica.app/api/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentConfiguration

URL Expired

The URL for this request expired after 30 days.

Path Params

apisecControllerId

string

required

length ≤ 50

The ID of the controller.

Responses

Headers

object

Date

string

The timestamp the response was processed, based on the server's clock, in RFC 5322 date and time format. GMT must be used as the time zone reference for this header.

TrackingID

string

length ≤ 50

Unique identifier for the request

Headers

object

Date

string

The timestamp the response was processed, based on the server's clock, in RFC 5322 date and time format. GMT must be used as the time zone reference for this header.

TrackingID

string

length ≤ 50

Unique identifier for the request

Headers

object

Date

string

The timestamp the response was processed, based on the server's clock, in RFC 5322 date and time format. GMT must be used as the time zone reference for this header.

TrackingID

string

length ≤ 50

Unique identifier for the request

Headers

object

Date

string

The timestamp the response was processed, based on the server's clock, in RFC 5322 date and time format. GMT must be used as the time zone reference for this header.

TrackingID

string

length ≤ 50

Unique identifier for the request

Headers

object

Date

string

The timestamp the response was processed, based on the server's clock, in RFC 5322 date and time format. GMT must be used as the time zone reference for this header.

TrackingID

string

length ≤ 50

Unique identifier for the request

Updated 7 months ago

Retrieve the deployment configuration for an API security controller

Retrieve the deployment instruction for an API security controller

Language

URL


xxxxxxxxxx
1
curl --request HEAD \
2
     --url https://api.us1.console.panoptica.app/api/apisec/v2/trace-analysis/controllers/apisecControllerId/deploymentConfiguration

Click Try It! to start a request and see the response here! Or choose an example:

*/*

Updated 7 months ago

Retrieve the deployment configuration for an API security controller

Retrieve the deployment instruction for an API security controller

Panoptica API Reference
REST API Quick Start Guide

Panoptica API Specification
API Security Inventory
/apisec/v2/trace-analysis/securityContextLabelshead
Show all supported security context labelsget
/apisec/v2/trace-analysis/apis/{apiId}/specifications/{specId}/oapihead
Get the API specs for a specific APIget
Add or edit a spec for a specific APIput
/apisec/v2/trace-analysis/apis/{apiId}/specifications/{specId}head
Get the API specification for a specific APIget
Unset a spec for a specific APIdelete
Create a new specificationpost
/apisec/v2/trace-analysis/apis/{apiId}/specificationshead
Get the api specs for a specific APIget
/apisec/v2/trace-analysis/apis/{apiId}/endpoints/{endpointId}head
Get API Endpoint details of a specific APIget
/apisec/v2/trace-analysis/apis/{apiId}/endpointshead
Get list of all endpoints for a given APIget
/apisec/v2/trace-analysis/apis/{apiId}head
Get API Summary of a specific APIget
Delete an API from inventorydelete
Create a new APIpost
/apisec/v2/trace-analysis/apishead
Returns the list of all APIs for a given account.get
API Security Access Control Posture
Update an existing authentication configuration itemput
/apisec/v2/trace-analysis/authConfigurations/{authConfigId}head
Show a specific authentication configurationget
Delete an authentication configuration itemdelete
Create a new authentication configuration itempost
/apisec/v2/trace-analysis/authConfigurationshead
List authentication configurationsget
/apisec/v2/trace-analysis/apis/{apiId}/endpoints/{endpointId}/accessControlPosturehead
Retrieve the authorization models for a given API endpointget
API Security Findings
/apisec/v2/trace-analysis/findings/sourceshead
Shows the list of all finding sourcesget
/apisec/v2/trace-analysis/findings/categorieshead
Show the list of all finding categoriesget
/apisec/v2/trace-analysis/apis/findings/occurrenceshead
List all findings for a given API, grouped by finding typeget
/apisec/v2/trace-analysis/apis/findings/{findingTypeId}head
List all occurrences of the specified finding typeget
/apisec/v2/trace-analysis/apis/findingshead
Get list of all findings for a given API, grouped by finding typeget
/apisec/v2/trace-analysis/apis/{apiId}/findings/countershead
Show the list and the number of all findings for the specified API, grouped by finding type.get
/apisec/v2/trace-analysis/apis/{apiId}/findings/{findingTypeId}head
Get API all occurrences of the finding type in the APIget
/apisec/v2/trace-analysis/apis/{apiId}/findingshead
Get list of all findings for a given API grouped by finding typeget
API Security Sensitive Data
Update status of sensitive data pattern for a specific sensitive data pattern by Idput
/apisec/v2/trace-analysis/patternshead
Show all sensitive data patternsget
/apisec/v2/trace-analysis/apis/{apiId}/sensitiveDataFindingshead
Show sensitive data findingsget
API Security Controllers
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/statushead
Retrieve the status of an API security controllerget
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentInstructionshead
Retrieve the deployment instruction for an API security controllerget
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentConfigurationhead
Retrieve the deployment configuration for an API security controllerget
Modify attributes of an API security controllerput
/apisec/v2/trace-analysis/controllers/{apisecControllerId}head
Get details of a specific API security controllerget
Delete an API security controllerdelete
Create a new API security controllerpost
/apisec/v2/trace-analysis/controllershead
List all controllersget
API Security Dashboard
/apisec/v2/trace-analysis/dashboard/topRiskyApishead
Get the list of top risky APIsget
/apisec/v2/trace-analysis/dashboard/specsAndOperationsDiffshead
Get the specifications and the operations differences of the APIsget
/apisec/v2/trace-analysis/dashboard/riskyFindingshead
Get the numbers of risky findingsget
API Security Trace Sources
/apisec/v2/trace-analysis/tracesources/{traceSourceType}/controllershead
Get all controllers attached to an account with eligibility for a specific trace source typeget
Generate a new token for a specific trace source and update the bundlepost
/apisec/v2/trace-analysis/tracesources/{traceSourceId}/bundlehead
Retrieve the install bundle for the trace source specified in the `traceSourceId` parameterget
Update trace analyzer ref for the trace source specified in the `traceSourceId` parameterput
/apisec/v2/trace-analysis/tracesources/{traceSourceId}head
Show the details of the trace source specified in the `traceSourceId` parameterget
Delete a trace sourcedelete
Register a new trace sourcepost
/apisec/v2/trace-analysis/tracesourceshead
List the configured trace sourcesget
Platform
/platform/inventory/assets/{uuid}/detailsget
/platform/inventory/assets/updatepost
/platform/inventory/assets/listget
Panoptica Onboarding
/api/settings/get_onboarded_environments/get
/api/settings/get_onboarded_environment_details/get
CSPM Assets
/cspm/assets/listget
/cspm/assets/details/{asset_id}/{only_asset_details}/{matched_pattern_id}get
/cspm/assets/details/{asset_id}/{only_asset_details}get
/cspm/assets/details/{asset_id}get
/cspm/assets/aggregated/by_service/{provider}get
/cspm/assets/aggregated/by_serviceget
CSPM Attack Path
/cspm/attackpath/{matched_pattern_id}/risksget
/cspm/attackpath/getattackpathdetails/{attack_path_id}get
/cspm/attackpath/{matched_pattern_id}/remediationget
/cspm/attackpath/listget
CSPM Security Findings
/cspm/security_findings/{type}get
/cspm/security_findings/related_assets/{matched_agg_id}get
CSPM Security Posture
/cspm/security_posture/getsecurityfindingdetails/{risk_id}get
/cspm/security_posture/total_summaryget
/cspm/security_posture/listget
CSPM Vulnerabilities
/cspm/vulnerabilities/top_vulnerabilitiesget
/cspm/vulnerabilities/listget
/cspm/vulnerabilities/distinct/top_vulnerabilitiesget
/cspm/vulnerabilities/distinct/tableget
/cspm/vulnerabilities/distinct/filtersget
/cspm/vulnerabilities/distinct/cve/image_table/{cve_id}/{limit}get
/cspm/vulnerabilities/distinct/cve/details/{cve_id}get
/cspm/vulnerabilities/distinct/cve/assets_table/{cve_id}/{limit}get
/cspm/vulnerabilities/details/{cve_id}get
/cspm/vulnerabilities/assetreportget
/cspm/vulnerabilities/k8s/report/status/{report_id}get
/cspm/vulnerabilities/k8s/report/initget
CSPM Discovery Graph
/cspm/discovery_graph/list_from_query_responsepost
/cspm/discovery_graph/graphqueries/{id}/patch
/cspm/discovery_graph/graphqueries/{id}/delete
/cspm/discovery_graph/graphqueries/{id}/put
/cspm/discovery_graph/graphqueries/{id}/get
/cspm/discovery_graph/graphqueries/post
/cspm/discovery_graph/graphqueries/get
/cspm/discovery_graph/execute_query/{query_id}get
/cspm/discovery_graph/build_query_asyncpost
/cspm/discovery_graph/build_querypost
Panoptica Integrations
Get information about the helm chartget
Get the helm values file for an integrationget
Get the helm command for an integrationget
Delete Integrationdelete
Update Integration.patch
Replace Integrationput
Get Integrationget
Create Integrationpost
List Integrationsget
Panoptica Releases
Get the latest releaseget
Get releaseget
List releasesget
Policy Frameworks
Delete the specific Policy Framework based on the IDdelete
Update the specific Policy Framework based on the IDput
Returns the specific Policy Framework based on the IDget
Update the Status of the specific Policy Frameworks and their Policy Rules based on the FrameworkIDpatch
List all Policy Frameworks.get
Create a new Policy Frameworkpost
Policy Categories
Delete the specific Category based on the IDdelete
Update the specific Category based on the IDput
Returns the specific Category based on the IDget
List all Categories.get
Create a new Categorypost
Policy Rules
Returns the number of Policy Rule per engine.get
Update Policy Rule and Category associations.put
Returns the specific Policy Rule based on the IDget
List all the PolicyRulesget

Panoptica API Reference
REST API Quick Start Guide

Panoptica API Specification
API Security Inventory
/apisec/v2/trace-analysis/securityContextLabelshead
Show all supported security context labelsget
/apisec/v2/trace-analysis/apis/{apiId}/specifications/{specId}/oapihead
Get the API specs for a specific APIget
Add or edit a spec for a specific APIput
/apisec/v2/trace-analysis/apis/{apiId}/specifications/{specId}head
Get the API specification for a specific APIget
Unset a spec for a specific APIdelete
Create a new specificationpost
/apisec/v2/trace-analysis/apis/{apiId}/specificationshead
Get the api specs for a specific APIget
/apisec/v2/trace-analysis/apis/{apiId}/endpoints/{endpointId}head
Get API Endpoint details of a specific APIget
/apisec/v2/trace-analysis/apis/{apiId}/endpointshead
Get list of all endpoints for a given APIget
/apisec/v2/trace-analysis/apis/{apiId}head
Get API Summary of a specific APIget
Delete an API from inventorydelete
Create a new APIpost
/apisec/v2/trace-analysis/apishead
Returns the list of all APIs for a given account.get
API Security Access Control Posture
Update an existing authentication configuration itemput
/apisec/v2/trace-analysis/authConfigurations/{authConfigId}head
Show a specific authentication configurationget
Delete an authentication configuration itemdelete
Create a new authentication configuration itempost
/apisec/v2/trace-analysis/authConfigurationshead
List authentication configurationsget
/apisec/v2/trace-analysis/apis/{apiId}/endpoints/{endpointId}/accessControlPosturehead
Retrieve the authorization models for a given API endpointget
API Security Findings
/apisec/v2/trace-analysis/findings/sourceshead
Shows the list of all finding sourcesget
/apisec/v2/trace-analysis/findings/categorieshead
Show the list of all finding categoriesget
/apisec/v2/trace-analysis/apis/findings/occurrenceshead
List all findings for a given API, grouped by finding typeget
/apisec/v2/trace-analysis/apis/findings/{findingTypeId}head
List all occurrences of the specified finding typeget
/apisec/v2/trace-analysis/apis/findingshead
Get list of all findings for a given API, grouped by finding typeget
/apisec/v2/trace-analysis/apis/{apiId}/findings/countershead
Show the list and the number of all findings for the specified API, grouped by finding type.get
/apisec/v2/trace-analysis/apis/{apiId}/findings/{findingTypeId}head
Get API all occurrences of the finding type in the APIget
/apisec/v2/trace-analysis/apis/{apiId}/findingshead
Get list of all findings for a given API grouped by finding typeget
API Security Sensitive Data
Update status of sensitive data pattern for a specific sensitive data pattern by Idput
/apisec/v2/trace-analysis/patternshead
Show all sensitive data patternsget
/apisec/v2/trace-analysis/apis/{apiId}/sensitiveDataFindingshead
Show sensitive data findingsget
API Security Controllers
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/statushead
Retrieve the status of an API security controllerget
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentInstructionshead
Retrieve the deployment instruction for an API security controllerget
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentConfigurationhead
Retrieve the deployment configuration for an API security controllerget
Modify attributes of an API security controllerput
/apisec/v2/trace-analysis/controllers/{apisecControllerId}head
Get details of a specific API security controllerget
Delete an API security controllerdelete
Create a new API security controllerpost
/apisec/v2/trace-analysis/controllershead
List all controllersget
API Security Dashboard
/apisec/v2/trace-analysis/dashboard/topRiskyApishead
Get the list of top risky APIsget
/apisec/v2/trace-analysis/dashboard/specsAndOperationsDiffshead
Get the specifications and the operations differences of the APIsget
/apisec/v2/trace-analysis/dashboard/riskyFindingshead
Get the numbers of risky findingsget
API Security Trace Sources
/apisec/v2/trace-analysis/tracesources/{traceSourceType}/controllershead
Get all controllers attached to an account with eligibility for a specific trace source typeget
Generate a new token for a specific trace source and update the bundlepost
/apisec/v2/trace-analysis/tracesources/{traceSourceId}/bundlehead
Retrieve the install bundle for the trace source specified in the `traceSourceId` parameterget
Update trace analyzer ref for the trace source specified in the `traceSourceId` parameterput
/apisec/v2/trace-analysis/tracesources/{traceSourceId}head
Show the details of the trace source specified in the `traceSourceId` parameterget
Delete a trace sourcedelete
Register a new trace sourcepost
/apisec/v2/trace-analysis/tracesourceshead
List the configured trace sourcesget
Platform
/platform/inventory/assets/{uuid}/detailsget
/platform/inventory/assets/updatepost
/platform/inventory/assets/listget
Panoptica Onboarding
/api/settings/get_onboarded_environments/get
/api/settings/get_onboarded_environment_details/get
CSPM Assets
/cspm/assets/listget
/cspm/assets/details/{asset_id}/{only_asset_details}/{matched_pattern_id}get
/cspm/assets/details/{asset_id}/{only_asset_details}get
/cspm/assets/details/{asset_id}get
/cspm/assets/aggregated/by_service/{provider}get
/cspm/assets/aggregated/by_serviceget
CSPM Attack Path
/cspm/attackpath/{matched_pattern_id}/risksget
/cspm/attackpath/getattackpathdetails/{attack_path_id}get
/cspm/attackpath/{matched_pattern_id}/remediationget
/cspm/attackpath/listget
CSPM Security Findings
/cspm/security_findings/{type}get
/cspm/security_findings/related_assets/{matched_agg_id}get
CSPM Security Posture
/cspm/security_posture/getsecurityfindingdetails/{risk_id}get
/cspm/security_posture/total_summaryget
/cspm/security_posture/listget
CSPM Vulnerabilities
/cspm/vulnerabilities/top_vulnerabilitiesget
/cspm/vulnerabilities/listget
/cspm/vulnerabilities/distinct/top_vulnerabilitiesget
/cspm/vulnerabilities/distinct/tableget
/cspm/vulnerabilities/distinct/filtersget
/cspm/vulnerabilities/distinct/cve/image_table/{cve_id}/{limit}get
/cspm/vulnerabilities/distinct/cve/details/{cve_id}get
/cspm/vulnerabilities/distinct/cve/assets_table/{cve_id}/{limit}get
/cspm/vulnerabilities/details/{cve_id}get
/cspm/vulnerabilities/assetreportget
/cspm/vulnerabilities/k8s/report/status/{report_id}get
/cspm/vulnerabilities/k8s/report/initget
CSPM Discovery Graph
/cspm/discovery_graph/list_from_query_responsepost
/cspm/discovery_graph/graphqueries/{id}/patch
/cspm/discovery_graph/graphqueries/{id}/delete
/cspm/discovery_graph/graphqueries/{id}/put
/cspm/discovery_graph/graphqueries/{id}/get
/cspm/discovery_graph/graphqueries/post
/cspm/discovery_graph/graphqueries/get
/cspm/discovery_graph/execute_query/{query_id}get
/cspm/discovery_graph/build_query_asyncpost
/cspm/discovery_graph/build_querypost
Panoptica Integrations
Get information about the helm chartget
Get the helm values file for an integrationget
Get the helm command for an integrationget
Delete Integrationdelete
Update Integration.patch
Replace Integrationput
Get Integrationget
Create Integrationpost
List Integrationsget
Panoptica Releases
Get the latest releaseget
Get releaseget
List releasesget
Policy Frameworks
Delete the specific Policy Framework based on the IDdelete
Update the specific Policy Framework based on the IDput
Returns the specific Policy Framework based on the IDget
Update the Status of the specific Policy Frameworks and their Policy Rules based on the FrameworkIDpatch
List all Policy Frameworks.get
Create a new Policy Frameworkpost
Policy Categories
Delete the specific Category based on the IDdelete
Update the specific Category based on the IDput
Returns the specific Category based on the IDget
List all Categories.get
Create a new Categorypost
Policy Rules
Returns the number of Policy Rule per engine.get
Update Policy Rule and Category associations.put
Returns the specific Policy Rule based on the IDget
List all the PolicyRulesget

200OK

400Bad Request

404Not Found

500Internal Server Error

defaultGeneral error