Workload Protection API

Introduction In architectures that are focused on container and microservices, you can use IBM Cloud® Security and Compliance Center Workload Protection to protect, monitor, and enhance forensic analysis of your pipeline and runtime components. IBM Cloud Security and Compliance Center Workload Protection is available natively on IBM Cloud with an API and SDK that is maintained and provided by Sysdig. For details about using IBM Cloud Security and Compliance Center Workload Protection, see the IBM Cloud docshttps://cloud.ibm.com/docs/workload-protection?topic=workload-protection-getting-startedgetting-started. Use the following syntax from a terminal to run a cURL command: shell curl -X

MethodPathSummary
GET/api/cloud/v2/accountIDsList the Cloud Account IDs.
GET/api/cloud/v2/accountsList the Cloud Accounts.
POST/api/cloud/v2/accountsCreate a new Cloud Account.
POST/api/cloud/v2/accounts/registerRegister a new Cloud Account.
DELETE/api/cloud/v2/accounts/{accountId}Delete a Cloud Account.
GET/api/cloud/v2/accounts/{accountId}Get the Cloud Account.
PUT/api/cloud/v2/accounts/{accountId}Update the alias, roleAvailable or roleName of a Cloud Account.
GET/api/cloud/v2/accounts/{accountId}/validateRoleDetermine whether a valid role exists.
GET/api/cloud/v2/dataSources/accountsList the Cloud Account's Datasources.
GET/api/cloud/v2/dataSources/clustersList the Cloud Account's Clusters.
GET/api/cloud/v2/dataSources/filter/accountsList the Cloud Accounts and Monitor Accounts.
GET/api/cloud/v2/dataSources/filter/agentStatusList Agent Status.
GET/api/cloud/v2/dataSources/filter/agentVersionsList all Agent Versions.
GET/api/cloud/v2/dataSources/filter/clustersList the Clusters.
GET/api/cloud/v2/dataSources/filter/nodesList all the Nodes.
GET/api/cloud/v2/dataSources/statusGet the DataSources status.
GET/api/cloud/v2/groupsGet the list of groups.
GET/api/cloud/v2/groups/policiesGet the list of policies attached to the specified group.
GET/api/cloud/v2/groups/policySuggestionGet a policy suggestion by group.
GET/api/cloud/v2/groups/usersGet the list of users attached to the specified group.
GET/api/cloud/v2/labelsList the supported labels.
GET/api/cloud/v2/policiesGet the list of policies.
GET/api/cloud/v2/policies/groupsGet the policy groups.
GET/api/cloud/v2/policies/policyDocGet the policy document.
GET/api/cloud/v2/policies/policySuggestionGet the policy suggestion by policy.
GET/api/cloud/v2/policies/usersGet the policy users.
GET/api/cloud/v2/reports/groups/csvGet the Groups CSV Report.
GET/api/cloud/v2/reports/policies/csvGet the Policies CSV Report.
GET/api/cloud/v2/reports/users/csvGet the Users CSV Report.
GET/api/cloud/v2/riskCategoryList the risk category thresholds.
GET/api/cloud/v2/riskFindingsDefinitionList the risk finding(s) definition.
GET/api/cloud/v2/riskLabelScoresList the risk label scores.
GET/api/cloud/v2/usersGet the list of users.
GET/api/cloud/v2/users/groupsGet the list of groups attached to a specified user.
GET/api/cloud/v2/users/policyInfoGet the policy information.
GET/api/cloud/v2/users/policySuggestionGet a policy suggestion by user.
GET/api/cloudauth/v1/accountsList Cloudauth Accounts
POST/api/cloudauth/v1/accountsCreate Cloudauth Accounts
DELETE/api/cloudauth/v1/accounts/{accountId}Delete Cloudauth Accounts By Account Id
GET/api/cloudauth/v1/accounts/{accountId}Get Cloudauth Accounts By Account Id
PUT/api/cloudauth/v1/accounts/{accountId}Update Cloudauth Accounts By Account Id
GET/api/cloudauth/v1/accounts/{accountId}/componentsList Cloudauth Accounts Components By Account Id
POST/api/cloudauth/v1/accounts/{accountId}/componentsCreate Cloudauth Accounts Components By Account Id
DELETE/api/cloudauth/v1/accounts/{accountId}/components/{componentType}/{componentInstance}Delete Cloudauth Accounts Components By Account Id And Component Type And Component Instance
GET/api/cloudauth/v1/accounts/{accountId}/components/{componentType}/{componentInstance}Get Cloudauth Accounts Components By Account Id And Component Type And Component Instance
PUT/api/cloudauth/v1/accounts/{accountId}/components/{componentType}/{componentInstance}Update Cloudauth Accounts Components By Account Id And Component Type And Component Instance
POST/api/cloudauth/v1/accounts/{accountId}/components/{componentType}/{componentInstance}/validateCreate Cloudauth Accounts Components Validate By Account Id And Component Type And Component Instance
DELETE/api/cloudauth/v1/accounts/{accountId}/feature/{featureType}Delete Cloudauth Accounts Feature By Account Id And Feature Type
GET/api/cloudauth/v1/accounts/{accountId}/feature/{featureType}Get Cloudauth Accounts Feature By Account Id And Feature Type
PUT/api/cloudauth/v1/accounts/{accountId}/feature/{featureType}Update Cloudauth Accounts Feature By Account Id And Feature Type
POST/api/cloudauth/v1/accounts/{accountId}/feature/{featureType}/validateCreate Cloudauth Accounts Feature Validate By Account Id And Feature Type
POST/api/cloudauth/v1/accounts/{accountId}/validateCreate Cloudauth Accounts Validate By Account Id
POST/api/cloudauth/v1/components/validateCreate Cloudauth Components Validate
GET/api/cloudauth/v1/organizationsList Cloudauth Organizations
POST/api/cloudauth/v1/organizationsCreate Cloudauth Organizations
DELETE/api/cloudauth/v1/organizations/{organizationId}Delete Cloudauth Organizations By Organization Id
GET/api/cloudauth/v1/organizations/{organizationId}Get Cloudauth Organizations By Organization Id
PUT/api/cloudauth/v1/organizations/{organizationId}Update Cloudauth Organizations By Organization Id
POST/api/cloudauth/v1/organizations/{organizationId}/validateCreate Cloudauth Organizations Validate By Organization Id
GET/api/cspm/v1/cloud/resourcesCloud Resources
GET/api/cspm/v1/clusteranalysis/resourcesCluster Analysis Resources
GET/api/cspm/v1/compliance/requirementsCompliance Results
GET/api/cspm/v1/compliance/viewsCompliance Views
PUT/api/cspm/v1/compliance/views/favoriteUpdate favorite view
POST/api/cspm/v1/compliance/violations/acceptancesAccept Posture Risk
GET/api/cspm/v1/kube/resourcesKuberenetes Resources
POST/api/cspm/v1/policy/controlsSave Control
GET/api/cspm/v1/policy/controls/resource-template/kindsGet Resource Kinds
GET/api/cspm/v1/policy/controls/resource-template/view/{resource_kind}Get Resource Example
GET/api/cspm/v1/policy/controls/searchControls
POST/api/cspm/v1/policy/controls/test-regoTest Rego
GET/api/cspm/v1/policy/controls/{controlId}/configurationGet Control Configurations
PUT/api/cspm/v1/policy/controls/{controlId}/configurationUpdate Control Configurations
GET/api/cspm/v1/policy/policies/listGet Policies
GET/api/cspm/v1/policy/zonesGet Zones
POST/api/cspm/v1/policy/zonesSave Zone
DELETE/api/cspm/v1/policy/zones/delete/{id}Delete Zone
GET/api/cspm/v1/tasksSearch and list CSPM Tasks
GET/api/cspm/v1/tasks/{taskId}Task
POST/api/cspm/v1/tasks/{taskId}/rerunRerun Task
GET/api/cspm/v1/inventory/resourcesSearch and list Inventory Resources
GET/api/cspm/v1/inventory/resources/{hash}Retrieve a single Inventory Resource by its hash
GET/api/policies/v3/rules/groupsRetrieve a group of all rules matching a list of given names
POST/api/secure/rulesCreate a new rule
GET/api/secure/rules/groupsRetrieve a group of all rules having a given name
GET/api/secure/rules/policyMappingsRetrieve a map of rule names to their corresponding policies that use them
GET/api/secure/rules/summariesRetrieve a list of summary rule information, grouped by rule name
GET/api/secure/rules/tagsRetrieves every tag associated with a runtime policy rule
DELETE/api/secure/rules/{ruleId}Delete a rule
GET/api/secure/rules/{ruleId}Retrieve info about a single rule
PUT/api/secure/rules/{ruleId}Update info associated with a rule
GET/api/reporting/v1/{domain}/reports/{fileId}Download a previously generated report
GET/api/reporting/v1/{domain}/schedulesList all the saved schedules for report generation
POST/api/reporting/v1/{domain}/schedulesCreate a new schedule for report generation
DELETE/api/reporting/v1/{domain}/schedules/{scheduleId}Remove the requested schedule for report generation
GET/api/reporting/v1/{domain}/schedules/{scheduleId}Get the configuration of the requested schedule for report generation
PUT/api/reporting/v1/{domain}/schedules/{scheduleId}Edit the configuration of the requested schedule for report generation
POST/api/reporting/v1/{domain}/schedules/{scheduleId}/runGenerate an on-demand report using the configuration of the requested schedule
GET/api/reporting/v1/{domain}/{reportType}/configGet all the options available to define a report configuration
POST/api/reporting/v1/{domain}/{reportType}/previewGet a result preview of a report with the given configuration
GET/api/scanning/reporting/v2/schedulesList all the saved schedules for report generation
POST/api/scanning/reporting/v2/schedulesCreate a new schedule for report generation
POST/api/scanning/reporting/v2/schedules/disableDisable all schedules for a given customer
DELETE/api/scanning/reporting/v2/schedules/{scheduleId}Remove the requested schedule for report generation
GET/api/scanning/reporting/v2/schedules/{scheduleId}Get the configuration of the requested schedule for report generation
PUT/api/scanning/reporting/v2/schedules/{scheduleId}Edit the configuration of the requested schedule for report generation
GET/api/scanning/reporting/v2/schedules/{scheduleId}/downloadDownload the last generated report of the given schedule
HEAD/api/scanning/reporting/v2/schedules/{scheduleId}/downloadReturn headers of the download request
GET/api/scanning/reporting/v2/schedules/{scheduleId}/reportsGet the list of reports generated by a schedule
GET/api/scanning/reporting/v2/schedules/{scheduleId}/reports/{reportId}Get a specific report
GET/api/scanning/reporting/v2/schedules/{scheduleId}/reports/{reportId}/downloadDownload a specific report
HEAD/api/scanning/reporting/v2/schedules/{scheduleId}/reports/{reportId}/downloadGet the download headers
POST/api/scanning/reporting/v2/schedules/{scheduleId}/runGenerate an on-demand report using the configuration of the requested schedule
GET/api/scanning/reporting/v2/schedules/{scheduleId}/statusGet the status of the current and last completed reports generated by the schedule
GET/api/scanning/reporting/v2/{reportType}/configGet all the options available to define a report configuration
GET/api/scanning/reporting/v2/{reportType}/entities/{entityType}/configGet all the options available to define a report configuration
POST/api/scanning/reporting/v2/{reportType}/entities/{entityType}/previewGet a result preview of a report with the given configuration
POST/api/scanning/reporting/v2/{reportType}/previewGet a result preview of a report with the given configuration
POST/api/secure/falco/listsCreate a new falco list
GET/api/secure/falco/lists/groupsRetrieve a group of falco lists having a given name
GET/api/secure/falco/lists/summariesRetrieve a list of summary falco list information, grouped by list name
DELETE/api/secure/falco/lists/{listId}Delete a Falco list
GET/api/secure/falco/lists/{listId}Retrieve a Falco list
PUT/api/secure/falco/lists/{listId}Update a Falco list
PUT/api/settings/falco/listsUpdate multiple default falco lists
PUT/api/settings/falco/lists/{listId}Update a default Falco list
POST/api/secure/falco/macrosCreate a new Falco macro
GET/api/secure/falco/macros/groupsRetrieve a group of all falco macros having a given name
GET/api/secure/falco/macros/summariesRetrieve a list of summary macro information, grouped by macro name
DELETE/api/secure/falco/macros/{macroId}Delete a Falco macro
GET/api/secure/falco/macros/{macroId}Retrieve a Falco macro
PUT/api/secure/falco/macros/{macroId}Update a Falco macro
GET/api/secure/lists/groups/versionsGet the last 10 versions of a list.
GET/api/secure/lists/groups/versions/diff/{version1}/{version2}Compares two list versions
GET/api/secure/lists/groups/versions/latestGets latest version of a list.
GET/api/secure/macros/groups/versionsGet the last 10 versions of a macro.
GET/api/secure/macros/groups/versions/diff/{version1}/{version2}Compares two macro versions
GET/api/secure/macros/groups/versions/latestGets latest version of a macro.
GET/api/secure/rules/groups/versionsGet the last 10 versions of a rule.
GET/api/secure/rules/groups/versions/diff/{version1}/{version2}Compares two rules versions
GET/api/secure/rules/groups/versions/latestGets latest version of a rule.
GET/api/secure/onboarding/v2/connectionStatus/{environment}Get the connection status
GET/api/secure/onboarding/v2/environmentsGet the list of available environments.
GET/api/secure/onboarding/v2/environments/selectionGet the selected environments.
POST/api/secure/onboarding/v2/environments/selectionRegister the selected environment.
PUT/api/secure/onboarding/v2/feature/customer/skipSkips the onboarding feature per customer
GET/api/secure/onboarding/v2/feature/statusCheck the onboarding feature status
GET/api/secure/onboarding/v2/frameworksGet all compliance frameworks.
GET/api/secure/onboarding/v2/frameworks/{environment}Get the list of compliance frameworks.
POST/api/secure/onboarding/v2/frameworks/{environment}Create compliance tasks
GET/api/secure/onboarding/v2/installActions/{installType}Get the install action.
GET/api/secure/onboarding/v2/installActions/{installType}/valuesGet values.yaml content
GET/api/secure/onboarding/v2/statusCheck the onboarding status
GET/api/secure/onboarding/v2/userProfileGet a user profile
GET/api/secure/onboarding/v2/userProfile/questionnaireGet the user profile questionnaire
POST/api/secure/onboarding/v2/userProfile/questionnaireSubmit the user profile questionnaire
GET/api/secure/onboarding/v3/environments/{environment}/installActions/{installType}Get the install action.
GET/api/settings/falco/customRulesFilesGet the custom falco rules files
PUT/api/settings/falco/customRulesFilesSet the custom rules files e.g. the set of falco rules managed by a customer.
DELETE/api/settings/falco/customRulesFiles/{filename}Delete the specified falco rules file
GET/api/settings/falco/customRulesFiles/{filename}Get the custom falco rules file matching the filename
PUT/api/settings/falco/customRulesFiles/{filename}Update the custom falco rules file matching the filename
GET/api/settings/falco/defaultRulesFilesGet the default falco rules files
GET/api/settings/falco/newestDefaultRulesFilesGet the newest default falco rules files
GET/api/settings/falco/filtersView the available falco filters for a customer
GET/api/ticketing/v1/integrations/{provider}Get all integration.
POST/api/ticketing/v1/integrations/{provider}Create a new Integration
DELETE/api/ticketing/v1/integrations/{provider}/{integration_id}Delete an Integration.
GET/api/ticketing/v1/integrations/{provider}/{integration_id}Get an Integration.
PUT/api/ticketing/v1/integrations/{provider}/{integration_id}Update an Integration.
GET/api/ticketing/v1/integrations/{provider}/{integration_id}/project/{project_id}/projectMetaPull all jira project metadata.
GET/api/ticketing/v1/integrations/{provider}/{integration_id}/projectsPull all jira projects.
DELETE/api/v1/capturesDelete captures
GET/api/v1/capturesRetrieve the list of captures
POST/api/v1/capturesCreate a capture
GET/api/v1/captures/{captureId}Get a capture
PUT/api/v1/captures/{captureId}Update a capture
GET/api/v1/captures/{captureId}/downloadDownload a capture
POST/api/v1/captures/{captureId}/stopStop a capture
GET/api/v1/eventsForwarding/channelsRetrieve a list of the supported channels.
GET/api/v1/eventsForwarding/integrationsRetrieve a list of integrations for the customer.
POST/api/v1/eventsForwarding/integrationsCreate an integration for the customer.
DELETE/api/v1/eventsForwarding/integrations/{integrationId}Delete an integration given its id.
GET/api/v1/eventsForwarding/integrations/{integrationId}Retrieve an integration given its id.
PATCH/api/v1/eventsForwarding/integrations/{integrationId}Update an integration given its id.
GET/api/v1/eventsForwarding/supportedRetrieve a list of the supported targets.
POST/api/v1/networkSecurity/namespaces/{namespaceName}/simulatedPoliciesCreates a Kubernetes Network Policy
POST/api/v1/networkSecurity/networkPolicyOverlayOwnerTopologyCreates a communication topology graph around the specified owner
GET/api/v1/networkSecurity/statusPing the status
GET/api/v1/networkTopology/clustersReturns all cluster names for the customer
GET/api/v1/networkTopology/egressSummariesReturns an overview of egress networking traffic
GET/api/v1/networkTopology/egressUnresolvedIpsReturns the unresolved ips for a time range and pod owner
GET/api/v1/networkTopology/ingressSummariesReturns an overview of ingress networking traffic
GET/api/v1/networkTopology/ingressUnresolvedIpsReturns the unresolved ips for a time range and pod owner
GET/api/v1/networkTopology/namespaceLabelKeysReturns sorted list of unique namespace label key values
GET/api/v1/networkTopology/namespacesReturns all namespace names for the cluster
GET/api/v1/networkTopology/ownerTopologyCreates a communication topology graph around the specified owner
GET/api/v1/networkTopology/ownersReturns all pod owners for a cluster, namespace, and time range
GET/api/v1/networkTopology/statusPing the status
GET/api/v1/networkTopology/workloadLabelKeysReturns sorted list of unique workload label key values
GET/api/v1/profiling/profileGroupsGet info about profile groups for a customer
GET/api/v1/profiling/profileGroups/{profileGroupId}Get info about a profile group with a specific id for a customer
GET/api/v1/profiling/profileGroups/{profileGroupId}/profilesGet all profiles for a given profileGroupId
GET/api/v1/profiling/profiles/{profileId}Get profile matching given profileId
POST/api/v1/profiling/profiles/{profileId}/actions/removeRemove a profile given the profileId
POST/api/v1/profiling/profiles/{profileId}/actions/resetReset a profile given the profileId
GET/api/v1/profiling/statusGet status of Profiling API
POST/api/v1/secure/policyTuner/disableThe policy tuner service records this customer as disabled such that a tune will not be run for this customer during the next run cycle
POST/api/v1/secure/policyTuner/enableThe policy tuner service records this customer as enabled such that a tune will be run for this customer during the next run cycle
POST/api/v1/secure/policyTuner/exceptionsAdds a provided set of exceptions to the tuner file
POST/api/v1/secure/policyTuner/excludeEventsReturns a list of exceptions to exclude the events matching a set of parameters
GET/api/v1/secure/policyTuner/statusPing the status
POST/api/v1/secure/policyTuner/tuneNowThe policy tuner immediately runs tuning for the customer
GET/api/v1/secure/policyTuner/tuningEnabledChecks if tuning is enabled
GET/api/v1/secureEventsRetrieves a secure events feed
GET/api/v1/secureEvents/filtersRetrieves the supported events feed scope filters
GET/api/v1/secureEvents/hasEventsVerify presence of old events
GET/api/v1/secureEvents/statusPing the status
GET/api/v1/secureEvents/{eventId}Retrieves an event given its id
GET/api/vi/secureEvents/bubbleChartRetrieves bubbleChart stats of runtime policy events and vulnerabilities with severities.
GET/api/vi/secureEvents/countRetrieves the count of scanning and policy events.
GET/api/vi/secureEvents/timeSeriesRetrieves timeseries counts of events by severity or user.
GET/api/vi/secureEvents/topStatsRetrieves top column value and counts of events by cluster, compliance, mitre, namespace, node, rule name, workload.
GET/api/v2/activityAudit/eventsRetrieves a list of audit events
GET/api/v2/activityAudit/events/{type}/{eventId}Retrieves an audit event given its type and id
GET/api/v2/activityAudit/events/{type}/{eventId}/traceRetrieves the trace of an audit event
GET/api/v2/activityAudit/summaryRetrieve a summary of the audit events
GET/api/v2/policiesRetrieve security policies
POST/api/v2/policiesCreate a new security policy
POST/api/v2/policies/batchCreate a new security policy and rules in a transaction
DELETE/api/v2/policies/{id}Delete a security policy.
GET/api/v2/policies/{id}Retrieve a security policy
PUT/api/v2/policies/{id}Update a security policy
GET/secure/vulnerability/v1beta1/pipeline-resultsGet a list of pipeline scan results
GET/secure/vulnerability/v1beta1/registry-resultsGet a list of registry scan results
GET/secure/vulnerability/v1beta1/results/{resultId}Get full scan result
GET/secure/vulnerability/v1beta1/runtime-resultsGet a list of runtime scan results
GET/secure/vulnerability/v1beta1/sbomsGet sbom
GET/secure/vulnerability/v1/runtime-resultsGet a list of runtime scan results
GET/secure/vulnerability/v1/registry-resultsGet a list of registry scan results
GET/secure/vulnerability/v1/pipeline-resultsGet a list of pipeline scan results
GET/secure/vulnerability/v1/results/{resultId}Get full scan result
GET/platform/v1/zonesList Zones
POST/platform/v1/zonesCreate Zone
DELETE/platform/v1/zones/{zoneId}Delete Zone
GET/platform/v1/zones/{zoneId}Get Zone
PUT/platform/v1/zones/{zoneId}Update Zone
GET/platform/reporting/v1/schedulesList Report Schedules
GET/platform/reporting/v1/jobsList Report Job Runs