openapi: 3.0.0 info: contact: email: support@datadoghq.com name: Datadog Support url: https://www.datadoghq.com/support/ description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically. title: Datadog Account Policies API version: '1.0' servers: - url: https://{subdomain}.{site} variables: site: default: datadoghq.com description: The regional site for Datadog customers. enum: - datadoghq.com - us3.datadoghq.com - us5.datadoghq.com - ap1.datadoghq.com - datadoghq.eu - ddog-gov.com subdomain: default: api description: The subdomain where the API is deployed. - url: '{protocol}://{name}' variables: name: default: api.datadoghq.com description: Full site DNS name. protocol: default: https description: The protocol for accessing the API. - url: https://{subdomain}.{site} variables: site: default: datadoghq.com description: Any Datadog deployment. subdomain: default: api description: The subdomain where the API is deployed. security: - apiKeyAuth: [] appKeyAuth: [] tags: - name: Policies paths: /api/v2/monitor/policy: get: description: Get all monitor configuration policies. operationId: ListMonitorConfigPolicies responses: '200': content: application/json: schema: $ref: '#/components/schemas/MonitorConfigPolicyListResponse' description: OK '403': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Datadog Get All Monitor Configuration Policies tags: - Policies x-menu-order: 10 x-permission: operator: OR permissions: - monitors_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Create a monitor configuration policy. operationId: CreateMonitorConfigPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/MonitorConfigPolicyCreateRequest' description: Create a monitor configuration policy request body. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MonitorConfigPolicyResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Create a Monitor Configuration Policy tags: - Policies x-codegen-request-body-name: body x-given: monitor_configuration_policy: parameters: - name: body value: "{\n \"data\": {\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"{{ unique_lower_alnum }}\", \"tag_key_required\": false, \"valid_tag_values\": [\"prod\", \"staging\"]\n }\n }\n }\n}" step: there is a valid "monitor_configuration_policy" in the system x-menu-order: 11 x-permission: operator: OR permissions: - monitor_config_policy_write x-undo: operationId: DeleteMonitorConfigPolicy parameters: - name: policy_id source: data.id type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/monitor/policy/{policy_id}: delete: description: Delete a monitor configuration policy. operationId: DeleteMonitorConfigPolicy parameters: - description: ID of the monitor configuration policy. in: path name: policy_id required: true schema: example: 00000000-0000-1234-0000-000000000000 type: string example: 00000000-0000-1234-0000-000000000000 responses: '204': description: OK '400': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Delete a Monitor Configuration Policy tags: - Policies x-menu-order: 13 x-permission: operator: OR permissions: - monitor_config_policy_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Get a monitor configuration policy by `policy_id`. operationId: GetMonitorConfigPolicy parameters: - description: ID of the monitor configuration policy. in: path name: policy_id required: true schema: example: 00000000-0000-1234-0000-000000000000 type: string example: 00000000-0000-1234-0000-000000000000 responses: '200': content: application/json: schema: $ref: '#/components/schemas/MonitorConfigPolicyResponse' description: OK '403': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - monitors_read summary: Datadog Get a Monitor Configuration Policy tags: - Policies x-menu-order: 9 x-permission: operator: OR permissions: - monitors_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: description: Edit a monitor configuration policy. operationId: UpdateMonitorConfigPolicy parameters: - description: ID of the monitor configuration policy. in: path name: policy_id required: true schema: example: 00000000-0000-1234-0000-000000000000 type: string example: 00000000-0000-1234-0000-000000000000 requestBody: content: application/json: schema: $ref: '#/components/schemas/MonitorConfigPolicyEditRequest' description: Description of the update. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MonitorConfigPolicyResponse' description: OK '403': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Unprocessable Entity '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Edit a Monitor Configuration Policy tags: - Policies x-codegen-request-body-name: body x-menu-order: 12 x-permission: operator: OR permissions: - monitor_config_policy_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/on-call/escalation-policies: post: description: Create a new On-Call escalation policy operationId: CreateOnCallEscalationPolicy parameters: - description: 'Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`.' in: query name: include schema: type: string example: example_value requestBody: content: application/json: schema: $ref: '#/components/schemas/EscalationPolicyCreateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/EscalationPolicy' description: Created '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Create On-call Escalation Policy tags: - Policies x-given: escalation_policy: parameters: - name: body value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ unique }}\",\n \"resolve_page_on_policy_end\": true,\n \"retries\": 2,\n \"steps\": [\n {\n \"assignment\": \"default\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"{{ dd_team.data.id }}\",\n \"type\": \"teams\"\n },\n {\n \"id\": \"{{ schedule.data.id }}\",\n \"type\": \"schedules\"\n },\n {\n \"id\": \"{{ user.data.id }}\",\n \"type\": \"users\"\n }\n ]\n },\n {\n \"assignment\": \"round-robin\",\n \"escalate_after_seconds\": 3600,\n \"targets\": [\n {\n \"id\": \"{{ dd_team.data.id }}\",\n \"type\": \"teams\"\n }\n ]\n }\n ]\n },\n \"relationships\": {\n \"teams\": {\n \"data\": [\n {\n \"id\": \"{{ dd_team.data.id }}\",\n \"type\": \"teams\"\n }\n ]\n }\n },\n \"type\": \"policies\"\n }\n}" step: there is a valid "escalation_policy" in the system x-menu-order: 5 x-permission: operator: AND permissions: - on_call_write x-undo: operationId: DeleteOnCallEscalationPolicy parameters: - name: policy_id source: data.id type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/on-call/escalation-policies/{policy_id}: delete: description: Delete an On-Call escalation policy operationId: DeleteOnCallEscalationPolicy parameters: - description: The ID of the escalation policy in: path name: policy_id required: true schema: example: a3000000-0000-0000-0000-000000000000 type: string example: a3000000-0000-0000-0000-000000000000 responses: '204': description: No Content '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Delete On-call Escalation Policy tags: - Policies x-menu-order: 8 x-permission: operator: AND permissions: - on_call_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Get an On-Call escalation policy operationId: GetOnCallEscalationPolicy parameters: - description: The ID of the escalation policy in: path name: policy_id required: true schema: example: a3000000-0000-0000-0000-000000000000 type: string example: a3000000-0000-0000-0000-000000000000 - description: 'Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`.' in: query name: include schema: type: string example: example_value responses: '200': content: application/json: schema: $ref: '#/components/schemas/EscalationPolicy' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Get On-call Escalation Policy tags: - Policies x-menu-order: 7 x-permission: operator: AND permissions: - on_call_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Update an On-Call escalation policy operationId: UpdateOnCallEscalationPolicy parameters: - description: The ID of the escalation policy in: path name: policy_id required: true schema: example: a3000000-0000-0000-0000-000000000000 type: string example: a3000000-0000-0000-0000-000000000000 - description: 'Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`.' in: query name: include schema: type: string example: example_value requestBody: content: application/json: schema: $ref: '#/components/schemas/EscalationPolicyUpdateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EscalationPolicy' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Update On-call Escalation Policy tags: - Policies x-menu-order: 6 x-permission: operator: AND permissions: - on_call_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/remote_config/products/cws/policy: get: 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': content: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse' description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Get All Workload Protection Policies tags: - Policies x-menu-order: 6 x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: 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: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateRequest' description: The definition of the new Agent policy required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '409': $ref: '#/components/responses/ConflictResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Create a Workload Protection Policy tags: - Policies x-codegen-request-body-name: body x-given: policy: parameters: - name: body value: "{\n \"data\": {\n \"type\": \"policy\",\n \"attributes\": {\n \"name\": \"{{ unique_lower_alnum }}\",\n \"description\": \"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: 8 x-undo: operationId: DeleteCSMThreatsAgentPolicy parameters: - name: policy_id source: data.id type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/remote_config/products/cws/policy/download: get: description: 'The download endpoint generates a Workload Protection policy file from your currently active 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. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.' operationId: DownloadCSMThreatsPolicy responses: '200': content: application/zip: schema: format: binary type: string description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Download the Workload Protection Policy tags: - Policies x-menu-order: 11 x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/remote_config/products/cws/policy/{policy_id}: delete: 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' responses: '202': description: OK '204': description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Delete a Workload Protection Policy tags: - Policies x-menu-order: 10 x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK get: 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' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse' description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Get a Workload Protection Policy tags: - Policies x-menu-order: 7 x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: description: 'Update a specific Workload Protection policy. Returns the 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateRequest' description: New definition of the Agent policy required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '409': $ref: '#/components/responses/ConcurrentModificationResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Update a Workload Protection Policy tags: - Policies x-codegen-request-body-name: body x-menu-order: 9 x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/restriction_policy/{resource_id}: delete: description: Deletes the restriction policy associated with a specified resource. operationId: DeleteRestrictionPolicy parameters: - $ref: '#/components/parameters/ResourceID' responses: '204': description: No Content '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Delete a Restriction Policy tags: - Policies x-menu-order: 3 x-permission: operator: OPEN permissions: [] x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Retrieves the restriction policy associated with a specified resource. operationId: GetRestrictionPolicy parameters: - $ref: '#/components/parameters/ResourceID' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestrictionPolicyResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Get a Restriction Policy tags: - Policies x-menu-order: 2 x-permission: operator: OPEN permissions: [] x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'Updates the restriction policy associated with a resource. #### Supported resources Restriction policies can be applied to the following resources: - Dashboards: `dashboard` - Integration Accounts: `integration-account` - Integration Services: `integration-service` - Integration Webhooks: `integration-webhook` - Notebooks: `notebook` - Powerpacks: `powerpack` - Reference Tables: `reference-table` - Security Rules: `security-rule` - Service Level Objectives: `slo` - Synthetic Global Variables: `synthetics-global-variable` - Synthetic Tests: `synthetics-test` - Synthetic Private Locations: `synthetics-private-location` - Monitors: `monitor` - Workflows: `workflow` - App Builder Apps: `app-builder-app` - Connections: `connection` - Connection Groups: `connection-group` - RUM Applications: `rum-application` #### Supported relations for resources Resource Type | Supported Relations ----------------------------|-------------------------- Dashboards | `viewer`, `editor` Integration Accounts | `viewer`, `editor` Integration Services | `viewer`, `editor` Integration Webhooks | `viewer`, `editor` Notebooks | `viewer`, `editor` Powerpacks | `viewer`, `editor` Security Rules | `viewer`, `editor` Service Level Objectives | `viewer`, `editor` Synthetic Global Variables | `viewer`, `editor` Synthetic Tests | `viewer`, `editor` Synthetic Private Locations | `viewer`, `editor` Monitors | `viewer`, `editor` Reference Tables | `viewer`, `editor` Workflows | `viewer`, `runner`, `editor` App Builder Apps | `viewer`, `editor` Connections | `viewer`, `resolver`, `editor` Connection Groups | `viewer`, `editor` RUM Application | `viewer`, `editor`' operationId: UpdateRestrictionPolicy parameters: - $ref: '#/components/parameters/ResourceID' - description: Allows admins (users with the `user_access_manage` permission) to remove their own access from the resource if set to `true`. By default, this is set to `false`, preventing admins from locking themselves out. in: query name: allow_self_lockout required: false schema: type: boolean example: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RestrictionPolicyUpdateRequest' description: Restriction policy payload required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestrictionPolicyResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Update a Restriction Policy tags: - Policies x-codegen-request-body-name: body x-menu-order: 1 x-permission: operator: OPEN permissions: [] x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/security/cloud_workload/policy/download: get: description: 'The download endpoint generates a Workload Protection policy file from your currently active 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. **Note**: This endpoint should only be used for the Government (US1-FED) site.' operationId: DownloadCloudWorkloadPolicyFile responses: '200': content: application/yaml: schema: format: binary type: string description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Download the Workload Protection Policy (us1-fed) tags: - Policies x-menu-order: 17 x-permission: operator: OR permissions: - security_monitoring_cws_agent_rules_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: EscalationPolicyCreateRequestDataAttributes: description: Defines the attributes for creating an escalation policy, including its description, name, resolution behavior, retries, and steps. properties: name: description: Specifies the name for the new escalation policy. example: On-Call Escalation Policy type: string resolve_page_on_policy_end: description: Indicates whether the page is automatically resolved when the policy ends. type: boolean example: true retries: description: Specifies how many times the escalation sequence is retried if there is no response. format: int64 type: integer example: 42 steps: description: A list of escalation steps, each defining assignment, escalation timeout, and targets for the new policy. items: $ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItems' type: array required: - name - steps type: object TeamTarget: description: Represents a team target for an escalation policy step, including the team's ID and resource type. properties: id: description: Specifies the unique identifier of the team resource. example: 00000000-aba1-0000-0000-000000000000 type: string type: $ref: '#/components/schemas/TeamTargetType' required: - type - id type: object CloudWorkloadSecurityAgentPolicyUpdateRequest: description: Request object that includes the Agent policy with the attributes to update properties: data: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateData' required: - data type: object ScheduleDataAttributes: description: Provides core properties of a schedule object such as its name and time zone. properties: name: description: A short name for the schedule. example: Primary On-Call type: string time_zone: description: The time zone in which this schedule operates. example: America/New_York type: string type: object RestrictionPolicyUpdateRequest: description: Update request for a restriction policy. properties: data: $ref: '#/components/schemas/RestrictionPolicy' required: - data type: object MonitorConfigPolicyEditData: description: A monitor configuration policy data. properties: attributes: $ref: '#/components/schemas/MonitorConfigPolicyAttributeEditRequest' id: description: ID of this monitor configuration policy. example: 00000000-0000-1234-0000-000000000000 type: string type: $ref: '#/components/schemas/MonitorConfigPolicyResourceType' required: - id - type - attributes type: object MonitorConfigPolicyListResponse: description: Response for retrieving all monitor configuration policies. properties: data: description: An array of monitor configuration policies. items: $ref: '#/components/schemas/MonitorConfigPolicyResponseData' type: array type: object UserAttributesStatus: description: The user's status. enum: - active - deactivated - pending type: string x-enum-varnames: - ACTIVE - DEACTIVATED - PENDING MonitorConfigPolicyEditRequest: description: Request for editing a monitor configuration policy. properties: data: $ref: '#/components/schemas/MonitorConfigPolicyEditData' required: - data type: object MonitorConfigPolicyTagPolicy: description: Tag attributes of a monitor configuration policy. properties: tag_key: description: The key of the tag. example: datacenter maxLength: 255 type: string tag_key_required: description: If a tag key is required for monitor creation. example: true type: boolean valid_tag_values: description: Valid values for the tag. example: - prod - staging items: maxLength: 255 type: string type: array type: object EscalationTarget: description: Represents an escalation target, which can be a team, user, or schedule. oneOf: - $ref: '#/components/schemas/TeamTarget' - $ref: '#/components/schemas/UserTarget' - $ref: '#/components/schemas/ScheduleTarget' EscalationPolicyStepType: default: steps description: Indicates that the resource is of type `steps`. enum: - steps example: steps type: string x-enum-varnames: - STEPS DataRelationshipsTeams: description: Associates teams with this schedule in a data structure. properties: data: description: An array of team references for this schedule. items: $ref: '#/components/schemas/DataRelationshipsTeamsDataItems' type: array type: object UserTarget: description: Represents a user target for an escalation policy step, including the user's ID and resource type. properties: id: description: Specifies the unique identifier of the user resource. example: 00000000-aba1-0000-0000-000000000000 type: string type: $ref: '#/components/schemas/UserTargetType' required: - type - id type: object RestrictionPolicyAttributes: description: Restriction policy attributes. example: bindings: [] properties: bindings: description: An array of bindings. items: $ref: '#/components/schemas/RestrictionPolicyBinding' type: array required: - bindings type: object EscalationPolicyStepAttributesAssignment: description: Specifies how this escalation step will assign targets (example `default` or `round-robin`). enum: - default - round-robin type: string x-enum-varnames: - DEFAULT - ROUND_ROBIN ScheduleDataRelationshipsLayersDataItems: description: Relates a layer to this schedule, identified by `id` and `type` (must be `layers`). properties: id: description: The unique identifier of the layer in this relationship. example: 00000000-0000-0000-0000-000000000001 type: string type: $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItemsType' required: - type - id type: object EscalationPolicyStep: description: Represents a single step in an escalation policy, including its attributes, relationships, and resource type. properties: attributes: $ref: '#/components/schemas/EscalationPolicyStepAttributes' id: description: Specifies the unique identifier of this escalation policy step. type: string example: abc-123-def relationships: $ref: '#/components/schemas/EscalationPolicyStepRelationships' type: $ref: '#/components/schemas/EscalationPolicyStepType' required: - type type: object RestrictionPolicyResponse: description: Response containing information about a single restriction policy. properties: data: $ref: '#/components/schemas/RestrictionPolicy' required: - data type: object EscalationPolicyUserType: default: users description: Users resource type. enum: - users example: users type: string x-enum-varnames: - USERS ScheduleDataRelationshipsLayersDataItemsType: default: layers description: Layers resource type. enum: - layers example: layers type: string x-enum-varnames: - LAYERS EscalationPolicyCreateRequest: description: Represents a request to create a new escalation policy, including the policy data. example: data: attributes: name: Escalation Policy 1 resolve_page_on_policy_end: true retries: 2 steps: - assignment: default escalate_after_seconds: 3600 targets: - id: 00000000-aba1-0000-0000-000000000000 type: users - id: 00000000-aba2-0000-0000-000000000000 type: schedules - id: 00000000-aba3-0000-0000-000000000000 type: teams - assignment: round-robin escalate_after_seconds: 3600 targets: - id: 00000000-aba1-0000-0000-000000000000 type: users - id: 00000000-abb1-0000-0000-000000000000 type: users relationships: teams: data: - id: 00000000-da3a-0000-0000-000000000000 type: teams type: policies properties: data: $ref: '#/components/schemas/EscalationPolicyCreateRequestData' required: - data type: object EscalationPolicyUser: description: Represents a user object in the context of an escalation policy, including their `id`, type, and basic attributes. properties: attributes: $ref: '#/components/schemas/EscalationPolicyUserAttributes' id: description: The unique user identifier. type: string example: abc-123-def type: $ref: '#/components/schemas/EscalationPolicyUserType' required: - type type: object EscalationPolicyUpdateRequest: description: Represents a request to update an existing escalation policy, including the updated policy data. example: data: attributes: name: Escalation Policy 1 resolve_page_on_policy_end: false retries: 2 steps: - assignment: default escalate_after_seconds: 3600 id: 00000000-aba1-0000-0000-000000000000 targets: - id: 00000000-aba1-0000-0000-000000000000 type: users - id: 00000000-aba2-0000-0000-000000000000 type: schedules id: a3000000-0000-0000-0000-000000000000 relationships: teams: data: - id: 00000000-da3a-0000-0000-000000000000 type: teams type: policies properties: data: $ref: '#/components/schemas/EscalationPolicyUpdateRequestData' required: - data type: object ScheduleDataRelationshipsLayers: description: Associates layers with this schedule in a data structure. properties: data: description: An array of layer references for this schedule. items: $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItems' type: array type: object EscalationPolicyUserAttributes: description: Provides basic user information for an escalation policy, including a name and email address. properties: email: description: The user's email address. example: jane.doe@example.com type: string name: description: The user's name. example: Jane Doe type: string status: $ref: '#/components/schemas/UserAttributesStatus' type: object TeamTargetType: default: teams description: Indicates that the resource is of type `teams`. enum: - teams example: teams type: string x-enum-varnames: - TEAMS DataRelationshipsTeamsDataItemsType: default: teams description: Teams resource type. enum: - teams example: teams type: string x-enum-varnames: - TEAMS CloudWorkloadSecurityAgentPolicyCreateAttributes: description: Create a new Cloud Workload Security Agent policy properties: description: description: The description of the policy example: My agent policy type: string enabled: description: Whether the policy is enabled example: true type: boolean hostTags: description: The host tags defining where this policy is deployed items: type: string type: array hostTagsLists: description: The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR items: items: type: string type: array type: array name: description: The name of the policy example: my_agent_policy type: string required: - name type: object CloudWorkloadSecurityAgentPolicyUpdateAttributes: description: Update an existing Cloud Workload Security Agent policy properties: description: description: The description of the policy example: My agent policy type: string enabled: description: Whether the policy is enabled example: true type: boolean hostTags: description: The host tags defining where this policy is deployed items: type: string type: array hostTagsLists: description: The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR items: items: type: string type: array type: array name: description: The name of the policy example: my_agent_policy type: string type: object MonitorConfigPolicyCreateRequest: description: Request for creating a monitor configuration policy. properties: data: $ref: '#/components/schemas/MonitorConfigPolicyCreateData' required: - data type: object CloudWorkloadSecurityAgentPolicyCreateData: description: Object for a single Agent rule properties: attributes: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateAttributes' type: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType' required: - attributes - type type: object EscalationPolicyDataRelationshipsStepsDataItemsType: default: steps description: Indicates that the resource is of type `steps`. enum: - steps example: steps type: string x-enum-varnames: - STEPS EscalationPolicyDataType: default: policies description: Indicates that the resource is of type `policies`. enum: - policies example: policies type: string x-enum-varnames: - POLICIES EscalationPolicyIncluded: description: Represents included related resources when retrieving an escalation policy, such as teams, steps, or targets. oneOf: - $ref: '#/components/schemas/TeamReference' - $ref: '#/components/schemas/EscalationPolicyStep' - $ref: '#/components/schemas/EscalationPolicyUser' - $ref: '#/components/schemas/ScheduleData' EscalationPolicyCreateRequestDataType: default: policies description: Indicates that the resource is of type `policies`. enum: - policies example: policies type: string x-enum-varnames: - POLICIES EscalationPolicyStepTarget: description: Defines a single escalation target within a step for an escalation policy creation request. Contains `id` and `type`. properties: id: description: Specifies the unique identifier for this target. example: 00000000-aba1-0000-0000-000000000000 type: string type: $ref: '#/components/schemas/EscalationPolicyStepTargetType' type: object EscalationPolicyStepTargetType: description: Specifies the type of escalation target (example `users`, `schedules`, or `teams`). enum: - users - schedules - teams example: users type: string x-enum-varnames: - USERS - SCHEDULES - TEAMS MonitorConfigPolicyPolicyCreateRequest: description: Configuration for the policy. oneOf: - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest' MonitorConfigPolicyResponseData: description: A monitor configuration policy data. properties: attributes: $ref: '#/components/schemas/MonitorConfigPolicyAttributeResponse' id: description: ID of this monitor configuration policy. example: 00000000-0000-1234-0000-000000000000 type: string type: $ref: '#/components/schemas/MonitorConfigPolicyResourceType' type: object ScheduleTarget: description: Represents a schedule target for an escalation policy step, including its ID and resource type. properties: id: description: Specifies the unique identifier of the schedule resource. example: 00000000-aba1-0000-0000-000000000000 type: string type: $ref: '#/components/schemas/ScheduleTargetType' required: - type - id type: object CloudWorkloadSecurityAgentPoliciesListResponse: description: Response object that includes a list of Agent policies properties: data: description: A list of Agent policy objects items: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData' type: array type: object MonitorConfigPolicyCreateData: description: A monitor configuration policy data. properties: attributes: $ref: '#/components/schemas/MonitorConfigPolicyAttributeCreateRequest' type: $ref: '#/components/schemas/MonitorConfigPolicyResourceType' required: - type - attributes type: object ScheduleDataRelationships: description: Groups the relationships for a schedule object, referencing layers and teams. properties: layers: $ref: '#/components/schemas/ScheduleDataRelationshipsLayers' teams: $ref: '#/components/schemas/DataRelationshipsTeams' type: object TeamReference: description: Provides a reference to a team, including ID, type, and basic attributes/relationships. properties: attributes: $ref: '#/components/schemas/TeamReferenceAttributes' id: description: The team's unique identifier. type: string example: abc-123-def type: $ref: '#/components/schemas/TeamReferenceType' required: - type type: object EscalationTargets: description: A list of escalation targets for a step properties: data: description: The `EscalationTargets` `data`. items: $ref: '#/components/schemas/EscalationTarget' type: array type: object MonitorConfigPolicyAttributeResponse: description: Policy and policy type for a monitor configuration policy. properties: policy: $ref: '#/components/schemas/MonitorConfigPolicyPolicy' policy_type: $ref: '#/components/schemas/MonitorConfigPolicyType' type: object TeamReferenceAttributes: description: Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description. properties: avatar: description: URL or reference for the team's avatar (if available). type: string example: example_value description: description: A short text describing the team. type: string example: example_value handle: description: A unique handle/slug for the team. type: string example: example_value name: description: The full, human-readable name of the team. type: string example: Example Monitor type: object MonitorConfigPolicyResponse: description: Response for retrieving a monitor configuration policy. properties: data: $ref: '#/components/schemas/MonitorConfigPolicyResponseData' type: object CloudWorkloadSecurityAgentPolicyResponse: description: Response object that includes an Agent policy properties: data: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData' type: object ScheduleDataType: default: schedules description: Schedules resource type. enum: - schedules example: schedules type: string x-enum-varnames: - SCHEDULES MonitorConfigPolicyType: default: tag description: The monitor configuration policy type. enum: - tag example: tag type: string x-enum-varnames: - TAG MonitorConfigPolicyTagPolicyCreateRequest: description: Tag attributes of a monitor configuration policy. properties: tag_key: description: The key of the tag. example: datacenter maxLength: 255 type: string tag_key_required: description: If a tag key is required for monitor creation. example: true type: boolean valid_tag_values: description: Valid values for the tag. example: - prod - staging items: maxLength: 255 type: string type: array required: - tag_key - tag_key_required - valid_tag_values type: object CloudWorkloadSecurityAgentPolicyCreateRequest: description: Request object that includes the Agent policy to create properties: data: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateData' required: - data type: object EscalationPolicy: description: Represents a complete escalation policy response, including policy data and optionally included related resources. example: data: attributes: name: Escalation Policy 1 resolve_page_on_policy_end: true retries: 2 id: 00000000-aba1-0000-0000-000000000000 relationships: steps: data: - id: 00000000-aba1-0000-0000-000000000000 type: steps teams: data: - id: 00000000-da3a-0000-0000-000000000000 type: teams type: policies included: - attributes: avatar: '' description: Team 1 description handle: team1 name: Team 1 id: 00000000-da3a-0000-0000-000000000000 type: teams - attributes: assignment: default escalate_after_seconds: 3600 id: 00000000-aba1-0000-0000-000000000000 relationships: targets: data: - id: 00000000-aba1-0000-0000-000000000000 type: users - id: 00000000-aba2-0000-0000-000000000000 type: schedules - id: 00000000-aba3-0000-0000-000000000000 type: teams type: steps - id: 00000000-aba1-0000-0000-000000000000 type: users - id: 00000000-aba2-0000-0000-000000000000 type: schedules - id: 00000000-aba3-0000-0000-000000000000 type: teams properties: data: $ref: '#/components/schemas/EscalationPolicyData' included: description: Provides any included related resources, such as steps or targets, returned with the policy. items: $ref: '#/components/schemas/EscalationPolicyIncluded' type: array type: object APIErrorResponse: description: API error response. properties: errors: description: A list of errors. example: - Bad Request items: description: A list of items. example: Bad Request type: string type: array required: - errors type: object EscalationPolicyDataRelationships: description: Represents the relationships for an escalation policy, including references to steps and teams. properties: steps: $ref: '#/components/schemas/EscalationPolicyDataRelationshipsSteps' teams: $ref: '#/components/schemas/DataRelationshipsTeams' required: - steps type: object EscalationPolicyStepRelationships: description: Represents the relationship of an escalation policy step to its targets. properties: targets: $ref: '#/components/schemas/EscalationTargets' type: object CloudWorkloadSecurityAgentPolicyData: description: Object for a single Agent policy properties: attributes: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyAttributes' id: description: The ID of the Agent policy example: 6517fcc1-cec7-4394-a655-8d6e9d085255 type: string type: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType' type: object ScheduleTargetType: default: schedules description: Indicates that the resource is of type `schedules`. enum: - schedules example: schedules type: string x-enum-varnames: - SCHEDULES EscalationPolicyCreateRequestDataRelationships: description: Represents relationships in an escalation policy creation request, including references to teams. properties: teams: $ref: '#/components/schemas/DataRelationshipsTeams' type: object CloudWorkloadSecurityAgentPolicyUpdateData: description: Object for a single Agent policy properties: attributes: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateAttributes' id: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyID' type: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType' required: - attributes - type type: object CloudWorkloadSecurityAgentPolicyID: description: The ID of the Agent policy example: 6517fcc1-cec7-4394-a655-8d6e9d085255 type: string RestrictionPolicy: description: Restriction policy object. properties: attributes: $ref: '#/components/schemas/RestrictionPolicyAttributes' id: description: The identifier, always equivalent to the value specified in the `resource_id` path parameter. example: dashboard:abc-def-ghi type: string type: $ref: '#/components/schemas/RestrictionPolicyType' required: - type - id - attributes type: object ScheduleData: description: Represents the primary data object for a schedule, linking attributes and relationships. properties: attributes: $ref: '#/components/schemas/ScheduleDataAttributes' id: description: The schedule's unique identifier. example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d type: string relationships: $ref: '#/components/schemas/ScheduleDataRelationships' type: $ref: '#/components/schemas/ScheduleDataType' required: - type type: object MonitorConfigPolicyResourceType: default: monitor-config-policy description: Monitor configuration policy resource type. enum: - monitor-config-policy example: monitor-config-policy type: string x-enum-varnames: - MONITOR_CONFIG_POLICY DataRelationshipsTeamsDataItems: description: Relates a team to this schedule, identified by `id` and `type` (must be `teams`). properties: id: description: The unique identifier of the team in this relationship. example: 00000000-da3a-0000-0000-000000000000 type: string type: $ref: '#/components/schemas/DataRelationshipsTeamsDataItemsType' required: - type - id type: object MonitorConfigPolicyPolicy: description: Configuration for the policy. oneOf: - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicy' EscalationPolicyDataAttributes: description: Defines the main attributes of an escalation policy, such as its name and behavior on policy end. properties: name: description: Specifies the name of the escalation policy. example: On-Call Escalation Policy type: string resolve_page_on_policy_end: description: Indicates whether the page is automatically resolved when the policy ends. type: boolean example: true retries: description: Specifies how many times the escalation sequence is retried if there is no response. format: int64 type: integer example: 42 required: - name type: object CloudWorkloadSecurityAgentPolicyUpdaterAttributes: description: The attributes of the user who last updated the policy properties: handle: description: The handle of the user example: datadog.user@example.com type: string name: description: The name of the user example: Datadog User nullable: true type: string type: object RestrictionPolicyBinding: description: Specifies which principals are associated with a relation. properties: principals: description: 'An array of principals. A principal is a subject or group of subjects. Each principal is formatted as `type:id`. Supported types: `role`, `team`, `user`, and `org`. The org ID can be obtained through the api/v2/current_user API. The user principal type accepts service account IDs.' example: - role:00000000-0000-1111-0000-000000000000 items: description: 'Subject or group of subjects. Each principal is formatted as `type:id`. Supported types: `role`, `team`, `user`, and `org`. The org ID can be obtained through the api/v2/current_user API. The user principal type accepts service account IDs.' type: string type: array relation: description: The role/level of access. example: editor type: string required: - relation - principals type: object EscalationPolicyData: description: Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type. properties: attributes: $ref: '#/components/schemas/EscalationPolicyDataAttributes' id: description: Specifies the unique identifier of the escalation policy. example: ab000000-0000-0000-0000-000000000000 type: string relationships: $ref: '#/components/schemas/EscalationPolicyDataRelationships' type: $ref: '#/components/schemas/EscalationPolicyDataType' required: - type type: object EscalationPolicyUpdateRequestDataType: default: policies description: Indicates that the resource is of type `policies`. enum: - policies example: policies type: string x-enum-varnames: - POLICIES EscalationPolicyCreateRequestDataAttributesStepsItems: description: Defines a single escalation step within an escalation policy creation request. Contains assignment strategy, escalation timeout, and a list of targets. properties: assignment: $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment' escalate_after_seconds: description: Defines how many seconds to wait before escalating to the next step. example: 3600 format: int64 type: integer targets: description: Specifies the collection of escalation targets for this step. example: - users items: $ref: '#/components/schemas/EscalationPolicyStepTarget' type: array required: - targets type: object MonitorConfigPolicyAttributeCreateRequest: description: Policy and policy type for a monitor configuration policy. properties: policy: $ref: '#/components/schemas/MonitorConfigPolicyPolicyCreateRequest' policy_type: $ref: '#/components/schemas/MonitorConfigPolicyType' required: - policy_type - policy type: object CloudWorkloadSecurityAgentPolicyType: default: policy description: The type of the resource, must always be `policy` enum: - policy example: policy type: string x-enum-varnames: - POLICY EscalationPolicyDataRelationshipsStepsDataItems: description: Defines a relationship to a single step within an escalation policy. Contains the step's `id` and `type`. properties: id: description: Specifies the unique identifier for the step resource. example: 00000000-aba1-0000-0000-000000000000 type: string type: $ref: '#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItemsType' required: - type - id type: object EscalationPolicyUpdateRequestDataAttributesStepsItems: description: Defines a single escalation step within an escalation policy update request. Contains assignment strategy, escalation timeout, an optional step ID, and a list of targets. properties: assignment: $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment' escalate_after_seconds: description: Defines how many seconds to wait before escalating to the next step. example: 3600 format: int64 type: integer id: description: Specifies the unique identifier of this step. example: 00000000-aba1-0000-0000-000000000000 type: string targets: description: Specifies the collection of escalation targets for this step. items: $ref: '#/components/schemas/EscalationPolicyStepTarget' type: array required: - targets type: object EscalationPolicyCreateRequestData: description: Represents the data for creating an escalation policy, including its attributes, relationships, and resource type. properties: attributes: $ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributes' relationships: $ref: '#/components/schemas/EscalationPolicyCreateRequestDataRelationships' type: $ref: '#/components/schemas/EscalationPolicyCreateRequestDataType' required: - type - attributes type: object EscalationPolicyUpdateRequestDataAttributes: description: Defines the attributes that can be updated for an escalation policy, such as description, name, resolution behavior, retries, and steps. properties: name: description: Specifies the name of the escalation policy. example: On-Call Escalation Policy type: string resolve_page_on_policy_end: description: Indicates whether the page is automatically resolved when the policy ends. type: boolean example: true retries: description: Specifies how many times the escalation sequence is retried if there is no response. format: int64 type: integer example: 42 steps: description: A list of escalation steps, each defining assignment, escalation timeout, and targets. items: $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItems' type: array required: - name - steps type: object EscalationPolicyStepAttributes: description: Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout. properties: assignment: $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment' escalate_after_seconds: description: Specifies how many seconds to wait before escalating to the next step. format: int64 type: integer example: 42 type: object CloudWorkloadSecurityAgentPolicyAttributes: description: A Cloud Workload Security Agent policy returned by the API properties: blockingRulesCount: description: The number of rules with the blocking feature in this policy example: 100 format: int32 maximum: 2147483647 type: integer datadogManaged: description: Whether the policy is managed by Datadog example: false type: boolean description: description: The description of the policy example: My agent policy type: string disabledRulesCount: description: The number of rules that are disabled in this policy example: 100 format: int32 maximum: 2147483647 type: integer enabled: description: Whether the Agent policy is enabled example: true type: boolean hostTags: description: The host tags defining where this policy is deployed items: type: string type: array hostTagsLists: description: The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR items: items: type: string type: array type: array monitoringRulesCount: description: The number of rules in the monitoring state in this policy example: 100 format: int32 maximum: 2147483647 type: integer name: description: The name of the policy example: my_agent_policy type: string policyVersion: description: The version of the policy example: '1' type: string priority: description: The priority of the policy example: 10 format: int64 type: integer ruleCount: description: The number of rules in this policy example: 100 format: int32 maximum: 2147483647 type: integer updateDate: description: Timestamp in milliseconds when the policy was last updated example: 1624366480320 format: int64 type: integer updatedAt: description: When the policy was last updated, timestamp in milliseconds example: 1624366480320 format: int64 type: integer updater: $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdaterAttributes' type: object EscalationPolicyUpdateRequestData: description: Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type. properties: attributes: $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributes' id: description: Specifies the unique identifier of the escalation policy being updated. example: 00000000-aba1-0000-0000-000000000000 type: string relationships: $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataRelationships' type: $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataType' required: - type - id - attributes type: object EscalationPolicyDataRelationshipsSteps: description: Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references. properties: data: description: An array of references to the steps defined in this escalation policy. items: $ref: '#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItems' type: array type: object RestrictionPolicyType: default: restriction_policy description: Restriction policy type. enum: - restriction_policy example: restriction_policy type: string x-enum-varnames: - RESTRICTION_POLICY EscalationPolicyUpdateRequestDataRelationships: description: Represents relationships in an escalation policy update request, including references to teams. properties: teams: $ref: '#/components/schemas/DataRelationshipsTeams' type: object UserTargetType: default: users description: Indicates that the resource is of type `users`. enum: - users example: users type: string x-enum-varnames: - USERS MonitorConfigPolicyAttributeEditRequest: description: Policy and policy type for a monitor configuration policy. properties: policy: $ref: '#/components/schemas/MonitorConfigPolicyPolicy' policy_type: $ref: '#/components/schemas/MonitorConfigPolicyType' required: - policy_type - policy type: object TeamReferenceType: default: teams description: Teams resource type. enum: - teams example: teams type: string x-enum-varnames: - TEAMS responses: NotFoundResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found UnauthorizedResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Unauthorized ForbiddenResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden ConflictResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Conflict ConcurrentModificationResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Concurrent Modification NotAuthorizedResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Authorized TooManyRequestsResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too many requests BadRequestResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Bad Request parameters: ResourceID: description: 'Identifier, formatted as `type:id`. Supported types: `connection`, `dashboard`, `integration-account`, `integration-service`, `integration-webhook`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`.' example: dashboard:abc-def-ghi in: path name: resource_id required: true schema: type: string CloudWorkloadSecurityPathAgentPolicyID: description: The ID of the Agent policy example: 6517fcc1-cec7-4394-a655-8d6e9d085255 in: path name: policy_id required: true schema: type: string securitySchemes: AuthZ: description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: authorizationUrl: /oauth2/v1/authorize scopes: apm_api_catalog_read: View API catalog and API definitions. apm_api_catalog_write: Add, modify, and delete API catalog definitions. apm_read: Read and query APM and Trace Analytics. apm_service_catalog_read: View service catalog and service definitions. apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog. appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source. cases_read: View Cases. cases_write: Create and update cases. ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API. ci_visibility_read: View CI Visibility. cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs. cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs. code_analysis_read: View Code Analysis. continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO). create_webhooks: Create webhooks integrations. dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'. dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'. dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. data_scanner_read: View Data Scanner configurations. data_scanner_write: Edit Data Scanner configurations. embeddable_graphs_share: Generate public links to share embeddable graphs externally. events_read: Read Events data. hosts_read: List hosts and their attributes. incident_notification_settings_write: Configure Incidents Notification settings. incident_read: View incidents in Datadog. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. monitor_config_policy_write: Edit and delete monitor configuration. monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. monitors_write: Edit, delete, and resolve individual monitors. org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization. security_comments_read: Read comments of vulnerabilities. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks. security_monitoring_notification_profiles_read: View Rule Security Notification rules. security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. security_monitoring_suppressions_read: Read Rule Suppressions. security_monitoring_suppressions_write: Write Rule Suppressions. security_pipelines_read: View Security Pipelines. security_pipelines_write: Create, edit, and delete CSM Security Pipelines. slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs. slos_read: View SLOs and status corrections. slos_write: Create, edit, and delete SLOs. synthetics_global_variable_read: View, search, and use Synthetics global variables. synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics. synthetics_private_location_read: View, search, and use Synthetics private locations. synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines. synthetics_read: List and view configured Synthetic tests and test results. synthetics_write: Create, edit, and delete Synthetic tests. teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission. teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team. test_optimization_read: View Test Optimization. timeseries_query: Query Timeseries data. usage_read: View your organization's usage and usage attribution. user_access_invite: Invite other users to your organization. user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries. user_access_read: View users and their roles and settings. workflows_read: View workflows. workflows_run: Run workflows. workflows_write: Create, edit, and delete workflows. tokenUrl: /oauth2/v1/token type: oauth2 apiKeyAuth: description: Your Datadog API Key. in: header name: DD-API-KEY type: apiKey x-env-name: DD_API_KEY appKeyAuth: description: Your Datadog APP Key. in: header name: DD-APPLICATION-KEY type: apiKey x-env-name: DD_APP_KEY bearerAuth: scheme: bearer type: http x-env-name: DD_BEARER_TOKEN x-group-parameters: true x-merge-override: paths: false