diff --git a/.apigentools-info b/.apigentools-info index 6c12e0aab33c4..53fc432a2e137 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -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" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index e745a10d4c303..75785a9f7c225 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -5631,7 +5631,7 @@ menu: operationids: - ListCSMThreatsAgentRules unstable: [] - order: 3 + order: 1 - name: Case Management url: /api/latest/case-management/ identifier: case-management diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 06834c141262a..53635d0e0b757 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -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": [ diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 299b55863ff2d..3d87a5b544006 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -55563,7 +55563,11 @@ paths: type: idempotent /api/v2/remote_config/products/cws/agent_rules: get: - description: Get the list of Cloud Security Management Threats Agent rules + description: 'Get the list of Workload Protection agent rules. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: ListCSMThreatsAgentRules parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID' @@ -55578,22 +55582,25 @@ paths: $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get all CSM Threats Agent rules + summary: Get all Workload Protection agent rules tags: - CSM Threats - x-menu-order: 3 + x-menu-order: 1 x-undo: type: safe post: - description: Create a new Cloud Security Management Threats Agent rule with - the given parameters + description: 'Create a new Workload Protection agent rule with the given parameters. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: CreateCSMThreatsAgentRule requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest' - description: The definition of the new Agent rule + description: The definition of the new agent rule required: true responses: '200': @@ -55610,7 +55617,7 @@ paths: $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Create a CSM Threats Agent rule + summary: Create a Workload Protection agent rule tags: - CSM Threats x-codegen-request-body-name: body @@ -55625,7 +55632,7 @@ paths: \"technique:T1059\"],\n \"policy_id\": \"{{ policy.data.id }}\"\n \ }\n }\n}" step: there is a valid "agent_rule_rc" in the system - x-menu-order: 4 + x-menu-order: 3 x-undo: operationId: DeleteCSMThreatsAgentRule parameters: @@ -55634,7 +55641,11 @@ paths: type: unsafe /api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}: delete: - description: Delete a specific Cloud Security Management Threats Agent rule + description: 'Delete a specific Workload Protection agent rule. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: DeleteCSMThreatsAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -55648,15 +55659,18 @@ paths: $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Delete a CSM Threats Agent rule + summary: Delete a Workload Protection agent rule tags: - CSM Threats - x-menu-order: 6 + x-menu-order: 5 x-undo: type: idempotent get: - description: Get the details of a specific Cloud Security Management Threats - Agent rule + description: 'Get the details of a specific Workload Protection agent rule. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: GetCSMThreatsAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -55674,16 +55688,20 @@ paths: $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get a CSM Threats Agent rule + summary: Get a Workload Protection agent rule tags: - CSM Threats x-menu-order: 2 x-undo: type: safe patch: - description: 'Update a specific Cloud Security Management Threats Agent rule. + description: 'Update a specific Workload Protection Agent rule. - Returns the Agent rule object when the request is successful.' + Returns the agent rule object when the request is successful. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: UpdateCSMThreatsAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -55693,7 +55711,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest' - description: New definition of the Agent rule + description: New definition of the agent rule required: true responses: '200': @@ -55712,16 +55730,20 @@ paths: $ref: '#/components/responses/ConcurrentModificationResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Update a CSM Threats Agent rule + summary: Update a Workload Protection agent rule tags: - CSM Threats x-codegen-request-body-name: body - x-menu-order: 5 + x-menu-order: 4 x-undo: type: idempotent /api/v2/remote_config/products/cws/policy: get: - description: Get the list of Cloud Security Management Threats Agent policies + description: 'Get the list of Workload Protection policies. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: ListCSMThreatsAgentPolicies responses: '200': @@ -55734,15 +55756,18 @@ paths: $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get all CSM Threats Agent policies + summary: Get all Workload Protection policies tags: - CSM Threats - x-menu-order: 3 + x-menu-order: 6 x-undo: type: safe post: - description: Create a new Cloud Security Management Threats Agent policy with - the given parameters + description: 'Create a new Workload Protection policy with the given parameters. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: CreateCSMThreatsAgentPolicy requestBody: content: @@ -55766,7 +55791,7 @@ paths: $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Create a CSM Threats Agent policy + summary: Create a Workload Protection policy tags: - CSM Threats x-codegen-request-body-name: body @@ -55779,7 +55804,7 @@ paths: \"My agent policy\",\n \"hostTags\": [\"env:staging\"],\n \"enabled\": true\n }\n }\n}" step: there is a valid "policy_rc" in the system - x-menu-order: 4 + x-menu-order: 8 x-undo: operationId: DeleteCSMThreatsAgentPolicy parameters: @@ -55788,13 +55813,17 @@ paths: type: unsafe /api/v2/remote_config/products/cws/policy/download: get: - description: 'The download endpoint generates a CSM Threats policy file from - your currently active + description: 'The download endpoint generates a Workload Protection policy file + from your currently active - CSM Threats rules, and downloads them as a `.policy` file. This file can then - be deployed to + Workload Protection agent rules, and downloads them as a `.policy` file. This + file can then be deployed to - your Agents to update the policy running in your environment.' + your agents to update the policy running in your environment. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: DownloadCSMThreatsPolicy responses: '200': @@ -55808,15 +55837,19 @@ paths: $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get the latest CSM Threats policy + summary: Download the Workload Protection policy tags: - CSM Threats - x-menu-order: 1 + x-menu-order: 11 x-undo: type: safe /api/v2/remote_config/products/cws/policy/{policy_id}: delete: - description: Delete a specific Cloud Security Management Threats Agent policy + description: 'Delete a specific Workload Protection policy. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: DeleteCSMThreatsAgentPolicy parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID' @@ -55831,15 +55864,18 @@ paths: $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Delete a CSM Threats Agent policy + summary: Delete a Workload Protection policy tags: - CSM Threats - x-menu-order: 6 + x-menu-order: 10 x-undo: type: idempotent get: - description: Get the details of a specific Cloud Security Management Threats - Agent policy + description: 'Get the details of a specific Workload Protection policy. + + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: GetCSMThreatsAgentPolicy parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID' @@ -55856,16 +55892,20 @@ paths: $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get a CSM Threats Agent policy + summary: Get a Workload Protection policy tags: - CSM Threats - x-menu-order: 2 + x-menu-order: 7 x-undo: type: safe patch: - description: 'Update a specific Cloud Security Management Threats Agent policy. + description: 'Update a specific Workload Protection policy. + + Returns the policy object when the request is successful. - Returns the Agent policy object when the request is successful.' + + **Note**: This endpoint is not available for the Government (US1-FED) site. + Please reference the (US1-FED) specific resource below.' operationId: UpdateCSMThreatsAgentPolicy parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID' @@ -55893,11 +55933,11 @@ paths: $ref: '#/components/responses/ConcurrentModificationResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Update a CSM Threats Agent policy + summary: Update a Workload Protection policy tags: - CSM Threats x-codegen-request-body-name: body - x-menu-order: 5 + x-menu-order: 9 x-undo: type: idempotent /api/v2/remote_config/products/obs_pipelines/pipelines: @@ -58872,13 +58912,16 @@ paths: If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).' /api/v2/security/cloud_workload/policy/download: get: - description: 'The download endpoint generates a Cloud Workload Security policy - file from your currently active + description: 'The download endpoint generates a Workload Protection policy file + from your currently active - Cloud Workload Security rules, and downloads them as a .policy file. This + Workload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to - your Agents to update the policy running in your environment.' + your agents to update the policy running in your environment. + + + **Note**: This endpoint should only be used for the Government (US1-FED) site.' operationId: DownloadCloudWorkloadPolicyFile responses: '200': @@ -58892,10 +58935,10 @@ paths: $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get the latest Cloud Workload Security policy + summary: Download the Workload Protection policy (US1-FED) tags: - CSM Threats - x-menu-order: 1 + x-menu-order: 17 x-permission: operator: OR permissions: @@ -59783,7 +59826,10 @@ paths: type: idempotent /api/v2/security_monitoring/cloud_workload_security/agent_rules: get: - description: Get the list of Agent rules + description: 'Get the list of agent rules. + + + **Note**: This endpoint should only be used for the Government (US1-FED) site.' operationId: ListCloudWorkloadSecurityAgentRules responses: '200': @@ -59796,10 +59842,10 @@ paths: $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get all Cloud Workload Security Agent rules + summary: Get all Workload Protection agent rules (US1-FED) tags: - CSM Threats - x-menu-order: 3 + x-menu-order: 12 x-permission: operator: OR permissions: @@ -59807,14 +59853,17 @@ paths: x-undo: type: safe post: - description: Create a new Agent rule with the given parameters. + description: 'Create a new agent rule with the given parameters. + + + **Note**: This endpoint should only be used for the Government (US1-FED) site.' operationId: CreateCloudWorkloadSecurityAgentRule requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest' - description: The definition of the new Agent rule + description: The definition of the new agent rule required: true responses: '200': @@ -59831,7 +59880,7 @@ paths: $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Create a Cloud Workload Security Agent rule + summary: Create a Workload Protection agent rule (US1-FED) tags: - CSM Threats x-codegen-request-body-name: body @@ -59844,7 +59893,7 @@ paths: \"My Agent rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n \ \"enabled\": true\n }\n }\n}" step: there is a valid "agent_rule" in the system - x-menu-order: 4 + x-menu-order: 14 x-permission: operator: OR permissions: @@ -59857,7 +59906,10 @@ paths: type: unsafe /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}: delete: - description: Delete a specific Agent rule + description: 'Delete a specific agent rule. + + + **Note**: This endpoint should only be used for the Government (US1-FED) site.' operationId: DeleteCloudWorkloadSecurityAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -59870,10 +59922,10 @@ paths: $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Delete a Cloud Workload Security Agent rule + summary: Delete a Workload Protection agent rule (US1-FED) tags: - CSM Threats - x-menu-order: 6 + x-menu-order: 16 x-permission: operator: OR permissions: @@ -59881,7 +59933,10 @@ paths: x-undo: type: idempotent get: - description: Get the details of a specific Agent rule + description: 'Get the details of a specific agent rule. + + + **Note**: This endpoint should only be used for the Government (US1-FED) site.' operationId: GetCloudWorkloadSecurityAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -59898,10 +59953,10 @@ paths: $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get a Cloud Workload Security Agent rule + summary: Get a Workload Protection agent rule (US1-FED) tags: - CSM Threats - x-menu-order: 2 + x-menu-order: 13 x-permission: operator: OR permissions: @@ -59909,9 +59964,12 @@ paths: x-undo: type: safe patch: - description: 'Update a specific Agent rule. + description: 'Update a specific agent rule. + + Returns the agent rule object when the request is successful. + - Returns the Agent rule object when the request is successful.' + **Note**: This endpoint should only be used for the Government (US1-FED) site.' operationId: UpdateCloudWorkloadSecurityAgentRule parameters: - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' @@ -59920,7 +59978,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest' - description: New definition of the Agent rule + description: New definition of the agent rule required: true responses: '200': @@ -59939,11 +59997,11 @@ paths: $ref: '#/components/responses/ConcurrentModificationResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Update a Cloud Workload Security Agent rule + summary: Update a Workload Protection agent rule (US1-FED) tags: - CSM Threats x-codegen-request-body-name: body - x-menu-order: 5 + x-menu-order: 15 x-permission: operator: OR permissions: @@ -65878,10 +65936,14 @@ tags: Go to https://docs.datadoghq.com/security/cloud_security_management to learn more.' name: CSM Coverage Analysis -- description: Cloud Security Management Threats (CSM Threats) monitors file, network, - and process activity across your environment to detect real-time threats to your - infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/) - for more information on setting up CSM Threats. +- description: 'Workload Protection monitors file, network, and process activity across + your environment to detect real-time threats to your infrastructure. See [Workload + Protection](https://docs.datadoghq.com/security/workload_protection/) for more + information on setting up Workload Protection. + + + **Note**: These endpoints are split based on whether you are using the US1-FED + site or not. Please reference the specific resource for the site you are using.' name: CSM Threats - description: View and manage cases and projects within Case Management. See the [Case Management page](https://docs.datadoghq.com/service_management/case_management/) diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index fed98235feaef..1ab6e2af48827 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -438207,7 +438207,7 @@ }, "/api/v2/remote_config/products/cws/agent_rules": { "get": { - "description": "Get the list of Cloud Security Management Threats Agent rules", + "description": "Get the list of Workload Protection agent rules.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "ListCSMThreatsAgentRules", "parameters": [ { @@ -438466,17 +438466,17 @@ "description": "Too many requests" } }, - "summary": "Get all CSM Threats Agent rules", + "summary": "Get all Workload Protection agent rules", "tags": [ "CSM Threats" ], - "x-menu-order": 3, + "x-menu-order": 1, "x-undo": { "type": "safe" } }, "post": { - "description": "Create a new Cloud Security Management Threats Agent rule with the given parameters", + "description": "Create a new Workload Protection agent rule with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "CreateCSMThreatsAgentRule", "requestBody": { "content": { @@ -438563,7 +438563,7 @@ } } }, - "description": "The definition of the new Agent rule", + "description": "The definition of the new agent rule", "required": true }, "responses": { @@ -438863,7 +438863,7 @@ "description": "Too many requests" } }, - "summary": "Create a CSM Threats Agent rule", + "summary": "Create a Workload Protection agent rule", "tags": [ "CSM Threats" ], @@ -438879,7 +438879,7 @@ "step": "there is a valid \"agent_rule_rc\" in the system" } }, - "x-menu-order": 4, + "x-menu-order": 3, "x-undo": { "operationId": "DeleteCSMThreatsAgentRule", "parameters": [ @@ -438894,7 +438894,7 @@ }, "/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}": { "delete": { - "description": "Delete a specific Cloud Security Management Threats Agent rule", + "description": "Delete a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "DeleteCSMThreatsAgentRule", "parameters": [ { @@ -439007,17 +439007,17 @@ "description": "Too many requests" } }, - "summary": "Delete a CSM Threats Agent rule", + "summary": "Delete a Workload Protection agent rule", "tags": [ "CSM Threats" ], - "x-menu-order": 6, + "x-menu-order": 5, "x-undo": { "type": "idempotent" } }, "get": { - "description": "Get the details of a specific Cloud Security Management Threats Agent rule", + "description": "Get the details of a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "GetCSMThreatsAgentRule", "parameters": [ { @@ -439310,7 +439310,7 @@ "description": "Too many requests" } }, - "summary": "Get a CSM Threats Agent rule", + "summary": "Get a Workload Protection agent rule", "tags": [ "CSM Threats" ], @@ -439320,7 +439320,7 @@ } }, "patch": { - "description": "Update a specific Cloud Security Management Threats Agent rule.\nReturns the Agent rule object when the request is successful.", + "description": "Update a specific Workload Protection Agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "UpdateCSMThreatsAgentRule", "parameters": [ { @@ -439418,7 +439418,7 @@ } } }, - "description": "New definition of the Agent rule", + "description": "New definition of the agent rule", "required": true }, "responses": { @@ -439746,12 +439746,12 @@ "description": "Too many requests" } }, - "summary": "Update a CSM Threats Agent rule", + "summary": "Update a Workload Protection agent rule", "tags": [ "CSM Threats" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 4, "x-undo": { "type": "idempotent" } @@ -439759,7 +439759,7 @@ }, "/api/v2/remote_config/products/cws/policy": { "get": { - "description": "Get the list of Cloud Security Management Threats Agent policies", + "description": "Get the list of Workload Protection policies.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "ListCSMThreatsAgentPolicies", "responses": { "200": { @@ -439970,17 +439970,17 @@ "description": "Too many requests" } }, - "summary": "Get all CSM Threats Agent policies", + "summary": "Get all Workload Protection policies", "tags": [ "CSM Threats" ], - "x-menu-order": 3, + "x-menu-order": 6, "x-undo": { "type": "safe" } }, "post": { - "description": "Create a new Cloud Security Management Threats Agent policy with the given parameters", + "description": "Create a new Workload Protection policy with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "CreateCSMThreatsAgentPolicy", "requestBody": { "content": { @@ -440323,7 +440323,7 @@ "description": "Too many requests" } }, - "summary": "Create a CSM Threats Agent policy", + "summary": "Create a Workload Protection policy", "tags": [ "CSM Threats" ], @@ -440339,7 +440339,7 @@ "step": "there is a valid \"policy_rc\" in the system" } }, - "x-menu-order": 4, + "x-menu-order": 8, "x-undo": { "operationId": "DeleteCSMThreatsAgentPolicy", "parameters": [ @@ -440354,7 +440354,7 @@ }, "/api/v2/remote_config/products/cws/policy/download": { "get": { - "description": "The download endpoint generates a CSM Threats policy file from your currently active\nCSM Threats rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour Agents to update the policy running in your environment.", + "description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "DownloadCSMThreatsPolicy", "responses": { "200": { @@ -440425,11 +440425,11 @@ "description": "Too many requests" } }, - "summary": "Get the latest CSM Threats policy", + "summary": "Download the Workload Protection policy", "tags": [ "CSM Threats" ], - "x-menu-order": 1, + "x-menu-order": 11, "x-undo": { "type": "safe" } @@ -440437,7 +440437,7 @@ }, "/api/v2/remote_config/products/cws/policy/{policy_id}": { "delete": { - "description": "Delete a specific Cloud Security Management Threats Agent policy", + "description": "Delete a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "DeleteCSMThreatsAgentPolicy", "parameters": [ { @@ -440543,17 +440543,17 @@ "description": "Too many requests" } }, - "summary": "Delete a CSM Threats Agent policy", + "summary": "Delete a Workload Protection policy", "tags": [ "CSM Threats" ], - "x-menu-order": 6, + "x-menu-order": 10, "x-undo": { "type": "idempotent" } }, "get": { - "description": "Get the details of a specific Cloud Security Management Threats Agent policy", + "description": "Get the details of a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "GetCSMThreatsAgentPolicy", "parameters": [ { @@ -440800,17 +440800,17 @@ "description": "Too many requests" } }, - "summary": "Get a CSM Threats Agent policy", + "summary": "Get a Workload Protection policy", "tags": [ "CSM Threats" ], - "x-menu-order": 2, + "x-menu-order": 7, "x-undo": { "type": "safe" } }, "patch": { - "description": "Update a specific Cloud Security Management Threats Agent policy.\nReturns the Agent policy object when the request is successful.", + "description": "Update a specific Workload Protection policy.\nReturns the policy object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "UpdateCSMThreatsAgentPolicy", "parameters": [ { @@ -441195,12 +441195,12 @@ "description": "Too many requests" } }, - "summary": "Update a CSM Threats Agent policy", + "summary": "Update a Workload Protection policy", "tags": [ "CSM Threats" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 9, "x-undo": { "type": "idempotent" } @@ -486390,7 +486390,7 @@ }, "/api/v2/security/cloud_workload/policy/download": { "get": { - "description": "The download endpoint generates a Cloud Workload Security policy file from your currently active\nCloud Workload Security rules, and downloads them as a .policy file. This file can then be deployed to\nyour Agents to update the policy running in your environment.", + "description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "DownloadCloudWorkloadPolicyFile", "responses": { "200": { @@ -486461,11 +486461,11 @@ "description": "Too many requests" } }, - "summary": "Get the latest Cloud Workload Security policy", + "summary": "Download the Workload Protection policy (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 1, + "x-menu-order": 17, "x-permission": { "operator": "OR", "permissions": [ @@ -492716,7 +492716,7 @@ }, "/api/v2/security_monitoring/cloud_workload_security/agent_rules": { "get": { - "description": "Get the list of Agent rules", + "description": "Get the list of agent rules.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "ListCloudWorkloadSecurityAgentRules", "responses": { "200": { @@ -492963,11 +492963,11 @@ "description": "Too many requests" } }, - "summary": "Get all Cloud Workload Security Agent rules", + "summary": "Get all Workload Protection agent rules (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 3, + "x-menu-order": 12, "x-permission": { "operator": "OR", "permissions": [ @@ -492979,7 +492979,7 @@ } }, "post": { - "description": "Create a new Agent rule with the given parameters.", + "description": "Create a new agent rule with the given parameters.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "CreateCloudWorkloadSecurityAgentRule", "requestBody": { "content": { @@ -493066,7 +493066,7 @@ } } }, - "description": "The definition of the new Agent rule", + "description": "The definition of the new agent rule", "required": true }, "responses": { @@ -493366,7 +493366,7 @@ "description": "Too many requests" } }, - "summary": "Create a Cloud Workload Security Agent rule", + "summary": "Create a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], @@ -493382,7 +493382,7 @@ "step": "there is a valid \"agent_rule\" in the system" } }, - "x-menu-order": 4, + "x-menu-order": 14, "x-permission": { "operator": "OR", "permissions": [ @@ -493403,7 +493403,7 @@ }, "/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}": { "delete": { - "description": "Delete a specific Agent rule", + "description": "Delete a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "DeleteCloudWorkloadSecurityAgentRule", "parameters": [ { @@ -493506,11 +493506,11 @@ "description": "Too many requests" } }, - "summary": "Delete a Cloud Workload Security Agent rule", + "summary": "Delete a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 6, + "x-menu-order": 16, "x-permission": { "operator": "OR", "permissions": [ @@ -493522,7 +493522,7 @@ } }, "get": { - "description": "Get the details of a specific Agent rule", + "description": "Get the details of a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "GetCloudWorkloadSecurityAgentRule", "parameters": [ { @@ -493805,11 +493805,11 @@ "description": "Too many requests" } }, - "summary": "Get a Cloud Workload Security Agent rule", + "summary": "Get a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 2, + "x-menu-order": 13, "x-permission": { "operator": "OR", "permissions": [ @@ -493821,7 +493821,7 @@ } }, "patch": { - "description": "Update a specific Agent rule.\nReturns the Agent rule object when the request is successful.", + "description": "Update a specific agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "UpdateCloudWorkloadSecurityAgentRule", "parameters": [ { @@ -493909,7 +493909,7 @@ } } }, - "description": "New definition of the Agent rule", + "description": "New definition of the agent rule", "required": true }, "responses": { @@ -494237,12 +494237,12 @@ "description": "Too many requests" } }, - "summary": "Update a Cloud Workload Security Agent rule", + "summary": "Update a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 15, "x-permission": { "operator": "OR", "permissions": [ @@ -561134,7 +561134,7 @@ "name": "CSM Coverage Analysis" }, { - "description": "Cloud Security Management Threats (CSM Threats) monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/) for more information on setting up CSM Threats.", + "description": "Workload Protection monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Workload Protection](https://docs.datadoghq.com/security/workload_protection/) for more information on setting up Workload Protection.\n\n**Note**: These endpoints are split based on whether you are using the US1-FED site or not. Please reference the specific resource for the site you are using.", "name": "CSM Threats" }, { diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 4bd18e5916b90..fae3fb43de4c6 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1506,54 +1506,54 @@ "request_schema_description": "Request object for updating a single WAF exclusion filter." }, "ListCSMThreatsAgentRules": { - "description": "Get the list of Cloud Security Management Threats Agent rules", - "summary": "Get all CSM Threats Agent rules" + "description": "Get the list of Workload Protection agent rules.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Get all Workload Protection agent rules" }, "CreateCSMThreatsAgentRule": { - "description": "Create a new Cloud Security Management Threats Agent rule with the given parameters", - "summary": "Create a CSM Threats Agent rule", - "request_description": "The definition of the new Agent rule", + "description": "Create a new Workload Protection agent rule with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Create a Workload Protection agent rule", + "request_description": "The definition of the new agent rule", "request_schema_description": "Request object that includes the Agent rule to create" }, "DeleteCSMThreatsAgentRule": { - "description": "Delete a specific Cloud Security Management Threats Agent rule", - "summary": "Delete a CSM Threats Agent rule" + "description": "Delete a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Delete a Workload Protection agent rule" }, "GetCSMThreatsAgentRule": { - "description": "Get the details of a specific Cloud Security Management Threats Agent rule", - "summary": "Get a CSM Threats Agent rule" + "description": "Get the details of a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Get a Workload Protection agent rule" }, "UpdateCSMThreatsAgentRule": { - "description": "Update a specific Cloud Security Management Threats Agent rule.\nReturns the Agent rule object when the request is successful.", - "summary": "Update a CSM Threats Agent rule", - "request_description": "New definition of the Agent rule", + "description": "Update a specific Workload Protection Agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Update a Workload Protection agent rule", + "request_description": "New definition of the agent rule", "request_schema_description": "Request object that includes the Agent rule with the attributes to update" }, "ListCSMThreatsAgentPolicies": { - "description": "Get the list of Cloud Security Management Threats Agent policies", - "summary": "Get all CSM Threats Agent policies" + "description": "Get the list of Workload Protection policies.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Get all Workload Protection policies" }, "CreateCSMThreatsAgentPolicy": { - "description": "Create a new Cloud Security Management Threats Agent policy with the given parameters", - "summary": "Create a CSM Threats Agent policy", + "description": "Create a new Workload Protection policy with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Create a Workload Protection policy", "request_description": "The definition of the new Agent policy", "request_schema_description": "Request object that includes the Agent policy to create" }, "DownloadCSMThreatsPolicy": { - "description": "The download endpoint generates a CSM Threats policy file from your currently active\nCSM Threats rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour Agents to update the policy running in your environment.", - "summary": "Get the latest CSM Threats policy" + "description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Download the Workload Protection policy" }, "DeleteCSMThreatsAgentPolicy": { - "description": "Delete a specific Cloud Security Management Threats Agent policy", - "summary": "Delete a CSM Threats Agent policy" + "description": "Delete a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Delete a Workload Protection policy" }, "GetCSMThreatsAgentPolicy": { - "description": "Get the details of a specific Cloud Security Management Threats Agent policy", - "summary": "Get a CSM Threats Agent policy" + "description": "Get the details of a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Get a Workload Protection policy" }, "UpdateCSMThreatsAgentPolicy": { - "description": "Update a specific Cloud Security Management Threats Agent policy.\nReturns the Agent policy object when the request is successful.", - "summary": "Update a CSM Threats Agent policy", + "description": "Update a specific Workload Protection policy.\nReturns the policy object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", + "summary": "Update a Workload Protection policy", "request_description": "New definition of the Agent policy", "request_schema_description": "Request object that includes the Agent policy with the attributes to update" }, @@ -1858,8 +1858,8 @@ "summary": "List vulnerable assets" }, "DownloadCloudWorkloadPolicyFile": { - "description": "The download endpoint generates a Cloud Workload Security policy file from your currently active\nCloud Workload Security rules, and downloads them as a .policy file. This file can then be deployed to\nyour Agents to update the policy running in your environment.", - "summary": "Get the latest Cloud Workload Security policy" + "description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", + "summary": "Download the Workload Protection policy (US1-FED)" }, "GetSBOM": { "description": "Get a single SBOM related to an asset by its type and name.\n", @@ -1918,27 +1918,27 @@ "request_schema_description": "Body of the notification rule patch request." }, "ListCloudWorkloadSecurityAgentRules": { - "description": "Get the list of Agent rules", - "summary": "Get all Cloud Workload Security Agent rules" + "description": "Get the list of agent rules.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", + "summary": "Get all Workload Protection agent rules (US1-FED)" }, "CreateCloudWorkloadSecurityAgentRule": { - "description": "Create a new Agent rule with the given parameters.", - "summary": "Create a Cloud Workload Security Agent rule", - "request_description": "The definition of the new Agent rule", + "description": "Create a new agent rule with the given parameters.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", + "summary": "Create a Workload Protection agent rule (US1-FED)", + "request_description": "The definition of the new agent rule", "request_schema_description": "Request object that includes the Agent rule to create" }, "DeleteCloudWorkloadSecurityAgentRule": { - "description": "Delete a specific Agent rule", - "summary": "Delete a Cloud Workload Security Agent rule" + "description": "Delete a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", + "summary": "Delete a Workload Protection agent rule (US1-FED)" }, "GetCloudWorkloadSecurityAgentRule": { - "description": "Get the details of a specific Agent rule", - "summary": "Get a Cloud Workload Security Agent rule" + "description": "Get the details of a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", + "summary": "Get a Workload Protection agent rule (US1-FED)" }, "UpdateCloudWorkloadSecurityAgentRule": { - "description": "Update a specific Agent rule.\nReturns the Agent rule object when the request is successful.", - "summary": "Update a Cloud Workload Security Agent rule", - "request_description": "New definition of the Agent rule", + "description": "Update a specific agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", + "summary": "Update a Workload Protection agent rule (US1-FED)", + "request_description": "New definition of the agent rule", "request_schema_description": "Request object that includes the Agent rule with the attributes to update" }, "ListSecurityFilters": { diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index deaca7dcce406..36427432594a8 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -57,7 +57,7 @@ }, "csm-threats": { "name": "CSM Threats", - "description": "Cloud Security Management Threats (CSM Threats) monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/) for more information on setting up CSM Threats." + "description": "Workload Protection monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Workload Protection](https://docs.datadoghq.com/security/workload_protection/) for more information on setting up Workload Protection.\n\n**Note**: These endpoints are split based on whether you are using the US1-FED site or not. Please reference the specific resource for the site you are using." }, "case-management": { "name": "Case Management", diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index fed98235feaef..1ab6e2af48827 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -438207,7 +438207,7 @@ }, "/api/v2/remote_config/products/cws/agent_rules": { "get": { - "description": "Get the list of Cloud Security Management Threats Agent rules", + "description": "Get the list of Workload Protection agent rules.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "ListCSMThreatsAgentRules", "parameters": [ { @@ -438466,17 +438466,17 @@ "description": "Too many requests" } }, - "summary": "Get all CSM Threats Agent rules", + "summary": "Get all Workload Protection agent rules", "tags": [ "CSM Threats" ], - "x-menu-order": 3, + "x-menu-order": 1, "x-undo": { "type": "safe" } }, "post": { - "description": "Create a new Cloud Security Management Threats Agent rule with the given parameters", + "description": "Create a new Workload Protection agent rule with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "CreateCSMThreatsAgentRule", "requestBody": { "content": { @@ -438563,7 +438563,7 @@ } } }, - "description": "The definition of the new Agent rule", + "description": "The definition of the new agent rule", "required": true }, "responses": { @@ -438863,7 +438863,7 @@ "description": "Too many requests" } }, - "summary": "Create a CSM Threats Agent rule", + "summary": "Create a Workload Protection agent rule", "tags": [ "CSM Threats" ], @@ -438879,7 +438879,7 @@ "step": "there is a valid \"agent_rule_rc\" in the system" } }, - "x-menu-order": 4, + "x-menu-order": 3, "x-undo": { "operationId": "DeleteCSMThreatsAgentRule", "parameters": [ @@ -438894,7 +438894,7 @@ }, "/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}": { "delete": { - "description": "Delete a specific Cloud Security Management Threats Agent rule", + "description": "Delete a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "DeleteCSMThreatsAgentRule", "parameters": [ { @@ -439007,17 +439007,17 @@ "description": "Too many requests" } }, - "summary": "Delete a CSM Threats Agent rule", + "summary": "Delete a Workload Protection agent rule", "tags": [ "CSM Threats" ], - "x-menu-order": 6, + "x-menu-order": 5, "x-undo": { "type": "idempotent" } }, "get": { - "description": "Get the details of a specific Cloud Security Management Threats Agent rule", + "description": "Get the details of a specific Workload Protection agent rule.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "GetCSMThreatsAgentRule", "parameters": [ { @@ -439310,7 +439310,7 @@ "description": "Too many requests" } }, - "summary": "Get a CSM Threats Agent rule", + "summary": "Get a Workload Protection agent rule", "tags": [ "CSM Threats" ], @@ -439320,7 +439320,7 @@ } }, "patch": { - "description": "Update a specific Cloud Security Management Threats Agent rule.\nReturns the Agent rule object when the request is successful.", + "description": "Update a specific Workload Protection Agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "UpdateCSMThreatsAgentRule", "parameters": [ { @@ -439418,7 +439418,7 @@ } } }, - "description": "New definition of the Agent rule", + "description": "New definition of the agent rule", "required": true }, "responses": { @@ -439746,12 +439746,12 @@ "description": "Too many requests" } }, - "summary": "Update a CSM Threats Agent rule", + "summary": "Update a Workload Protection agent rule", "tags": [ "CSM Threats" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 4, "x-undo": { "type": "idempotent" } @@ -439759,7 +439759,7 @@ }, "/api/v2/remote_config/products/cws/policy": { "get": { - "description": "Get the list of Cloud Security Management Threats Agent policies", + "description": "Get the list of Workload Protection policies.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "ListCSMThreatsAgentPolicies", "responses": { "200": { @@ -439970,17 +439970,17 @@ "description": "Too many requests" } }, - "summary": "Get all CSM Threats Agent policies", + "summary": "Get all Workload Protection policies", "tags": [ "CSM Threats" ], - "x-menu-order": 3, + "x-menu-order": 6, "x-undo": { "type": "safe" } }, "post": { - "description": "Create a new Cloud Security Management Threats Agent policy with the given parameters", + "description": "Create a new Workload Protection policy with the given parameters.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "CreateCSMThreatsAgentPolicy", "requestBody": { "content": { @@ -440323,7 +440323,7 @@ "description": "Too many requests" } }, - "summary": "Create a CSM Threats Agent policy", + "summary": "Create a Workload Protection policy", "tags": [ "CSM Threats" ], @@ -440339,7 +440339,7 @@ "step": "there is a valid \"policy_rc\" in the system" } }, - "x-menu-order": 4, + "x-menu-order": 8, "x-undo": { "operationId": "DeleteCSMThreatsAgentPolicy", "parameters": [ @@ -440354,7 +440354,7 @@ }, "/api/v2/remote_config/products/cws/policy/download": { "get": { - "description": "The download endpoint generates a CSM Threats policy file from your currently active\nCSM Threats rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour Agents to update the policy running in your environment.", + "description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "DownloadCSMThreatsPolicy", "responses": { "200": { @@ -440425,11 +440425,11 @@ "description": "Too many requests" } }, - "summary": "Get the latest CSM Threats policy", + "summary": "Download the Workload Protection policy", "tags": [ "CSM Threats" ], - "x-menu-order": 1, + "x-menu-order": 11, "x-undo": { "type": "safe" } @@ -440437,7 +440437,7 @@ }, "/api/v2/remote_config/products/cws/policy/{policy_id}": { "delete": { - "description": "Delete a specific Cloud Security Management Threats Agent policy", + "description": "Delete a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "DeleteCSMThreatsAgentPolicy", "parameters": [ { @@ -440543,17 +440543,17 @@ "description": "Too many requests" } }, - "summary": "Delete a CSM Threats Agent policy", + "summary": "Delete a Workload Protection policy", "tags": [ "CSM Threats" ], - "x-menu-order": 6, + "x-menu-order": 10, "x-undo": { "type": "idempotent" } }, "get": { - "description": "Get the details of a specific Cloud Security Management Threats Agent policy", + "description": "Get the details of a specific Workload Protection policy.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "GetCSMThreatsAgentPolicy", "parameters": [ { @@ -440800,17 +440800,17 @@ "description": "Too many requests" } }, - "summary": "Get a CSM Threats Agent policy", + "summary": "Get a Workload Protection policy", "tags": [ "CSM Threats" ], - "x-menu-order": 2, + "x-menu-order": 7, "x-undo": { "type": "safe" } }, "patch": { - "description": "Update a specific Cloud Security Management Threats Agent policy.\nReturns the Agent policy object when the request is successful.", + "description": "Update a specific Workload Protection policy.\nReturns the policy object when the request is successful.\n\n**Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.", "operationId": "UpdateCSMThreatsAgentPolicy", "parameters": [ { @@ -441195,12 +441195,12 @@ "description": "Too many requests" } }, - "summary": "Update a CSM Threats Agent policy", + "summary": "Update a Workload Protection policy", "tags": [ "CSM Threats" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 9, "x-undo": { "type": "idempotent" } @@ -486390,7 +486390,7 @@ }, "/api/v2/security/cloud_workload/policy/download": { "get": { - "description": "The download endpoint generates a Cloud Workload Security policy file from your currently active\nCloud Workload Security rules, and downloads them as a .policy file. This file can then be deployed to\nyour Agents to update the policy running in your environment.", + "description": "The download endpoint generates a Workload Protection policy file from your currently active\nWorkload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to\nyour agents to update the policy running in your environment.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "DownloadCloudWorkloadPolicyFile", "responses": { "200": { @@ -486461,11 +486461,11 @@ "description": "Too many requests" } }, - "summary": "Get the latest Cloud Workload Security policy", + "summary": "Download the Workload Protection policy (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 1, + "x-menu-order": 17, "x-permission": { "operator": "OR", "permissions": [ @@ -492716,7 +492716,7 @@ }, "/api/v2/security_monitoring/cloud_workload_security/agent_rules": { "get": { - "description": "Get the list of Agent rules", + "description": "Get the list of agent rules.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "ListCloudWorkloadSecurityAgentRules", "responses": { "200": { @@ -492963,11 +492963,11 @@ "description": "Too many requests" } }, - "summary": "Get all Cloud Workload Security Agent rules", + "summary": "Get all Workload Protection agent rules (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 3, + "x-menu-order": 12, "x-permission": { "operator": "OR", "permissions": [ @@ -492979,7 +492979,7 @@ } }, "post": { - "description": "Create a new Agent rule with the given parameters.", + "description": "Create a new agent rule with the given parameters.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "CreateCloudWorkloadSecurityAgentRule", "requestBody": { "content": { @@ -493066,7 +493066,7 @@ } } }, - "description": "The definition of the new Agent rule", + "description": "The definition of the new agent rule", "required": true }, "responses": { @@ -493366,7 +493366,7 @@ "description": "Too many requests" } }, - "summary": "Create a Cloud Workload Security Agent rule", + "summary": "Create a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], @@ -493382,7 +493382,7 @@ "step": "there is a valid \"agent_rule\" in the system" } }, - "x-menu-order": 4, + "x-menu-order": 14, "x-permission": { "operator": "OR", "permissions": [ @@ -493403,7 +493403,7 @@ }, "/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}": { "delete": { - "description": "Delete a specific Agent rule", + "description": "Delete a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "DeleteCloudWorkloadSecurityAgentRule", "parameters": [ { @@ -493506,11 +493506,11 @@ "description": "Too many requests" } }, - "summary": "Delete a Cloud Workload Security Agent rule", + "summary": "Delete a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 6, + "x-menu-order": 16, "x-permission": { "operator": "OR", "permissions": [ @@ -493522,7 +493522,7 @@ } }, "get": { - "description": "Get the details of a specific Agent rule", + "description": "Get the details of a specific agent rule.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "GetCloudWorkloadSecurityAgentRule", "parameters": [ { @@ -493805,11 +493805,11 @@ "description": "Too many requests" } }, - "summary": "Get a Cloud Workload Security Agent rule", + "summary": "Get a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], - "x-menu-order": 2, + "x-menu-order": 13, "x-permission": { "operator": "OR", "permissions": [ @@ -493821,7 +493821,7 @@ } }, "patch": { - "description": "Update a specific Agent rule.\nReturns the Agent rule object when the request is successful.", + "description": "Update a specific agent rule.\nReturns the agent rule object when the request is successful.\n\n**Note**: This endpoint should only be used for the Government (US1-FED) site.", "operationId": "UpdateCloudWorkloadSecurityAgentRule", "parameters": [ { @@ -493909,7 +493909,7 @@ } } }, - "description": "New definition of the Agent rule", + "description": "New definition of the agent rule", "required": true }, "responses": { @@ -494237,12 +494237,12 @@ "description": "Too many requests" } }, - "summary": "Update a Cloud Workload Security Agent rule", + "summary": "Update a Workload Protection agent rule (US1-FED)", "tags": [ "CSM Threats" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 15, "x-permission": { "operator": "OR", "permissions": [ @@ -561134,7 +561134,7 @@ "name": "CSM Coverage Analysis" }, { - "description": "Cloud Security Management Threats (CSM Threats) monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/) for more information on setting up CSM Threats.", + "description": "Workload Protection monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Workload Protection](https://docs.datadoghq.com/security/workload_protection/) for more information on setting up Workload Protection.\n\n**Note**: These endpoints are split based on whether you are using the US1-FED site or not. Please reference the specific resource for the site you are using.", "name": "CSM Threats" }, {