Skip to content

[CWS-4395] Update API docs to align with product rebrand to Workload Protection #29361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-05-14 15:46:38.896407",
"spec_repo_commit": "64f5e7ee"
"regenerated": "2025-05-15 15:04:13.684613",
"spec_repo_commit": "07801a80"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-05-14 15:46:48.228708",
"spec_repo_commit": "64f5e7ee"
"regenerated": "2025-05-15 15:04:22.929393",
"spec_repo_commit": "07801a80"
}
}
}
134 changes: 67 additions & 67 deletions config/_default/menus/api.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5428,9 +5428,9 @@ menu:
url: /api/latest/csm-threats/
identifier: csm-threats
generated: true
- name: Update a Cloud Workload Security Agent rule
url: '#update-a-cloud-workload-security-agent-rule'
identifier: csm-threats-update-a-cloud-workload-security-agent-rule
- name: Update a Workload Protection agent rule (US1-FED)
url: '#update-a-workload-protection-agent-rule-us1-fed'
identifier: csm-threats-update-a-workload-protection-agent-rule-us1-fed
parent: csm-threats
generated: true
params:
Expand All @@ -5439,10 +5439,10 @@ menu:
operationids:
- UpdateCloudWorkloadSecurityAgentRule
unstable: []
order: 5
- name: Get a Cloud Workload Security Agent rule
url: '#get-a-cloud-workload-security-agent-rule'
identifier: csm-threats-get-a-cloud-workload-security-agent-rule
order: 15
- name: Get a Workload Protection agent rule (US1-FED)
url: '#get-a-workload-protection-agent-rule-us1-fed'
identifier: csm-threats-get-a-workload-protection-agent-rule-us1-fed
parent: csm-threats
generated: true
params:
Expand All @@ -5451,10 +5451,10 @@ menu:
operationids:
- GetCloudWorkloadSecurityAgentRule
unstable: []
order: 2
- name: Delete a Cloud Workload Security Agent rule
url: '#delete-a-cloud-workload-security-agent-rule'
identifier: csm-threats-delete-a-cloud-workload-security-agent-rule
order: 13
- name: Delete a Workload Protection agent rule (US1-FED)
url: '#delete-a-workload-protection-agent-rule-us1-fed'
identifier: csm-threats-delete-a-workload-protection-agent-rule-us1-fed
parent: csm-threats
generated: true
params:
Expand All @@ -5463,10 +5463,10 @@ menu:
operationids:
- DeleteCloudWorkloadSecurityAgentRule
unstable: []
order: 6
- name: Create a Cloud Workload Security Agent rule
url: '#create-a-cloud-workload-security-agent-rule'
identifier: csm-threats-create-a-cloud-workload-security-agent-rule
order: 16
- name: Create a Workload Protection agent rule (US1-FED)
url: '#create-a-workload-protection-agent-rule-us1-fed'
identifier: csm-threats-create-a-workload-protection-agent-rule-us1-fed
parent: csm-threats
generated: true
params:
Expand All @@ -5475,10 +5475,10 @@ menu:
operationids:
- CreateCloudWorkloadSecurityAgentRule
unstable: []
order: 4
- name: Get all Cloud Workload Security Agent rules
url: '#get-all-cloud-workload-security-agent-rules'
identifier: csm-threats-get-all-cloud-workload-security-agent-rules
order: 14
- name: Get all Workload Protection agent rules (US1-FED)
url: '#get-all-workload-protection-agent-rules-us1-fed'
identifier: csm-threats-get-all-workload-protection-agent-rules-us1-fed
parent: csm-threats
generated: true
params:
Expand All @@ -5487,10 +5487,10 @@ menu:
operationids:
- ListCloudWorkloadSecurityAgentRules
unstable: []
order: 3
- name: Get the latest Cloud Workload Security policy
url: '#get-the-latest-cloud-workload-security-policy'
identifier: csm-threats-get-the-latest-cloud-workload-security-policy
order: 12
- name: Download the Workload Protection policy (US1-FED)
url: '#download-the-workload-protection-policy-us1-fed'
identifier: csm-threats-download-the-workload-protection-policy-us1-fed
parent: csm-threats
generated: true
params:
Expand All @@ -5499,10 +5499,10 @@ menu:
operationids:
- DownloadCloudWorkloadPolicyFile
unstable: []
order: 1
- name: Update a CSM Threats Agent policy
url: '#update-a-csm-threats-agent-policy'
identifier: csm-threats-update-a-csm-threats-agent-policy
order: 17
- name: Update a Workload Protection policy
url: '#update-a-workload-protection-policy'
identifier: csm-threats-update-a-workload-protection-policy
parent: csm-threats
generated: true
params:
Expand All @@ -5511,10 +5511,10 @@ menu:
operationids:
- UpdateCSMThreatsAgentPolicy
unstable: []
order: 5
- name: Get a CSM Threats Agent policy
url: '#get-a-csm-threats-agent-policy'
identifier: csm-threats-get-a-csm-threats-agent-policy
order: 9
- name: Get a Workload Protection policy
url: '#get-a-workload-protection-policy'
identifier: csm-threats-get-a-workload-protection-policy
parent: csm-threats
generated: true
params:
Expand All @@ -5523,10 +5523,10 @@ menu:
operationids:
- GetCSMThreatsAgentPolicy
unstable: []
order: 2
- name: Delete a CSM Threats Agent policy
url: '#delete-a-csm-threats-agent-policy'
identifier: csm-threats-delete-a-csm-threats-agent-policy
order: 7
- name: Delete a Workload Protection policy
url: '#delete-a-workload-protection-policy'
identifier: csm-threats-delete-a-workload-protection-policy
parent: csm-threats
generated: true
params:
Expand All @@ -5535,10 +5535,10 @@ menu:
operationids:
- DeleteCSMThreatsAgentPolicy
unstable: []
order: 6
- name: Get the latest CSM Threats policy
url: '#get-the-latest-csm-threats-policy'
identifier: csm-threats-get-the-latest-csm-threats-policy
order: 10
- name: Download the Workload Protection policy
url: '#download-the-workload-protection-policy'
identifier: csm-threats-download-the-workload-protection-policy
parent: csm-threats
generated: true
params:
Expand All @@ -5547,10 +5547,10 @@ menu:
operationids:
- DownloadCSMThreatsPolicy
unstable: []
order: 1
- name: Create a CSM Threats Agent policy
url: '#create-a-csm-threats-agent-policy'
identifier: csm-threats-create-a-csm-threats-agent-policy
order: 11
- name: Create a Workload Protection policy
url: '#create-a-workload-protection-policy'
identifier: csm-threats-create-a-workload-protection-policy
parent: csm-threats
generated: true
params:
Expand All @@ -5559,10 +5559,10 @@ menu:
operationids:
- CreateCSMThreatsAgentPolicy
unstable: []
order: 4
- name: Get all CSM Threats Agent policies
url: '#get-all-csm-threats-agent-policies'
identifier: csm-threats-get-all-csm-threats-agent-policies
order: 8
- name: Get all Workload Protection policies
url: '#get-all-workload-protection-policies'
identifier: csm-threats-get-all-workload-protection-policies
parent: csm-threats
generated: true
params:
Expand All @@ -5571,10 +5571,10 @@ menu:
operationids:
- ListCSMThreatsAgentPolicies
unstable: []
order: 3
- name: Update a CSM Threats Agent rule
url: '#update-a-csm-threats-agent-rule'
identifier: csm-threats-update-a-csm-threats-agent-rule
order: 6
- name: Update a Workload Protection agent rule
url: '#update-a-workload-protection-agent-rule'
identifier: csm-threats-update-a-workload-protection-agent-rule
parent: csm-threats
generated: true
params:
Expand All @@ -5583,10 +5583,10 @@ menu:
operationids:
- UpdateCSMThreatsAgentRule
unstable: []
order: 5
- name: Get a CSM Threats Agent rule
url: '#get-a-csm-threats-agent-rule'
identifier: csm-threats-get-a-csm-threats-agent-rule
order: 4
- name: Get a Workload Protection agent rule
url: '#get-a-workload-protection-agent-rule'
identifier: csm-threats-get-a-workload-protection-agent-rule
parent: csm-threats
generated: true
params:
Expand All @@ -5596,9 +5596,9 @@ menu:
- GetCSMThreatsAgentRule
unstable: []
order: 2
- name: Delete a CSM Threats Agent rule
url: '#delete-a-csm-threats-agent-rule'
identifier: csm-threats-delete-a-csm-threats-agent-rule
- name: Delete a Workload Protection agent rule
url: '#delete-a-workload-protection-agent-rule'
identifier: csm-threats-delete-a-workload-protection-agent-rule
parent: csm-threats
generated: true
params:
Expand All @@ -5607,10 +5607,10 @@ menu:
operationids:
- DeleteCSMThreatsAgentRule
unstable: []
order: 6
- name: Create a CSM Threats Agent rule
url: '#create-a-csm-threats-agent-rule'
identifier: csm-threats-create-a-csm-threats-agent-rule
order: 5
- name: Create a Workload Protection agent rule
url: '#create-a-workload-protection-agent-rule'
identifier: csm-threats-create-a-workload-protection-agent-rule
parent: csm-threats
generated: true
params:
Expand All @@ -5619,10 +5619,10 @@ menu:
operationids:
- CreateCSMThreatsAgentRule
unstable: []
order: 4
- name: Get all CSM Threats Agent rules
url: '#get-all-csm-threats-agent-rules'
identifier: csm-threats-get-all-csm-threats-agent-rules
order: 3
- name: Get all Workload Protection agent rules
url: '#get-all-workload-protection-agent-rules'
identifier: csm-threats-get-all-workload-protection-agent-rules
parent: csm-threats
generated: true
params:
Expand All @@ -5631,7 +5631,7 @@ menu:
operationids:
- ListCSMThreatsAgentRules
unstable: []
order: 3
order: 1
- name: Case Management
url: /api/latest/case-management/
identifier: case-management
Expand Down
18 changes: 9 additions & 9 deletions data/api/v2/CodeExamples.json
Original file line number Diff line number Diff line change
Expand Up @@ -200,39 +200,39 @@
"description": "Search tests events returns \"OK\" response with pagination"
}
],
"CreateCSMThreatsAgentPolicy": [
"CreateCloudWorkloadSecurityAgentRule": [
{
"group": "csm_threats",
"suffix": "",
"description": "Create a CSM Threats Agent policy returns \"OK\" response"
"description": "Create a Workload Protection agent rule (US1-FED) returns \"OK\" response"
}
],
"CreateCSMThreatsAgentRule": [
{
"group": "csm_threats",
"suffix": "",
"description": "Create a CSM Threats Agent rule returns \"OK\" response"
"description": "Create a Workload Protection agent rule returns \"OK\" response"
}
],
"CreateCloudWorkloadSecurityAgentRule": [
"CreateCSMThreatsAgentPolicy": [
{
"group": "csm_threats",
"suffix": "",
"description": "Create a Cloud Workload Security Agent rule returns \"OK\" response"
"description": "Create a Workload Protection policy returns \"OK\" response"
}
],
"UpdateCSMThreatsAgentPolicy": [
"UpdateCloudWorkloadSecurityAgentRule": [
{
"group": "csm_threats",
"suffix": "",
"description": "Update a CSM Threats Agent policy returns \"OK\" response"
"description": "Update a Workload Protection agent rule (US1-FED) returns \"OK\" response"
}
],
"UpdateCloudWorkloadSecurityAgentRule": [
"UpdateCSMThreatsAgentPolicy": [
{
"group": "csm_threats",
"suffix": "",
"description": "Update a Cloud Workload Security Agent rule returns \"OK\" response"
"description": "Update a Workload Protection policy returns \"OK\" response"
}
],
"ArchiveCase": [
Expand Down
Loading
Loading