Jump to Content
Documentation
API Reference
Release Notes
Home
Documentation
API Reference
Release Notes
v1.0
v2.0
Documentation
API Reference
Release Notes
Log In
API Reference
Log In
v2.0
API Reference
REST API Quick Start Guide
All
Pages
Start typing to search…
JUMP TO
Panoptica API Reference
REST API Quick Start Guide
Panoptica API Specification
API Security Inventory
Returns the list of all APIs for a given account.
get
/apisec/v2/trace-analysis/apis
head
Create a new API
post
Delete an API from inventory
del
Get API Summary of a specific API
get
/apisec/v2/trace-analysis/apis/{apiId}
head
Get list of all endpoints for a given API
get
/apisec/v2/trace-analysis/apis/{apiId}/endpoints
head
Get API Endpoint details of a specific API
get
/apisec/v2/trace-analysis/apis/{apiId}/endpoints/{endpointId}
head
Get the api specs for a specific API
get
/apisec/v2/trace-analysis/apis/{apiId}/specifications
head
Create a new specification
post
Unset a spec for a specific API
del
Get the API specification for a specific API
get
/apisec/v2/trace-analysis/apis/{apiId}/specifications/{specId}
head
Add or edit a spec for a specific API
put
Get the API specs for a specific API
get
/apisec/v2/trace-analysis/apis/{apiId}/specifications/{specId}/oapi
head
Show all supported security context labels
get
/apisec/v2/trace-analysis/securityContextLabels
head
API Security Access Control Posture
Retrieve the authorization models for a given API endpoint
get
/apisec/v2/trace-analysis/apis/{apiId}/endpoints/{endpointId}/accessControlPosture
head
List authentication configurations
get
/apisec/v2/trace-analysis/authConfigurations
head
Create a new authentication configuration item
post
Delete an authentication configuration item
del
Show a specific authentication configuration
get
/apisec/v2/trace-analysis/authConfigurations/{authConfigId}
head
Update an existing authentication configuration item
put
API Security Findings
Get list of all findings for a given API grouped by finding type
get
/apisec/v2/trace-analysis/apis/{apiId}/findings
head
Get API all occurrences of the finding type in the API
get
/apisec/v2/trace-analysis/apis/{apiId}/findings/{findingTypeId}
head
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/counters
head
Get list of all findings for a given API, grouped by finding type
get
/apisec/v2/trace-analysis/apis/findings
head
List all occurrences of the specified finding type
get
/apisec/v2/trace-analysis/apis/findings/{findingTypeId}
head
List all findings for a given API, grouped by finding type
get
/apisec/v2/trace-analysis/apis/findings/occurrences
head
Show the list of all finding categories
get
/apisec/v2/trace-analysis/findings/categories
head
Shows the list of all finding sources
get
/apisec/v2/trace-analysis/findings/sources
head
API Security Sensitive Data
Show sensitive data findings
get
/apisec/v2/trace-analysis/apis/{apiId}/sensitiveDataFindings
head
Show all sensitive data patterns
get
/apisec/v2/trace-analysis/patterns
head
Update status of sensitive data pattern for a specific sensitive data pattern by Id
put
API Security Controllers
List all controllers
get
/apisec/v2/trace-analysis/controllers
head
Create a new API security controller
post
Delete an API security controller
del
Get details of a specific API security controller
get
/apisec/v2/trace-analysis/controllers/{apisecControllerId}
head
Modify attributes of an API security controller
put
Retrieve the deployment configuration for an API security controller
get
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentConfiguration
head
Retrieve the deployment instruction for an API security controller
get
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/deploymentInstructions
head
Retrieve the status of an API security controller
get
/apisec/v2/trace-analysis/controllers/{apisecControllerId}/status
head
API Security Dashboard
Get the numbers of risky findings
get
/apisec/v2/trace-analysis/dashboard/riskyFindings
head
Get the specifications and the operations differences of the APIs
get
/apisec/v2/trace-analysis/dashboard/specsAndOperationsDiffs
head
Get the list of top risky APIs
get
/apisec/v2/trace-analysis/dashboard/topRiskyApis
head
API Security Trace Sources
List the configured trace sources
get
/apisec/v2/trace-analysis/tracesources
head
Register a new trace source
post
Delete a trace source
del
Show the details of the trace source specified in the `traceSourceId` parameter
get
/apisec/v2/trace-analysis/tracesources/{traceSourceId}
head
Update trace analyzer ref for the trace source specified in the `traceSourceId` parameter
put
Retrieve the install bundle for the trace source specified in the `traceSourceId` parameter
get
/apisec/v2/trace-analysis/tracesources/{traceSourceId}/bundle
head
Generate a new token for a specific trace source and update the bundle
post
Get all controllers attached to an account with eligibility for a specific trace source type
get
/apisec/v2/trace-analysis/tracesources/{traceSourceType}/controllers
head
Platform
/platform/inventory/assets/list
get
/platform/inventory/assets/update
post
/platform/inventory/assets/{uuid}/details
get
Panoptica Onboarding
/api/settings/get_onboarded_environment_details/
get
/api/settings/get_onboarded_environments/
get
CSPM Assets
/cspm/assets/aggregated/by_service
get
/cspm/assets/aggregated/by_service/{provider}
get
/cspm/assets/details/{asset_id}
get
/cspm/assets/details/{asset_id}/{only_asset_details}
get
/cspm/assets/details/{asset_id}/{only_asset_details}/{matched_pattern_id}
get
/cspm/assets/list
get
CSPM Attack Path
/cspm/attackpath/list
get
/cspm/attackpath/{matched_pattern_id}/remediation
get
/cspm/attackpath/getattackpathdetails/{attack_path_id}
get
/cspm/attackpath/{matched_pattern_id}/risks
get
CSPM Security Findings
/cspm/security_findings/related_assets/{matched_agg_id}
get
/cspm/security_findings/{type}
get
CSPM Security Posture
/cspm/security_posture/list
get
/cspm/security_posture/total_summary
get
/cspm/security_posture/getsecurityfindingdetails/{risk_id}
get
CSPM Vulnerabilities
/cspm/vulnerabilities/k8s/report/init
get
/cspm/vulnerabilities/k8s/report/status/{report_id}
get
/cspm/vulnerabilities/assetreport
get
/cspm/vulnerabilities/details/{cve_id}
get
/cspm/vulnerabilities/distinct/cve/assets_table/{cve_id}/{limit}
get
/cspm/vulnerabilities/distinct/cve/details/{cve_id}
get
/cspm/vulnerabilities/distinct/cve/image_table/{cve_id}/{limit}
get
/cspm/vulnerabilities/distinct/filters
get
/cspm/vulnerabilities/distinct/table
get
/cspm/vulnerabilities/distinct/top_vulnerabilities
get
/cspm/vulnerabilities/list
get
/cspm/vulnerabilities/top_vulnerabilities
get
CSPM Discovery Graph
/cspm/discovery_graph/build_query
post
/cspm/discovery_graph/build_query_async
post
/cspm/discovery_graph/execute_query/{query_id}
get
/cspm/discovery_graph/graphqueries/
get
/cspm/discovery_graph/graphqueries/
post
/cspm/discovery_graph/graphqueries/{id}/
get
/cspm/discovery_graph/graphqueries/{id}/
put
/cspm/discovery_graph/graphqueries/{id}/
del
/cspm/discovery_graph/graphqueries/{id}/
patch
/cspm/discovery_graph/list_from_query_response
post
Panoptica Integrations
List Integrations
get
Create Integration
post
Get Integration
get
Replace Integration
put
Update Integration.
patch
Delete Integration
del
Get the helm command for an integration
get
Get the helm values file for an integration
get
Get information about the helm chart
get
Panoptica Releases
List releases
get
Get release
get
Get the latest release
get
Policy Frameworks
Create a new Policy Framework
post
List all Policy Frameworks.
get
Update the Status of the specific Policy Frameworks and their Policy Rules based on the FrameworkID
patch
Returns the specific Policy Framework based on the ID
get
Update the specific Policy Framework based on the ID
put
Delete the specific Policy Framework based on the ID
del
Policy Categories
Create a new Category
post
List all Categories.
get
Returns the specific Category based on the ID
get
Update the specific Category based on the ID
put
Delete the specific Category based on the ID
del
Policy Rules
List all the PolicyRules
get
Returns the specific Policy Rule based on the ID
get
Update Policy Rule and Category associations.
put
Returns the number of Policy Rule per engine.
get
Powered by
REST API Quick Start Guide
Ask AI
