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 Events 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: - description: 'The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information. **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you''re using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question.' name: Events paths: /api/v2/audit/events: get: description: 'List endpoint returns events that match a Audit Logs search query. [Results are paginated][1]. Use this endpoint to see your latest Audit Logs events. [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' operationId: ListAuditLogs parameters: - description: Search query following Audit Logs syntax. example: '@type:session @application_id:xxxx' in: query name: filter[query] required: false schema: type: string - description: Minimum timestamp for requested events. example: '2019-01-02T09:42:36.320Z' in: query name: filter[from] required: false schema: format: date-time type: string - description: Maximum timestamp for requested events. example: '2019-01-03T09:42:36.320Z' in: query name: filter[to] required: false schema: format: date-time type: string - description: Order of events in results. in: query name: sort required: false schema: $ref: '#/components/schemas/AuditLogsSort' example: example_value - description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== in: query name: page[cursor] required: false schema: type: string - description: Maximum number of events in the response. example: 25 in: query name: page[limit] required: false schema: default: 10 format: int32 maximum: 1000 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuditLogsEventsResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Get a List of Audit Logs Events tags: - Events x-menu-order: 2 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data x-permission: operator: OR permissions: - audit_logs_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/audit/events/search: post: description: 'List endpoint returns Audit Logs events that match an Audit search query. [Results are paginated][1]. Use this endpoint to build complex Audit Logs events filtering and search. [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' operationId: SearchAuditLogs requestBody: content: application/json: schema: $ref: '#/components/schemas/AuditLogsSearchEventsRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuditLogsEventsResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Search Audit Logs Events tags: - Events x-codegen-request-body-name: body x-menu-order: 1 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data x-permission: operator: OR permissions: - audit_logs_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/ci/pipeline: post: description: 'Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). Pipeline events can be submitted with a timestamp that is up to 18 hours in the past.' operationId: CreateCIAppPipelineEvent requestBody: content: application/json: schema: $ref: '#/components/schemas/CIAppCreatePipelineEventRequest' required: true responses: '202': content: application/json: schema: type: object description: Request accepted for processing '400': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Forbidden '408': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Request Timeout '413': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Payload Too Large '429': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Too Many Requests '500': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Internal Server Error '503': content: application/json: schema: $ref: '#/components/schemas/HTTPCIAppErrors' description: Service Unavailable security: - apiKeyAuth: [] summary: Datadog Send Pipeline Event tags: - Events x-codegen-request-body-name: body x-menu-order: 1 x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/ci/pipelines/analytics/aggregate: post: description: Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. operationId: AggregateCIAppPipelineEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/CIAppPipelinesAggregateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - ci_visibility_read summary: Datadog Aggregate Pipelines Events tags: - Events x-codegen-request-body-name: body x-menu-order: 4 x-permission: operator: OR permissions: - ci_visibility_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/ci/pipelines/events: get: description: 'List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to see your latest pipeline events.' operationId: ListCIAppPipelineEvents parameters: - description: Search query following log syntax. example: '@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler' in: query name: filter[query] required: false schema: type: string - description: Minimum timestamp for requested events. example: '2019-01-02T09:42:36.320Z' in: query name: filter[from] required: false schema: format: date-time type: string - description: Maximum timestamp for requested events. example: '2019-01-03T09:42:36.320Z' in: query name: filter[to] required: false schema: format: date-time type: string - description: Order of events in results. in: query name: sort required: false schema: $ref: '#/components/schemas/CIAppSort' example: example_value - description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== in: query name: page[cursor] required: false schema: type: string - description: Maximum number of events in the response. example: 25 in: query name: page[limit] required: false schema: default: 10 format: int32 maximum: 1000 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/CIAppPipelineEventsResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - ci_visibility_read summary: Datadog Get a List of Pipelines Events tags: - Events x-menu-order: 2 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data x-permission: operator: OR permissions: - ci_visibility_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/ci/pipelines/events/search: post: description: 'List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to build complex events filtering and search.' operationId: SearchCIAppPipelineEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/CIAppPipelineEventsRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/CIAppPipelineEventsResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - ci_visibility_read summary: Datadog Search Pipelines Events tags: - Events x-codegen-request-body-name: body x-menu-order: 3 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data x-permission: operator: OR permissions: - ci_visibility_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/ci/tests/analytics/aggregate: post: description: The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries. operationId: AggregateCIAppTestEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/CIAppTestsAggregateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CIAppTestsAnalyticsAggregateResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - ci_visibility_read summary: Datadog Aggregate Tests Events tags: - Events x-codegen-request-body-name: body x-menu-order: 3 x-permission: operator: OR permissions: - ci_visibility_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/ci/tests/events: get: description: 'List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to see your latest test events.' operationId: ListCIAppTestEvents parameters: - description: Search query following log syntax. example: '@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model' in: query name: filter[query] required: false schema: type: string - description: Minimum timestamp for requested events. example: '2019-01-02T09:42:36.320Z' in: query name: filter[from] required: false schema: format: date-time type: string - description: Maximum timestamp for requested events. example: '2019-01-03T09:42:36.320Z' in: query name: filter[to] required: false schema: format: date-time type: string - description: Order of events in results. in: query name: sort required: false schema: $ref: '#/components/schemas/CIAppSort' example: example_value - description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== in: query name: page[cursor] required: false schema: type: string - description: Maximum number of events in the response. example: 25 in: query name: page[limit] required: false schema: default: 10 format: int32 maximum: 1000 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/CIAppTestEventsResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - ci_visibility_read summary: Datadog Get a List of Tests Events tags: - Events x-menu-order: 1 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data x-permission: operator: OR permissions: - ci_visibility_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/ci/tests/events/search: post: description: 'List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to build complex events filtering and search.' operationId: SearchCIAppTestEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/CIAppTestEventsRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/CIAppTestEventsResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - ci_visibility_read summary: Datadog Search Tests Events tags: - Events x-codegen-request-body-name: body x-menu-order: 2 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data x-permission: operator: OR permissions: - ci_visibility_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dora/deployment: post: description: 'Use this API endpoint to provide data about deployments for DORA metrics. This is necessary for: - Deployment Frequency - Change Lead Time - Change Failure Rate' operationId: CreateDORADeployment requestBody: content: application/json: schema: $ref: '#/components/schemas/DORADeploymentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DORADeploymentResponse' description: OK '202': content: application/json: schema: $ref: '#/components/schemas/DORADeploymentResponse' description: OK - but delayed due to incident '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad Request '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] summary: Datadog Send a Deployment Event for Dora Metrics tags: - Events x-codegen-request-body-name: body x-menu-order: 1 x-undo: type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dora/deployments: post: description: Use this API endpoint to get a list of deployment events. operationId: ListDORADeployments requestBody: content: application/json: schema: $ref: '#/components/schemas/DORAListDeploymentsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DORAListResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad Request '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] summary: Datadog Get a List of Deployment Events tags: - Events x-codegen-request-body-name: body x-menu-order: 3 x-permission: operator: OR permissions: - dora_metrics_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dora/deployments/{deployment_id}: get: description: Use this API endpoint to get a deployment event. operationId: GetDORADeployment parameters: - description: The ID of the deployment event. in: path name: deployment_id required: true schema: type: string example: abc-123-def responses: '200': content: application/json: schema: $ref: '#/components/schemas/DORAFetchResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad Request '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] - appKeyAuth: [] summary: Datadog Get a Deployment Event tags: - Events x-codegen-request-body-name: body x-menu-order: 5 x-permission: operator: OR permissions: - dora_metrics_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dora/failures: post: description: Use this API endpoint to get a list of failure events. operationId: ListDORAFailures requestBody: content: application/json: schema: $ref: '#/components/schemas/DORAListFailuresRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DORAListResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad Request '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] summary: Datadog Get a List of Failure Events tags: - Events x-codegen-request-body-name: body x-menu-order: 4 x-permission: operator: OR permissions: - dora_metrics_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dora/failures/{failure_id}: get: description: Use this API endpoint to get a failure event. operationId: GetDORAFailure parameters: - description: The ID of the failure event. in: path name: failure_id required: true schema: type: string example: abc-123-def responses: '200': content: application/json: schema: $ref: '#/components/schemas/DORAFetchResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad Request '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] - appKeyAuth: [] summary: Datadog Get a Failure Event tags: - Events x-codegen-request-body-name: body x-menu-order: 6 x-permission: operator: OR permissions: - dora_metrics_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/dora/incident: post: description: 'Use this API endpoint to provide failure data for DORA metrics. This is necessary for: - Change Failure Rate - Time to Restore' operationId: CreateDORAIncident requestBody: content: application/json: schema: $ref: '#/components/schemas/DORAIncidentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DORAIncidentResponse' description: OK '202': content: application/json: schema: $ref: '#/components/schemas/DORAIncidentResponse' description: OK - but delayed due to incident '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad Request '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] summary: Datadog Send an Incident Event for Dora Metrics tags: - Events x-codegen-request-body-name: body x-menu-order: 2 x-undo: type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/events: x-merge-override: get: false post: false get: description: 'List endpoint returns events that match an events search query. [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to see your latest events.' operationId: ListEvents parameters: - description: Search query following events syntax. in: query name: filter[query] required: false schema: type: string example: avg:system.cpu.user{*} - description: Minimum timestamp for requested events, in milliseconds. in: query name: filter[from] required: false schema: type: string example: example_value - description: Maximum timestamp for requested events, in milliseconds. in: query name: filter[to] required: false schema: type: string example: example_value - description: Order of events in results. in: query name: sort required: false schema: $ref: '#/components/schemas/EventsSort' example: example_value - description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== in: query name: page[cursor] required: false schema: type: string - description: Maximum number of events in the response. example: 25 in: query name: page[limit] required: false schema: default: 10 format: int32 maximum: 1000 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/EventsListResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - events_read summary: Datadog Get a List of Events tags: - Events x-menu-order: 1 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data x-permission: operator: OR permissions: - events_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'This endpoint allows you to post events. ✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details. ❌ For use cases involving other event categories, please use the V1 endpoint.' operationId: CreateEvent requestBody: content: application/json: examples: json-request-body: value: data: attributes: attributes: author: name: datadog@datadog.com type: user change_metadata: dd: team: datadog_team user_email: datadog@datadog.com user_id: datadog_user_id user_name: datadog_username resource_link: datadog.com/feature/fallback_payments_test changed_resource: name: fallback_payments_test type: feature_flag impacted_resources: - name: payments_api type: service new_value: enabled: true percentage: 50% rule: datacenter: devcycle.us1.prod prev_value: enabled: true percentage: 10% rule: datacenter: devcycle.us1.prod category: change message: payment_processed feature flag has been enabled tags: - env:test title: payment_processed feature flag updated type: event schema: $ref: '#/components/schemas/EventCreateRequestPayload' description: Event request object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EventCreateResponsePayload' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] summary: Datadog Post an Event tags: - Events x-codegen-request-body-name: body x-menu-order: 2 x-undo: type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/events/search: x-merge-override: post: false post: description: 'List endpoint returns events that match an events search query. [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to build complex events filtering and search.' operationId: SearchEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/EventsListRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/EventsListResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Search Events tags: - Events x-codegen-request-body-name: body x-menu-order: 2 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data x-permission: operator: OR permissions: - events_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/logs/analytics/aggregate: post: description: The API endpoint to aggregate events into buckets and compute metrics and timeseries. operationId: AggregateLogs requestBody: content: application/json: schema: $ref: '#/components/schemas/LogsAggregateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LogsAggregateResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Aggregate Events tags: - Events x-codegen-request-body-name: body x-menu-order: 2 x-permission: operator: OR permissions: - logs_read_data x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/rum/analytics/aggregate: post: description: The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries. operationId: AggregateRUMEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/RUMAggregateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RUMAnalyticsAggregateResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Aggregate Rum Events tags: - Events x-codegen-request-body-name: body x-menu-order: 3 x-permission: operator: OPEN permissions: [] x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/rum/events: get: description: 'List endpoint returns events that match a RUM search query. [Results are paginated][1]. Use this endpoint to see your latest RUM events. [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' operationId: ListRUMEvents parameters: - description: Search query following RUM syntax. example: '@type:session @application_id:xxxx' in: query name: filter[query] required: false schema: type: string - description: Minimum timestamp for requested events. example: '2019-01-02T09:42:36.320Z' in: query name: filter[from] required: false schema: format: date-time type: string - description: Maximum timestamp for requested events. example: '2019-01-03T09:42:36.320Z' in: query name: filter[to] required: false schema: format: date-time type: string - description: Order of events in results. in: query name: sort required: false schema: $ref: '#/components/schemas/RUMSort' example: example_value - description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== in: query name: page[cursor] required: false schema: type: string - description: Maximum number of events in the response. example: 25 in: query name: page[limit] required: false schema: default: 10 format: int32 maximum: 1000 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/RUMEventsResponse' 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 List of Rum Events tags: - Events x-menu-order: 2 x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data x-permission: operator: OPEN permissions: [] x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/rum/events/search: post: description: 'List endpoint returns RUM events that match a RUM search query. [Results are paginated][1]. Use this endpoint to build complex RUM events filtering and search. [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' operationId: SearchRUMEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/RUMSearchEventsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RUMEventsResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Search Rum Events tags: - Events x-codegen-request-body-name: body x-menu-order: 1 x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data x-permission: operator: OPEN permissions: [] x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/events/{event_id}: get: operationId: getEvent summary: Datadog Get an Event description: Returns the full details of a specific event identified by its unique event ID. Includes the event title, text, timestamp, source, tags, alert type, priority, and associated hosts. The event ID is returned when creating events or from list event responses. tags: - Events parameters: - $ref: '#/components/parameters/eventIdParam' responses: '200': description: Successful response with event details content: application/json: schema: $ref: '#/components/schemas/EventResponse_2' '401': description: Unauthorized - missing or invalid credentials content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse_2' '403': description: Forbidden - insufficient permissions to view this event content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse_2' '404': description: Not found - event with the specified ID does not exist content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse_2' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: CIAppGroupByTotal: default: false description: A resulting object to put the given computes in over all the matching records. oneOf: - $ref: '#/components/schemas/CIAppGroupByTotalBoolean' - $ref: '#/components/schemas/CIAppGroupByTotalString' - $ref: '#/components/schemas/CIAppGroupByTotalNumber' LogsAggregateRequestPage: description: Paging settings properties: cursor: description: 'The returned paging point to use to get the next results. Note: at most 1000 results can be paged.' example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object AuditLogsResponsePage: description: Paging attributes. properties: after: description: The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object RUMResponseStatus: description: The status of the response. enum: - done - timeout example: done type: string x-enum-varnames: - DONE - TIMEOUT CIAppPipelineEventPipelineInProgressStatus: description: The in progress status of the pipeline. enum: - running example: running type: string x-enum-varnames: - RUNNING RUMEventAttributes: description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from RUM events. example: customAttribute: 123 duration: 2345 type: object service: description: 'The name of the application or service generating RUM events. It is used to switch from RUM to APM, so make sure you define the same value when you use both products.' example: web-app type: string tags: description: Array of tags associated with your event. example: - team:A items: description: Tag associated with your event. type: string type: array timestamp: description: Timestamp of your event. example: '2019-01-02T09:42:36.320Z' format: date-time type: string type: object CIAppComputeType: default: total description: The type of compute. enum: - timeseries - total type: string x-enum-varnames: - TIMESERIES - TOTAL ChangeEventCustomAttributesImpactedResourcesItems: description: Object representing a uniquely identified resource. Only the resource type `service` is supported. properties: name: description: Resource's name. example: payments_api type: string type: $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType' required: - type - name type: object GitCommitSHA: description: Git Commit SHA. example: 66adc9350f2cc9b250b69abddab733dd55e1a588 pattern: ^[a-fA-F0-9]{40,}$ type: string CIAppAggregateBucketValueSingleString: description: A single string value. type: string CIAppPipelinesAggregationBucketsResponse: description: The query results. properties: buckets: description: The list of matching buckets, one item per bucket. items: $ref: '#/components/schemas/CIAppPipelinesBucketResponse' type: array type: object EventCreateResponseAttributes: description: JSON object containing all events attributes and their associated values. properties: attributes: $ref: '#/components/schemas/EventCreateResponseAttributesAttributes' type: object LogsAggregateBucketValueSingleString: description: A single string value type: string JSONAPIErrorItem: description: API error response body properties: detail: description: A human-readable explanation specific to this occurrence of the error. example: Missing required attribute in body type: string meta: additionalProperties: {} description: Non-standard meta-information about the error type: object source: $ref: '#/components/schemas/JSONAPIErrorItemSource' status: description: Status code of the response. example: '400' type: string title: description: Short human-readable summary of the error. example: Bad Request type: string type: object RUMAggregateRequest: description: The object sent with the request to retrieve aggregation buckets of RUM events from your organization. properties: compute: description: The list of metrics or timeseries to compute for the retrieved buckets. items: $ref: '#/components/schemas/RUMCompute' type: array filter: $ref: '#/components/schemas/RUMQueryFilter' group_by: description: The rules for the group by. items: $ref: '#/components/schemas/RUMGroupBy' type: array options: $ref: '#/components/schemas/RUMQueryOptions' page: $ref: '#/components/schemas/RUMQueryPageOptions' type: object CIAppPipelineEventParameters: additionalProperties: type: string description: A map of key-value parameters or environment variables that were defined for the pipeline. example: LOG_LEVEL: debug nullable: true type: object RUMGroupByTotalBoolean: description: If set to true, creates an additional bucket labeled "$facet_total". type: boolean APIErrorResponse_2: type: object description: Standard API error response returned for failed requests required: - errors properties: errors: type: array description: List of error messages describing the failure items: type: string CIAppPipelineEventPipelineStatus: description: The final status of the pipeline. enum: - success - error - canceled - skipped - blocked example: success type: string x-enum-varnames: - SUCCESS - ERROR - CANCELED - SKIPPED - BLOCKED CIAppPipelineEventStageStatus: description: The final status of the stage. enum: - success - error - canceled - skipped example: success type: string x-enum-varnames: - SUCCESS - ERROR - CANCELED - SKIPPED CIAppPipelineEventTags: description: A list of user-defined tags. The tags must follow the `key:value` pattern. example: - team:backend - type:deployment items: description: Tags in the form of `key:value`. type: string nullable: true type: array EventResponseAttributes: description: The object description of an event response attribute. properties: attributes: $ref: '#/components/schemas/EventAttributes' message: description: The message of the event. type: string example: CPU usage is high on {{host.name}} tags: description: An array of tags associated with the event. example: - team:A items: description: The tag associated with the event. type: string type: array timestamp: description: The timestamp of the event. example: '2019-01-02T09:42:36.320Z' format: date-time type: string type: object EventsRequestPage: description: Pagination settings. properties: cursor: description: The returned paging point to use to get the next results. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string limit: default: 10 description: The maximum number of logs in the response. example: 25 format: int32 maximum: 1000 type: integer type: object CIAppGroupByMissing: description: The value to use for logs that don't have the facet used to group-by. oneOf: - $ref: '#/components/schemas/CIAppGroupByMissingString' - $ref: '#/components/schemas/CIAppGroupByMissingNumber' CIAppPipelineEventMetrics: description: A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric. example: - bundle_size:370 - build_time:50021 items: description: Metrics in the form of `key:value`. The value needs to be numeric. type: string nullable: true type: array DORADeploymentRequestAttributes: description: Attributes to create a DORA deployment event. properties: env: description: Environment name to where the service was deployed. example: staging type: string finished_at: description: Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour. example: 1693491984000000000 format: int64 type: integer git: $ref: '#/components/schemas/DORAGitInfo' id: description: Deployment ID. type: string example: abc-123-def service: description: Service name. example: shopist type: string started_at: description: Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds. example: 1693491974000000000 format: int64 type: integer team: description: Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog. example: backend type: string version: description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/). example: v1.12.07 type: string required: - service - started_at - finished_at type: object DORAGitInfo: description: Git info for DORA Metrics events. properties: commit_sha: $ref: '#/components/schemas/GitCommitSHA' repository_url: $ref: '#/components/schemas/GitRepositoryURL' required: - repository_url - commit_sha type: object CIAppCompute: description: A compute rule to compute metrics or timeseries. properties: aggregation: $ref: '#/components/schemas/CIAppAggregationFunction' interval: description: 'The time buckets'' size (only used for type=timeseries) Defaults to a resolution of 150 points.' example: 5m type: string metric: description: The metric to use. example: '@duration' type: string type: $ref: '#/components/schemas/CIAppComputeType' required: - aggregation type: object RUMAggregateBucketValueTimeseries: description: A timeseries array. items: $ref: '#/components/schemas/RUMAggregateBucketValueTimeseriesPoint' type: array x-generate-alias-as-model: true EventsListResponse: description: The response object with all events matching the request and pagination information. properties: data: description: An array of events matching the request. items: $ref: '#/components/schemas/EventResponse' type: array links: $ref: '#/components/schemas/EventsListResponseLinks' meta: $ref: '#/components/schemas/EventsResponseMetadata' type: object CIAppPipelineEventStepLevel: default: step description: Used to distinguish between pipelines, stages, jobs and steps. enum: - step example: step type: string x-enum-varnames: - STEP EventPayloadAttributes: description: JSON object for custom attributes. Schema are different per each event category. oneOf: - $ref: '#/components/schemas/ChangeEventCustomAttributes' RUMGroupByTotalNumber: description: A number to use as the key value for the total bucket. format: double type: number AuditLogsResponseMetadata: description: The metadata associated with a request. properties: elapsed: description: Time elapsed in milliseconds. example: 132 format: int64 type: integer page: $ref: '#/components/schemas/AuditLogsResponsePage' request_id: description: The identifier of the request. example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR type: string status: $ref: '#/components/schemas/AuditLogsResponseStatus' warnings: description: 'A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.' items: $ref: '#/components/schemas/AuditLogsWarning' type: array type: object CIAppTestsQueryFilter: description: The search and filter query settings. properties: from: default: now-15m description: The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds). example: now-15m type: string query: default: '*' description: The search query following the CI Visibility Explorer search syntax. example: '@test.service:web-ui-tests AND @test.status:fail' type: string to: default: now description: The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds). example: now type: string type: object CIAppGitInfo: description: 'If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either `tag` or `branch` has to be provided, but not both.' nullable: true properties: author_email: description: The commit author email. example: author@example.com type: string author_name: description: The commit author name. example: John Doe nullable: true type: string author_time: description: The commit author timestamp in RFC3339 format. example: '2023-05-31T15:30:00Z' nullable: true type: string branch: description: The branch name (if a tag use the tag parameter). example: feature-1 nullable: true type: string commit_time: description: The commit timestamp in RFC3339 format. example: '2023-05-31T15:30:00Z' nullable: true type: string committer_email: description: The committer email. example: committer@example.com nullable: true type: string committer_name: description: The committer name. nullable: true type: string example: Example Monitor default_branch: description: The Git repository's default branch. example: main nullable: true type: string message: description: The commit message. example: Instrumenting tests with CI Visibility. nullable: true type: string repository_url: description: The URL of the repository. example: https://github.com/username/repository type: string sha: description: The git commit SHA. example: da39a3ee5e6b4b0d3255bfef95601890afd80709 pattern: ^[a-fA-F0-9]{40}$ type: string tag: description: The tag name (if a branch use the branch parameter). example: v1.0.0 nullable: true type: string required: - repository_url - sha - author_email type: object CIAppPipelineEventStage: description: Details of a CI stage. properties: dependencies: description: A list of stage IDs that this stage depends on. example: - f7e6a006-a029-46c3-b0cc-742c9d7d363b - c8a69849-3c3b-4721-8b33-3e8ec2df1ebe items: description: A list of stage IDs. type: string nullable: true type: array end: description: Time when the stage run finished. The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string error: $ref: '#/components/schemas/CIAppCIError' git: $ref: '#/components/schemas/CIAppGitInfo' id: description: UUID for the stage. It has to be unique at least in the pipeline scope. example: 562bdbbb-7cab-48c8-851c-b24ca14628bf type: string level: $ref: '#/components/schemas/CIAppPipelineEventStageLevel' metrics: $ref: '#/components/schemas/CIAppPipelineEventMetrics' name: description: The name for the stage. example: build type: string node: $ref: '#/components/schemas/CIAppHostInfo' parameters: $ref: '#/components/schemas/CIAppPipelineEventParameters' pipeline_name: description: The parent pipeline name. example: Build type: string pipeline_unique_id: description: The parent pipeline UUID. example: 76b572af-a078-42b2-a08a-cc28f98b944f type: string queue_time: description: The queue time in milliseconds, if applicable. example: 1004 format: int64 minimum: 0 nullable: true type: integer start: description: Time when the stage run started (it should not include any queue time). The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string status: $ref: '#/components/schemas/CIAppPipelineEventStageStatus' tags: $ref: '#/components/schemas/CIAppPipelineEventTags' required: - level - id - name - pipeline_unique_id - pipeline_name - start - end - status type: object LogsStorageTier: default: indexes description: Specifies storage type as indexes, online-archives or flex enum: - indexes - online-archives - flex example: indexes type: string x-enum-varnames: - INDEXES - ONLINE_ARCHIVES - FLEX RUMResponseMetadata: description: The metadata associated with a request. properties: elapsed: description: The time elapsed in milliseconds. example: 132 format: int64 type: integer page: $ref: '#/components/schemas/RUMResponsePage' request_id: description: The identifier of the request. example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR type: string status: $ref: '#/components/schemas/RUMResponseStatus' warnings: description: 'A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.' items: $ref: '#/components/schemas/RUMWarning' type: array type: object DORAIncidentRequest: description: Request to create a DORA incident event. properties: data: $ref: '#/components/schemas/DORAIncidentRequestData' required: - data type: object AuditLogsEventType: default: audit description: Type of the event. enum: - audit example: audit type: string x-enum-varnames: - Audit CIAppTestsAggregateRequest: description: The object sent with the request to retrieve aggregation buckets of test events from your organization. properties: compute: description: The list of metrics or timeseries to compute for the retrieved buckets. items: $ref: '#/components/schemas/CIAppCompute' type: array filter: $ref: '#/components/schemas/CIAppTestsQueryFilter' group_by: description: The rules for the group-by. items: $ref: '#/components/schemas/CIAppTestsGroupBy' type: array options: $ref: '#/components/schemas/CIAppQueryOptions' type: object JSONAPIErrorResponse: description: API error response. properties: errors: description: A list of errors. items: $ref: '#/components/schemas/JSONAPIErrorItem' type: array required: - errors type: object LogsGroupByTotalBoolean: description: If set to true, creates an additional bucket labeled "$facet_total" type: boolean CIAppTestEvent: description: Object description of test event after being processed and stored by Datadog. properties: attributes: $ref: '#/components/schemas/CIAppEventAttributes' id: description: Unique ID of the event. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/CIAppTestEventTypeName' type: object DORAListDeploymentsRequestDataType: description: The definition of `DORAListDeploymentsRequestDataType` object. enum: - dora_deployments_list_request type: string x-enum-varnames: - DORA_DEPLOYMENTS_LIST_REQUEST ChangeEventCustomAttributesAuthorType: description: Author's type. enum: - user - system example: user type: string x-enum-varnames: - USER - SYSTEM CIAppPipelineEventJob: description: Details of a CI job. properties: dependencies: description: A list of job IDs that this job depends on. example: - f7e6a006-a029-46c3-b0cc-742c9d7d363b - c8a69849-3c3b-4721-8b33-3e8ec2df1ebe items: description: A list of job IDs. type: string nullable: true type: array end: description: Time when the job run finished. The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string error: $ref: '#/components/schemas/CIAppCIError' git: $ref: '#/components/schemas/CIAppGitInfo' id: description: The UUID for the job. It has to be unique within each pipeline execution. example: c865bad4-de82-44b8-ade7-2c987528eb54 type: string level: $ref: '#/components/schemas/CIAppPipelineEventJobLevel' metrics: $ref: '#/components/schemas/CIAppPipelineEventMetrics' name: description: The name for the job. example: test type: string node: $ref: '#/components/schemas/CIAppHostInfo' parameters: $ref: '#/components/schemas/CIAppPipelineEventParameters' pipeline_name: description: The parent pipeline name. example: Build type: string pipeline_unique_id: description: The parent pipeline UUID. example: 76b572af-a078-42b2-a08a-cc28f98b944f type: string queue_time: description: The queue time in milliseconds, if applicable. example: 1004 format: int64 minimum: 0 nullable: true type: integer stage_id: description: The parent stage UUID (if applicable). nullable: true type: string example: abc-123-def stage_name: description: The parent stage name (if applicable). nullable: true type: string example: Example Monitor start: description: Time when the job run instance started (it should not include any queue time). The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string status: $ref: '#/components/schemas/CIAppPipelineEventJobStatus' tags: $ref: '#/components/schemas/CIAppPipelineEventTags' url: description: The URL to look at the job in the CI provider UI. example: https://ci-platform.com/job/your-job-name/build/123 type: string required: - level - id - name - pipeline_unique_id - pipeline_name - start - end - status - url type: object CIAppPipelineEventInProgressPipeline: description: Details of a running pipeline. properties: error: $ref: '#/components/schemas/CIAppCIError' git: $ref: '#/components/schemas/CIAppGitInfo' is_manual: description: Whether or not the pipeline was triggered manually by the user. example: false nullable: true type: boolean is_resumed: description: Whether or not the pipeline was resumed after being blocked. example: false nullable: true type: boolean level: $ref: '#/components/schemas/CIAppPipelineEventPipelineLevel' metrics: $ref: '#/components/schemas/CIAppPipelineEventMetrics' name: description: Name of the pipeline. All pipeline runs for the builds should have the same name. example: Deploy to AWS type: string node: $ref: '#/components/schemas/CIAppHostInfo' parameters: $ref: '#/components/schemas/CIAppPipelineEventParameters' parent_pipeline: $ref: '#/components/schemas/CIAppPipelineEventParentPipeline' partial_retry: description: 'Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one which only runs a subset of the original jobs.' example: false type: boolean pipeline_id: description: 'Any ID used in the provider to identify the pipeline run even if it is not unique across retries. If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.' example: '#023' type: string previous_attempt: $ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline' queue_time: description: The queue time in milliseconds, if applicable. example: 1004 format: int64 minimum: 0 nullable: true type: integer start: description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string status: $ref: '#/components/schemas/CIAppPipelineEventPipelineInProgressStatus' tags: $ref: '#/components/schemas/CIAppPipelineEventTags' unique_id: description: UUID of the pipeline run. The ID has to be the same as the finished pipeline. example: 3eacb6f3-ff04-4e10-8a9c-46e6d054024a type: string url: description: The URL to look at the pipeline in the CI provider UI. example: https://my-ci-provider.example/pipelines/my-pipeline/run/1 type: string required: - level - unique_id - name - url - start - status - partial_retry type: object RUMAggregateBucketValueSingleString: description: A single string value. type: string EventCreateRequestPayload: description: Payload for creating an event. properties: data: $ref: '#/components/schemas/EventCreateRequest' type: object DORAIncidentRequestAttributes: description: Attributes to create a DORA incident event. properties: env: description: Environment name that was impacted by the incident. example: staging type: string finished_at: description: Unix timestamp when the incident finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour. example: 1693491984000000000 format: int64 type: integer git: $ref: '#/components/schemas/DORAGitInfo' id: description: Incident ID. Must have at least 16 characters. Required to update a previously sent incident. type: string example: abc-123-def name: description: Incident name. example: Webserver is down failing all requests. type: string services: description: Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided. example: - shopist items: type: string type: array severity: description: Incident severity. example: High type: string started_at: description: Unix timestamp when the incident started. It must be in nanoseconds, milliseconds, or seconds. example: 1693491974000000000 format: int64 type: integer team: description: Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided. example: backend type: string version: description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/). example: v1.12.07 type: string required: - started_at type: object Event_2: type: object description: A single event from the Datadog Events Explorer properties: id: type: string description: The unique string identifier of the event example: abc-123-def type: type: string description: The resource type identifier (always 'event') example: metric alert attributes: $ref: '#/components/schemas/EventAttributes_2' EventsResponseMetadataPage: description: Pagination attributes. properties: after: description: 'The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`.' example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object EventPayload: description: Event attributes. properties: aggregation_key: description: An arbitrary string to use for aggregation when correlating events. Limited to 100 characters. maxLength: 100 type: string example: example_value attributes: $ref: '#/components/schemas/EventPayloadAttributes' category: $ref: '#/components/schemas/EventCategory' message: description: The body of the event. Limited to 4000 characters. example: payment_processed feature flag has been enabled maxLength: 4000 type: string tags: description: 'A list of tags to apply to the event. Refer to [Tags docs](https://docs.datadoghq.com/getting_started/tagging/).' example: - env:test items: description: A tag. type: string type: array timestamp: description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. For example `"2017-01-15T01:30:15.010000Z"`. Defaults to the timestamp of receipt. Limited to values no older than 18 hours.' type: string example: '2026-04-17T12:00:00Z' title: description: The event title. Limited to 500 characters. example: payment_processed feature flag updated maxLength: 500 type: string required: - title - category - attributes type: object DORAIncidentResponseData: description: Response after receiving a DORA incident event. properties: id: description: The ID of the received DORA incident event. example: 4242fcdd31586083 type: string type: $ref: '#/components/schemas/DORAIncidentType' required: - id type: object CIAppCreatePipelineEventRequest: description: Request object. properties: data: $ref: '#/components/schemas/CIAppCreatePipelineEventRequestData' type: object CIAppPipelineEventTypeName: description: Type of the event. enum: - cipipeline example: cipipeline type: string x-enum-varnames: - CIPIPELINE LogsAggregateBucketValueTimeseriesPoint: description: A timeseries point properties: time: description: The time value for this point example: '2020-06-08T11:55:00Z' type: string value: description: The value for this point example: 19 format: double type: number type: object RUMGroupByTotal: default: false description: A resulting object to put the given computes in over all the matching records. oneOf: - $ref: '#/components/schemas/RUMGroupByTotalBoolean' - $ref: '#/components/schemas/RUMGroupByTotalString' - $ref: '#/components/schemas/RUMGroupByTotalNumber' CIAppGroupByTotalNumber: description: A number to use as the key value for the total bucket. format: double type: number CIAppAggregateBucketValueSingleNumber: description: A single number value. format: double type: number AuditLogsEvent: description: Object description of an Audit Logs event after it is processed and stored by Datadog. properties: attributes: $ref: '#/components/schemas/AuditLogsEventAttributes' id: description: Unique ID of the event. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/AuditLogsEventType' type: object LogsGroupByMissingNumber: description: The missing value to use if there is a number valued facet. format: double type: number ChangeEventCustomAttributesChangedResourceType: description: Resource's type. enum: - feature_flag - configuration example: feature_flag type: string x-enum-varnames: - FEATURE_FLAG - CONFIGURATION CIAppWarning: description: A warning message indicating something that went wrong with the query. properties: code: description: A unique code for this type of warning. example: unknown_index type: string detail: description: A detailed explanation of this specific warning. example: 'indexes: foo, bar' type: string title: description: A short human-readable summary of the warning. example: One or several indexes are missing or invalid, results hold data from the other indexes type: string type: object RUMSearchEventsRequest: description: The request for a RUM events list. properties: filter: $ref: '#/components/schemas/RUMQueryFilter' options: $ref: '#/components/schemas/RUMQueryOptions' page: $ref: '#/components/schemas/RUMQueryPageOptions' sort: $ref: '#/components/schemas/RUMSort' type: object RUMQueryFilter: description: The search and filter query settings. properties: from: default: now-15m description: The minimum time for the requested events; supports date (in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds). example: now-15m type: string query: default: '*' description: The search query following the RUM search syntax. example: '@type:session AND @session.type:user' type: string to: default: now description: The maximum time for the requested events; supports date (in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds). example: now type: string type: object LogsAggregateSort: description: A sort rule example: aggregation: count order: asc properties: aggregation: $ref: '#/components/schemas/LogsAggregationFunction' metric: description: The metric to sort by (only used for `type=measure`) example: '@duration' type: string order: $ref: '#/components/schemas/LogsSortOrder' type: $ref: '#/components/schemas/LogsAggregateSortType' type: object CIAppAggregateSort: description: A sort rule. The `aggregation` field is required when `type` is `measure`. example: aggregation: count order: asc properties: aggregation: $ref: '#/components/schemas/CIAppAggregationFunction' metric: description: The metric to sort by (only used for `type=measure`). example: '@duration' type: string order: $ref: '#/components/schemas/CIAppSortOrder' type: $ref: '#/components/schemas/CIAppAggregateSortType' type: object CIAppTestEventsRequest: description: The request for a tests search. properties: filter: $ref: '#/components/schemas/CIAppTestsQueryFilter' options: $ref: '#/components/schemas/CIAppQueryOptions' page: $ref: '#/components/schemas/CIAppQueryPageOptions' sort: $ref: '#/components/schemas/CIAppSort' type: object CIAppComputes: additionalProperties: $ref: '#/components/schemas/CIAppAggregateBucketValue' description: A map of the metric name to value for regular compute, or a list of values for a timeseries. type: object CIAppPipelinesGroupBy: description: A group-by rule. properties: facet: description: The name of the facet to use (required). example: '@ci.status' type: string histogram: $ref: '#/components/schemas/CIAppGroupByHistogram' limit: default: 10 description: The maximum buckets to return for this group-by. format: int64 type: integer example: 42 missing: $ref: '#/components/schemas/CIAppGroupByMissing' sort: $ref: '#/components/schemas/CIAppAggregateSort' total: $ref: '#/components/schemas/CIAppGroupByTotal' required: - facet type: object CIAppPipelineEventsResponse: description: Response object with all pipeline events matching the request and pagination information. properties: data: description: Array of events matching the request. items: $ref: '#/components/schemas/CIAppPipelineEvent' type: array links: $ref: '#/components/schemas/CIAppResponseLinks' meta: $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object RUMQueryPageOptions: description: Paging attributes for listing events. properties: cursor: description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string limit: default: 10 description: Maximum number of events in the response. example: 25 format: int32 maximum: 1000 type: integer type: object LogsAggregateResponse: description: The response object for the logs aggregate API endpoint properties: data: $ref: '#/components/schemas/LogsAggregateResponseData' meta: $ref: '#/components/schemas/LogsResponseMetadata' type: object CIAppTestsGroupBy: description: A group-by rule. properties: facet: description: The name of the facet to use (required). example: '@test.service' type: string histogram: $ref: '#/components/schemas/CIAppGroupByHistogram' limit: default: 10 description: The maximum buckets to return for this group-by. format: int64 type: integer example: 42 missing: $ref: '#/components/schemas/CIAppGroupByMissing' sort: $ref: '#/components/schemas/CIAppAggregateSort' total: $ref: '#/components/schemas/CIAppGroupByTotal' required: - facet type: object ChangeEventCustomAttributes: description: Object representing custom change event attributes. properties: author: $ref: '#/components/schemas/ChangeEventCustomAttributesAuthor' change_metadata: additionalProperties: {} description: Free form object with information related to the `change` event. Can be arbitrarily nested and contain any valid JSON. example: dd: team: datadog_team user_email: datadog@datadog.com user_id: datadog_user_id user_name: datadog_username resource_link: datadog.com/feature/fallback_payments_test type: object changed_resource: $ref: '#/components/schemas/ChangeEventCustomAttributesChangedResource' impacted_resources: description: 'A list of resources impacted by this change. It is recommended to provide an impacted resource to display the change event at the right location. Only resources of type `service` are supported.' example: - name: payments_api type: service items: $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems' type: array new_value: additionalProperties: {} description: Free form object to track new value of the changed resource. example: enabled: true percentage: 50% rule: datacenter: devcycle.us1.prod type: object prev_value: additionalProperties: {} description: Free form object to track previous value of the changed resource. example: enabled: true percentage: 10% rule: datacenter: devcycle.us1.prod type: object required: - changed_resource type: object LogsGroupByTotalString: description: A string to use as the key value for the total bucket type: string AuditLogsWarning: description: Warning message indicating something that went wrong with the query. properties: code: description: Unique code for this type of warning. example: unknown_index type: string detail: description: Detailed explanation of this specific warning. example: 'indexes: foo, bar' type: string title: description: Short human-readable summary of the warning. example: One or several indexes are missing or invalid, results hold data from the other indexes type: string type: object AuditLogsEventAttributes: description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from Audit Logs events. example: customAttribute: 123 duration: 2345 type: object message: description: Message of the event. type: string example: CPU usage is high on {{host.name}} service: description: 'Name of the application or service generating Audit Logs events. This name is used to correlate Audit Logs to APM, so make sure you specify the same value when you use both products.' example: web-app type: string tags: description: Array of tags associated with your event. example: - team:A items: description: Tag associated with your event. type: string type: array timestamp: description: Timestamp of your event. example: '2019-01-02T09:42:36.320Z' format: date-time type: string type: object EventPriority: description: The priority of the event's monitor. For example, `normal` or `low`. enum: - normal - low example: normal nullable: true type: string x-enum-varnames: - NORMAL - LOW RUMAnalyticsAggregateResponse: description: The response object for the RUM events aggregate API endpoint. properties: data: $ref: '#/components/schemas/RUMAggregationBucketsResponse' links: $ref: '#/components/schemas/RUMResponseLinks' meta: $ref: '#/components/schemas/RUMResponseMetadata' type: object CIAppGroupByMissingNumber: description: The missing value to use if there is a number valued facet. format: double type: number CIAppCreatePipelineEventRequestAttributesResource: description: Details of the CI pipeline event. example: Details TBD oneOf: - $ref: '#/components/schemas/CIAppPipelineEventPipeline' - $ref: '#/components/schemas/CIAppPipelineEventStage' - $ref: '#/components/schemas/CIAppPipelineEventJob' - $ref: '#/components/schemas/CIAppPipelineEventStep' CIAppCIError: description: Contains information of the CI error. nullable: true properties: domain: $ref: '#/components/schemas/CIAppCIErrorDomain' message: description: Error message. maxLength: 5000 nullable: true type: string example: CPU usage is high on {{host.name}} stack: description: The stack trace of the reported errors. nullable: true type: string example: example_value type: description: Short description of the error type. maxLength: 100 nullable: true type: string example: metric alert type: object CIAppResponseStatus: description: The status of the response. enum: - done - timeout example: done type: string x-enum-varnames: - DONE - TIMEOUT EventCreateResponsePayload: description: Response containing information about created event. properties: data: $ref: '#/components/schemas/EventCreateResponse' type: object DORADeploymentType: default: dora_deployment description: JSON:API type for DORA deployment events. enum: - dora_deployment example: dora_deployment type: string x-enum-varnames: - DORA_DEPLOYMENT LogsResponseMetadataPage: description: Paging attributes. properties: after: description: 'The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`.' example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object EventStatusType: description: 'If an alert event is enabled, its status is one of the following: `failure`, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, or `snapshot`.' enum: - failure - error - warning - info - success - user_update - recommendation - snapshot example: info type: string x-enum-varnames: - FAILURE - ERROR - WARNING - INFO - SUCCESS - USER_UPDATE - RECOMMENDATION - SNAPSHOT CIAppTestEventsResponse: description: Response object with all test events matching the request and pagination information. properties: data: description: Array of events matching the request. items: $ref: '#/components/schemas/CIAppTestEvent' type: array links: $ref: '#/components/schemas/CIAppResponseLinks' meta: $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object RUMAggregateBucketValue: description: A bucket value, can be either a timeseries or a single value. oneOf: - $ref: '#/components/schemas/RUMAggregateBucketValueSingleString' - $ref: '#/components/schemas/RUMAggregateBucketValueSingleNumber' - $ref: '#/components/schemas/RUMAggregateBucketValueTimeseries' EventsSort: description: The sort parameters when querying events. enum: - timestamp - -timestamp type: string x-enum-varnames: - TIMESTAMP_ASCENDING - TIMESTAMP_DESCENDING CIAppPipelinesBucketResponse: description: Bucket values. properties: by: additionalProperties: description: The values for each group-by. description: The key-value pairs for each group-by. example: '@ci.provider.name': gitlab '@ci.status': success type: object computes: $ref: '#/components/schemas/CIAppComputes' type: object RUMQueryOptions: description: 'Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.' properties: time_offset: description: The time offset (in seconds) to apply to the query. format: int64 type: integer example: 42 timezone: default: UTC description: The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object CIAppPipelineEventJobLevel: default: job description: Used to distinguish between pipelines, stages, jobs, and steps. enum: - job example: job type: string x-enum-varnames: - JOB CIAppPipelinesQueryFilter: description: The search and filter query settings. properties: from: default: now-15m description: The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds). example: now-15m type: string query: default: '*' description: The search query following the CI Visibility Explorer search syntax. example: '@ci.provider.name:github AND @ci.status:error' type: string to: default: now description: The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds). example: now type: string type: object RUMEvent: description: Object description of a RUM event after being processed and stored by Datadog. properties: attributes: $ref: '#/components/schemas/RUMEventAttributes' id: description: Unique ID of the event. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/RUMEventType' type: object RUMGroupByTotalString: description: A string to use as the key value for the total bucket. type: string DORAListDeploymentsRequestData: description: The JSON:API data. properties: attributes: $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes' type: $ref: '#/components/schemas/DORAListDeploymentsRequestDataType' required: - attributes type: object JSONAPIErrorItemSource: description: References to the source of the error. properties: header: description: A string indicating the name of a single request header which caused the error. example: Authorization type: string parameter: description: A string indicating which URI query parameter caused the error. example: limit type: string pointer: description: A JSON pointer to the value in the request document that caused the error. example: /data/attributes/title type: string type: object CIAppAggregateSortType: default: alphabetical description: The type of sorting algorithm. enum: - alphabetical - measure type: string x-enum-varnames: - ALPHABETICAL - MEASURE DORAListDeploymentsRequestAttributes: description: Attributes to get a list of deployments. properties: from: description: Minimum timestamp for requested events. format: date-time type: string example: example_value limit: default: 10 description: Maximum number of events in the response. format: int32 maximum: 1000 type: integer example: 42 query: description: Search query with event platform syntax. type: string example: avg:system.cpu.user{*} sort: description: Sort order (prefixed with `-` for descending). type: string example: example_value to: description: Maximum timestamp for requested events. format: date-time type: string example: example_value type: object DORADeploymentRequest: description: Request to create a DORA deployment event. properties: data: $ref: '#/components/schemas/DORADeploymentRequestData' required: - data type: object RUMAggregationBucketsResponse: description: The query results. properties: buckets: description: The list of matching buckets, one item per bucket. items: $ref: '#/components/schemas/RUMBucketResponse' type: array type: object CIAppPipelineEventPreviousPipeline: description: If the pipeline is a retry, this should contain the details of the previous attempt. nullable: true properties: id: description: UUID of a pipeline. example: 93bfeb70-af47-424d-908a-948d3f08e37f type: string url: description: The URL to look at the pipeline in the CI provider UI. example: https://ci-platform.com/pipelines/123456789 type: string required: - id type: object EventCreateRequest: description: Object representing an event creation request. properties: attributes: $ref: '#/components/schemas/EventPayload' type: $ref: '#/components/schemas/EventCreateRequestType' type: object ChangeEventCustomAttributesAuthor: description: Object representing the entity which made the change. Optional field but if provided should include `type` and `name`. properties: name: description: Author's name. Limited to 128 characters. example: datadog@datadog.com maxLength: 128 type: string type: $ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType' required: - name - type type: object RUMAggregateSort: description: A sort rule. example: aggregation: count order: asc properties: aggregation: $ref: '#/components/schemas/RUMAggregationFunction' metric: description: The metric to sort by (only used for `type=measure`). example: '@duration' type: string order: $ref: '#/components/schemas/RUMSortOrder' type: $ref: '#/components/schemas/RUMAggregateSortType' type: object CIAppGroupByMissingString: description: The missing value to use if there is a string valued facet. type: string CIAppPipelineEvent: description: Object description of a pipeline event after being processed and stored by Datadog. properties: attributes: $ref: '#/components/schemas/CIAppPipelineEventAttributes' id: description: Unique ID of the event. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/CIAppPipelineEventTypeName' type: object EventAttributes_2: type: object description: The attributes of an event returned from the Events Explorer properties: title: type: string description: The event title as displayed in the Events Explorer example: Example Monitor message: type: string description: The event body text containing details about the event example: CPU usage is high on {{host.name}} timestamp: type: string format: date-time description: ISO 8601 timestamp when the event was recorded example: '2026-04-17T12:00:00Z' priority: type: string description: The event priority level enum: - normal - low example: normal host: type: string description: The hostname associated with this event example: example_value tags: type: array description: List of tags associated with the event in key:value format items: type: string alert_type: type: string description: The alert type category for visual display enum: - error - warning - info - success - user_update - recommendation - snapshot example: error aggregation_key: type: string description: The arbitrary string used to group related events into a rollup example: example_value source_type_name: type: string description: The source technology or integration that generated this event example: Example Monitor status: type: string description: The event status (active or expired) example: OK attributes: type: object description: Custom key-value attributes associated with the event additionalProperties: true CIAppHostInfo: description: Contains information of the host running the pipeline, stage, job, or step. nullable: true properties: hostname: description: FQDN of the host. example: www.example.com type: string labels: description: A list of labels used to select or identify the node. example: - ubuntu-18.04 - n2.large items: type: string type: array name: description: Name for the host. type: string example: Example Monitor workspace: description: The path where the code is checked out. example: /home/workspace/code/my-repo type: string type: object CIAppTestLevel: description: Test run level. enum: - session - module - suite - test example: test type: string x-enum-varnames: - SESSION - MODULE - SUITE - TEST CIAppPipelineEventsRequest: description: The request for a pipelines search. properties: filter: $ref: '#/components/schemas/CIAppPipelinesQueryFilter' options: $ref: '#/components/schemas/CIAppQueryOptions' page: $ref: '#/components/schemas/CIAppQueryPageOptions' sort: $ref: '#/components/schemas/CIAppSort' type: object CIAppCreatePipelineEventRequestAttributes: description: Attributes of the pipeline event to create. properties: env: description: The Datadog environment. type: string example: example_value provider_name: description: The name of the CI provider. By default, this is "custom". type: string example: abc-123-def resource: $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributesResource' service: description: If the CI provider is SaaS, use this to differentiate between instances. type: string example: example_value required: - resource type: object DORAIncidentType: default: dora_incident description: JSON:API type for DORA incident events. enum: - dora_incident example: dora_incident type: string x-enum-varnames: - DORA_INCIDENT LogsGroupByHistogram: description: 'Used to perform a histogram computation (only for measure facets). Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.' properties: interval: description: The bin size of the histogram buckets example: 10 format: double type: number max: description: 'The maximum value for the measure used in the histogram (values greater than this one are filtered out)' example: 100 format: double type: number min: description: 'The minimum value for the measure used in the histogram (values smaller than this one are filtered out)' example: 50 format: double type: number required: - interval - min - max type: object AuditLogsSearchEventsRequest: description: The request for a Audit Logs events list. properties: filter: $ref: '#/components/schemas/AuditLogsQueryFilter' options: $ref: '#/components/schemas/AuditLogsQueryOptions' page: $ref: '#/components/schemas/AuditLogsQueryPageOptions' sort: $ref: '#/components/schemas/AuditLogsSort' type: object AuditLogsEventsResponse: description: Response object with all events matching the request and pagination information. properties: data: description: Array of events matching the request. items: $ref: '#/components/schemas/AuditLogsEvent' type: array links: $ref: '#/components/schemas/AuditLogsResponseLinks' meta: $ref: '#/components/schemas/AuditLogsResponseMetadata' type: object LogsGroupByMissingString: description: The missing value to use if there is string valued facet. type: string LogsAggregateBucketValueSingleNumber: description: A single number value format: double type: number EventCreateResponse: description: Object containing an event response. properties: attributes: $ref: '#/components/schemas/EventCreateResponseAttributes' type: description: Event type example: event type: string type: object AuditLogsQueryOptions: description: 'Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.' properties: time_offset: description: Time offset (in seconds) to apply to the query. format: int64 type: integer example: 42 timezone: default: UTC description: The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object ChangeEventCustomAttributesChangedResource: description: Object representing a uniquely identified resource. properties: name: description: Resource's name. example: fallback_payments_test type: string type: $ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType' required: - type - name type: object CIAppAggregateBucketValueTimeseries: description: A timeseries array. items: $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint' type: array x-generate-alias-as-model: true CIAppGroupByTotalString: description: A string to use as the key value for the total bucket. type: string LogsAggregateResponseStatus: description: The status of the response enum: - done - timeout example: done type: string x-enum-varnames: - DONE - TIMEOUT CIAppPipelineEventAttributes: description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from CI Visibility pipeline events. example: customAttribute: 123 duration: 2345 type: object ci_level: $ref: '#/components/schemas/CIAppPipelineLevel' tags: $ref: '#/components/schemas/TagsEventAttribute' type: object DORAListFailuresRequestAttributes: description: Attributes to get a list of failures. properties: from: description: Minimum timestamp for requested events. format: date-time type: string example: example_value limit: default: 10 description: Maximum number of events in the response. format: int32 maximum: 1000 type: integer example: 42 query: description: Search query with event platform syntax. type: string example: avg:system.cpu.user{*} sort: description: Sort order (prefixed with `-` for descending). type: string example: example_value to: description: Maximum timestamp for requested events. format: date-time type: string example: example_value type: object CIAppAggregateBucketValue: description: A bucket value, can either be a timeseries or a single value. oneOf: - $ref: '#/components/schemas/CIAppAggregateBucketValueSingleString' - $ref: '#/components/schemas/CIAppAggregateBucketValueSingleNumber' - $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseries' LogsResponseMetadata: description: The metadata associated with a request properties: elapsed: description: The time elapsed in milliseconds example: 132 format: int64 type: integer page: $ref: '#/components/schemas/LogsResponseMetadataPage' request_id: description: The identifier of the request example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR type: string status: $ref: '#/components/schemas/LogsAggregateResponseStatus' warnings: description: 'A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response.' items: $ref: '#/components/schemas/LogsWarning' type: array type: object DORADeploymentResponse: description: Response after receiving a DORA deployment event. properties: data: $ref: '#/components/schemas/DORADeploymentResponseData' required: - data type: object LogsAggregateBucketValue: description: A bucket value, can be either a timeseries or a single value oneOf: - $ref: '#/components/schemas/LogsAggregateBucketValueSingleString' - $ref: '#/components/schemas/LogsAggregateBucketValueSingleNumber' - $ref: '#/components/schemas/LogsAggregateBucketValueTimeseries' RUMBucketResponse: description: Bucket values. properties: by: additionalProperties: description: The values for each group-by. type: string description: The key-value pairs for each group-by. example: '@session.type': user '@type': view type: object computes: additionalProperties: $ref: '#/components/schemas/RUMAggregateBucketValue' description: A map of the metric name to value for regular compute, or a list of values for a timeseries. type: object type: object EventsWarning: description: A warning message indicating something is wrong with the query. properties: code: description: A unique code for this type of warning. example: unknown_index type: string detail: description: A detailed explanation of this specific warning. example: 'indexes: foo, bar' type: string title: description: A short human-readable summary of the warning. example: One or several indexes are missing or invalid. Results hold data from the other indexes. type: string type: object CIAppGroupByHistogram: description: 'Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.' properties: interval: description: The bin size of the histogram buckets. example: 10 format: double type: number max: description: 'The maximum value for the measure used in the histogram (values greater than this one are filtered out).' example: 100 format: double type: number min: description: 'The minimum value for the measure used in the histogram (values smaller than this one are filtered out).' example: 50 format: double type: number required: - interval - min - max type: object Event: description: The metadata associated with a request. properties: id: description: Event ID. example: '6509751066204996294' type: string name: description: The event name. type: string example: Example Monitor source_id: description: Event source ID. example: 36 format: int64 type: integer type: description: Event type. example: error_tracking_alert type: string 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 CIAppTestsBucketResponse: description: Bucket values. properties: by: additionalProperties: description: The values for each group-by. description: The key-value pairs for each group-by. example: '@test.service': web-ui-tests '@test.status': skip type: object computes: $ref: '#/components/schemas/CIAppComputes' type: object CIAppPipelinesAnalyticsAggregateResponse: description: The response object for the pipeline events aggregate API endpoint. properties: data: $ref: '#/components/schemas/CIAppPipelinesAggregationBucketsResponse' links: $ref: '#/components/schemas/CIAppResponseLinks' meta: $ref: '#/components/schemas/CIAppResponseMetadata' type: object EventsQueryOptions: description: 'The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.' properties: timeOffset: description: The time offset to apply to the query in seconds. format: int64 type: integer example: 42 timezone: default: UTC description: The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object RUMGroupByMissingString: description: The missing value to use if there is string valued facet. type: string DORAListDeploymentsRequest: description: Request to get a list of deployments. properties: data: $ref: '#/components/schemas/DORAListDeploymentsRequestData' required: - data type: object AuditLogsQueryPageOptions: description: Paging attributes for listing events. properties: cursor: description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string limit: default: 10 description: Maximum number of events in the response. example: 25 format: int32 maximum: 1000 type: integer type: object EventResponse: description: The object description of an event after being processed and stored by Datadog. properties: attributes: $ref: '#/components/schemas/EventResponseAttributes' id: description: the unique ID of the event. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: $ref: '#/components/schemas/EventType' type: object RUMEventType: default: rum description: Type of the event. enum: - rum example: rum type: string x-enum-varnames: - RUM CIAppPipelineLevel: description: Pipeline execution level. enum: - pipeline - stage - job - step - custom example: pipeline type: string x-enum-varnames: - PIPELINE - STAGE - JOB - STEP - CUSTOM CIAppAggregationFunction: description: An aggregation function. enum: - count - cardinality - pc75 - pc90 - pc95 - pc98 - pc99 - sum - min - max - avg - median - latest - earliest - most_frequent - delta example: pc90 type: string x-enum-varnames: - COUNT - CARDINALITY - PERCENTILE_75 - PERCENTILE_90 - PERCENTILE_95 - PERCENTILE_98 - PERCENTILE_99 - SUM - MIN - MAX - AVG - MEDIAN - LATEST - EARLIEST - MOST_FREQUENT - DELTA RUMGroupByMissing: description: The value to use for logs that don't have the facet used to group by. oneOf: - $ref: '#/components/schemas/RUMGroupByMissingString' - $ref: '#/components/schemas/RUMGroupByMissingNumber' EventAttributes: description: Object description of attributes from your event. properties: aggregation_key: description: Aggregation key of the event. type: string example: example_value date_happened: description: 'POSIX timestamp of the event. Must be sent as an integer (no quotation marks). Limited to events no older than 18 hours.' format: int64 type: integer example: 42 device_name: description: A device name. type: string example: Example Monitor duration: description: The duration between the triggering of the event and its recovery in nanoseconds. format: int64 type: integer example: 42 event_object: description: The event title. example: Did you hear the news today? type: string evt: $ref: '#/components/schemas/Event' hostname: description: 'Host name to associate with the event. Any tags associated with the host are also applied to this event.' type: string example: Example Monitor monitor: $ref: '#/components/schemas/MonitorType' monitor_groups: description: List of groups referred to in the event. items: description: Group referred to in the event. type: string nullable: true type: array monitor_id: description: ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty. format: int64 nullable: true type: integer example: 42 priority: $ref: '#/components/schemas/EventPriority' related_event_id: description: Related event ID. format: int64 type: integer example: 42 service: description: Service that triggered the event. example: datadog-api type: string source_type_name: description: 'The type of event being posted. For example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`. The list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' type: string example: Example Monitor sourcecategory: description: Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration. type: string example: example_value status: $ref: '#/components/schemas/EventStatusType' tags: description: A list of tags to apply to the event. example: - environment:test items: description: A tag. type: string type: array timestamp: description: POSIX timestamp of your event in milliseconds. example: 1652274265000 format: int64 type: integer title: description: The event title. example: Oh boy! type: string type: object DORAListFailuresRequest: description: Request to get a list of failures. properties: data: $ref: '#/components/schemas/DORAListFailuresRequestData' required: - data type: object LogsSortOrder: description: The order to use, ascending or descending enum: - asc - desc example: asc type: string x-enum-varnames: - ASCENDING - DESCENDING DORAIncidentRequestData: description: The JSON:API data. properties: attributes: $ref: '#/components/schemas/DORAIncidentRequestAttributes' required: - attributes type: object CIAppTestsAnalyticsAggregateResponse: description: The response object for the test events aggregate API endpoint. properties: data: $ref: '#/components/schemas/CIAppTestsAggregationBucketsResponse' links: $ref: '#/components/schemas/CIAppResponseLinks' meta: $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' type: object HTTPCIAppError: description: List of errors. properties: detail: description: Error message. example: Malformed payload type: string status: description: Error code. example: '400' type: string title: description: Error title. example: Bad Request type: string type: object CIAppPipelineEventFinishedPipeline: description: Details of a finished pipeline. properties: end: description: Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string error: $ref: '#/components/schemas/CIAppCIError' git: $ref: '#/components/schemas/CIAppGitInfo' is_manual: description: Whether or not the pipeline was triggered manually by the user. example: false nullable: true type: boolean is_resumed: description: Whether or not the pipeline was resumed after being blocked. example: false nullable: true type: boolean level: $ref: '#/components/schemas/CIAppPipelineEventPipelineLevel' metrics: $ref: '#/components/schemas/CIAppPipelineEventMetrics' name: description: Name of the pipeline. All pipeline runs for the builds should have the same name. example: Deploy to AWS type: string node: $ref: '#/components/schemas/CIAppHostInfo' parameters: $ref: '#/components/schemas/CIAppPipelineEventParameters' parent_pipeline: $ref: '#/components/schemas/CIAppPipelineEventParentPipeline' partial_retry: description: 'Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one which only runs a subset of the original jobs.' example: false type: boolean pipeline_id: description: 'Any ID used in the provider to identify the pipeline run even if it is not unique across retries. If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.' example: '#023' type: string previous_attempt: $ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline' queue_time: description: The queue time in milliseconds, if applicable. example: 1004 format: int64 minimum: 0 nullable: true type: integer start: description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string status: $ref: '#/components/schemas/CIAppPipelineEventPipelineStatus' tags: $ref: '#/components/schemas/CIAppPipelineEventTags' unique_id: description: 'UUID of the pipeline run. The ID has to be unique across retries and pipelines, including partial retries.' example: 3eacb6f3-ff04-4e10-8a9c-46e6d054024a type: string url: description: The URL to look at the pipeline in the CI provider UI. example: https://my-ci-provider.example/pipelines/my-pipeline/run/1 type: string required: - level - unique_id - name - url - start - end - status - partial_retry type: object LogsAggregationFunction: description: An aggregation function enum: - count - cardinality - pc75 - pc90 - pc95 - pc98 - pc99 - sum - min - max - avg - median example: pc90 type: string x-enum-varnames: - COUNT - CARDINALITY - PERCENTILE_75 - PERCENTILE_90 - PERCENTILE_95 - PERCENTILE_98 - PERCENTILE_99 - SUM - MIN - MAX - AVG - MEDIAN EventCreateResponseAttributesAttributes: description: JSON object of attributes from your events. properties: evt: $ref: '#/components/schemas/EventCreateResponseAttributesAttributesEvt' type: object LogsComputeType: default: total description: The type of compute enum: - timeseries - total type: string x-enum-varnames: - TIMESERIES - TOTAL TagsEventAttribute: description: Array of tags associated with your event. example: - team:A items: description: Tag associated with your event. type: string type: array CIAppAggregateBucketValueTimeseriesPoint: description: A timeseries point. properties: time: description: The time value for this point. example: '2020-06-08T11:55:00.123Z' format: date-time type: string value: description: The value for this point. example: 19 format: double type: number type: object CIAppQueryOptions: description: 'Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.' properties: time_offset: description: The time offset (in seconds) to apply to the query. format: int64 type: integer example: 42 timezone: default: UTC description: The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object RUMAggregateSortType: default: alphabetical description: The type of sorting algorithm. enum: - alphabetical - measure type: string x-enum-varnames: - ALPHABETICAL - MEASURE EventsListRequest: description: The object sent with the request to retrieve a list of events from your organization. properties: filter: $ref: '#/components/schemas/EventsQueryFilter' options: $ref: '#/components/schemas/EventsQueryOptions' page: $ref: '#/components/schemas/EventsRequestPage' sort: $ref: '#/components/schemas/EventsSort' type: object RUMGroupBy: description: A group-by rule. properties: facet: description: The name of the facet to use (required). example: '@view.time_spent' type: string histogram: $ref: '#/components/schemas/RUMGroupByHistogram' limit: default: 10 description: The maximum buckets to return for this group-by. format: int64 type: integer example: 42 missing: $ref: '#/components/schemas/RUMGroupByMissing' sort: $ref: '#/components/schemas/RUMAggregateSort' total: $ref: '#/components/schemas/RUMGroupByTotal' required: - facet type: object LogsAggregateBucketValueTimeseries: description: A timeseries array items: $ref: '#/components/schemas/LogsAggregateBucketValueTimeseriesPoint' type: array x-generate-alias-as-model: true CIAppResponseMetadataWithPagination: description: The metadata associated with a request. properties: elapsed: description: The time elapsed in milliseconds. example: 132 format: int64 type: integer page: $ref: '#/components/schemas/CIAppResponsePage' request_id: description: The identifier of the request. example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR type: string status: $ref: '#/components/schemas/CIAppResponseStatus' warnings: description: 'A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.' items: $ref: '#/components/schemas/CIAppWarning' type: array type: object RUMSort: description: Sort parameters when querying events. enum: - timestamp - -timestamp type: string x-enum-varnames: - TIMESTAMP_ASCENDING - TIMESTAMP_DESCENDING CIAppCIErrorDomain: description: Error category used to differentiate between issues related to the developer or provider environments. enum: - provider - user - unknown type: string x-enum-varnames: - PROVIDER - USER - UNKNOWN LogsGroupByMissing: description: The value to use for logs that don't have the facet used to group by oneOf: - $ref: '#/components/schemas/LogsGroupByMissingString' - $ref: '#/components/schemas/LogsGroupByMissingNumber' DORADeploymentResponseData: description: The JSON:API data. properties: id: description: The ID of the received DORA deployment event. example: 4242fcdd31586083 type: string type: $ref: '#/components/schemas/DORADeploymentType' required: - id type: object GitRepositoryURL: description: Git Repository URL example: https://github.com/organization/example-repository type: string LogsAggregateResponseData: description: The query results properties: buckets: description: The list of matching buckets, one item per bucket items: $ref: '#/components/schemas/LogsAggregateBucket' type: array type: object CIAppPipelineEventPipelineLevel: default: pipeline description: Used to distinguish between pipelines, stages, jobs, and steps. enum: - pipeline example: pipeline type: string x-enum-varnames: - PIPELINE RUMComputeType: default: total description: The type of compute. enum: - timeseries - total type: string x-enum-varnames: - TIMESERIES - TOTAL CIAppCreatePipelineEventRequestData: description: Data of the pipeline event to create. properties: attributes: $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributes' type: $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataType' type: object CIAppPipelineEventStageLevel: default: stage description: Used to distinguish between pipelines, stages, jobs and steps. enum: - stage example: stage type: string x-enum-varnames: - STAGE EventCategory: description: Event category to identify the type of event. Only the value `change` is supported. Support for other categories are coming. please reach out to datadog support if you're interested. enum: - change example: change type: string x-enum-varnames: - CHANGE RUMSortOrder: description: The order to use, ascending or descending. enum: - asc - desc example: asc type: string x-enum-varnames: - ASCENDING - DESCENDING LogsQueryOptions: deprecated: true description: 'Global query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results.' properties: timeOffset: description: The time offset (in seconds) to apply to the query. format: int64 type: integer example: 42 timezone: default: UTC description: The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object AuditLogsSort: description: Sort parameters when querying events. enum: - timestamp - -timestamp type: string x-enum-varnames: - TIMESTAMP_ASCENDING - TIMESTAMP_DESCENDING LogsQueryFilter: description: The search and filter query settings properties: from: default: now-15m description: The minimum time for the requested logs, supports date math and regular timestamps (milliseconds). example: now-15m type: string indexes: default: - '*' description: For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. example: - main - web items: description: The name of a log index. type: string type: array query: default: '*' description: The search query - following the log search syntax. example: service:web* AND @http.status_code:[200 TO 299] type: string storage_tier: $ref: '#/components/schemas/LogsStorageTier' to: default: now description: The maximum time for the requested logs, supports date math and regular timestamps (milliseconds). example: now type: string type: object EventsResponseMetadata: description: The metadata associated with a request. properties: elapsed: description: The time elapsed in milliseconds. example: 132 format: int64 type: integer page: $ref: '#/components/schemas/EventsResponseMetadataPage' request_id: description: The identifier of the request. example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR type: string status: description: The request status. example: done type: string warnings: description: 'A list of warnings (non-fatal errors) encountered. Partial results might be returned if warnings are present in the response.' items: $ref: '#/components/schemas/EventsWarning' type: array type: object AuditLogsResponseLinks: description: Links attributes. properties: next: description: 'Link for the next set of results. Note that the request can also be made using the POST endpoint.' example: https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object RUMResponseLinks: description: Links attributes. properties: next: description: 'Link for the next set of results. Note that the request can also be made using the POST endpoint.' example: https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object AuditLogsResponseStatus: description: The status of the response. enum: - done - timeout example: done type: string x-enum-varnames: - DONE - TIMEOUT ChangeEventCustomAttributesImpactedResourcesItemsType: description: Resource's type. enum: - service example: service type: string x-enum-varnames: - SERVICE CIAppTestsAggregationBucketsResponse: description: The query results. properties: buckets: description: The list of matching buckets, one item per bucket. items: $ref: '#/components/schemas/CIAppTestsBucketResponse' type: array type: object CIAppCreatePipelineEventRequestDataType: default: cipipeline_resource_request description: Type of the event. enum: - cipipeline_resource_request example: cipipeline_resource_request type: string x-enum-varnames: - CIPIPELINE_RESOURCE_REQUEST DORAListFailuresRequestDataType: description: The definition of `DORAListFailuresRequestDataType` object. enum: - dora_failures_list_request type: string x-enum-varnames: - DORA_FAILURES_LIST_REQUEST CIAppTestEventTypeName: description: Type of the event. enum: - citest example: citest type: string x-enum-varnames: - CITEST EventType: default: event description: Type of the event. enum: - event example: event type: string x-enum-varnames: - EVENT CIAppQueryPageOptions: description: Paging attributes for listing events. properties: cursor: description: List following results with a cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string limit: default: 10 description: Maximum number of events in the response. example: 25 format: int32 maximum: 1000 type: integer type: object RUMAggregateBucketValueSingleNumber: description: A single number value. format: double type: number CIAppEventAttributes: description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from CI Visibility test events. example: customAttribute: 123 duration: 2345 type: object tags: $ref: '#/components/schemas/TagsEventAttribute' test_level: $ref: '#/components/schemas/CIAppTestLevel' type: object AuditLogsQueryFilter: description: Search and filter query settings. properties: from: default: now-15m description: Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds). example: now-15m type: string query: default: '*' description: Search query following the Audit Logs search syntax. example: '@type:session AND @session.type:user' type: string to: default: now description: Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds). example: now type: string type: object EventResponse_2: type: object description: Response wrapper for a single event properties: data: $ref: '#/components/schemas/Event_2' EventsQueryFilter: description: The search and filter query settings. properties: from: default: now-15m description: The minimum time for the requested events. Supports date math and regular timestamps in milliseconds. example: now-15m type: string query: default: '*' description: The search query following the event search syntax. example: service:web* AND @http.status_code:[200 TO 299] type: string to: default: now description: The maximum time for the requested events. Supports date math and regular timestamps in milliseconds. example: now type: string type: object DORAEvent: description: A DORA event. properties: attributes: description: The attributes of the event. type: object id: description: The ID of the event. type: string example: abc-123-def type: description: The type of the event. type: string example: metric alert type: object CIAppPipelineEventParentPipeline: description: If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline. nullable: true properties: id: description: UUID of a pipeline. example: 93bfeb70-af47-424d-908a-948d3f08e37f type: string url: description: The URL to look at the pipeline in the CI provider UI. example: https://ci-platform.com/pipelines/123456789 type: string required: - id type: object CIAppResponsePage: description: Paging attributes. properties: after: description: The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object CIAppPipelinesAggregateRequest: description: The object sent with the request to retrieve aggregation buckets of pipeline events from your organization. properties: compute: description: The list of metrics or timeseries to compute for the retrieved buckets. items: $ref: '#/components/schemas/CIAppCompute' type: array filter: $ref: '#/components/schemas/CIAppPipelinesQueryFilter' group_by: description: The rules for the group-by. items: $ref: '#/components/schemas/CIAppPipelinesGroupBy' type: array options: $ref: '#/components/schemas/CIAppQueryOptions' type: object CIAppSort: description: Sort parameters when querying events. enum: - timestamp - -timestamp type: string x-enum-varnames: - TIMESTAMP_ASCENDING - TIMESTAMP_DESCENDING CIAppPipelineEventStep: description: Details of a CI step. properties: end: description: Time when the step run finished. The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string error: $ref: '#/components/schemas/CIAppCIError' git: $ref: '#/components/schemas/CIAppGitInfo' id: description: UUID for the step. It has to be unique within each pipeline execution. example: c2d517a8-4f3a-4b41-b4ae-69df0c864c79 type: string job_id: description: The parent job UUID (if applicable). nullable: true type: string example: abc-123-def job_name: description: The parent job name (if applicable). nullable: true type: string example: Example Monitor level: $ref: '#/components/schemas/CIAppPipelineEventStepLevel' metrics: $ref: '#/components/schemas/CIAppPipelineEventMetrics' name: description: The name for the step. example: test-server type: string node: $ref: '#/components/schemas/CIAppHostInfo' parameters: $ref: '#/components/schemas/CIAppPipelineEventParameters' pipeline_name: description: The parent pipeline name. example: Build type: string pipeline_unique_id: description: The parent pipeline UUID. example: 76b572af-a078-42b2-a08a-cc28f98b944f type: string stage_id: description: The parent stage UUID (if applicable). nullable: true type: string example: abc-123-def stage_name: description: The parent stage name (if applicable). nullable: true type: string example: Example Monitor start: description: Time when the step run started. The time format must be RFC3339. example: '2023-05-31T15:30:00Z' format: date-time type: string status: $ref: '#/components/schemas/CIAppPipelineEventStepStatus' tags: $ref: '#/components/schemas/CIAppPipelineEventTags' url: description: The URL to look at the step in the CI provider UI. nullable: true type: string example: https://app.datadoghq.com required: - level - id - name - pipeline_unique_id - pipeline_name - start - end - status type: object LogsWarning: description: A warning message indicating something that went wrong with the query properties: code: description: A unique code for this type of warning example: unknown_index type: string detail: description: A detailed explanation of this specific warning example: 'indexes: foo, bar' type: string title: description: A short human-readable summary of the warning example: One or several indexes are missing or invalid, results hold data from the other indexes type: string type: object DORAListFailuresRequestData: description: The JSON:API data. properties: attributes: $ref: '#/components/schemas/DORAListFailuresRequestAttributes' type: $ref: '#/components/schemas/DORAListFailuresRequestDataType' required: - attributes type: object RUMEventsResponse: description: Response object with all events matching the request and pagination information. properties: data: description: Array of events matching the request. items: $ref: '#/components/schemas/RUMEvent' type: array links: $ref: '#/components/schemas/RUMResponseLinks' meta: $ref: '#/components/schemas/RUMResponseMetadata' type: object EventCreateRequestType: description: Entity type. enum: - event example: event type: string x-enum-varnames: - EVENT DORAIncidentResponse: description: Response after receiving a DORA incident event. properties: data: $ref: '#/components/schemas/DORAIncidentResponseData' required: - data type: object DORADeploymentRequestData: description: The JSON:API data. properties: attributes: $ref: '#/components/schemas/DORADeploymentRequestAttributes' required: - attributes type: object RUMAggregateBucketValueTimeseriesPoint: description: A timeseries point. properties: time: description: The time value for this point. example: '2020-06-08T11:55:00.123Z' format: date-time type: string value: description: The value for this point. example: 19 format: double type: number type: object DORAListResponse: description: Response for the DORA list endpoints. properties: data: description: The list of DORA events. items: $ref: '#/components/schemas/DORAEvent' type: array type: object EventsListResponseLinks: description: Links attributes. properties: next: description: 'Link for the next set of results. Note that the request can also be made using the POST endpoint.' example: https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object MonitorType: description: Attributes from the monitor that triggered the event. nullable: true properties: created_at: description: The POSIX timestamp of the monitor's creation in nanoseconds. example: 1646318692000 format: int64 type: integer group_status: description: Monitor group status used when there is no `result_groups`. format: int32 maximum: 2147483647 type: integer example: 42 groups: description: Groups to which the monitor belongs. items: description: A group. type: string type: array id: description: The monitor ID. format: int64 type: integer example: 42 message: description: The monitor message. type: string example: CPU usage is high on {{host.name}} modified: description: The monitor's last-modified timestamp. format: int64 type: integer example: 42 name: description: The monitor name. type: string example: Example Monitor query: description: The query that triggers the alert. type: string example: avg:system.cpu.user{*} tags: description: A list of tags attached to the monitor. example: - environment:test items: description: A tag. type: string type: array templated_name: description: The templated name of the monitor before resolving any template variables. type: string example: Example Monitor type: description: The monitor type. type: string example: metric alert type: object LogsGroupByTotal: default: false description: A resulting object to put the given computes in over all the matching records. oneOf: - $ref: '#/components/schemas/LogsGroupByTotalBoolean' - $ref: '#/components/schemas/LogsGroupByTotalString' - $ref: '#/components/schemas/LogsGroupByTotalNumber' LogsAggregateRequest: description: The object sent with the request to retrieve a list of logs from your organization. properties: compute: description: The list of metrics or timeseries to compute for the retrieved buckets. items: $ref: '#/components/schemas/LogsCompute' type: array filter: $ref: '#/components/schemas/LogsQueryFilter' group_by: description: The rules for the group by items: $ref: '#/components/schemas/LogsGroupBy' type: array options: $ref: '#/components/schemas/LogsQueryOptions' page: $ref: '#/components/schemas/LogsAggregateRequestPage' type: object RUMWarning: description: A warning message indicating something that went wrong with the query. properties: code: description: A unique code for this type of warning. example: unknown_index type: string detail: description: A detailed explanation of this specific warning. example: 'indexes: foo, bar' type: string title: description: A short human-readable summary of the warning. example: One or several indexes are missing or invalid, results hold data from the other indexes type: string type: object CIAppPipelineEventPipeline: description: Details of the top level pipeline, build, or workflow of your CI. oneOf: - $ref: '#/components/schemas/CIAppPipelineEventFinishedPipeline' - $ref: '#/components/schemas/CIAppPipelineEventInProgressPipeline' LogsCompute: description: A compute rule to compute metrics or timeseries properties: aggregation: $ref: '#/components/schemas/LogsAggregationFunction' interval: description: 'The time buckets'' size (only used for type=timeseries) Defaults to a resolution of 150 points' example: 5m type: string metric: description: The metric to use example: '@duration' type: string type: $ref: '#/components/schemas/LogsComputeType' required: - aggregation type: object CIAppResponseLinks: description: Links attributes. properties: next: description: 'Link for the next set of results. The request can also be made using the POST endpoint.' example: https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object CIAppPipelineEventStepStatus: description: The final status of the step. enum: - success - error example: success type: string x-enum-varnames: - SUCCESS - ERROR CIAppPipelineEventJobStatus: description: The final status of the job. enum: - success - error - canceled - skipped example: success type: string x-enum-varnames: - SUCCESS - ERROR - CANCELED - SKIPPED CIAppSortOrder: description: The order to use, ascending or descending. enum: - asc - desc example: asc type: string x-enum-varnames: - ASCENDING - DESCENDING CIAppResponseMetadata: description: The metadata associated with a request. properties: elapsed: description: The time elapsed in milliseconds. example: 132 format: int64 type: integer request_id: description: The identifier of the request. example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR type: string status: $ref: '#/components/schemas/CIAppResponseStatus' warnings: description: 'A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.' items: $ref: '#/components/schemas/CIAppWarning' type: array type: object CIAppGroupByTotalBoolean: description: If set to true, creates an additional bucket labeled "$facet_total". type: boolean DORAFetchResponse: description: Response for the DORA fetch endpoints. properties: data: $ref: '#/components/schemas/DORAEvent' type: object RUMResponsePage: description: Paging attributes. properties: after: description: The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object EventCreateResponseAttributesAttributesEvt: description: JSON object of event system attributes. properties: id: description: Event id type: string example: abc-123-def type: object HTTPCIAppErrors: description: Errors occurred. properties: errors: description: Structured errors. items: $ref: '#/components/schemas/HTTPCIAppError' type: array type: object RUMAggregationFunction: description: An aggregation function. enum: - count - cardinality - pc75 - pc90 - pc95 - pc98 - pc99 - sum - min - max - avg - median example: pc90 type: string x-enum-varnames: - COUNT - CARDINALITY - PERCENTILE_75 - PERCENTILE_90 - PERCENTILE_95 - PERCENTILE_98 - PERCENTILE_99 - SUM - MIN - MAX - AVG - MEDIAN RUMGroupByHistogram: description: 'Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.' properties: interval: description: The bin size of the histogram buckets. example: 10 format: double type: number max: description: 'The maximum value for the measure used in the histogram (values greater than this one are filtered out).' example: 100 format: double type: number min: description: 'The minimum value for the measure used in the histogram (values smaller than this one are filtered out).' example: 50 format: double type: number required: - interval - min - max type: object LogsAggregateBucket: description: A bucket values properties: by: additionalProperties: description: The values for each group by description: The key, value pairs for each group by example: '@state': success '@version': abc type: object computes: additionalProperties: $ref: '#/components/schemas/LogsAggregateBucketValue' description: A map of the metric name -> value for regular compute or list of values for a timeseries type: object type: object LogsAggregateSortType: default: alphabetical description: The type of sorting algorithm enum: - alphabetical - measure type: string x-enum-varnames: - ALPHABETICAL - MEASURE LogsGroupByTotalNumber: description: A number to use as the key value for the total bucket format: double type: number RUMGroupByMissingNumber: description: The missing value to use if there is a number valued facet. format: double type: number LogsGroupBy: description: A group by rule properties: facet: description: The name of the facet to use (required) example: host type: string histogram: $ref: '#/components/schemas/LogsGroupByHistogram' limit: default: 10 description: 'The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed. If grouping by multiple facets, the product of limits must not exceed 10000.' format: int64 type: integer example: 42 missing: $ref: '#/components/schemas/LogsGroupByMissing' sort: $ref: '#/components/schemas/LogsAggregateSort' total: $ref: '#/components/schemas/LogsGroupByTotal' required: - facet type: object RUMCompute: description: A compute rule to compute metrics or timeseries. properties: aggregation: $ref: '#/components/schemas/RUMAggregationFunction' interval: description: 'The time buckets'' size (only used for type=timeseries) Defaults to a resolution of 150 points.' example: 5m type: string metric: description: The metric to use. example: '@duration' type: string type: $ref: '#/components/schemas/RUMComputeType' required: - aggregation type: object parameters: eventIdParam: name: event_id in: path required: true description: The unique string identifier of the event to retrieve schema: type: string responses: 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 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