Skip to content
Changelog

Report a bug

Datadog integration: operations for AI agents

Datadog connects to Type.com as an integration. This page lists the 1939 operations documented for Claude and Codex in Type.com: 898 read, 585 write, 456 destructive.

About Datadog

Datadog offers monitoring, observability, and security for cloud-scale applications, unifying metrics, logs, and traces to help teams detect issues and optimize performance

Categories: Developer Tools & IT

How to connect Datadog to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

1939 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

1939 operations listed.

IP Ranges

  • Read

    List IP Ranges

    Get information about Datadog IP ranges.

    GET /

Key Management

  • Read

    Get all API keys

    Get all API keys available for your account. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    GET /api/v1/api_key

  • Read

    Get API key

    Get a given API key. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    GET /api/v1/api_key/{key}

  • Read

    Get all application keys

    Get all application keys available for your Datadog account. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    GET /api/v1/application_key

  • Read

    Get an application key

    Get a given application key. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    GET /api/v1/application_key/{key}

  • Read

    Get all API keys

    List all API keys available for your account.

    GET /api/v2/api_keys

  • Read

    Get API key

    Get an API key.

    GET /api/v2/api_keys/{api_key_id}

  • Read

    Get all application keys

    List all application keys available for your org

    GET /api/v2/application_keys

  • Read

    Get an application key

    Get an application key for your org.

    GET /api/v2/application_keys/{app_key_id}

  • Read

    Get all application keys owned by current user

    List all application keys available for current user

    GET /api/v2/current_user/application_keys

  • Read

    Get one application key owned by current user

    Get an application key owned by current user. The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).

    GET /api/v2/current_user/application_keys/{app_key_id}

  • Read

    Get all access tokens

    List all access tokens for the organization.

    GET /api/v2/personal_access_tokens

  • Read

    Get a personal access token

    Get a specific personal access token by its ID.

    GET /api/v2/personal_access_tokens/{token_id}

  • Read

    Validate API key

    Check if the API key is valid. Returns the organization UUID, API key ID, and associated scopes.

    GET /api/v2/validate

  • Read

    Validate API and application keys

    Check that the API key and application key used for the request are both valid. Returns `{"status": "ok"}` on success, `401` or `403` otherwise. Useful as a lightweight authentication probe before issuing other API calls that require full credentials.

    GET /api/v2/validate_keys

  • Write

    Create an API key

    Creates an API key with a given name. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    POST /api/v1/api_key

  • Write

    Create an application key

    Create an application key with a given name. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    POST /api/v1/application_key

  • Write

    Create an API key

    Create an API key.

    POST /api/v2/api_keys

  • Write

    Edit an API key

    Update an API key.

    PATCH /api/v2/api_keys/{api_key_id}

  • Write

    Edit an application key

    Edit an application key

    PATCH /api/v2/application_keys/{app_key_id}

  • Write

    Create an application key for current user

    Create an application key for current user

    POST /api/v2/current_user/application_keys

  • Write

    Edit an application key owned by current user

    Edit an application key owned by current user. The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).

    PATCH /api/v2/current_user/application_keys/{app_key_id}

  • Write

    Create a personal access token

    Create a personal access token for the current user.

    POST /api/v2/personal_access_tokens

  • Write

    Update a personal access token

    Update a specific personal access token.

    PATCH /api/v2/personal_access_tokens/{token_id}

  • Destructive

    Delete an API key

    Delete a given API key. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    DELETE /api/v1/api_key/{key}

  • Destructive

    Edit an API key

    Edit an API key name. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    PUT /api/v1/api_key/{key}

  • Destructive

    Delete an application key

    Delete a given application key. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    DELETE /api/v1/application_key/{key}

  • Destructive

    Edit an application key

    Edit an application key name. This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management/) endpoints instead.

    PUT /api/v1/application_key/{key}

  • Destructive

    Delete an API key

    Delete an API key.

    DELETE /api/v2/api_keys/{api_key_id}

  • Destructive

    Delete an application key

    Delete an application key

    DELETE /api/v2/application_keys/{app_key_id}

  • Destructive

    Delete an application key owned by current user

    Delete an application key owned by current user

    DELETE /api/v2/current_user/application_keys/{app_key_id}

  • Destructive

    Revoke a personal access token

    Revoke a specific personal access token.

    DELETE /api/v2/personal_access_tokens/{token_id}

Service Checks

  • Write

    Submit a Service Check

    Submit a list of Service Checks. **Notes**: - A valid API key is required. - Service checks can be submitted up to 10 minutes in the past.

    POST /api/v1/check_run

Usage Metering

  • Read

    Get the list of available daily custom reports (deprecated)

    Get daily custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide.

    GET /api/v1/daily_custom_reports

  • Read

    Get specified daily custom reports (deprecated)

    Get specified daily custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide.

    GET /api/v1/daily_custom_reports/{report_id}

  • Read

    Get the list of available monthly custom reports (deprecated)

    Get monthly custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide.

    GET /api/v1/monthly_custom_reports

  • Read

    Get specified monthly custom reports (deprecated)

    Get specified monthly custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide.

    GET /api/v1/monthly_custom_reports/{report_id}

  • Read

    Get hourly usage for analyzed logs (deprecated)

    Get hourly usage for analyzed logs (Security Monitoring). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/analyzed_logs

  • Read

    Get hourly usage for audit logs (deprecated)

    Get hourly usage for audit logs. **Note:** This endpoint has been deprecated.

    GET /api/v1/usage/audit_logs

  • Read

    Get hourly usage for Lambda (deprecated)

    Get hourly usage for Lambda. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/aws_lambda

  • Read

    Get billable usage across your account

    Get billable usage across your account. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).

    GET /api/v1/usage/billable-summary

  • Read

    Get hourly usage for CI visibility (deprecated)

    Get hourly usage for CI visibility (tests, pipeline, and spans). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/ci-app

  • Read

    Get hourly usage for CSM Pro (deprecated)

    Get hourly usage for cloud security management (CSM) pro. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/cspm

  • Read

    Get hourly usage for cloud workload security (deprecated)

    Get hourly usage for cloud workload security. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/cws

  • Read

    Get hourly usage for database monitoring (deprecated)

    Get hourly usage for database monitoring **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/dbm

  • Read

    Get hourly usage for Fargate (deprecated)

    Get hourly usage for [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/fargate

  • Read

    Get hourly usage for hosts and containers (deprecated)

    Get hourly usage for hosts and containers. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/hosts

  • Read

    Get hourly usage attribution

    Get hourly usage attribution. Multi-region data is available starting March 1, 2023. **Note**: All `estimated_*` usage types will be deprecated on February 1, 2027. This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is set in the response. If it is, make another request and pass `next_record_id` as a parameter. Pseudo code example: ``` response := GetHourlyUsageAttribution(start_month) cursor := response.metadata.pagination.next_record_id WHILE cursor != null BEGIN sleep(5 seconds) # Avoid running into rate limit response := GetHourlyUsageAttribution(start_month, next_record_id=cursor) cursor := response.metadata.pagination.next_record_id END ```

    GET /api/v1/usage/hourly-attribution

  • Read

    Get hourly usage for incident management (deprecated)

    Get hourly usage for incident management. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/incident-management

  • Read

    Get hourly usage for indexed spans (deprecated)

    Get hourly usage for indexed spans. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/indexed-spans

  • Read

    Get hourly usage for ingested spans (deprecated)

    Get hourly usage for ingested spans. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/ingested-spans

  • Read

    Get hourly usage for IoT (deprecated)

    Get hourly usage for IoT. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/iot

  • Read

    Get hourly usage for logs (deprecated)

    Get hourly usage for logs. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/logs

  • Read

    Get hourly logs usage by retention (deprecated)

    Get hourly usage for indexed logs by retention period. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/logs-by-retention

  • Read

    Get hourly usage for logs by index

    Get hourly usage for logs by index.

    GET /api/v1/usage/logs_by_index

  • Read

    Get monthly usage attribution

    Get monthly usage attribution. Multi-region data is available starting March 1, 2023. **Note**: All `estimated_*` usage types will be deprecated on February 1, 2027. This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is set in the response. If it is, make another request and pass `next_record_id` as a parameter. Pseudo code example: ``` response := GetMonthlyUsageAttribution(start_month) cursor := response.metadata.pagination.next_record_id WHILE cursor != null BEGIN sleep(5 seconds) # Avoid running into rate limit response := GetMonthlyUsageAttribution(start_month, next_record_id=cursor) cursor := response.metadata.pagination.next_record_id END ```

    GET /api/v1/usage/monthly-attribution

  • Read

    get hourly usage for network flows (deprecated)

    Get hourly usage for network flows. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/network_flows

  • Read

    Get hourly usage for network hosts (deprecated)

    Get hourly usage for network hosts. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/network_hosts

  • Read

    Get hourly usage for online archive (deprecated)

    Get hourly usage for online archive. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/online-archive

  • Read

    Get hourly usage for profiled hosts (deprecated)

    Get hourly usage for profiled hosts. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/profiling

  • Read

    Get hourly usage for RUM units (deprecated)

    Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) Units. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/rum

  • Read

    Get hourly usage for RUM sessions (deprecated)

    Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) Sessions. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/rum_sessions

  • Read

    Get hourly usage for sensitive data scanner (deprecated)

    Get hourly usage for sensitive data scanner. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/sds

  • Read

    Get hourly usage for SNMP devices (deprecated)

    Get hourly usage for SNMP devices. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/snmp

  • Read

    Get usage across your account

    Get all usage across your account. For SDK users only: all fields on `UsageSummaryResponse`, `UsageSummaryDate`, and `UsageSummaryDateOrg` are accessible through each object's `additionalProperties` map. Existing typed-field getters are unchanged. New billing dimensions will not have typed-field getters. Use [Get available fields for usage summary](https://docs.datadoghq.com/api/latest/usage-metering/get-available-fields-for-usage-summary/) to enumerate every available key at each response level. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).

    GET /api/v1/usage/summary

  • Read

    Get hourly usage for synthetics checks (deprecated)

    Get hourly usage for [synthetics checks](https://docs.datadoghq.com/synthetics/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/synthetics

  • Read

    Get hourly usage for synthetics API checks (deprecated)

    Get hourly usage for [synthetics API checks](https://docs.datadoghq.com/synthetics/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/synthetics_api

  • Read

    Get hourly usage for synthetics browser checks (deprecated)

    Get hourly usage for synthetics browser checks. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/synthetics_browser

  • Read

    Get hourly usage for custom metrics (deprecated)

    Get hourly usage for [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/). **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.

    GET /api/v1/usage/timeseries

  • Read

    Get all custom metrics by hourly average

    Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed.

    GET /api/v1/usage/top_avg_metrics

  • Read

    Get active billing dimensions for cost attribution

    Get active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 19th of the following month.

    GET /api/v2/cost_by_tag/active_billing_dimensions

  • Read

    Get Monthly Cost Attribution

    Get monthly cost attribution by tag across multi-org and single root-org accounts. Cost Attribution data for a given month becomes available no later than the 19th of the following month. This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is set in the response. If it is, make another request and pass `next_record_id` as a parameter. Pseudo code example: ``` response := GetMonthlyCostAttribution(start_month, end_month) cursor := response.metadata.pagination.next_record_id WHILE cursor != null BEGIN sleep(5 seconds) # Avoid running into rate limit response := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor) cursor := response.metadata.pagination.next_record_id END ``` This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). This endpoint is not available in the Government (US1-FED) site.

    GET /api/v2/cost_by_tag/monthly_cost_attribution

  • Read

    Get hourly usage for application security (deprecated)

    Get hourly usage for application security . **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)

    GET /api/v2/usage/application_security

  • Read

    Get billing dimension mapping for usage endpoints

    Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints. Mapping data is updated on a monthly cadence. This endpoint is only accessible to [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).

    GET /api/v2/usage/billing_dimension_mapping

  • Read

    Get cost across multi-org account (deprecated)

    Get cost across multi-org account. Cost by org data for a given month becomes available no later than the 16th of the following month. **Note:** This endpoint has been deprecated. Please use the new endpoint [`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account) instead. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).

    GET /api/v2/usage/cost_by_org

  • Read

    Get estimated cost across your account

    Get estimated cost across multi-org and single root-org accounts. Estimated cost data is only available for the current month and previous month and is delayed by up to 72 hours from when it was incurred. To access historical costs prior to this, use the `/historical_cost` endpoint. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).

    GET /api/v2/usage/estimated_cost

  • Read

    Get historical cost across your account

    Get historical cost across multi-org and single root-org accounts. Cost data for a given month becomes available no later than the 16th of the following month. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).

    GET /api/v2/usage/historical_cost

  • Read

    Get hourly usage by product family

    Get hourly usage by product family.

    GET /api/v2/usage/hourly_usage

  • Read

    Get hourly usage for Lambda traced invocations (deprecated)

    Get hourly usage for Lambda traced invocations. **Note:** This endpoint has been deprecated.. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)

    GET /api/v2/usage/lambda_traced_invocations

  • Read

    Get hourly usage for observability pipelines (deprecated)

    Get hourly usage for observability pipelines. **Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)

    GET /api/v2/usage/observability_pipelines

  • Read

    Get projected cost across your account

    Get projected cost across multi-org and single root-org accounts. Projected cost data is only available for the current month and becomes available around the 12th of the month. This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).

    GET /api/v2/usage/projected_cost

  • Read

    List usage quotas

    Lists usage quotas for the caller's organization in a quota namespace. You can optionally include descendant organizations in the same datacenter as the caller. Requires the `billing_read` or `billing_edit` permission.

    GET /api/v2/usage/quotas/{quota_namespace}

  • Read

    Get available fields for usage summary

    List the field names returned by `GET /api/v1/usage/summary` at each of its three response levels. Each list contains every key the data endpoint emits—both typed fields declared in the OpenAPI spec and untyped keys exposed through `additionalProperties` (the latter used for billing dimensions and usage types added after the v1 schema freeze). This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). Go example: ```go fields, _, err := api.GetUsageSummaryAvailableFields(ctx) attr := fields.Data.GetAttributes() // resp is the *UsageSummaryResponse returned by api.GetUsageSummary(ctx, ...) // Layer 1: UsageSummaryResponse for _, key := range attr.GetResponseFields() { if val, ok := resp.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 2: UsageSummaryDate (per month) for _, date := range resp.GetUsage() { for _, key := range attr.GetDateFields() { if val, ok := date.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 3: UsageSummaryDateOrg (per org per month) for _, org := range date.GetOrgs() { for _, key := range attr.GetDateOrgFields() { if val, ok := org.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } } } ```

    GET /api/v2/usage/summary/available_fields

  • Read

    Get usage attribution types

    Get usage attribution types.

    GET /api/v2/usage/usage-attribution-types

  • Write

    Create or update usage quotas

    Creates or updates one or more usage quotas by scope. If a quota already exists for a supplied scope, it is updated. Otherwise, a quota is created only when `usage_limit` and `enforced` are provided. For the organization-wide quota, `pending_usage_limit` schedules a limit for the next usage period and can accompany an immediate limit or update an existing quota by itself. Scheduled changes follow `include_descendants` like the other fields. Requires the `billing_edit` permission.

    POST /api/v2/usage/quotas/{quota_namespace}

  • Write

    Update a usage quota

    Updates the supplied fields on a usage quota and leaves omitted fields unchanged. For an organization-wide quota, `pending_usage_limit` schedules a limit for the next usage period. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires the `billing_edit` permission.

    PATCH /api/v2/usage/quotas/{quota_namespace}/{id}

  • Destructive

    Delete a usage quota

    Deletes a usage quota by its opaque identifier. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires the `billing_edit` permission.

    DELETE /api/v2/usage/quotas/{quota_namespace}/{id}

  • Destructive

    Cancel a scheduled usage quota limit

    Cancels the limit change scheduled to take effect at the start of the next usage period, leaving the usage quota and its current limit unchanged. Returns `404` when the quota does not exist, has no scheduled change, or its scheduled change has already taken effect; in every case the quota is left unchanged. The quota must belong to the caller's organization or one of its descendants, and its opaque identifier must belong to the requested quota namespace. Requires the `billing_edit` permission.

    DELETE /api/v2/usage/quotas/{quota_namespace}/{id}/pending

Dashboards

  • Read

    Get all dashboards

    Get all dashboards. **Note**: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.

    GET /api/v1/dashboard

  • Read

    Get a shared dashboard

    Fetch an existing shared dashboard's sharing metadata associated with the specified token.

    GET /api/v1/dashboard/public/{token}

  • Read

    Get all invitations for a shared dashboard

    Describe the invitations that exist for the given shared dashboard (paginated).

    GET /api/v1/dashboard/public/{token}/invitation

  • Read

    Get a dashboard

    Get a dashboard using the specified ID.

    GET /api/v1/dashboard/{dashboard_id}

  • Read

    Get usage stats for all dashboards

    Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set. Use `filter[edited_before]` or `filter[viewed_before]` to narrow results by edit or view date. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM. **View counts are refreshed once per day** and **only reflect views recorded starting January 2025**; views prior to that date are not included.

    GET /api/v2/dashboards/usage

  • Read

    Get usage stats for a dashboard

    Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM. **View counts are refreshed once per day** and **only reflect views recorded starting January 2025**; views prior to that date are not included.

    GET /api/v2/dashboards/{dashboard_id}/usage

  • Write

    Restore deleted dashboards

    Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).

    PATCH /api/v1/dashboard

  • Write

    Create a new dashboard

    Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended. Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers.

    POST /api/v1/dashboard

  • Write

    Create a shared dashboard

    Share a specified private dashboard, generating a URL at which it can be publicly viewed.

    POST /api/v1/dashboard/public

  • Write

    Send shared dashboard invitation email

    Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list.

    POST /api/v1/dashboard/public/{token}/invitation

  • Destructive

    Delete dashboards

    Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed).

    DELETE /api/v1/dashboard

  • Destructive

    Revoke a shared dashboard URL

    Revoke the public URL for a dashboard (rendering it private) associated with the specified token.

    DELETE /api/v1/dashboard/public/{token}

  • Destructive

    Update a shared dashboard

    Update a shared dashboard associated with the specified token.

    PUT /api/v1/dashboard/public/{token}

  • Destructive

    Revoke shared dashboard invitations

    Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.

    DELETE /api/v1/dashboard/public/{token}/invitation

  • Destructive

    Delete a dashboard

    Delete a dashboard using the specified ID.

    DELETE /api/v1/dashboard/{dashboard_id}

  • Destructive

    Update a dashboard

    Update a dashboard using the specified ID.

    PUT /api/v1/dashboard/{dashboard_id}

Dashboard Lists

  • Read

    Get all dashboard lists

    Fetch all of your existing dashboard list definitions.

    GET /api/v1/dashboard/lists/manual

  • Read

    Get a dashboard list

    Fetch an existing dashboard list's definition.

    GET /api/v1/dashboard/lists/manual/{list_id}

  • Read

    Get items of a Dashboard List

    Fetch the dashboard list’s dashboard definitions.

    GET /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards

  • Write

    Create a dashboard list

    Create an empty dashboard list.

    POST /api/v1/dashboard/lists/manual

  • Write

    Add Items to a Dashboard List

    Add dashboards to an existing dashboard list.

    POST /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards

  • Destructive

    Delete a dashboard list

    Delete a dashboard list.

    DELETE /api/v1/dashboard/lists/manual/{list_id}

  • Destructive

    Update a dashboard list

    Update the name of a dashboard list.

    PUT /api/v1/dashboard/lists/manual/{list_id}

  • Destructive

    Delete items from a dashboard list

    Delete dashboards from an existing dashboard list.

    DELETE /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards

  • Destructive

    Update items of a dashboard list

    Update dashboards of an existing dashboard list.

    PUT /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards

Metrics

  • Read

    Get active metrics list

    Get the list of actively reporting metrics from a given time until now.

    GET /api/v1/metrics

  • Read

    Get metric metadata

    Get metadata about a specific metric.

    GET /api/v1/metrics/{metric_name}

  • Read

    Query timeseries points

    Query timeseries points. Datadog recommends using the v2 `/api/v2/query/timeseries` endpoint over this endpoint for querying timeseries data.

    GET /api/v1/query

  • Read

    Search metrics (deprecated)

    **Note**: This endpoint is deprecated. Use `/api/v2/metrics` instead. Search for metrics from the last 24 hours in Datadog.

    GET /api/v1/search

  • Read

    Get a list of metrics

    Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters. Query parameters use bracket notation (for example, `filter[tags]`, `filter[queried][window][seconds]`). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example: `GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500`.

    GET /api/v2/metrics

  • Read

    Get a derived metric

    Get the definition of a derived metric by name.

    GET /api/v2/metrics/derived-metrics/{metric_name}

  • Read

    Get a historical metrics configuration

    Get the historical metrics ingestion configuration for a metric. Existence of the resource means historical metrics ingestion is enabled; returns 404 when it is not enabled for the metric.

    GET /api/v2/metrics/historical-metrics-configurations/{metric_name}

  • Read

    List tag indexing rule exemptions

    Returns explicit exemptions and legacy tag configurations that exclude metrics from tag indexing rules. You can filter results by metric name prefix, whether an exemption is safe to remove, or the UUID of a matching tag indexing rule. You can sort results by metric name or by estimated change in indexed volume.

    GET /api/v2/metrics/list-tag-indexing-rule-exemptions

  • Read

    List tag indexing rules

    List tag indexing rules for an org, sorted by `rule_order`, with offset/limit pagination.

    GET /api/v2/metrics/tag-indexing-rules

  • Read

    Get a tag indexing rule

    Get a single tag indexing rule by its UUID.

    GET /api/v2/metrics/tag-indexing-rules/{id}

  • Read

    List active tags and aggregations

    List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name.

    GET /api/v2/metrics/{metric_name}/active-configurations

  • Read

    List tags by metric name

    View indexed and ingested tags for a given metric name. Results are filtered by the `window[seconds]` parameter, which defaults to 14400 (4 hours).

    GET /api/v2/metrics/{metric_name}/all-tags

  • Read

    Related Assets to a Metric

    Returns dashboards, monitors, notebooks, and SLOs that a metric is stored in, if any. Updated every 24 hours.

    GET /api/v2/metrics/{metric_name}/assets

  • Read

    Tag Configuration Cardinality Estimator

    Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™.

    GET /api/v2/metrics/{metric_name}/estimate

  • Read

    Get tag key cardinality details

    Returns the cardinality details of tags for a specific metric.

    GET /api/v2/metrics/{metric_name}/tag-cardinalities

  • Read

    Get a tag indexing rule exemption

    Returns why a metric is excluded from tag indexing rules. Returns 200 with `kind=exemption` when an explicit exemption exists, 200 with `kind=legacy_tag_configuration` when the metric has a legacy tag configuration acting as an implicit exclusion, or 404 when neither applies.

    GET /api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions

  • Read

    List tag indexing rules for a metric

    List the tag indexing rules that apply to a given metric, sorted by `rule_order`. Matching is performed server-side using each rule's `metric_name_matches` glob patterns.

    GET /api/v2/metrics/{metric_name}/tag-indexing-rules

  • Read

    List tag configuration by name

    Returns the tag configuration for the given metric name. A metric may exist and submit data without having a tag configuration. If no tag configuration exists for the metric, this endpoint returns `404 Not Found`. This response does not indicate that the metric itself is missing.

    GET /api/v2/metrics/{metric_name}/tags

  • Read

    List distinct metric volumes by metric name

    View hourly average cardinality for the given metric name over the look back period. For Metric Name Pricing customers, view total point volume for the given metric name over the look back period.

    GET /api/v2/metrics/{metric_name}/volumes

  • Read

    Query scalar data across multiple products

    Query scalar values (as seen on Query Value, Table, and Toplist widgets). Multiple data sources are supported with the ability to process the data using formulas and functions.

    POST /api/v2/query/scalar

  • Read

    Query timeseries data across multiple products

    Query timeseries data across various data sources and process the data by applying formulas and functions. Datadog recommends using this endpoint over the v1 `/api/v1/query` endpoint for querying timeseries data.

    POST /api/v2/query/timeseries

  • Write

    Submit distribution points

    The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards.

    POST /api/v1/distribution_points

  • Write

    Submit metrics

    The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes). If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect: - 64 bits for the timestamp - 64 bits for the value - 40 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size.

    POST /api/v1/series

  • Write

    Configure tags for multiple metrics (deprecated)

    **Note**: This endpoint is deprecated. Use [Tag Indexing Rules](/api/latest/metrics/#create-a-tag-indexing-rule) (`POST /api/v2/metrics/tag-indexing-rules`) instead. Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations. Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app. If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric. Can only be used with application keys of users with the `Manage Tags for Metrics` permission.

    POST /api/v2/metrics/config/bulk-tags

  • Write

    Create a derived metric

    Create a derived metric for the org. The metric name is supplied as the resource `id`, and the `definition` sets the formula and the queries the formula is computed from. Requires the `Manage Tags for Metrics` permission.

    POST /api/v2/metrics/derived-metrics

  • Write

    Enable historical metrics ingestion

    Enable historical metrics ingestion (late data ingestion) for a metric. Idempotent: enabling an already-enabled metric returns 200 instead of 201. Not supported for distribution metrics, metrics with an existing tag configuration, or most standard (non-custom) metrics.

    POST /api/v2/metrics/historical-metrics-configurations

  • Write

    Create a tag indexing rule

    Create a tag indexing rule for the org. `rule_order` is assigned server-side as max+1 among existing rules; use the reorder endpoint to change the evaluation order. Requires the `Manage Tags for Metrics` permission.

    POST /api/v2/metrics/tag-indexing-rules

  • Write

    Reorder tag indexing rules

    Atomically re-sequence the tag indexing rules for an org to match the supplied list of rule UUIDs. The server assigns `rule_order` 1, 2, … matching each rule UUID by position in the list. The UUIDs of all active rules must be provided; omitting any active rule UUID returns a 400 error. Requires the `Manage Tags for Metrics` permission.

    POST /api/v2/metrics/tag-indexing-rules/order

  • Write

    Create a tag indexing rule exemption

    Exempt a metric from all tag indexing rules. The response includes the created exemption resource. Requires the `Manage Tags for Metrics` permission.

    POST /api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions

  • Write

    Update a tag configuration

    Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed from an allow-list to a deny-list, and tags in the defined list will not be queryable. Can only be used with application keys from users with the `Manage Tags for Metrics` permission. This endpoint requires a tag configuration to be created first.

    PATCH /api/v2/metrics/{metric_name}/tags

  • Write

    Create a tag configuration

    Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode` to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are not queryable. Can only be used with application keys of users with the `Manage Tags for Metrics` permission.

    POST /api/v2/metrics/{metric_name}/tags

  • Write

    Submit metrics

    The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes). If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect: - 64 bits for the timestamp - 64 bits for the value - 20 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. Host name is one of the resources in the Resources field.

    POST /api/v2/series

  • Destructive

    Edit metric metadata

    Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics).

    PUT /api/v1/metrics/{metric_name}

  • Destructive

    Delete tags for multiple metrics (deprecated)

    **Note**: This endpoint is deprecated. Use [Tag Indexing Rules](/api/latest/metrics/#create-a-tag-indexing-rule) (`POST /api/v2/metrics/tag-indexing-rules`) instead. Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. Metrics are selected by passing a metric name prefix. Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app. Can only be used with application keys of users with the `Manage Tags for Metrics` permission.

    DELETE /api/v2/metrics/config/bulk-tags

  • Destructive

    Delete a derived metric

    Delete a derived metric by name. Idempotent: returns 204 regardless of whether the derived metric existed. Requires the `Manage Tags for Metrics` permission.

    DELETE /api/v2/metrics/derived-metrics/{metric_name}

  • Destructive

    Update a derived metric

    Update the definition of an existing derived metric. The `id` in the request body must match the `metric_name` path parameter. Requires the `Manage Tags for Metrics` permission.

    PUT /api/v2/metrics/derived-metrics/{metric_name}

  • Destructive

    Delete a historical metrics configuration

    Disable historical metrics ingestion for a metric. Idempotent: always returns 204, whether or not the configuration existed or the metric itself still exists, so that Terraform destroy succeeds for a metric removed out-of-band.

    DELETE /api/v2/metrics/historical-metrics-configurations/{metric_name}

  • Destructive

    Delete a tag indexing rule

    Soft-delete a tag indexing rule. Idempotent: returns 204 whether the rule existed or was already deleted. Remaining rules in the org are automatically re-sequenced to keep `rule_order` dense and 1-based. Requires the `Manage Tags for Metrics` permission.

    DELETE /api/v2/metrics/tag-indexing-rules/{id}

  • Destructive

    Update a tag indexing rule

    Partially update a tag indexing rule. Fields omitted from the request body are left unchanged. Setting `rule_order` to a value already used by another rule returns 409; use the reorder endpoint for atomic re-sequencing. Requires the `Manage Tags for Metrics` permission.

    PUT /api/v2/metrics/tag-indexing-rules/{id}

  • Destructive

    Delete a tag indexing rule exemption

    Remove a metric's exemption from tag indexing rules. Idempotent: returns 204 whether or not an exemption existed. Any associated legacy tag configuration record is also removed. Requires the `Manage Tags for Metrics` permission.

    DELETE /api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions

  • Destructive

    Update a tag indexing rule exemption

    Update the reason for an explicit tag indexing rule exemption. The exemption's `created_at` and `created_by_handle` values remain unchanged. Returns 404 when the metric has no explicit exemption or has only a legacy tag configuration. Requires the `Manage Tags for Metrics` permission.

    PUT /api/v2/metrics/{metric_name}/tag-indexing-rule-exemptions

  • Destructive

    Delete a tag configuration

    Deletes a metric's tag configuration. Can only be used with application keys from users with the `Manage Tags for Metrics` permission. Note: This operation is irreversible.

    DELETE /api/v2/metrics/{metric_name}/tags

Downtimes

  • Read

    Get all downtimes (deprecated)

    Get all scheduled downtimes. **Note:** This endpoint has been deprecated. Please use v2 endpoints.

    GET /api/v1/downtime

  • Read

    Get a downtime (deprecated)

    Get downtime detail by `downtime_id`. **Note:** This endpoint has been deprecated. Please use v2 endpoints.

    GET /api/v1/downtime/{downtime_id}

  • Read

    Get active downtimes for a monitor (deprecated)

    Get all active v1 downtimes for the specified monitor. **Note:** This endpoint has been deprecated. Please use v2 endpoints.

    GET /api/v1/monitor/{monitor_id}/downtimes

  • Read

    Get all downtimes

    Get all scheduled downtimes.

    GET /api/v2/downtime

  • Read

    Get a downtime

    Get downtime detail by `downtime_id`.

    GET /api/v2/downtime/{downtime_id}

  • Read

    Get active downtimes for a monitor

    Get all active downtimes for the specified monitor.

    GET /api/v2/monitor/{monitor_id}/downtime_matches

  • Write

    Schedule a downtime (deprecated)

    Schedule a downtime. **Note:** This endpoint has been deprecated. Please use v2 endpoints.

    POST /api/v1/downtime

  • Write

    Schedule a downtime

    Schedule a downtime.

    POST /api/v2/downtime

  • Write

    Update a downtime

    Update a downtime by `downtime_id`.

    PATCH /api/v2/downtime/{downtime_id}

  • Destructive

    Cancel downtimes by scope (deprecated)

    Delete all downtimes that match the scope of `X`. **Note:** This only interacts with Downtimes created using v1 endpoints. This endpoint has been deprecated and will not be replaced. Please use v2 endpoints to find and cancel downtimes.

    POST /api/v1/downtime/cancel/by_scope

  • Destructive

    Cancel a downtime (deprecated)

    Cancel a downtime. **Note:** This endpoint has been deprecated. Please use v2 endpoints.

    DELETE /api/v1/downtime/{downtime_id}

  • Destructive

    Update a downtime (deprecated)

    Update a single downtime by `downtime_id`. **Note:** This endpoint has been deprecated. Please use v2 endpoints.

    PUT /api/v1/downtime/{downtime_id}

  • Destructive

    Cancel a downtime

    Cancel a downtime. **Note**: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed.

    DELETE /api/v2/downtime/{downtime_id}

Events

  • Read

    Get a list of events

    The event stream can be queried and filtered by time, priority, sources and tags. **Notes**: - If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\`,`n` in your output. - This endpoint returns a maximum of `1000` most recent results. To return additional results, identify the last timestamp of the last result and set that as the `end` query time to paginate the results. You can also use the page parameter to specify which set of `1000` results to return.

    GET /api/v1/events

  • Read

    Get an event

    This endpoint allows you to query for event details. **Note**: If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\`,`n` in your output.

    GET /api/v1/events/{event_id}

  • Read

    Get a list of events

    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.

    GET /api/v2/events

  • Read

    Search events

    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.

    POST /api/v2/events/search

  • Read

    Get an event

    Get the details of an event by `event_id`.

    GET /api/v2/events/{event_id}

  • Write

    Post an event (deprecated)

    This endpoint is deprecated and is available only to organizations that have previously used it. Use the V2 endpoint instead. This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.

    POST /api/v1/events

  • Write

    Post an event

    This endpoint allows you to publish events. **Note:** To utilize this endpoint with our client libraries, please ensure you are using the latest version released on or after July 1, 2025. Earlier versions do not support this functionality. **Important:** Upgrade to the latest client library version to use the updated endpoint at `https://event-management-intake.{site}/api/v2/events`. Older client library versions of the Post an event (v2) API send requests to a deprecated endpoint (`https://api.{site}/api/v2/events`). Supported event categories are `change` and `alert`. For more information about change events, see [Change Tracking](https://docs.datadoghq.com/change_tracking).

    POST /api/v2/events

Snapshots

  • Read

    Take graph snapshots

    Take graph snapshots. Snapshots are PNG images generated by rendering a specified widget in a web page and capturing it once the data is available. The image is then uploaded to cloud storage. **Note**: When a snapshot is created, there is some delay before it is available.

    GET /api/v1/graph/snapshot

Hosts

  • Read

    Get all hosts for your organization

    This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time. **Note:** If the host is an Amazon EC2 instance, `id` is replaced with `aws_id` in the response. **Note**: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint.

    GET /api/v1/hosts

  • Read

    Get the total number of active hosts

    This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.

    GET /api/v1/hosts/totals

  • Write

    Unmute a host

    Unmutes a host. This endpoint takes no JSON arguments.

    POST /api/v1/host/{host_name}/unmute

  • Destructive

    Mute a host

    Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime) for the host.

    POST /api/v1/host/{host_name}/mute

AWS Integration

  • Read

    List all AWS integrations (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** List all Datadog-AWS integrations available in your Datadog organization.

    GET /api/v1/integration/aws

  • Read

    List namespace rules (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.

    GET /api/v1/integration/aws/available_namespace_rules

  • Read

    Get all Amazon EventBridge sources (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** Get all Amazon EventBridge sources.

    GET /api/v1/integration/aws/event_bridge

  • Read

    Get all AWS tag filters (deprecated)

    Get all AWS tag filters.

    GET /api/v1/integration/aws/filtering

  • Read

    List all AWS integrations

    Get a list of AWS Account Integration Configs.

    GET /api/v2/integration/aws/accounts

  • Read

    Get an AWS integration by config ID

    Get an AWS Account Integration Config by config ID.

    GET /api/v2/integration/aws/accounts/{aws_account_config_id}

  • Read

    Get AWS CCM config

    Get the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report (CUR) 2.0 by config ID.

    GET /api/v2/integration/aws/accounts/{aws_account_config_id}/ccm_config

  • Read

    Get AWS metric name filter preview

    Preview which collected CloudWatch metrics would be filtered by the account's saved metric name filters.

    GET /api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview

  • Read

    Preview AWS metric name filter

    Preview which collected CloudWatch metrics would be filtered by the supplied metric name filters. The filters are not persisted.

    POST /api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview

  • Read

    List available namespaces

    Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog.

    GET /api/v2/integration/aws/available_namespaces

  • Read

    Get all Amazon EventBridge sources

    Get all Amazon EventBridge sources.

    GET /api/v2/integration/aws/event_bridge

  • Read

    Get AWS integration IAM permissions

    Get all AWS IAM permissions required for the AWS integration.

    GET /api/v2/integration/aws/iam_permissions

  • Read

    Get resource collection IAM permissions

    Get all resource collection AWS IAM permissions required for the AWS integration.

    GET /api/v2/integration/aws/iam_permissions/resource_collection

  • Read

    Get AWS integration standard IAM permissions

    Get all standard AWS IAM permissions required for the AWS integration.

    GET /api/v2/integration/aws/iam_permissions/standard

  • Read

    Validate AWS CCM config

    Validate a Cloud Cost Management config for an AWS account using Cost and Usage Report (CUR) 2.0 against Datadog's ingest requirements without persisting it.

    POST /api/v2/integration/aws/validate_ccm_config

  • Write

    Create an AWS integration (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** Create a Datadog-Amazon Web Services integration. Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication.

    POST /api/v1/integration/aws

  • Write

    Create an Amazon EventBridge source (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** Create an Amazon EventBridge source.

    POST /api/v1/integration/aws/event_bridge

  • Write

    Set an AWS tag filter (deprecated)

    Set an AWS tag filter.

    POST /api/v1/integration/aws/filtering

  • Write

    Create an AWS integration

    Create a new AWS Account Integration Config.

    POST /api/v2/integration/aws/accounts

  • Write

    Update an AWS integration

    Update an AWS Account Integration Config by config ID.

    PATCH /api/v2/integration/aws/accounts/{aws_account_config_id}

  • Write

    Update AWS CCM config

    Update the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report (CUR) 2.0 by config ID.

    PATCH /api/v2/integration/aws/accounts/{aws_account_config_id}/ccm_config

  • Write

    Create AWS CCM config

    Create the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report (CUR) 2.0 by config ID.

    POST /api/v2/integration/aws/accounts/{aws_account_config_id}/ccm_config

  • Write

    Create an Amazon EventBridge source

    Create an Amazon EventBridge source.

    POST /api/v2/integration/aws/event_bridge

  • Write

    Generate a new external ID

    Generate a new external ID for AWS role-based authentication.

    POST /api/v2/integration/aws/generate_new_external_id

  • Destructive

    Delete an AWS integration (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.

    DELETE /api/v1/integration/aws

  • Destructive

    Update an AWS integration (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** Update a Datadog-Amazon Web Services integration.

    PUT /api/v1/integration/aws

  • Destructive

    Delete an Amazon EventBridge source (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** Delete an Amazon EventBridge source.

    DELETE /api/v1/integration/aws/event_bridge

  • Destructive

    Delete a tag filtering entry (deprecated)

    Delete a tag filtering entry.

    DELETE /api/v1/integration/aws/filtering

  • Destructive

    Generate a new external ID (deprecated)

    **This endpoint is deprecated - use the V2 endpoints instead.** Generate a new AWS external ID for a given AWS account ID and role name pair.

    PUT /api/v1/integration/aws/generate_new_external_id

  • Destructive

    Delete an AWS integration

    Delete an AWS Account Integration Config by config ID.

    DELETE /api/v2/integration/aws/accounts/{aws_account_config_id}

  • Destructive

    Delete AWS CCM config

    Delete the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report (CUR) 2.0 by config ID.

    DELETE /api/v2/integration/aws/accounts/{aws_account_config_id}/ccm_config

  • Destructive

    Delete an Amazon EventBridge source

    Delete an Amazon EventBridge source.

    DELETE /api/v2/integration/aws/event_bridge

AWS Logs Integration

  • Read

    List all AWS Logs integrations (deprecated)

    List all Datadog-AWS Logs integrations configured in your Datadog account.

    GET /api/v1/integration/aws/logs

  • Read

    Get list of AWS log ready services (deprecated)

    **This endpoint is deprecated - use the V2 endpoint instead.** Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.

    GET /api/v1/integration/aws/logs/services

  • Read

    Get list of AWS log ready services

    Get a list of AWS services that can send logs to Datadog.

    GET /api/v2/integration/aws/logs/services

  • Write

    Add AWS Log Lambda ARN (deprecated)

    **This endpoint is deprecated.** Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection.

    POST /api/v1/integration/aws/logs

  • Write

    Check that an AWS Lambda Function exists (deprecated)

    **This endpoint is deprecated.** Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking. - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist.

    POST /api/v1/integration/aws/logs/check_async

  • Write

    Enable an AWS Logs integration (deprecated)

    Enable automatic log collection for a list of services. This should be run after running `CreateAWSLambdaARN` to save the configuration.

    POST /api/v1/integration/aws/logs/services

  • Write

    Check permissions for log services (deprecated)

    **This endpoint is deprecated.** Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for `EnableAWSLogServices`. Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes. - Returns a status of `created` when it's checking if the permissions exists in the AWS account. - Returns a status of `waiting` while checking. - Returns a status of `checked and ok` if the Lambda exists. - Returns a status of `error` if the Lambda does not exist.

    POST /api/v1/integration/aws/logs/services_async

  • Destructive

    Delete an AWS Logs integration (deprecated)

    **This endpoint is deprecated.** Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account.

    DELETE /api/v1/integration/aws/logs

Azure Integration

  • Read

    List all Azure integrations

    List all Datadog-Azure integrations configured in your Datadog account.

    GET /api/v1/integration/azure

  • Write

    Create an Azure integration

    Create a Datadog-Azure integration. Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. Using the `PUT` method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.

    POST /api/v1/integration/azure

  • Write

    Update Azure integration host filters

    Update the defined list of host filters for a given Datadog-Azure integration.

    POST /api/v1/integration/azure/host_filters

  • Destructive

    Delete an Azure integration

    Delete a given Datadog-Azure integration from your Datadog account.

    DELETE /api/v1/integration/azure

  • Destructive

    Update an Azure integration

    Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`. Any other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`, use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload.

    PUT /api/v1/integration/azure

GCP Integration

  • Read

    List all GCP integrations (deprecated)

    This endpoint is deprecated – use the V2 endpoints instead. List all Datadog-GCP integrations configured in your Datadog account.

    GET /api/v1/integration/gcp

  • Read

    List all GCP STS-enabled service accounts

    List all GCP STS-enabled service accounts configured in your Datadog account.

    GET /api/v2/integration/gcp/accounts

  • Read

    List delegate account

    List your Datadog-GCP STS delegate account configured in your Datadog account.

    GET /api/v2/integration/gcp/sts_delegate

  • Write

    Create a GCP integration (deprecated)

    This endpoint is deprecated – use the V2 endpoints instead. Create a Datadog-GCP integration.

    POST /api/v1/integration/gcp

  • Write

    Create a new entry for your service account

    Create a new entry within Datadog for your STS enabled service account.

    POST /api/v2/integration/gcp/accounts

  • Write

    Update STS Service Account

    Update an STS enabled service account.

    PATCH /api/v2/integration/gcp/accounts/{account_id}

  • Write

    Create a Datadog GCP principal

    Create a Datadog GCP principal.

    POST /api/v2/integration/gcp/sts_delegate

  • Destructive

    Delete a GCP integration (deprecated)

    This endpoint is deprecated – use the V2 endpoints instead. Delete a given Datadog-GCP integration.

    DELETE /api/v1/integration/gcp

  • Destructive

    Update a GCP integration (deprecated)

    This endpoint is deprecated – use the V2 endpoints instead. Update a Datadog-GCP integrations host_filters and/or auto-mute. Requires a `project_id` and `client_email`, however these fields cannot be updated. If you need to update these fields, delete and use the create (`POST`) endpoint. The unspecified fields will keep their original values.

    PUT /api/v1/integration/gcp

  • Destructive

    Delete an STS enabled GCP Account

    Delete an STS enabled GCP account from within Datadog.

    DELETE /api/v2/integration/gcp/accounts/{account_id}

Pager Duty Integration

  • Read

    Get a single service object

    Get service name in the Datadog-PagerDuty integration.

    GET /api/v1/integration/pagerduty/configuration/services/{service_name}

  • Write

    Create a new service object

    Create a new service object in the PagerDuty integration.

    POST /api/v1/integration/pagerduty/configuration/services

  • Destructive

    Delete a single service object

    Delete a single service object in the Datadog-PagerDuty integration.

    DELETE /api/v1/integration/pagerduty/configuration/services/{service_name}

  • Destructive

    Update a single service object

    Update a single service object in the Datadog-PagerDuty integration.

    PUT /api/v1/integration/pagerduty/configuration/services/{service_name}

Slack Integration

  • Read

    Get all channels in a Slack integration

    Get a list of all channels configured for your Datadog-Slack integration.

    GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels

  • Read

    Get a Slack integration channel

    Get a channel configured for your Datadog-Slack integration.

    GET /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}

  • Read

    List Slack user bindings

    List all Slack user bindings for a given Datadog user from the Datadog Slack integration.

    GET /api/v2/integration/slack/user-bindings

  • Write

    Create a Slack integration channel

    Add a channel to your Datadog-Slack integration.

    POST /api/v1/integration/slack/configuration/accounts/{account_name}/channels

  • Write

    Update a Slack integration channel

    Update a channel used in your Datadog-Slack integration.

    PATCH /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}

  • Destructive

    Remove a Slack integration channel

    Remove a channel from your Datadog-Slack integration.

    DELETE /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}

Webhooks Integration

  • Read

    Get a custom variable

    Shows the content of the custom variable with the name `<CUSTOM_VARIABLE_NAME>`. If the custom variable is secret, the value does not return in the response payload.

    GET /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}

  • Read

    Get a webhook integration

    Gets the content of the webhook with the name `<WEBHOOK_NAME>`.

    GET /api/v1/integration/webhooks/configuration/webhooks/{webhook_name}

  • Read

    Get all auth methods

    Get a list of all auth methods configured for the Webhooks integration in your organization.

    GET /api/v2/integration/webhooks/configuration/auth-method

  • Read

    Get an OAuth2 client credentials auth method

    Get a single OAuth2 client credentials auth method by ID.

    GET /api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}

  • Write

    Create a custom variable

    Creates an endpoint with the name `<CUSTOM_VARIABLE_NAME>`.

    POST /api/v1/integration/webhooks/configuration/custom-variables

  • Write

    Create a webhooks integration

    Creates an endpoint with the name `<WEBHOOK_NAME>`.

    POST /api/v1/integration/webhooks/configuration/webhooks

  • Write

    Create an OAuth2 client credentials auth method

    Create a new OAuth2 client credentials auth method for the Webhooks integration. The `client_secret` is stored securely and never returned.

    POST /api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials

  • Write

    Update an OAuth2 client credentials auth method

    Update an existing OAuth2 client credentials auth method.

    PATCH /api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}

  • Destructive

    Delete a custom variable

    Deletes the endpoint with the name `<CUSTOM_VARIABLE_NAME>`.

    DELETE /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}

  • Destructive

    Update a custom variable

    Updates the endpoint with the name `<CUSTOM_VARIABLE_NAME>`.

    PUT /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}

  • Destructive

    Delete a webhook

    Deletes the endpoint with the name `<WEBHOOK NAME>`. This action cannot be undone.

    DELETE /api/v1/integration/webhooks/configuration/webhooks/{webhook_name}

  • Destructive

    Update a webhook

    Updates the endpoint with the name `<WEBHOOK_NAME>`.

    PUT /api/v1/integration/webhooks/configuration/webhooks/{webhook_name}

  • Destructive

    Delete an OAuth2 client credentials auth method

    Delete an OAuth2 client credentials auth method by ID.

    DELETE /api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}

Logs

  • Read

    Search logs

    List endpoint returns logs that match a log search query. [Results are paginated][1]. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** **Note**: This endpoint is enabled by default for logs customers. To disable it, contact [Datadog support](https://docs.datadoghq.com/help/). [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives

    POST /api/v1/logs-queries/list

  • Read

    Search logs (GET)

    List endpoint returns logs that match a log search query. [Results are paginated][1]. Use this endpoint to search and filter your logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives

    GET /api/v2/logs/events

  • Read

    Search logs (POST)

    List endpoint returns logs that match a log search query. [Results are paginated][1]. Use this endpoint to search and filter your logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives

    POST /api/v2/logs/events/search

  • Write

    Send logs (deprecated)

    Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - Maximum array size if sending multiple logs in an array: 1000 entries Any log exceeding 1MB is accepted and truncated by Datadog: - For a single log request, the API truncates the log at 1MB and returns a 2xx. - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx. Datadog recommends sending your logs compressed. Add the `Content-Encoding: gzip` header to the request when sending compressed logs. The status codes answered by the HTTP API are: - 200: OK - 400: Bad request (likely an issue in the payload formatting) - 403: Permission issue (likely using an invalid API Key) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time

    POST /v1/input

  • Write

    Send logs

    Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - Maximum array size if sending multiple logs in an array: 1000 entries Any log exceeding 1MB is accepted and truncated by Datadog: - For a single log request, the API truncates the log at 1MB and returns a 2xx. - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx. Datadog recommends sending your logs compressed. Add the `Content-Encoding: gzip` header to the request when sending compressed logs. Log events can be submitted with a timestamp that is up to 18 hours in the past. The status codes answered by the HTTP API are: - 202: Accepted: the request has been accepted for processing - 400: Bad request (likely an issue in the payload formatting) - 401: Unauthorized (likely a missing API Key) - 403: Permission issue (likely using an invalid API Key) - 408: Request Timeout, request should be retried after some time - 413: Payload too large (batch is above 5MB uncompressed) - 429: Too Many Requests, request should be retried after some time - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time

    POST /api/v2/logs

  • Write

    Aggregate events

    The API endpoint to aggregate events into buckets and compute metrics and timeseries.

    POST /api/v2/logs/analytics/aggregate

Logs Indexes

  • Read

    Get indexes order

    Get the current order of your log indexes. This endpoint takes no JSON arguments.

    GET /api/v1/logs/config/index-order

  • Read

    Get all indexes

    The Index object describes the configuration of a log index. This endpoint returns an array of the `LogIndex` objects of your organization.

    GET /api/v1/logs/config/indexes

  • Read

    Get an index

    Get one log index from your organization. This endpoint takes no JSON arguments.

    GET /api/v1/logs/config/indexes/{name}

  • Write

    Create an index

    Creates a new index. Returns the Index object passed in the request body when the request is successful.

    POST /api/v1/logs/config/indexes

  • Destructive

    Update indexes order

    This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful.

    PUT /api/v1/logs/config/index-order

  • Destructive

    Delete an index

    Delete an existing index from your organization. Index deletions are permanent and cannot be reverted. You cannot recreate an index with the same name as deleted ones.

    DELETE /api/v1/logs/config/indexes/{name}

  • Destructive

    Update an index

    Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful. Using the `PUT` method updates your index's configuration by **replacing** your current configuration with the new one sent to your Datadog organization.

    PUT /api/v1/logs/config/indexes/{name}

Logs Pipelines

  • Read

    Get pipeline order

    Get the current order of your pipelines. This endpoint takes no JSON arguments.

    GET /api/v1/logs/config/pipeline-order

  • Read

    Get all pipelines

    Get all pipelines from your organization. This endpoint takes no JSON arguments.

    GET /api/v1/logs/config/pipelines

  • Read

    Get a pipeline

    Get a specific pipeline from your organization. This endpoint takes no JSON arguments.

    GET /api/v1/logs/config/pipelines/{pipeline_id}

  • Write

    Create a pipeline

    Create a pipeline in your organization.

    POST /api/v1/logs/config/pipelines

  • Destructive

    Update pipeline order

    Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors. **Note**: Using the `PUT` method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization.

    PUT /api/v1/logs/config/pipeline-order

  • Destructive

    Delete a pipeline

    Delete a given pipeline from your organization. This endpoint takes no JSON arguments.

    DELETE /api/v1/logs/config/pipelines/{pipeline_id}

  • Destructive

    Update a pipeline

    Update a given pipeline configuration to change it’s processors or their order. **Note**: Using this method updates your pipeline configuration by **replacing** your current configuration with the new one sent to your Datadog organization.

    PUT /api/v1/logs/config/pipelines/{pipeline_id}

Monitors

  • Read

    Get all monitors

    Get all monitors from your organization.

    GET /api/v1/monitor

  • Read

    Check if a monitor can be deleted

    Check if the given monitors can be deleted.

    GET /api/v1/monitor/can_delete

  • Read

    Monitors group search

    Search and filter your monitor groups details.

    GET /api/v1/monitor/groups/search

  • Read

    Monitors search

    Search and filter your monitors details.

    GET /api/v1/monitor/search

  • Read

    Validate a monitor

    Validate the monitor provided in the request. **Note**: Log monitors require an unscoped App Key and `logs_read_data` permission.

    POST /api/v1/monitor/validate

  • Read

    Get a monitor's details

    Get details about the specified monitor from your organization.

    GET /api/v1/monitor/{monitor_id}

  • Read

    Validate an existing monitor

    Validate the monitor provided in the request. **Note**: Log monitors require an unscoped App Key and `logs_read_data` permission.

    POST /api/v1/monitor/{monitor_id}/validate

  • Read

    Get all monitor notification rules

    Returns a list of all monitor notification rules.

    GET /api/v2/monitor/notification_rule

  • Read

    Get a monitor notification rule

    Returns a monitor notification rule by `rule_id`.

    GET /api/v2/monitor/notification_rule/{rule_id}

  • Read

    Get all monitor configuration policies

    Get all monitor configuration policies.

    GET /api/v2/monitor/policy

  • Read

    Get a monitor configuration policy

    Get a monitor configuration policy by `policy_id`.

    GET /api/v2/monitor/policy/{policy_id}

  • Read

    Get all monitor user templates

    Retrieve all monitor user templates.

    GET /api/v2/monitor/template

  • Read

    Validate a monitor user template

    Validate the structure and content of a monitor user template.

    POST /api/v2/monitor/template/validate

  • Read

    Get a monitor user template

    Retrieve a monitor user template by its ID.

    GET /api/v2/monitor/template/{template_id}

  • Read

    Validate an existing monitor user template

    Validate the structure and content of an existing monitor user template being updated to a new version.

    POST /api/v2/monitor/template/{template_id}/validate

  • Write

    Create a monitor

    Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: `query alert` - APM: `query alert` or `trace-analytics alert` - composite: `composite` - custom: `service check` - forecast: `query alert` - host: `service check` - integration: `query alert` or `service check` - live process: `process alert` - logs: `log alert` - metric: `query alert` - network: `service check` - outlier: `query alert` - process: `service check` - rum: `rum alert` - SLO: `slo alert` - watchdog: `event-v2 alert` - event-v2: `event-v2 alert` - audit: `audit alert` - error-tracking: `error-tracking alert` - database-monitoring: `database-monitoring alert` - network-performance: `network-performance alert` - cloud cost: `cost alert` - network-path: `network-path alert` **Notes**: - Synthetic monitors are created through the Synthetics API. See the [Synthetics API](https://docs.datadoghq.com/api/latest/synthetics/) documentation for more information. - Log monitors require an unscoped App Key. #### Query Types ##### Metric Alert Query Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` - `time_aggr`: avg, sum, max, min, change, or pct_change - `time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type) or `last_1d`, or `last_1w` - `space_aggr`: avg, sum, min, or max - `tags`: one or more tags (comma-separated), or * - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - `operator`: <, <=, >, >=, ==, or != - `#`: an integer or decimal number used to set the threshold To use a dynamic threshold on a metric monitor with a formula query, replace `#` with the `threshold` keyword (for example, `... > threshold`) and provide the threshold as a query via `critical_query` on `options.thresholds`. This feature is in preview. If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator #` with: - `change_aggr` change, pct_change - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions) - `time_window` last\_#m (between 1 and 2880 depending on the monitor type), last\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: `avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0` ##### Service Check Query Example: `"check".over(tags).last(count).by(group).count_by_status()` - `check` name of the check, for example `datadog.agent.up` - `tags` one or more quoted tags (comma-separated), or "*". for example: `.over("env:prod", "role:db")`; `over` cannot be blank. - `count` must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3. - `group` must be specified for check monitors. Per-check grouping is already explicitly known for some service checks. For example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information. ##### Event Alert Query **Note:** The Event Alert Query has been replaced by the Event V2 Alert Query. For more information, see the [Event Migration guide](https://docs.datadoghq.com/service_management/events/guides/migrating_to_new_events_features/). ##### Event V2 Alert Query Example: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### Process Alert Query Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` - `search` free text search string for querying processes. Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. - `tags` one or more tags (comma-separated) - `timeframe` the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - `operator` <, <=, >, >=, ==, or != - `#` an integer or decimal number used to set the threshold ##### Logs Alert Query Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `index_name` For multi-index organizations, the log index in which the request is performed. - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### Composite Query Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors * `name` [*required*, *default* = **dynamic, based on query**]: The name of the alert. * `message` [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. * `tags` [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI. ##### SLO Alert Query Example: `error_budget("slo_id").over("time_window") operator #` - `slo_id`: The alphanumeric SLO ID of the SLO you are configuring the alert for. - `time_window`: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`. - `operator`: `>=` or `>` ##### Audit Alert Query Example: `audits(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### CI Pipelines Alert Query Example: `ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### CI Tests Alert Query Example: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. ##### Error Tracking Alert Query "New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #` "High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `issue_source` The issue source - supports `all`, `browser`, `mobile` and `backend` and defaults to `all` if omitted. - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality` and defaults to `count` if omitted. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `group by` Comma-separated list of attributes to group by - should contain at least `issue.id`. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. **Database Monitoring Alert Query** Example: `database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. **Network Performance Alert Query** Example: `network-performance(query).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. **Cost Alert Query** Example: `formula(query).timeframe_type(time_window).function(parameter) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `timeframe_type` The timeframe type to evaluate the cost - for `forecast` supports `current` - for `change`, `anomaly`, `threshold` supports `last` - `time_window` - supports daily roll-up e.g. `7d` - `function` - [optional, defaults to `threshold` monitor if omitted] supports `change`, `anomaly`, `forecast` - `parameter` Specify the parameter of the type - for `change`: - supports `relative`, `absolute` - [optional] supports `#`, where `#` is an integer or decimal number used to set the threshold - for `anomaly`: - supports `direction=both`, `direction=above`, `direction=below` - [optional] supports `threshold=#`, where `#` is an integer or decimal number used to set the threshold - `operator` - for `threshold` supports `<`, `<=`, `>`, `>=`, `==`, or `!=` - for `change` supports `>`, `<` - for `anomaly` supports `>=` - for `forecast` supports `>` - `#` an integer or decimal number used to set the threshold. **Network Path Alert Query** Example: `network-path(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - `index_name` The data type to monitor on - supports `netpath-path` and `netpath-hop`. - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold.

    POST /api/v1/monitor

  • Write

    Create a monitor notification rule

    Creates a monitor notification rule.

    POST /api/v2/monitor/notification_rule

  • Write

    Update a monitor notification rule

    Updates a monitor notification rule by `rule_id`.

    PATCH /api/v2/monitor/notification_rule/{rule_id}

  • Write

    Create a monitor configuration policy

    Create a monitor configuration policy.

    POST /api/v2/monitor/policy

  • Write

    Edit a monitor configuration policy

    Edit a monitor configuration policy.

    PATCH /api/v2/monitor/policy/{policy_id}

  • Write

    Create a monitor user template

    Create a new monitor user template.

    POST /api/v2/monitor/template

  • Destructive

    Delete a monitor

    Delete the specified monitor

    DELETE /api/v1/monitor/{monitor_id}

  • Destructive

    Edit a monitor

    Edit the specified monitor.

    PUT /api/v1/monitor/{monitor_id}

  • Destructive

    Delete a monitor notification rule

    Deletes a monitor notification rule by `rule_id`.

    DELETE /api/v2/monitor/notification_rule/{rule_id}

  • Destructive

    Delete a monitor configuration policy

    Delete a monitor configuration policy.

    DELETE /api/v2/monitor/policy/{policy_id}

  • Destructive

    Delete a monitor user template

    Delete an existing monitor user template by its ID.

    DELETE /api/v2/monitor/template/{template_id}

  • Destructive

    Update a monitor user template to a new version

    Creates a new version of an existing monitor user template.

    PUT /api/v2/monitor/template/{template_id}

Notebooks

  • Read

    Get all notebooks

    Get all notebooks. This can also be used to search for notebooks with a particular `query` in the notebook `name` or author `handle`.

    GET /api/v1/notebooks

  • Read

    Get a notebook

    Get a notebook using the specified notebook ID.

    GET /api/v1/notebooks/{notebook_id}

  • Write

    Create a notebook

    Create a notebook using the specified options.

    POST /api/v1/notebooks

  • Destructive

    Delete a notebook

    Delete a notebook using the specified ID.

    DELETE /api/v1/notebooks/{notebook_id}

  • Destructive

    Update a notebook

    Update a notebook using the specified ID.

    PUT /api/v1/notebooks/{notebook_id}

Organizations

  • Read

    List your managed organizations

    This endpoint returns data on your top-level organization.

    GET /api/v1/org

  • Read

    Get organization information

    Get organization information.

    GET /api/v1/org/{public_id}

  • Read

    List global orgs

    Returns organizations across regions for the authenticated user. The `user_handle` query parameter must match the authenticated user's handle.

    GET /api/v2/global_orgs

  • Read

    List your managed organizations

    Returns the current organization and its managed organizations in JSON:API format.

    GET /api/v2/org

  • Read

    List Org Configs

    Returns all Org Configs (name, description, and value).

    GET /api/v2/org_configs

  • Read

    Get a specific Org Config value

    Return the name, description, and value of a specific Org Config.

    GET /api/v2/org_configs/{org_config_name}

  • Read

    List SAML configurations

    Get the list of SAML configurations for the current organization. An organization has at most one SAML configuration.

    GET /api/v2/saml_configurations

  • Read

    Get a SAML configuration

    Get a single SAML configuration for the current organization by its UUID.

    GET /api/v2/saml_configurations/{saml_config_uuid}

  • Write

    Create a child organization

    Create a child organization. This endpoint requires the [multi-organization account](https://docs.datadoghq.com/account_management/multi_organization/) feature and must be enabled by [contacting support](https://docs.datadoghq.com/help/). Once a new child organization is created, you can interact with it by using the `org.public_id`, `api_key.key`, and `application_key.hash` provided in the response.

    POST /api/v1/org

  • Write

    Upload IdP metadata

    There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP. * **Multipart Form-Data**: Post the IdP metadata file using a form post. * **XML Body:** Post the IdP metadata file as the body of the request.

    POST /api/v1/org/{public_id}/idp_metadata

  • Write

    Update organization SAML preferences

    Update the SAML preferences for the current organization. Use this endpoint to set the just-in-time (JIT) provisioning domains and the default role assigned to just-in-time provisioned users.

    PATCH /api/v2/org/saml_configurations

  • Write

    Update a specific Org Config

    Update the value of a specific Org Config.

    PATCH /api/v2/org_configs/{org_config_name}

  • Write

    Update a SAML configuration

    Update a single SAML configuration for the current organization. Use this endpoint to enable or disable identity-provider-initiated login, set the just-in-time provisioning domains, and set the default role assigned to just-in-time provisioned users. A default role is required to enable just-in-time provisioning.

    PATCH /api/v2/saml_configurations/{saml_config_uuid}

  • Destructive

    Update your organization

    Update your organization.

    PUT /api/v1/org/{public_id}

  • Destructive

    Spin-off Child Organization

    Only available for MSP customers. Removes a child organization from the hierarchy of the master organization and places the child organization on a 30-day trial.

    POST /api/v1/org/{public_id}/downgrade

  • Destructive

    Update the maximum session duration

    Update the maximum session duration for the current organization. The duration is specified in seconds.

    PUT /api/v2/login/org_configs/max_session_duration

  • Destructive

    Upload IdP metadata

    Endpoint for uploading IdP metadata for SAML setup. Use this endpoint to upload or replace IdP metadata for SAML login configuration.

    POST /api/v2/saml_configurations/idp_metadata

Security Monitoring

  • Read

    Get a custom framework

    Get a custom framework.

    GET /api/v2/cloud_security_management/custom_frameworks/{handle}/{version}

  • Read

    List resource filters

    List resource filters.

    GET /api/v2/cloud_security_management/resource_filters

  • Read

    List findings

    Get a list of findings. These include both misconfigurations and identity risks. **Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem` ### Filtering Filters can be applied by appending query parameters to the URL. - Using a single filter: `?filter[attribute_key]=attribute_value` - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...` - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2` Here, `attribute_key` can be any of the filter keys described further below. Query parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`. You can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources. The operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`. Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed. ### Additional extension fields Additional extension fields are available for some findings. The data is available when you include the query parameter `?detailed_findings=true` in the request. The following fields are available for findings: - `external_id`: The resource external ID related to the finding. - `description`: The description and remediation steps for the finding. - `datadog_link`: The Datadog relative link for the finding. - `ip_addresses`: The list of private IP addresses for the resource related to the finding. ### Response The response includes an array of finding objects, pagination metadata, and a count of items that match the query. Each finding object contains the following: - The finding ID that can be used in a `GetFinding` request to retrieve the full finding details. - Core attributes, including status, evaluation, high-level resource details, muted state, and rule details. - `evaluation_changed_at` and `resource_discovery_date` time stamps. - An array of associated tags.

    GET /api/v2/posture_management/findings

  • Read

    Get a finding

    Returns a single finding with message and resource configuration.

    GET /api/v2/posture_management/findings/{finding_id}

  • Read

    List security findings

    Get a list of security findings that match a search query. [See the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/). ### Query Syntax This endpoint uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix. Example: `@severity:(critical OR high) @status:open team:platform`

    GET /api/v2/security/findings

  • Read

    Get all default inbox rules

    Get all default inbox rules for the current organization. Datadog manages default inbox rules. Their name, rule, and action are read-only, and each organization can change only whether they are enabled.

    GET /api/v2/security/findings/automation/default_inbox_rules

  • Read

    Get a default inbox rule

    Get the details of a default inbox rule by ID. Datadog manages default inbox rules. Their name, rule, and action are read-only, and each organization can change only whether they are enabled.

    GET /api/v2/security/findings/automation/default_inbox_rules/{rule_id}

  • Read

    Get all due date rules

    Get all due date rules for the current organization.

    GET /api/v2/security/findings/automation/due_date_rules

  • Read

    Get a due date rule

    Get the details of a due date rule by ID.

    GET /api/v2/security/findings/automation/due_date_rules/{rule_id}

  • Read

    Get all inbox rules

    Get all inbox rules for the current organization.

    GET /api/v2/security/findings/automation/inbox_rules

  • Read

    Get an inbox rule

    Get the details of an inbox rule by ID.

    GET /api/v2/security/findings/automation/inbox_rules/{rule_id}

  • Read

    Get all mute rules

    Get all mute rules for the current organization.

    GET /api/v2/security/findings/automation/mute_rules

  • Read

    Get a mute rule

    Get the details of a mute rule by ID.

    GET /api/v2/security/findings/automation/mute_rules/{rule_id}

  • Read

    Get all severity modifier rules

    Get all severity modifier rules for the current organization.

    GET /api/v2/security/findings/automation/severity_modifier_rules

  • Read

    Get a severity modifier rule

    Get the details of a severity modifier rule by ID.

    GET /api/v2/security/findings/automation/severity_modifier_rules/{rule_id}

  • Read

    Get all ticket creation rules

    Get all ticket creation rules for the current organization.

    GET /api/v2/security/findings/automation/ticket_creation_rules

  • Read

    Get a ticket creation rule

    Get the details of a ticket creation rule by ID.

    GET /api/v2/security/findings/automation/ticket_creation_rules/{rule_id}

  • Read

    Search security findings

    Get a list of security findings that match a search query. [See the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/). ### Query Syntax The API uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix. Example: `@severity:(critical OR high) @status:open team:platform`

    POST /api/v2/security/findings/search

  • Read

    List assets SBOMs

    Get a list of assets SBOMs for an organization. The `filter[asset_type]` parameter is required for initial requests (when no `page[token]` is provided). Subsequent pages encode the asset type in the pagination token, so `filter[asset_type]` is not required for paginated requests. Mixing infrastructure asset types (`Host`, `HostImage`, `Image`, `ServerlessFunction`) with code asset types (`Repository`, `Service`) in the same request is not supported and returns a 400 error. ### Pagination Please review the [Pagination section](#pagination) for the "List Vulnerabilities" endpoint. ### Filtering Please review the [Filtering section](#filtering) for the "List Vulnerabilities" endpoint. ### Metadata Please review the [Metadata section](#metadata) for the "List Vulnerabilities" endpoint.

    GET /api/v2/security/sboms

  • Read

    Get SBOM

    Get a single SBOM related to an asset by its type and name.

    GET /api/v2/security/sboms/{asset_type}

  • Read

    List scanned assets metadata

    Get a list of security scanned assets metadata for an organization. ### Pagination For the "List Vulnerabilities" endpoint, see the [Pagination section](#pagination). ### Filtering For the "List Vulnerabilities" endpoint, see the [Filtering section](#filtering). ### Metadata For the "List Vulnerabilities" endpoint, see the [Metadata section](#metadata). ### Related endpoints This endpoint returns additional metadata for cloud resources that is not available from the standard resource endpoints. To access a richer dataset, call this endpoint together with the relevant resource endpoint(s) and merge (join) their results using the resource identifier. **Hosts** To enrich host data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields: | ENDPOINT | JOIN KEY | TYPE | | --- | --- | --- | | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.host_name | string | | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string | **Host Images** To enrich host image data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields: | ENDPOINT | JOIN KEY | TYPE | | --- | --- | --- | | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.tags_by_source["Amazon Web Services"]["image"] | string | | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string | **Container Images** To enrich container image data, join the response from the [Container Images](https://docs.datadoghq.com/api/latest/container-images/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields: | ENDPOINT | JOIN KEY | TYPE | | --- | --- | --- | | [/api/v2/container_images](https://docs.datadoghq.com/api/latest/container-images/) | `data.attributes.name`@`data.attributes.repo_digest` | string | | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string |

    GET /api/v2/security/scanned-assets-metadata

  • Read

    List indicators of compromise

    Get a list of indicators of compromise (IoCs) matching the specified filters.

    GET /api/v2/security/siem/ioc-explorer

  • Read

    Get an indicator of compromise

    Get detailed information about a specific indicator of compromise (IoC).

    GET /api/v2/security/siem/ioc-explorer/indicator

  • Read

    Get the list of signal-based notification rules

    Returns the list of notification rules for security signals.

    GET /api/v2/security/signals/notification_rules

  • Read

    Get details of a signal-based notification rule

    Get the details of a notification rule for security signals.

    GET /api/v2/security/signals/notification_rules/{id}

  • Read

    List vulnerabilities (deprecated)

    Get a list of vulnerabilities. ### Pagination Pagination is enabled by default in both `vulnerabilities` and `assets`. The size of the page varies depending on the endpoint and cannot be modified. To automate the request of the next page, you can use the links section in the response. This endpoint will return paginated responses. The pages are stored in the links section of the response: ```JSON { "data": [...], "meta": {...}, "links": { "self": "https://.../api/v2/security/vulnerabilities", "first": "https://.../api/v2/security/vulnerabilities?page[number]=1&page[token]=abc", "last": "https://.../api/v2/security/vulnerabilities?page[number]=43&page[token]=abc", "next": "https://.../api/v2/security/vulnerabilities?page[number]=2&page[token]=abc" } } ``` - `links.previous` is empty if the first page is requested. - `links.next` is empty if the last page is requested. #### Token Vulnerabilities can be created, updated or deleted at any point in time. Upon the first request, a token is created to ensure consistency across subsequent paginated requests. A token is valid only for 24 hours. #### First request We consider a request to be the first request when there is no `page[token]` parameter. The response of this first request contains the newly created token in the `links` section. This token can then be used in the subsequent paginated requests. *Note: The first request may take longer to complete than subsequent requests.* #### Subsequent requests Any request containing valid `page[token]` and `page[number]` parameters will be considered a subsequent request. If the `token` is invalid, a `404` response will be returned. If the page `number` is invalid, a `400` response will be returned. The returned `token` is valid for all requests in the pagination sequence. To send paginated requests in parallel, reuse the same `token` and change only the `page[number]` parameter. ### Filtering The request can include some filter parameters to filter the data to be retrieved. The format of the filter parameters follows the [JSON:API format](https://jsonapi.org/format/#fetching-filtering): `filter[$prop_name]`, where `prop_name` is the property name in the entity being filtered by. All filters can include multiple values, where data will be filtered with an OR clause: `filter[title]=Title1,Title2` will filter all vulnerabilities where title is equal to `Title1` OR `Title2`. String filters are case sensitive. Boolean filters accept `true` or `false` as values. Number filters must include an operator as a second filter input: `filter[$prop_name][$operator]`. For example, for the vulnerabilities endpoint: `filter[cvss.base.score][lte]=8`. Available operators are: `eq` (==), `lt` (<), `lte` (<=), `gt` (>) and `gte` (>=). ### Metadata Following [JSON:API format](https://jsonapi.org/format/#document-meta), object including non-standard meta-information. This endpoint includes the meta member in the response. For more details on each of the properties included in this section, check the endpoints response tables. ```JSON { "data": [...], "meta": { "total": 1500, "count": 18732, "token": "some_token" }, "links": {...} } ``` ### Extensions Requests may include extensions to modify the behavior of the requested endpoint. The filter parameters follow the [JSON:API format](https://jsonapi.org/extensions/#extensions) format: `ext:$extension_name`, where `extension_name` is the name of the modifier that is being applied. Extensions can only include one value: `ext:modifier=value`.

    GET /api/v2/security/vulnerabilities

  • Read

    Get the list of vulnerability notification rules

    Returns the list of notification rules for security vulnerabilities.

    GET /api/v2/security/vulnerabilities/notification_rules

  • Read

    Get details of a vulnerability notification rule

    Get the details of a notification rule for security vulnerabilities.

    GET /api/v2/security/vulnerabilities/notification_rules/{id}

  • Read

    List vulnerable assets

    Get a list of vulnerable assets. ### Pagination Please review the [Pagination section for the "List Vulnerabilities"](#pagination) endpoint. ### Filtering Please review the [Filtering section for the "List Vulnerabilities"](#filtering) endpoint. ### Metadata Please review the [Metadata section for the "List Vulnerabilities"](#metadata) endpoint.

    GET /api/v2/security/vulnerable-assets

  • Read

    List batch migrations

    List the batch migrations of your organization. A batch migration groups detection rules from another SIEM that the Datadog Detection Agent translates into Cloud SIEM detection rules. To retrieve a single batch migration, filter by its ID with `filter[query]=id:<batch_id>`. Poll this endpoint to follow the progress of a batch migration through its `status` and `resourceStatusCounts`.

    GET /api/v2/security_monitoring/batch-migrations

  • Read

    List batch migration resources

    List the resources of a batch migration, including the input of each source rule and, once translated, the proposed Cloud SIEM detection rule in `output`.

    GET /api/v2/security_monitoring/batch-migrations/{batch_id}/resources

  • Read

    Get all critical assets

    Get the list of all critical assets.

    GET /api/v2/security_monitoring/configuration/critical_assets

  • Read

    Get critical assets affecting a specific rule

    Get the list of critical assets that affect a specific existing rule by the rule's ID.

    GET /api/v2/security_monitoring/configuration/critical_assets/rules/{rule_id}

  • Read

    Get a critical asset

    Get the details of a specific critical asset.

    GET /api/v2/security_monitoring/configuration/critical_assets/{critical_asset_id}

  • Read

    List entity context sync configurations

    List the entity context sync configurations for Cloud SIEM. Each configuration connects Cloud SIEM to an external source that provides entities (for example, users from an identity provider) for use in signals and the entity explorer.

    GET /api/v2/security_monitoring/configuration/integration_config

  • Read

    Get Entra ID Azure App Registration prerequisites

    Get the Azure App Registrations discovered for the organization and whether at least one of them has resource collection enabled, which is a prerequisite for activating the Entra ID entity context sync integration.

    GET /api/v2/security_monitoring/configuration/integration_config/entra_id/azure_app_registrations

  • Read

    Validate entity context sync credentials

    Validate a set of credentials against the external entity source before creating a sync configuration. Returns a 200 status code if the credentials are valid.

    POST /api/v2/security_monitoring/configuration/integration_config/validate

  • Read

    Get an entity context sync configuration

    Get the details of a specific entity context sync configuration.

    GET /api/v2/security_monitoring/configuration/integration_config/{integration_config_id}

  • Read

    Validate an entity context sync configuration

    Validate the credentials currently stored on an existing entity context sync configuration. Returns a 200 status code if the credentials are still valid against the external entity source.

    POST /api/v2/security_monitoring/configuration/integration_config/{integration_config_id}/validate

  • Read

    Get all security filters

    Get the list of configured security filters with their definitions.

    GET /api/v2/security_monitoring/configuration/security_filters

  • Read

    Get the version history of security filters

    Get the configured security filters at each historical version of the configuration. Each entry in the response represents the set of all security filters at a given version, ordered from the most recent version to the oldest.

    GET /api/v2/security_monitoring/configuration/security_filters/versions

  • Read

    Get a security filter

    Get the details of a specific security filter. See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) for more examples.

    GET /api/v2/security_monitoring/configuration/security_filters/{security_filter_id}

  • Read

    Get all suppression rules

    Get the list of all suppression rules.

    GET /api/v2/security_monitoring/configuration/suppressions

  • Read

    Get suppressions affecting future rule

    Get the list of suppressions that would affect a rule.

    POST /api/v2/security_monitoring/configuration/suppressions/rules

  • Read

    Get suppressions affecting a specific rule

    Get the list of suppressions that affect a specific existing rule by its ID.

    GET /api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}

  • Read

    Validate a suppression rule

    Validate a suppression rule.

    POST /api/v2/security_monitoring/configuration/suppressions/validation

  • Read

    Get a suppression rule

    Get the details of a specific suppression rule.

    GET /api/v2/security_monitoring/configuration/suppressions/{suppression_id}

  • Read

    Get a suppression's version history

    Get a suppression's version history.

    GET /api/v2/security_monitoring/configuration/suppressions/{suppression_id}/version_history

  • Read

    Get content pack states

    Get the activation state, integration status, and log collection status for all Cloud SIEM content packs.

    GET /api/v2/security_monitoring/content_packs/states

  • Read

    List datasets

    List all Cloud SIEM datasets available to the organization, including both customer-defined datasets and Datadog out-of-the-box datasets.

    GET /api/v2/security_monitoring/datasets

  • Read

    Get dataset dependencies

    Return, for each of the requested datasets, the list of detection rules that depend on it. Useful for understanding the impact of updating or deleting a dataset.

    POST /api/v2/security_monitoring/datasets/dependencies

  • Read

    Get a dataset

    Get the current version of a Cloud SIEM dataset by ID.

    GET /api/v2/security_monitoring/datasets/{dataset_id}

  • Read

    Get a dataset at a specific version

    Retrieve a specific historical version of a Cloud SIEM dataset.

    GET /api/v2/security_monitoring/datasets/{dataset_id}/version/{version}

  • Read

    Get the version history of a dataset

    Retrieve the version history of a Cloud SIEM dataset, including the changes made at each version.

    GET /api/v2/security_monitoring/datasets/{dataset_id}/version_history

  • Read

    Get entity context

    Search the Cloud SIEM entity context store for entities that match a query, and return the historical revisions of each entity in the requested time range. The endpoint can either return revisions across an interval (`from` / `to`) or the snapshot of each entity at a single point in time (`as_of`); the two modes are mutually exclusive.

    GET /api/v2/security_monitoring/entity_context

  • Read

    Get recently updated entity context

    Get the entities with the most recent updates in the Cloud SIEM entity context store. Entities are ranked by the time of their most recent revision in the requested time range, and the top `limit` entities are returned in that order. This endpoint is not paginated.

    GET /api/v2/security_monitoring/entity_context/recently_updated

  • Read

    Get a single entity context

    Get a single entity from the Cloud SIEM entity context store by its identifier, returning the historical revisions of the entity in the requested time range. The endpoint can either return revisions across an interval (`from` / `to`) or the snapshot of the entity at a single point in time (`as_of`); the two modes are mutually exclusive.

    GET /api/v2/security_monitoring/entity_context/{id}

  • Read

    Get signals matching an event

    Returns the list of security signals that match a given event on the given track.

    GET /api/v2/security_monitoring/events/{event_id}/matching_signals

  • Read

    List rules

    List rules.

    GET /api/v2/security_monitoring/rules

  • Read

    Get a rule proposal

    Get the status of a rule proposal started with the start-a-rule-proposal endpoint. While the status is `pending` or `in_progress`, the proposed rule is still being generated. Poll this endpoint again later. If the status is `completed`, the response's `rule` field contains the proposed Cloud SIEM detection rule. If the status is `failed`, the response's `error` field contains the reason a rule could not be generated. This endpoint does not create or modify any detection rules in Cloud SIEM. To create the proposed rule, use the create-a-detection-rule endpoint.

    GET /api/v2/security_monitoring/rules/proposals/{proposal_id}

  • Read

    Validate a detection rule

    Validate a detection rule.

    POST /api/v2/security_monitoring/rules/validation

  • Read

    Get a rule's details

    Get a rule's details.

    GET /api/v2/security_monitoring/rules/{rule_id}

  • Read

    Convert an existing rule from JSON to Terraform

    Convert an existing rule from JSON to Terraform for Datadog provider resource `datadog_security_monitoring_rule`. You can do so for the following rule types: - App and API Protection - Cloud SIEM (log detection and signal correlation) - Workload Protection You can convert Cloud Security configuration rules using Terraform's [Datadog Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).

    GET /api/v2/security_monitoring/rules/{rule_id}/convert

  • Read

    Get a rule's version history

    Get a rule's version history.

    GET /api/v2/security_monitoring/rules/{rule_id}/version_history

  • Read

    Get sample log generation subscriptions

    Get the sample log generation subscriptions for the organization. Sample log generation injects representative example logs for a given Cloud SIEM content pack into the Logs platform, which can be used to test detection rules without onboarding the underlying integration first. **Availability**: this endpoint is restricted to Cloud SIEM trial organizations on an eligible pricing model. Other organizations receive a `403 Forbidden` (non-trial orgs) or a `400 Bad Request` (feature disabled), and legacy pricing tiers receive a response with `status: not_available`.

    GET /api/v2/security_monitoring/sample_log_generation/subscriptions

  • Read

    Get a quick list of security signals

    The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals.

    GET /api/v2/security_monitoring/signals

  • Read

    Get a list of security signals

    Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing security signals.

    POST /api/v2/security_monitoring/signals/search

  • Read

    Get a signal's details

    Get a signal's details.

    GET /api/v2/security_monitoring/signals/{signal_id}

  • Read

    Get entities related to a signal

    Get the list of entities related to a security signal, captured at the signal's timestamp.

    GET /api/v2/security_monitoring/signals/{signal_id}/entities

  • Read

    Get investigation queries for a signal

    Get the list of investigation log queries available for a given security signal.

    GET /api/v2/security_monitoring/signals/{signal_id}/investigation_queries

  • Read

    Get suggested actions for a signal

    Get the list of suggested actions for a given security signal.

    GET /api/v2/security_monitoring/signals/{signal_id}/suggested_actions

  • Read

    Export security monitoring resources to Terraform

    Export multiple security monitoring resources to Terraform, packaged as a zip archive. The `resource_type` path parameter specifies the type of resources to export and must be one of `suppressions`, `critical_assets`, `security_filters`, or `rules`. A maximum of 1000 resources can be exported in a single request. For `rules`, partner rules cannot be exported and return a 400 error.

    POST /api/v2/security_monitoring/terraform/{resource_type}/bulk

  • Read

    Export security monitoring resource to Terraform

    Export a security monitoring resource to a Terraform configuration. The `resource_type` path parameter specifies the type of resource to export and must be one of `suppressions`, `critical_assets`, `security_filters`, or `rules`. For `rules`, partner rules cannot be exported and return a 400 error.

    GET /api/v2/security_monitoring/terraform/{resource_type}/{resource_id}

  • Read

    List hist signals

    List hist signals.

    GET /api/v2/siem-historical-detections/histsignals

  • Read

    Search hist signals

    Search hist signals.

    POST /api/v2/siem-historical-detections/histsignals/search

  • Read

    Get a hist signal's details

    Get a hist signal's details.

    GET /api/v2/siem-historical-detections/histsignals/{histsignal_id}

  • Read

    List historical jobs

    List historical jobs.

    GET /api/v2/siem-historical-detections/jobs

  • Read

    Get a job's details

    Get a job's details.

    GET /api/v2/siem-historical-detections/jobs/{job_id}

  • Read

    Get a job's hist signals

    Get a job's hist signals.

    GET /api/v2/siem-historical-detections/jobs/{job_id}/histsignals

  • Read

    List codegen rulesets

    Get the rulesets relevant for code generation for the authenticated user.

    GET /api/v2/static-analysis/codegen/rulesets

  • Read

    Get default rulesets for a language

    Get the default SAST ruleset names for a given programming language.

    GET /api/v2/static-analysis/default-rulesets/{language}

  • Read

    Ruleset get multiple

    Get rules for multiple rulesets in batch.

    POST /api/v2/static-analysis/rulesets

  • Read

    Get a SAST ruleset

    Get a SAST ruleset by name, including all its rules.

    GET /api/v2/static-analysis/rulesets/{ruleset_name}

  • Read

    Returns a list of Secrets rules

    Returns a list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID.

    GET /api/v2/static-analysis/secrets/rules

  • Read

    Get AST for source code

    Parse source code into an abstract syntax tree (AST) for the specified language.

    POST /api/v2/static-analysis/static-analysis-server/get-ast

  • Read

    Get node types for a language

    Retrieve tree-sitter node type definitions for a given programming language.

    GET /api/v2/static-analysis/static-analysis-server/node-types/{language}

  • Read

    Get tree-sitter WASM file

    Download the WebAssembly binary for a tree-sitter grammar by file name.

    GET /api/v2/static-analysis/static-analysis-server/tree-sitter-wasm/{file}

  • Write

    Add a security signal to an incident

    Add a security signal to an incident. This makes it possible to search for signals by incident within the signal explorer and to view the signals on the incident timeline.

    PATCH /api/v1/security_analytics/signals/{signal_id}/add_to_incident

  • Write

    Modify the triage assignee of a security signal (deprecated)

    This endpoint is deprecated - Modify the triage assignee of a security signal.

    PATCH /api/v1/security_analytics/signals/{signal_id}/assignee

  • Write

    Change the triage state of a security signal (deprecated)

    This endpoint is deprecated - Change the triage state of a security signal.

    PATCH /api/v1/security_analytics/signals/{signal_id}/state

  • Write

    Create a custom framework

    Create a custom framework.

    POST /api/v2/cloud_security_management/custom_frameworks

  • Write

    Assign or unassign security findings

    Assign or unassign security findings. You can assign up to 100 security findings per request. Set `assignee_id` to the unique identifier of the Datadog user you want to assign the findings to. Omit `assignee_id` (or set it to `null`) to unassign the findings. Per-finding warnings and failures are returned in the response `meta` object.

    PATCH /api/v2/security/findings/assignee

  • Write

    Disable a default inbox rule

    Disable a default inbox rule for the current organization.

    POST /api/v2/security/findings/automation/default_inbox_rules/{rule_id}/disable

  • Write

    Enable a default inbox rule

    Enable a default inbox rule for the current organization.

    POST /api/v2/security/findings/automation/default_inbox_rules/{rule_id}/enable

  • Write

    Create a due date rule

    Create a due date rule for the current organization.

    POST /api/v2/security/findings/automation/due_date_rules

  • Write

    Reorder due date rules

    Reorder the list of due date rules for the current organization.

    POST /api/v2/security/findings/automation/due_date_rules/reorder

  • Write

    Create an inbox rule

    Create an inbox rule for the current organization.

    POST /api/v2/security/findings/automation/inbox_rules

  • Write

    Reorder inbox rules

    Reorder the list of inbox rules for the current organization.

    POST /api/v2/security/findings/automation/inbox_rules/reorder

  • Write

    Create a mute rule

    Create a mute rule for the current organization.

    POST /api/v2/security/findings/automation/mute_rules

  • Write

    Reorder mute rules

    Reorder the list of mute rules for the current organization.

    POST /api/v2/security/findings/automation/mute_rules/reorder

  • Write

    Create a severity modifier rule

    Create a severity modifier rule for the current organization.

    POST /api/v2/security/findings/automation/severity_modifier_rules

  • Write

    Reorder severity modifier rules

    Reorder the list of severity modifier rules for the current organization.

    POST /api/v2/security/findings/automation/severity_modifier_rules/reorder

  • Write

    Create a ticket creation rule

    Create a ticket creation rule for the current organization.

    POST /api/v2/security/findings/automation/ticket_creation_rules

  • Write

    Reorder ticket creation rules

    Reorder the list of ticket creation rules for the current organization.

    POST /api/v2/security/findings/automation/ticket_creation_rules/reorder

  • Write

    Create cases for security findings

    Create cases for security findings. You can create up to 50 cases per request and associate up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the newly created case.

    POST /api/v2/security/findings/cases

  • Write

    Attach security findings to a case

    Attach security findings to a case. You can attach up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the specified case.

    PATCH /api/v2/security/findings/cases/{case_id}

  • Write

    Attach security findings to a Jira issue

    Attach security findings to a Jira issue by providing the Jira issue URL. You can attach up to 50 security findings per Jira issue. If the Jira issue is not linked to any case, this operation will create a case for the security findings and link the Jira issue to the newly created case. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the specified Jira issue.

    PATCH /api/v2/security/findings/jira_issues

  • Write

    Create Jira issues for security findings

    Create Jira issues for security findings. This operation creates a case in Datadog and a Jira issue linked to that case for bidirectional sync between Datadog and Jira. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). You can create up to 50 Jira issues per request and associate up to 50 security findings per Jira issue. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the newly created Jira issue.

    POST /api/v2/security/findings/jira_issues

  • Write

    Attach security findings to a Linear issue

    Attach security findings to a Linear issue by providing the Linear issue URL. You can attach up to 50 security findings per Linear issue. If the Linear issue is not linked to any case, this operation will create a case for the security findings and link the Linear issue to the newly created case. Security findings that are already attached to another Linear issue will be detached from their previous Linear issue and attached to the specified Linear issue.

    PATCH /api/v2/security/findings/linear_issues

  • Write

    Create Linear issues for security findings

    Create Linear issues for security findings. This operation creates a case in Datadog and a Linear issue linked to that case for bidirectional sync between Datadog and Linear. You can create up to 50 Linear issues per request and associate up to 50 security findings per Linear issue. Security findings that are already attached to another Linear issue will be detached from their previous Linear issue and attached to the newly created Linear issue.

    POST /api/v2/security/findings/linear_issues

  • Write

    Mute or unmute security findings

    Mute or unmute security findings. You can mute or unmute up to 100 security findings per request. The request body must include `is_muted` and `reason` attributes. The allowed reasons depend on whether the finding is being muted or unmuted: - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `OTHER`, `NO_FIX`, `DUPLICATE`, `RISK_ACCEPTED`. - To unmute a finding: `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`, `OTHER`.

    PATCH /api/v2/security/findings/mute

  • Write

    Attach security findings to a ServiceNow ticket

    Attach security findings to a ServiceNow ticket by providing the ServiceNow ticket URL. You can attach up to 50 security findings per ServiceNow ticket. If the ServiceNow ticket is not linked to any case, this operation will create a case for the security findings and link the ServiceNow ticket to the newly created case. Security findings that are already attached to another ServiceNow ticket will be detached from their previous ServiceNow ticket and attached to the specified ServiceNow ticket.

    PATCH /api/v2/security/findings/servicenow_tickets

  • Write

    Create ServiceNow tickets for security findings

    Create ServiceNow tickets for security findings. This operation creates a case in Datadog and a ServiceNow ticket linked to that case for bidirectional sync between Datadog and ServiceNow. You can create up to 50 ServiceNow tickets per request and associate up to 50 security findings per ServiceNow ticket. Security findings that are already attached to another ServiceNow ticket will be detached from their previous ServiceNow ticket and attached to the newly created ServiceNow ticket.

    POST /api/v2/security/findings/servicenow_tickets

  • Write

    Create or update an indicator triage state

    Set the triage state of an indicator of compromise (IoC). This creates or updates the triage state for the indicator in your organization.

    POST /api/v2/security/siem/ioc-explorer/triage

  • Write

    Create a new signal-based notification rule

    Create a new notification rule for security signals and return the created rule.

    POST /api/v2/security/signals/notification_rules

  • Write

    Patch a signal-based notification rule

    Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated.

    PATCH /api/v2/security/signals/notification_rules/{id}

  • Write

    Import security vulnerabilities

    Import security vulnerabilities from an external scanner in CycloneDX 1.5 format. The payload is validated against the CycloneDX 1.5 JSON schema and the following additional constraints: - `metadata`, `metadata.component`, and `metadata.component.name` are required. - `metadata.tools.components` must contain exactly one element with a `name` field. - `components` cannot be empty. Each component requires `bom-ref`, `type`, `name`, and `version`. - When `type` is `library`, `purl` is required and must be a valid PURL. - When `type` is `operating-system`, `name` must be one of the supported OS values: `alma`, `alpine`, `amazon`, `azurelinux`, `bottlerocket`, `cbl-mariner`, `chainguard`, `centos`, `debian`, `fedora`, `opensuse`, `opensuse-leap`, `opensuse-tumbleweed`, `oracle`, `photon`, `redhat`, `rocky`, `slem`, `sles`, `ubuntu`, `wolfi`, `windows`, `macos`. - `vulnerabilities` cannot be empty. Each vulnerability requires `id`, exactly one `ratings` entry, and at least one `affects` entry. - Each `affects[].ref` must match a `bom-ref` value in `components`.

    POST /api/v2/security/vulnerabilities

  • Write

    Create a new vulnerability-based notification rule

    Create a new notification rule for security vulnerabilities and return the created rule.

    POST /api/v2/security/vulnerabilities/notification_rules

  • Write

    Patch a vulnerability-based notification rule

    Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated.

    PATCH /api/v2/security/vulnerabilities/notification_rules/{id}

  • Write

    Create a batch migration

    Create a batch migration in the `draft` status, together with 1 to 100 initial resources. Each resource holds one source rule to translate into a Cloud SIEM detection rule. To load more rules, add them with the add resources endpoint before starting the batch migration. A batch migration can hold up to 1000 resources. The response does not include the created resources: list the resources of the batch migration to retrieve them. Alternatively, use the start-a-rule-proposal endpoint to get a single proposed rule.

    POST /api/v2/security_monitoring/batch-migrations

  • Write

    Publish a batch migration

    Create a Cloud SIEM detection rule from the `output` of each selected `completed` resource of a batch migration. Completed resources can be published while the rest of the batch migration is still being translated. When `resourceIds` is omitted or empty, every `completed` resource is published. Published rules are created disabled. Every requested resource must be publishable: `completed`, or left in `publishing` for more than one minute after an uncertain result. Otherwise, the request returns `409 Conflict` and nothing is published. Already published resources are not publishable. The response reports the outcome of each resource, and some resources can be published while others fail. A `failed` result that contains a `ruleId` means the rule was created: do not retry that resource. Publishing a rule with a `block_ip` or `block_user` action requires the `appsec_protect_write` permission.

    POST /api/v2/security_monitoring/batch-migrations/{batch_id}/publish

  • Write

    Add resources to a batch migration

    Add 1 to 1000 resources to a `draft` batch migration. Returns `409 Conflict` if the batch migration is not `draft`, and `400 Bad Request` if the batch migration would contain more than 1000 resources.

    POST /api/v2/security_monitoring/batch-migrations/{batch_id}/resources

  • Write

    Update a batch migration resource

    Update a resource of a batch migration. At least one of `name`, `description`, `inputType`, or `input` must be provided. `name` and `description` can be updated at any time. `inputType` and `input` can only be updated while the resource is `pending`; otherwise, the request returns `409 Conflict`. The translated `output` cannot be edited.

    PATCH /api/v2/security_monitoring/batch-migrations/{batch_id}/resources/{resource_id}

  • Write

    Start a batch migration

    Start translating the `pending` resources of a `draft` batch migration into Cloud SIEM detection rules. The batch migration moves to `in_progress`, and its resources are translated asynchronously. Once no resource is `pending` or `in_progress`, the batch migration moves to `completed`. Starting an `in_progress` batch migration again does not queue duplicate work, so the request can be safely retried, including after a timeout or a `5xx` error. Returns `409 Conflict` if the batch migration is `completed` or `canceled`. An organization can translate up to 2000 resources in total across all of its batch migrations. Resources that were already processed count toward this limit even after they are deleted, and `pending` resources of `in_progress` batch migrations reserve capacity. Returns `409 Conflict` if starting the batch migration would exceed this limit. To request a higher limit for your organization, contact [Datadog support](https://docs.datadoghq.com/help/).

    POST /api/v2/security_monitoring/batch-migrations/{batch_id}/start

  • Write

    Create a critical asset

    Create a new critical asset.

    POST /api/v2/security_monitoring/configuration/critical_assets

  • Write

    Update a critical asset

    Update a specific critical asset.

    PATCH /api/v2/security_monitoring/configuration/critical_assets/{critical_asset_id}

  • Write

    Create an entity context sync configuration

    Create a new entity context sync configuration so Cloud SIEM can ingest entities from an external source. The credentials provided in `secrets` are validated against the source before the configuration is stored and never returned in subsequent responses.

    POST /api/v2/security_monitoring/configuration/integration_config

  • Write

    Update an entity context sync configuration

    Update an existing entity context sync configuration. Supports partial updates; only the fields provided in the request body are modified.

    PATCH /api/v2/security_monitoring/configuration/integration_config/{integration_config_id}

  • Write

    Activate an entity context sync integration

    Activate an entity context sync integration for a source type that does not require manually supplied credentials (for example, Entra ID). If an integration of this type already exists, it is returned (re-enabling it first if it was disabled) instead of creating a duplicate.

    POST /api/v2/security_monitoring/configuration/integration_config/{integration_type}/activate

  • Write

    Deactivate an entity context sync integration

    Deactivate all active entity context sync integrations of the given source type (for example, Entra ID).

    POST /api/v2/security_monitoring/configuration/integration_config/{integration_type}/deactivate

  • Write

    Test a notification rule

    Send a notification preview to test that a notification rule's targets are properly configured.

    POST /api/v2/security_monitoring/configuration/notification_rules/send_notification_preview

  • Write

    Create a security filter

    Create a security filter. See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) for more examples.

    POST /api/v2/security_monitoring/configuration/security_filters

  • Write

    Update a security filter

    Update a specific security filter. Returns the security filter object when the request is successful.

    PATCH /api/v2/security_monitoring/configuration/security_filters/{security_filter_id}

  • Write

    Create a suppression rule

    Create a new suppression rule.

    POST /api/v2/security_monitoring/configuration/suppressions

  • Write

    Create a dataset

    Create a new Cloud SIEM dataset. A dataset bundles a data source, a set of indexes, and a search query that can be referenced from detection rules.

    POST /api/v2/security_monitoring/datasets

  • Write

    Update a dataset

    Update an existing Cloud SIEM dataset. The current version of the dataset can be provided to detect concurrent modifications.

    PATCH /api/v2/security_monitoring/datasets/{dataset_id}

  • Write

    Create a detection rule

    Create a detection rule.

    POST /api/v2/security_monitoring/rules

  • Write

    Bulk export security monitoring rules

    Export a list of security monitoring rules as a ZIP file containing JSON rule definitions. The endpoint accepts a list of rule IDs and returns a ZIP archive where each rule is saved as a separate JSON file named after the rule.

    POST /api/v2/security_monitoring/rules/bulk_export

  • Write

    Convert a rule from JSON to Terraform

    Convert a rule that doesn't (yet) exist from JSON to Terraform for Datadog provider resource `datadog_security_monitoring_rule`. You can do so for the following rule types: - App and API Protection - Cloud SIEM (log detection and signal correlation) - Workload Protection You can convert Cloud Security configuration rules using Terraform's [Datadog Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).

    POST /api/v2/security_monitoring/rules/convert

  • Write

    Bulk convert rules to Terraform

    Convert a list of existing security monitoring rules to Terraform for the Datadog provider resource `datadog_security_monitoring_rule`. Returns a ZIP archive containing one Terraform file per rule. You can convert rules for the following types: - App and API Protection - Cloud SIEM (log detection and signal correlation) - Workload Protection

    POST /api/v2/security_monitoring/rules/convert/bulk

  • Write

    Start a rule proposal

    Start generating a proposed Cloud SIEM detection rule from a natural-language description, or from an SPL or KQL rule. The proposal is based on your organization's log sources, log fields, and existing detection rules. When logs from the matching source are available, the proposed query is tested against your recent logs. The proposed rule is generated asynchronously. This endpoint returns a proposal `id` with the status `pending`. To get the proposed rule, pass this `id` to the get-a-rule-proposal endpoint and poll the endpoint until the status is `completed` or `failed`. A proposal usually takes a few minutes, and up to 10 minutes. This endpoint does not create or modify any detection rules in Cloud SIEM. To translate many rules at once, use batch migrations instead.

    POST /api/v2/security_monitoring/rules/proposals

  • Write

    Test a rule

    Test a rule.

    POST /api/v2/security_monitoring/rules/test

  • Write

    Restore a rule to a historical version

    Restores a custom detection rule to a previously saved historical version. Only custom rules can be restored. Default and partner rules return 400. The restore creates a new version entry; it does not overwrite history.

    POST /api/v2/security_monitoring/rules/{rule_id}/restore/{version}

  • Write

    Test an existing rule

    Test an existing rule.

    POST /api/v2/security_monitoring/rules/{rule_id}/test

  • Write

    Subscribe to sample log generation

    Subscribe to sample log generation for a Cloud SIEM content pack. Sample logs for the requested content pack are injected into the Logs platform for the duration of the subscription, so detection rules can be exercised without onboarding the underlying integration first. **Availability**: this endpoint is restricted to Cloud SIEM trial organizations on an eligible pricing model. Non-trial orgs receive `403 Forbidden`, the feature flag may also reject requests with `400 Bad Request`, and legacy pricing tiers receive a response with `status: not_available`.

    POST /api/v2/security_monitoring/sample_log_generation/subscriptions

  • Write

    Bulk subscribe to sample log generation

    Subscribe to sample log generation for multiple Cloud SIEM content packs in a single call. Each requested content pack is processed independently; the response includes a per-item status so partial successes can be inspected. **Availability**: this endpoint is restricted to Cloud SIEM trial organizations on an eligible pricing model. Non-trial orgs receive `403 Forbidden`, the feature flag may also reject requests with `400 Bad Request`, and legacy pricing tiers receive per-item responses with `status: not_available`.

    POST /api/v2/security_monitoring/sample_log_generation/subscriptions/bulk

  • Write

    Bulk update triage assignee of security signals

    Change the triage assignees of multiple security signals at once. The maximum number of signals that can be updated in a single request is 199.

    PATCH /api/v2/security_monitoring/signals/bulk/assignee

  • Write

    Bulk update triage state of security signals

    Change the triage states of multiple security signals at once. The maximum number of signals that can be updated in a single request is 199.

    PATCH /api/v2/security_monitoring/signals/bulk/state

  • Write

    Bulk update security signals

    Update the triage state or assignee of multiple security signals at once. The maximum number of signals that can be updated in a single request is 199.

    PATCH /api/v2/security_monitoring/signals/bulk/update

  • Write

    Modify the triage assignee of a security signal

    Modify the triage assignee of a security signal.

    PATCH /api/v2/security_monitoring/signals/{signal_id}/assignee

  • Write

    Change the related incidents of a security signal

    Change the related incidents for a security signal.

    PATCH /api/v2/security_monitoring/signals/{signal_id}/incidents

  • Write

    Change the triage state of a security signal

    Change the triage state of a security signal.

    PATCH /api/v2/security_monitoring/signals/{signal_id}/state

  • Write

    Update security signal triage state or assignee

    Update the triage state or assignee of a security signal.

    PATCH /api/v2/security_monitoring/signals/{signal_id}/update

  • Write

    Convert security monitoring resource to Terraform

    Convert a security monitoring resource that doesn't (yet) exist from JSON to Terraform. The `resource_type` path parameter specifies the type of resource to convert and must be one of `suppressions`, `critical_assets`, `security_filters`, or `rules`.

    POST /api/v2/security_monitoring/terraform/{resource_type}/convert

  • Write

    Run a historical job

    Run a historical job.

    POST /api/v2/siem-historical-detections/jobs

  • Write

    Convert a job result to a signal

    Convert a job result to a signal.

    POST /api/v2/siem-historical-detections/jobs/signal_convert

  • Write

    Analyze code

    Run static analysis rules against a source code file and return violations found.

    POST /api/v2/static-analysis/static-analysis-server/analyze

  • Destructive

    Delete a custom framework

    Delete a custom framework.

    DELETE /api/v2/cloud_security_management/custom_frameworks/{handle}/{version}

  • Destructive

    Update a custom framework

    Update a custom framework.

    PUT /api/v2/cloud_security_management/custom_frameworks/{handle}/{version}

  • Destructive

    Update resource filters

    Update resource filters.

    PUT /api/v2/cloud_security_management/resource_filters

  • Destructive

    Delete a due date rule

    Delete a due date rule by ID.

    DELETE /api/v2/security/findings/automation/due_date_rules/{rule_id}

  • Destructive

    Update a due date rule

    Update a due date rule by ID.

    PUT /api/v2/security/findings/automation/due_date_rules/{rule_id}

  • Destructive

    Delete an inbox rule

    Delete an inbox rule by ID.

    DELETE /api/v2/security/findings/automation/inbox_rules/{rule_id}

  • Destructive

    Update an inbox rule

    Update an inbox rule by ID.

    PUT /api/v2/security/findings/automation/inbox_rules/{rule_id}

  • Destructive

    Delete a mute rule

    Delete a mute rule by ID.

    DELETE /api/v2/security/findings/automation/mute_rules/{rule_id}

  • Destructive

    Update a mute rule

    Update a mute rule by ID.

    PUT /api/v2/security/findings/automation/mute_rules/{rule_id}

  • Destructive

    Delete a severity modifier rule

    Delete a severity modifier rule by ID.

    DELETE /api/v2/security/findings/automation/severity_modifier_rules/{rule_id}

  • Destructive

    Update a severity modifier rule

    Update a severity modifier rule by ID.

    PUT /api/v2/security/findings/automation/severity_modifier_rules/{rule_id}

  • Destructive

    Delete a ticket creation rule

    Delete a ticket creation rule by ID.

    DELETE /api/v2/security/findings/automation/ticket_creation_rules/{rule_id}

  • Destructive

    Update a ticket creation rule

    Update a ticket creation rule by ID.

    PUT /api/v2/security/findings/automation/ticket_creation_rules/{rule_id}

  • Destructive

    Detach security findings from their case

    Detach security findings from their case. This operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored.

    DELETE /api/v2/security/findings/cases

  • Destructive

    Override the severity of security findings

    Set or clear the manual severity override of security findings. You can update up to 100 security findings per request. Use the `set` action with a `value` to apply a manual severity override. `value` is required for `set` and must be omitted for `clear`. The `info` value sets the lowest severity the finding type allows. Use the `clear` action to remove a manual severity override. `clear` does not remove a severity set by an automation rule. The optional `description` is accepted with both actions and has a limit of 280 characters. Auto-closed findings are excluded. Findings whose severity was set by an automation rule are skipped and listed in the response `meta.warnings`. If every finding is skipped this way, the request fails with a `400` error. Findings that cannot be found are skipped without a warning. The request fails with a `404` error only if none of the findings can be found.

    PATCH /api/v2/security/findings/severity

  • Destructive

    Delete a signal-based notification rule

    Delete a notification rule for security signals.

    DELETE /api/v2/security/signals/notification_rules/{id}

  • Destructive

    Delete a vulnerability-based notification rule

    Delete a notification rule for security vulnerabilities.

    DELETE /api/v2/security/vulnerabilities/notification_rules/{id}

  • Destructive

    Delete a batch migration

    Delete a batch migration and its resources. Detection rules that were already published are not deleted. Returns `409 Conflict` while any resource is `in_progress` or `publishing`: cancel the batch migration, or wait for publishing to finish, and then try again.

    DELETE /api/v2/security_monitoring/batch-migrations/{batch_id}

  • Destructive

    Update a batch migration

    Update the name, description, or tags of a batch migration, in any status. At least one of these attributes must be provided. Omitted attributes are left unchanged, and `tags` replaces the full list of tags.

    PATCH /api/v2/security_monitoring/batch-migrations/{batch_id}

  • Destructive

    Cancel a batch migration

    Cancel an `in_progress` batch migration. Resources that are `pending` or `in_progress` become `canceled`. Resources that are already `completed` or `failed` keep their status and output, so completed resources can still be published. Canceling a `canceled` batch migration succeeds, so the request can be safely retried. Returns `409 Conflict` if the batch migration is `draft` or `completed`.

    POST /api/v2/security_monitoring/batch-migrations/{batch_id}/cancel

  • Destructive

    Delete resources from a batch migration

    Delete resources from a batch migration. The request is all-or-nothing: it returns `404 Not Found` if any resource does not exist, and `409 Conflict` if any resource is `in_progress` or `publishing`. In both cases nothing is deleted. Duplicate resource IDs are ignored. Detection rules already published from the deleted resources are not deleted.

    DELETE /api/v2/security_monitoring/batch-migrations/{batch_id}/resources

  • Destructive

    Delete a critical asset

    Delete a specific critical asset.

    DELETE /api/v2/security_monitoring/configuration/critical_assets/{critical_asset_id}

  • Destructive

    Delete an entity context sync configuration

    Delete an entity context sync configuration. Cloud SIEM stops ingesting entities from this source, and the credentials stored for the configuration are removed from the secrets store.

    DELETE /api/v2/security_monitoring/configuration/integration_config/{integration_config_id}

  • Destructive

    Delete a security filter

    Delete a specific security filter.

    DELETE /api/v2/security_monitoring/configuration/security_filters/{security_filter_id}

  • Destructive

    Delete a suppression rule

    Delete a specific suppression rule.

    DELETE /api/v2/security_monitoring/configuration/suppressions/{suppression_id}

  • Destructive

    Update a suppression rule

    Update a specific suppression rule.

    PATCH /api/v2/security_monitoring/configuration/suppressions/{suppression_id}

  • Destructive

    Activate content pack

    Activate a Cloud SIEM content pack. This operation configures the necessary log filters or security filters depending on the pricing model and updates the content pack activation state.

    PUT /api/v2/security_monitoring/content_packs/{content_pack_id}/activate

  • Destructive

    Deactivate content pack

    Deactivate a Cloud SIEM content pack. This operation removes the content pack's configuration from log filters or security filters and updates the content pack activation state.

    PUT /api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate

  • Destructive

    Delete a dataset

    Delete a Cloud SIEM dataset. Out-of-the-box datasets cannot be deleted and deleting a dataset that is referenced by a detection rule is rejected.

    DELETE /api/v2/security_monitoring/datasets/{dataset_id}

  • Destructive

    Bulk delete security monitoring rules

    Delete multiple security monitoring rules in a single request. Default rules cannot be deleted.

    DELETE /api/v2/security_monitoring/rules/bulk_delete

  • Destructive

    Delete an existing rule

    Delete an existing rule. Default rules cannot be deleted.

    DELETE /api/v2/security_monitoring/rules/{rule_id}

  • Destructive

    Update an existing rule

    Update an existing rule. When updating `cases`, `queries` or `options`, the whole field must be included. For example, when modifying a query all queries must be included. Default rules can only be updated to be enabled, to change notifications, or to update the tags (default tags cannot be removed).

    PUT /api/v2/security_monitoring/rules/{rule_id}

  • Destructive

    Unsubscribe from sample log generation

    Unsubscribe from sample log generation for a Cloud SIEM content pack. After unsubscribing, no more sample logs are generated for the requested content pack. **Availability**: this endpoint is restricted to Cloud SIEM trial organizations on an eligible pricing model. Non-trial orgs receive `403 Forbidden`, the feature flag may also reject requests with `400 Bad Request`, and legacy pricing tiers receive a response with `status: not_available`.

    DELETE /api/v2/security_monitoring/sample_log_generation/subscriptions/{content_pack_id}

  • Destructive

    Delete an existing job

    Delete an existing job.

    DELETE /api/v2/siem-historical-detections/jobs/{job_id}

  • Destructive

    Cancel a historical job

    Cancel a historical job.

    PATCH /api/v2/siem-historical-detections/jobs/{job_id}/cancel

Service Level Objectives

  • Read

    Get all SLOs

    Get a list of service level objective objects for your organization.

    GET /api/v1/slo

  • Read

    Check if SLOs can be safely deleted

    Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard.

    GET /api/v1/slo/can_delete

  • Read

    Search for SLOs

    Get a list of service level objective objects for your organization.

    GET /api/v1/slo/search

  • Read

    Get an SLO's details

    Get a service level objective object.

    GET /api/v1/slo/{slo_id}

  • Read

    Get Corrections For an SLO

    Get corrections applied to an SLO

    GET /api/v1/slo/{slo_id}/corrections

  • Read

    Get an SLO's history

    Get a specific SLO’s history, regardless of its SLO type. The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history. **Note:** There are different response formats for event based and time based SLOs. Examples of both are shown.

    GET /api/v1/slo/{slo_id}/history

  • Read

    Get SLO report (deprecated)

    Download an SLO report. This can only be performed after the report job has completed. Reports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available.

    GET /api/v2/slo/report/{report_id}/download

  • Read

    Get SLO report status (deprecated)

    Get the status of the SLO report job.

    GET /api/v2/slo/report/{report_id}/status

  • Read

    Get SLO status

    Get the status of a Service Level Objective (SLO) for a given time period. This endpoint returns the current SLI value, error budget remaining, and other status information for the specified SLO.

    GET /api/v2/slo/{slo_id}/status

  • Write

    Create an SLO object

    Create a service level objective object.

    POST /api/v1/slo

  • Write

    Create a new SLO report (deprecated)

    Create a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download. Check the status of the job and download the CSV report using the returned `report_id`.

    POST /api/v2/slo/report

  • Destructive

    Bulk Delete SLO Timeframes

    Delete (or partially delete) multiple service level objective objects. This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well.

    POST /api/v1/slo/bulk_delete

  • Destructive

    Delete an SLO

    Permanently delete the specified service level objective object. If an SLO is used in a dashboard, the `DELETE /v1/slo/` endpoint returns a 409 conflict error because the SLO is referenced in a dashboard.

    DELETE /api/v1/slo/{slo_id}

  • Destructive

    Update an SLO

    Update the specified service level objective object.

    PUT /api/v1/slo/{slo_id}

Service Level Objective Corrections

  • Read

    Get all SLO corrections

    Get all Service Level Objective corrections.

    GET /api/v1/slo/correction

  • Read

    Get an SLO correction for an SLO

    Get an SLO correction.

    GET /api/v1/slo/correction/{slo_correction_id}

  • Write

    Create an SLO correction

    Create an SLO correction. Use `slo_id` to apply the correction to a single SLO, or `slo_query` to apply the correction to SLOs that match a query. Exactly one of `slo_id` or `slo_query` is required.

    POST /api/v1/slo/correction

  • Write

    Update an SLO correction

    Update the specified SLO correction object.

    PATCH /api/v1/slo/correction/{slo_correction_id}

  • Destructive

    Delete an SLO correction

    Permanently delete the specified SLO correction object.

    DELETE /api/v1/slo/correction/{slo_correction_id}

Synthetics

  • Read

    Get details of batch

    Get a batch's updated details.

    GET /api/v1/synthetics/ci/batch/{batch_id}

  • Read

    Get all locations (public and private)

    Get the list of public and private locations available for Synthetic tests. No arguments required.

    GET /api/v1/synthetics/locations

  • Read

    Get a private location

    Get a Synthetic private location.

    GET /api/v1/synthetics/private-locations/{location_id}

  • Read

    Get the default locations

    Get the default locations settings.

    GET /api/v1/synthetics/settings/default_locations

  • Read

    Get the list of all Synthetic tests

    Get the list of all Synthetic tests.

    GET /api/v1/synthetics/tests

  • Read

    Get an API test

    Get the detailed configuration associated with a Synthetic API test.

    GET /api/v1/synthetics/tests/api/{public_id}

  • Read

    Get a browser test

    Get the detailed configuration (including steps) associated with a Synthetic browser test.

    GET /api/v1/synthetics/tests/browser/{public_id}

  • Read

    Get a browser test's latest results summaries

    Get the last 150 test results summaries for a given Synthetic browser test.

    GET /api/v1/synthetics/tests/browser/{public_id}/results

  • Read

    Get a browser test result

    Get a specific full result from a given Synthetic browser test.

    GET /api/v1/synthetics/tests/browser/{public_id}/results/{result_id}

  • Read

    Get a mobile test

    Get the detailed configuration associated with a Synthetic mobile test.

    GET /api/v1/synthetics/tests/mobile/{public_id}

  • Read

    Search Synthetic tests

    Search for Synthetic tests.

    GET /api/v1/synthetics/tests/search

  • Read

    Fetch uptime for multiple tests

    Fetch uptime for multiple Synthetic tests by ID.

    POST /api/v1/synthetics/tests/uptimes

  • Read

    Get a test configuration

    Get the detailed configuration associated with a Synthetic test.

    GET /api/v1/synthetics/tests/{public_id}

  • Read

    Get an API test's latest results summaries

    Get the last 150 test results summaries for a given Synthetic API test.

    GET /api/v1/synthetics/tests/{public_id}/results

  • Read

    Get an API test result

    Get a specific full result from a given Synthetic API test.

    GET /api/v1/synthetics/tests/{public_id}/results/{result_id}

  • Read

    Get all global variables

    Get the list of all Synthetic global variables.

    GET /api/v1/synthetics/variables

  • Read

    Get a global variable

    Get the detailed configuration of a global variable.

    GET /api/v1/synthetics/variables/{variable_id}

  • Read

    Get available subtests for a multistep test

    Get the list of API tests that can be added as subtests to a given API multistep test. The current test is excluded from the list since a test cannot be a subtest of itself.

    GET /api/v2/synthetics/api-multistep/subtests/{public_id}

  • Read

    Get parent tests for a subtest

    Get the list of API multistep tests that include a given subtest, along with their monitor status.

    GET /api/v2/synthetics/api-multistep/subtests/{public_id}/parents

  • Read

    List Synthetics downtimes

    Get a list of all Synthetics downtimes for your organization.

    GET /api/v2/synthetics/downtimes

  • Read

    Get a Synthetics downtime

    Get a Synthetics downtime by its ID.

    GET /api/v2/synthetics/downtimes/{downtime_id}

  • Read

    Get the on-demand concurrency cap

    Get the on-demand concurrency cap.

    GET /api/v2/synthetics/settings/on_demand_concurrency_cap

  • Read

    Search test suites

    Search for test suites.

    GET /api/v2/synthetics/suites/search

  • Read

    Get a suite

    GET /api/v2/synthetics/suites/{public_id}

    GET /api/v2/synthetics/suites/{public_id}

  • Read

    Get a browser test's latest results

    Get the latest result summaries for a given Synthetic browser test.

    GET /api/v2/synthetics/tests/browser/{public_id}/results

  • Read

    Get a browser test result

    Get a specific full result from a given Synthetic browser test.

    GET /api/v2/synthetics/tests/browser/{public_id}/results/{result_id}

  • Read

    Get a fast test result

    GET /api/v2/synthetics/tests/fast/{id}

    GET /api/v2/synthetics/tests/fast/{id}

  • Read

    Get a Network Path test

    GET /api/v2/synthetics/tests/network/{public_id}

    GET /api/v2/synthetics/tests/network/{public_id}

  • Read

    Poll for test results

    Poll for test results given a list of result IDs. This is typically used after triggering tests with CI/CD to retrieve results once they are available.

    GET /api/v2/synthetics/tests/poll_results

  • Read

    Get a presigned URL for downloading a test file

    Get a presigned URL to download a file attached to a Synthetic test. The returned URL is temporary and expires after a short period.

    POST /api/v2/synthetics/tests/{public_id}/files/download

  • Read

    Get presigned URLs for uploading a test file

    Get presigned URLs for uploading a file to a Synthetic test using multipart upload. Returns the presigned URLs for each part along with the bucket key that references the file.

    POST /api/v2/synthetics/tests/{public_id}/files/multipart-presigned-urls

  • Read

    Get parent suites for a test

    Get the list of parent suites and their status for a given Synthetic test.

    GET /api/v2/synthetics/tests/{public_id}/parent-suites

  • Read

    Get a test's latest results

    Get the latest result summaries for a given Synthetic test.

    GET /api/v2/synthetics/tests/{public_id}/results

  • Read

    Get a test result

    Get a specific full result from a given Synthetic test.

    GET /api/v2/synthetics/tests/{public_id}/results/{result_id}

  • Read

    Get version history of a test

    Get the paginated version history for a Synthetic test.

    GET /api/v2/synthetics/tests/{public_id}/version_history

  • Read

    Get a specific version of a test

    Get a specific version of a Synthetic test by its version number.

    GET /api/v2/synthetics/tests/{public_id}/version_history/{version_number}

  • Write

    Create a private location

    Create a new Synthetic private location.

    POST /api/v1/synthetics/private-locations

  • Write

    Create an API test

    Create a Synthetic API test.

    POST /api/v1/synthetics/tests/api

  • Write

    Create a browser test

    Create a Synthetic browser test.

    POST /api/v1/synthetics/tests/browser

  • Write

    Create a mobile test

    Create a Synthetic mobile test.

    POST /api/v1/synthetics/tests/mobile

  • Write

    Trigger Synthetic tests

    Trigger a set of Synthetic tests.

    POST /api/v1/synthetics/tests/trigger

  • Write

    Trigger tests from CI/CD pipelines

    Trigger a set of Synthetic tests for continuous integration.

    POST /api/v1/synthetics/tests/trigger/ci

  • Write

    Patch a Synthetic test

    Patch the configuration of a Synthetic test with partial data.

    PATCH /api/v1/synthetics/tests/{public_id}

  • Write

    Create a global variable

    Create a Synthetic global variable.

    POST /api/v1/synthetics/variables

  • Write

    Create a Synthetics downtime

    Create a new Synthetics downtime.

    POST /api/v2/synthetics/downtimes

  • Write

    Save new value for on-demand concurrency cap

    Save new value for on-demand concurrency cap.

    POST /api/v2/synthetics/settings/on_demand_concurrency_cap

  • Write

    Create a test suite

    POST /api/v2/synthetics/suites

    POST /api/v2/synthetics/suites

  • Write

    Create a Network Path test

    POST /api/v2/synthetics/tests/network

    POST /api/v2/synthetics/tests/network

  • Write

    Complete a multipart upload of a test file

    Complete a multipart file upload for a Synthetic test. Call this endpoint after all parts have been uploaded using the presigned URLs obtained from the multipart presigned URLs endpoint.

    POST /api/v2/synthetics/tests/{public_id}/files/multipart-upload-complete

  • Destructive

    Delete a private location

    Delete a Synthetic private location.

    DELETE /api/v1/synthetics/private-locations/{location_id}

  • Destructive

    Edit a private location

    Edit a Synthetic private location.

    PUT /api/v1/synthetics/private-locations/{location_id}

  • Destructive

    Edit an API test

    Edit the configuration of a Synthetic API test.

    PUT /api/v1/synthetics/tests/api/{public_id}

  • Destructive

    Edit a browser test

    Edit the configuration of a Synthetic browser test.

    PUT /api/v1/synthetics/tests/browser/{public_id}

  • Destructive

    Delete tests

    Delete multiple Synthetic tests by ID.

    POST /api/v1/synthetics/tests/delete

  • Destructive

    Edit a mobile test

    Edit the configuration of a Synthetic mobile test.

    PUT /api/v1/synthetics/tests/mobile/{public_id}

  • Destructive

    Pause or start a test

    Pause or start a Synthetic test by changing the status.

    PUT /api/v1/synthetics/tests/{public_id}/status

  • Destructive

    Delete a global variable

    Delete a Synthetic global variable.

    DELETE /api/v1/synthetics/variables/{variable_id}

  • Destructive

    Edit a global variable

    Edit a Synthetic global variable.

    PUT /api/v1/synthetics/variables/{variable_id}

  • Destructive

    Delete a Synthetics downtime

    Delete a Synthetics downtime by its ID.

    DELETE /api/v2/synthetics/downtimes/{downtime_id}

  • Destructive

    Update a Synthetics downtime

    Update a Synthetics downtime by its ID.

    PUT /api/v2/synthetics/downtimes/{downtime_id}

  • Destructive

    Remove a test from a Synthetics downtime

    Disassociate a Synthetics test from a downtime.

    DELETE /api/v2/synthetics/downtimes/{downtime_id}/tests/{test_id}

  • Destructive

    Add a test to a Synthetics downtime

    Associate a Synthetics test with a downtime.

    PUT /api/v2/synthetics/downtimes/{downtime_id}/tests/{test_id}

  • Destructive

    Bulk delete suites

    POST /api/v2/synthetics/suites/bulk-delete

    POST /api/v2/synthetics/suites/bulk-delete

  • Destructive

    Edit a test suite

    PUT /api/v2/synthetics/suites/{public_id}

    PUT /api/v2/synthetics/suites/{public_id}

  • Destructive

    Patch a test suite

    Patch a Synthetic test suite using JSON Patch (RFC 6902). Use partial updates to modify only specific fields of a test suite. Common operations include: - Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}` - Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}` - Remove fields: `{"op": "remove", "path": "/message"}`

    PATCH /api/v2/synthetics/suites/{public_id}/jsonpatch

  • Destructive

    Bulk delete tests

    POST /api/v2/synthetics/tests/bulk-delete

    POST /api/v2/synthetics/tests/bulk-delete

  • Destructive

    Edit a Network Path test

    PUT /api/v2/synthetics/tests/network/{public_id}

    PUT /api/v2/synthetics/tests/network/{public_id}

  • Destructive

    Abort a multipart upload of a test file

    Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload and releases any storage used by already-uploaded parts.

    POST /api/v2/synthetics/tests/{public_id}/files/multipart-upload-abort

  • Destructive

    Patch a global variable

    Patch a global variable using JSON Patch (RFC 6902). This endpoint allows partial updates to a global variable by specifying only the fields to modify. Common operations include: - Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}` - Update nested values: `{"op": "replace", "path": "/value/value", "value": "new_value"}` - Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}` - Remove fields: `{"op": "remove", "path": "/description"}`

    PATCH /api/v2/synthetics/variables/{variable_id}/jsonpatch

Tags

  • Read

    Get All Host Tags

    Returns a mapping of tags to hosts. For each tag, the response returns a list of host names that contain this tag. There is a restriction of 10k total host names from the org that can be attached to tags and returned.

    GET /api/v1/tags/hosts

  • Read

    Get Host Tags

    Return the list of tags that apply to a given host.

    GET /api/v1/tags/hosts/{host_name}

  • Write

    Add tags to a host

    This endpoint allows you to add new tags to a host, optionally specifying what source these tags come from. If tags already exist, appends new tags to the tag list. If no source is specified, defaults to "user".

    POST /api/v1/tags/hosts/{host_name}

  • Destructive

    Remove host tags

    This endpoint allows you to remove all tags for a single host. If no source is specified, only deletes from the source "User".

    DELETE /api/v1/tags/hosts/{host_name}

  • Destructive

    Update host tags

    This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.

    PUT /api/v1/tags/hosts/{host_name}

Users

  • Read

    List all users

    List all users for your organization.

    GET /api/v1/user

  • Read

    Get user details

    Get a user's details.

    GET /api/v1/user/{user_handle}

  • Read

    Get current user

    Get the user associated with the current authentication context. The response includes the user's profile attributes (name, email, handle, status, MFA state), along with related resources: the user's organization, assigned roles with their granted permissions, and team-scoped roles. No additional permissions are required beyond valid authentication.

    GET /api/v2/current_user

  • Read

    Get a user invitation

    Returns a single user invitation by its UUID.

    GET /api/v2/user_invitations/{user_invitation_uuid}

  • Read

    List all users

    Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.

    GET /api/v2/users

  • Read

    Get user details

    Get a user in the organization specified by the user’s `user_id`.

    GET /api/v2/users/{user_id}

  • Read

    Get identity provider overrides for a user

    Get the identity provider overrides for a specific user in the organization. When a user has no overrides set, they use the organization's default identity providers.

    GET /api/v2/users/{user_id}/identity_providers

  • Read

    Get a user organization

    Get a user organization. Returns the user information and all organizations joined by this user.

    GET /api/v2/users/{user_id}/orgs

  • Read

    Get a user permissions

    Get a user permission set. Returns a list of the user’s permissions granted by the associated user's roles.

    GET /api/v2/users/{user_id}/permissions

  • Write

    Create a user

    Create a user for your organization. **Note**: Users can only be created with the admin access role if application keys belong to administrators.

    POST /api/v1/user

  • Write

    Update current user

    Edit the profile of the currently authenticated user. Updatable fields include `name`, `title`, `email`, and `disabled` status. The `id` field in the request body must match the authenticated user's UUID; a mismatch returns a 422 error. Email address changes are recorded in the audit trail. Requires the `user_self_profile_write` permission.

    PATCH /api/v2/current_user

  • Write

    Send invitation emails

    Sends emails to one or more users inviting them to join the organization.

    POST /api/v2/user_invitations

  • Write

    Create a user

    Create a user for your organization.

    POST /api/v2/users

  • Write

    Update a user

    Edit a user. Can only be used with an application key belonging to an administrator user.

    PATCH /api/v2/users/{user_id}

  • Destructive

    Disable a user

    Delete a user from an organization. **Note**: This endpoint can only be used with application keys belonging to administrators.

    DELETE /api/v1/user/{user_handle}

  • Destructive

    Update a user

    Update a user information. **Note**: It can only be used with application keys belonging to administrators.

    PUT /api/v1/user/{user_handle}

  • Destructive

    Anonymize users

    Anonymize a list of users, removing their personal data. This operation is irreversible. Requires the `user_access_manage` permission.

    PUT /api/v2/anonymize_users

  • Destructive

    Disable a user

    Disable a user. Can only be used with an application key belonging to an administrator user.

    DELETE /api/v2/users/{user_id}

  • Destructive

    Delete a pending user's invitations

    Cancel all pending invitations for a specified user. Requires the `user_access_invite` permission.

    DELETE /api/v2/users/{user_id}/invitations

  • Destructive

    Update identity provider overrides for a user

    Set the identity provider overrides for a specific user in the organization. Pass an empty list to remove all overrides, reverting the user to the organization's default identity providers.

    PATCH /api/v2/users/{user_id}/relationships/identity_providers

Authentication

  • Read

    Validate API key

    Check if the API key (not the APP key) is valid. If invalid, a 403 is returned.

    GET /api/v1/validate

Fleet Automation

  • Read

    List tracers for a specific agent

    Retrieve a paginated list of tracers for a specific agent. This endpoint returns tracers associated with a given agent key, identified by the agent's hostname. Use this to discover telemetry-derived service names for a particular host.

    GET /api/unstable/fleet/agents/{agent_key}/tracers

  • Read

    List all fleet tracers

    Retrieve a paginated list of all fleet tracers. This endpoint returns telemetry-derived service names from the SDK telemetry pipeline. These names may differ from span-derived names in APM and are useful for querying service library configurations. Use the `page_number` and `page_size` query parameters to paginate through results.

    GET /api/unstable/fleet/tracers

  • Read

    List available Datadog Agent versions

    Retrieve the list of Datadog Agent versions available for deployment. Returns `200` with an empty `data` array if the Agent package exists in the catalog but has no available versions, and `404` only if the Agent package itself is absent from the catalog.

    GET /api/v2/fleet/agent_versions

  • Read

    List all Datadog Agents

    Retrieve a paginated list of Datadog Agents. Returns agents with support for pagination, sorting, and filtering. Use `page_number` and `page_size` to navigate pages, `filter` to narrow by field values, and `tags` to filter by agent tags.

    GET /api/v2/fleet/agents

  • Read

    Get detailed information about an agent

    Retrieve detailed information about a specific Datadog Agent. By default, only `agent_infos` is returned. Use the `include` query parameter to request additional data: `integrations` and/or `configuration_files`.

    GET /api/v2/fleet/agents/{agent_key}

  • Read

    List all deployments

    Retrieve a paginated list of all deployments for fleet automation.

    GET /api/v2/fleet/deployments

  • Read

    Get a deployment by ID

    Retrieve detailed information about a specific deployment, including its current status, configuration operations, and per-host execution status. Returns a 404 if no deployment matches the given ID or if you do not have access to it.

    GET /api/v2/fleet/deployments/{deployment_id}

  • Read

    List all schedules

    Retrieve all upgrade schedules for the organization. Schedules automate package upgrades by defining maintenance windows and recurrence rules. Each schedule automatically creates deployments based on its configuration.

    GET /api/v2/fleet/schedules

  • Read

    Get a schedule by ID

    Retrieve detailed information about a specific schedule by its unique identifier.

    GET /api/v2/fleet/schedules/{id}

  • Write

    Create a schedule

    Create a new schedule for automated package upgrades. Schedules define when and how often to automatically deploy package upgrades to a fleet of hosts. Each schedule includes: - A filter query to select target hosts - A recurrence rule defining maintenance windows - A version strategy (e.g., always latest, or N versions behind latest) When the schedule triggers during a maintenance window, it automatically creates a deployment that upgrades the Datadog Agent to the specified version on all matching hosts.

    POST /api/unstable/fleet/schedules

  • Write

    Update a schedule

    Partially update a schedule by providing only the fields you want to change. This endpoint allows you to modify specific attributes of a schedule without affecting other fields. Common use cases include: - Changing the schedule status between active and inactive - Updating the maintenance window times - Modifying the filter query to target different hosts - Adjusting the version strategy Only include the fields you want to update in the request body. All fields are optional in a PATCH request.

    PATCH /api/unstable/fleet/schedules/{id}

  • Write

    Trigger a schedule deployment

    Manually trigger a schedule to immediately create and start a deployment. This endpoint allows you to manually initiate a deployment using the schedule's configuration, without waiting for the next scheduled maintenance window. This is useful for: - Testing a schedule before it runs automatically - Performing an emergency update outside the regular maintenance window - Creating an ad-hoc deployment with the same settings as a schedule The deployment is created immediately with: - The same filter query as the schedule - The package version determined by the schedule's version strategy - All matching hosts as targets The manually triggered deployment is independent of the schedule and does not affect the schedule's normal recurrence pattern.

    POST /api/unstable/fleet/schedules/{id}/trigger

  • Write

    Upgrade hosts

    Create and immediately start a new package upgrade on hosts matching the specified filter query. This endpoint allows you to upgrade the Datadog Agent to a specific version on hosts matching the specified filter query. The deployment is created and started automatically. The system: 1. Identifies all hosts matching the filter query. 2. Validates that the specified version is available. 3. Begins rolling out the package upgrade to the target hosts. Returns a 400 if `filter_query` or `target_packages` is missing, a target package is missing a name or version, or the filter query does not match any host eligible for the upgrade. Returns a 409 if a conflicting upgrade is already running on one or more target hosts.

    POST /api/v2/fleet/deployments/upgrade

  • Destructive

    Delete a schedule

    Delete a schedule permanently. When you delete a schedule: - The schedule is permanently removed and will no longer create deployments - Any deployments already created by this schedule are not affected - This action cannot be undone If you want to temporarily stop a schedule from creating deployments, consider updating its status to "inactive" instead of deleting it.

    DELETE /api/unstable/fleet/schedules/{id}

  • Destructive

    Create a configuration deployment

    Create a new deployment to apply configuration changes to a fleet of hosts matching the specified filter query. This endpoint supports two types of configuration operations: - `merge-patch`: Merges the provided patch data with the existing configuration file, creating the file if it doesn't exist. - `delete`: Removes the specified configuration file from the target hosts. You can optionally use `target_packages` to apply the configuration change only to specific package versions. The deployment is created and started automatically. You can specify multiple configuration operations to execute in order on each target host. Use the filter query to target specific hosts using the Datadog query syntax. Set `dry_run` to `true` to validate the configuration and resolve target hosts and packages without deploying anything. A dry run returns a 200 with the validation result instead of creating and starting a deployment. Returns a 400 if `filter_query` or `config_operations` is missing, a target package is missing a name or version or cannot be resolved, the configuration fails validation, or the filter query does not match any host eligible for the deployment.

    POST /api/v2/fleet/deployments/configure

  • Destructive

    Cancel a deployment

    Cancel an active deployment and stop all pending operations. When you cancel a deployment: - All pending operations on hosts that haven't started yet are stopped. - Operations currently in progress on hosts may complete or be interrupted, depending on their current status. - Configuration changes or package upgrades already applied to hosts are not rolled back. After cancellation, you can view the final state of the deployment using the GET endpoint to see which hosts were successfully updated before the cancellation. Only deployments with a `pending` or `running` status can be canceled. Returns a 400 if the deployment is not in a cancelable status. Returns a 404 if no deployment matches the specified ID or if you do not have access to it.

    POST /api/v2/fleet/deployments/{deployment_id}/cancel

Agent Observability

  • Read

    List custom evaluator configurations

    List all custom Agent Observability evaluator configurations for the organization.

    GET /api/unstable/llm-obs/config/evaluators/custom

  • Read

    Get a custom evaluator configuration

    Retrieve a custom Agent Observability evaluator configuration by its name.

    GET /api/unstable/llm-obs/config/evaluators/custom/{eval_name}

  • Read

    Get annotated interactions by content IDs

    Returns annotated interactions across all annotation queues for the given content IDs. Results include queue metadata (ID and name) for each interaction.

    GET /api/v2/llm-obs/v1/annotated-interactions

  • Read

    List Agent Observability annotation queues

    List annotation queues. Optionally filter by project ID or queue IDs. These parameters are mutually exclusive. If neither is provided, all queues in the organization are returned.

    GET /api/v2/llm-obs/v1/annotation-queues

  • Read

    Get annotated queue interactions

    Retrieve all interactions (traces and sessions) and their annotations for a given annotation queue.

    GET /api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions

  • Read

    Get an annotated queue interaction

    Retrieve an interaction, its annotations, and a page of related events from an annotation queue.

    GET /api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}

  • Read

    Get annotation queue label schema

    Retrieve the label schema for a given annotation queue.

    GET /api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema

  • Read

    Search Agent Observability experimentation

    Search across Agent Observability experimentation entities — projects, datasets, dataset records, experiments, and experiment runs — using cursor-based pagination. The `filter.scope` field controls which entity types are returned. At least one valid scope must be provided. Returns `200 OK` when all results fit in a single page. Returns `206 Partial Content` with a cursor in `meta.after` when additional pages are available.

    POST /api/v2/llm-obs/v1/experimentation/search

  • Read

    Simple search experimentation entities

    Search across Agent Observability experimentation entities using offset-based (page-number) pagination. Use this endpoint when you need total page count or want to navigate to a specific page number. The `filter.scope` field controls which entity types are returned. At least one valid scope must be provided.

    POST /api/v2/llm-obs/v1/experimentation/simple-search

  • Read

    List Agent Observability experiments

    List all Agent Observability experiments sorted by creation date, newest first.

    GET /api/v2/llm-obs/v1/experiments

  • Read

    List Agent Observability experiment spans (v1) (deprecated)

    Retrieve spans with their evaluation metrics for a given experiment. Returns spans only, with no summary metrics and no pagination. Deprecated in favor of `ListLLMObsExperimentEventsV3`.

    GET /api/v2/llm-obs/v1/experiments/{experiment_id}/events

  • Read

    List LLM integration accounts

    Retrieve the list of configured accounts for the specified LLM provider integration.

    GET /api/v2/llm-obs/v1/integrations/{integration}/accounts

  • Read

    List LLM integration models

    Retrieve the list of models available for the specified LLM provider integration and account.

    GET /api/v2/llm-obs/v1/integrations/{integration}/{account_id}/models

  • Read

    List Agent Observability projects

    List all Agent Observability projects sorted by creation date, newest first.

    GET /api/v2/llm-obs/v1/projects

  • Read

    List Agent Observability prompts

    List all Agent Observability prompts in the prompt registry for the organization.

    GET /api/v2/llm-obs/v1/prompts

  • Read

    Get an Agent Observability prompt

    Get the latest version of an Agent Observability prompt by prompt ID.

    GET /api/v2/llm-obs/v1/prompts/{prompt_id}

  • Read

    List versions of an Agent Observability prompt

    List all versions of an Agent Observability prompt, ordered newest to oldest. If the prompt does not exist, is not registered, or is archived, the response contains an empty list.

    GET /api/v2/llm-obs/v1/prompts/{prompt_id}/versions

  • Read

    Get a specific Agent Observability prompt version

    Get the full template and configuration of a single, specific version of an Agent Observability prompt.

    GET /api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version}

  • Read

    List Agent Observability spans

    List Agent Observability spans matching the specified filters.

    GET /api/v2/llm-obs/v1/spans/events

  • Read

    Search Agent Observability spans

    Search Agent Observability spans using structured filters in the request body.

    POST /api/v2/llm-obs/v1/spans/events/search

  • Read

    List patterns clustered points

    List the data points grouped into a topic. For a parent topic, points from all of its leaf topics are returned.

    GET /api/v2/llm-obs/v1/topic-discovery-clustered-points

  • Read

    List patterns configurations

    List all patterns configurations for the organization.

    GET /api/v2/llm-obs/v1/topic-discovery-configs

  • Read

    Get a patterns configuration

    Retrieve the patterns configuration for the organization.

    GET /api/v2/llm-obs/v1/topic-discovery-configs/latest

  • Read

    List patterns runs

    List the completed patterns runs for a configuration.

    GET /api/v2/llm-obs/v1/topic-discovery-runs

  • Read

    Get patterns run status

    Retrieve the status and step-by-step progress of the current or most recent patterns run for a configuration.

    GET /api/v2/llm-obs/v1/topic-discovery-runs/status

  • Read

    List patterns templates

    List all enabled patterns templates.

    GET /api/v2/llm-obs/v1/topic-discovery-templates

  • Read

    List patterns topics

    List the topics discovered by a patterns run. When no run is specified, the most recent completed run is used.

    GET /api/v2/llm-obs/v1/topic-discovery-topics

  • Read

    List patterns topics with clustered points

    List the topics discovered by a patterns run, with the clustered points attached inline to each leaf topic. When no run is specified, the most recent completed run is used.

    GET /api/v2/llm-obs/v1/topic-discovery-topics/with-cluster-points

  • Read

    List Agent Observability datasets

    List all Agent Observability datasets for a project, sorted by creation date, newest first.

    GET /api/v2/llm-obs/v1/{project_id}/datasets

  • Read

    Get Agent Observability dataset draft state

    Retrieve the draft state of a dataset, including whether it is currently locked for editing and which user holds the lock.

    GET /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/draft_state

  • Read

    Export an Agent Observability dataset

    Download the contents of a dataset as a CSV file. The download is streamed and includes one row per dataset record.

    GET /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/export

  • Read

    List Agent Observability dataset records

    List all records in an Agent Observability dataset, sorted by creation date, newest first.

    GET /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records

  • Read

    List Agent Observability dataset versions

    List the active versions of a dataset. A version is created each time a dataset is referenced by an experiment run.

    GET /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/versions

  • Read

    List Agent Observability experiment events (v2) (deprecated)

    Retrieve spans and experiment-level summary metrics for a given experiment. Returns the full events payload without pagination. Deprecated: use `ListLLMObsExperimentEventsV3` instead.

    GET /api/v2/llm-obs/v2/experiments/{experiment_id}/events

  • Read

    List events for an Agent Observability experiment

    Retrieve spans and experiment-level summary metrics for a given experiment with cursor-based pagination.

    GET /api/v2/llm-obs/v3/experiments/{experiment_id}/events

  • Write

    Create an Agent Observability annotation queue

    Create an annotation queue. The `name` and `project_id` fields are required. An optional `annotation_schema` can be provided to define the labels for the queue. Optional access-control fields can restrict annotation access to reviewers or assignees. Fields such as `created_by`, `owned_by`, `created_at`, `modified_by`, and `modified_at` are inferred by the backend.

    POST /api/v2/llm-obs/v1/annotation-queues

  • Write

    Update an Agent Observability annotation queue

    Partially update an annotation queue. The `name`, `description`, `annotation_schema`, `reviewer_emails`, `restrict_to_reviewers`, and `restrict_to_assignees` fields can be updated.

    PATCH /api/v2/llm-obs/v1/annotation-queues/{queue_id}

  • Write

    Create or update annotations

    Create or update annotations on interactions in a queue. Each annotation is matched by `interaction_id` and the requesting user's identity. Results and errors in the response are linked to request items by `interaction_id`. Errors for individual items are returned in the `errors` field without blocking the rest of the batch. Requests where every item is denied by queue access rules return `403`.

    POST /api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotations

  • Write

    Add annotation queue interactions

    Add one or more interactions to an annotation queue. At least one interaction must be provided. Each interaction has a `type`: - `trace`, `experiment_trace`, `session`: `content_id` references the upstream entity; the server fetches the actual content. - `display_block`: omit `content_id` and provide the rendered content in `display_block`. The server generates `content_id` as a deterministic hash of the block list. Items of different types can be mixed in a single request.

    POST /api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactions

  • Write

    Aggregate Agent Observability experimentation

    Execute an analytics aggregation over Agent Observability experimentation data. Use this endpoint to compute metrics (for example average eval scores) grouped by fields such as `span_id` or `experiment_id`. At least one `compute` definition and one `index` must be provided.

    POST /api/v2/llm-obs/v1/experimentation/analytics

  • Write

    Create an Agent Observability experiment

    Create a new Agent Observability experiment.

    POST /api/v2/llm-obs/v1/experiments

  • Write

    Update an Agent Observability experiment

    Partially update an existing Agent Observability experiment.

    PATCH /api/v2/llm-obs/v1/experiments/{experiment_id}

  • Write

    Push events for an Agent Observability experiment

    Push spans and metrics for an Agent Observability experiment.

    POST /api/v2/llm-obs/v1/experiments/{experiment_id}/events

  • Write

    Run an LLM inference

    Run an LLM inference request through the specified integration and account, returning the model response and token usage.

    POST /api/v2/llm-obs/v1/integrations/{integration}/{account_id}/inference

  • Write

    Create an Agent Observability project

    Create a new Agent Observability project. Returns the existing project if a name conflict occurs.

    POST /api/v2/llm-obs/v1/projects

  • Write

    Update an Agent Observability project

    Partially update an existing Agent Observability project.

    PATCH /api/v2/llm-obs/v1/projects/{project_id}

  • Write

    Create an Agent Observability prompt

    Create a new prompt (and its first version) in the Agent Observability prompt registry. > **Preview**: Prompt composition is available in Preview. To request access, contact [Datadog Support](https://docs.datadoghq.com/help/) or your Customer Success Manager.

    POST /api/v2/llm-obs/v1/prompts

  • Write

    Update an Agent Observability prompt

    Update the title, the description, or both, for an Agent Observability prompt.

    PATCH /api/v2/llm-obs/v1/prompts/{prompt_id}

  • Write

    Create a new Agent Observability prompt version

    Create a new version of an existing Agent Observability prompt. > **Preview**: Prompt composition is available in Preview. To request access, contact [Datadog Support](https://docs.datadoghq.com/help/) or your Customer Success Manager.

    POST /api/v2/llm-obs/v1/prompts/{prompt_id}/versions

  • Write

    Update an Agent Observability prompt version

    Update the description, the feature-flag environments, or both, for a specific version of an Agent Observability prompt.

    PATCH /api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version}

  • Write

    Trigger a patterns run

    Start a patterns run for a given configuration. The run executes asynchronously.

    POST /api/v2/llm-obs/v1/topic-discovery-runs

  • Write

    Create an Agent Observability dataset

    Create a new Agent Observability dataset within the specified project.

    POST /api/v2/llm-obs/v1/{project_id}/datasets

  • Write

    Update an Agent Observability dataset

    Partially update an existing Agent Observability dataset within the specified project.

    PATCH /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}

  • Write

    Clone an Agent Observability dataset

    Clone a dataset, copying its current records into a new dataset within the same project.

    POST /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/clone

  • Write

    Lock Agent Observability dataset draft state

    Acquire the draft lock on a dataset for the calling user. The lock prevents other users from concurrently editing the dataset draft.

    PATCH /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/draft_state/lock

  • Write

    Unlock Agent Observability dataset draft state

    Release the draft lock on a dataset held by the calling user, allowing other users to edit the dataset draft.

    PATCH /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/draft_state/unlock

  • Write

    Update Agent Observability dataset records

    Update one or more existing records in an Agent Observability dataset.

    PATCH /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records

  • Write

    Append records to an Agent Observability dataset

    Append one or more records to an Agent Observability dataset.

    POST /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records

  • Destructive

    Delete a custom evaluator configuration

    Delete a custom Agent Observability evaluator configuration by its name.

    DELETE /api/unstable/llm-obs/config/evaluators/custom/{eval_name}

  • Destructive

    Create or update a custom evaluator configuration

    Create or update a custom Agent Observability evaluator configuration by its name.

    PUT /api/unstable/llm-obs/config/evaluators/custom/{eval_name}

  • Destructive

    Delete an Agent Observability annotation queue

    Delete an annotation queue by its ID.

    DELETE /api/v2/llm-obs/v1/annotation-queues/{queue_id}

  • Destructive

    Delete annotations

    Delete one or more annotations from an annotation queue.

    POST /api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotations/delete

  • Destructive

    Delete annotation queue interactions

    Delete one or more interactions from an annotation queue.

    POST /api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactions/delete

  • Destructive

    Update annotation queue label schema

    Create or replace the label schema for a given annotation queue. The label schema defines the labels annotators can apply to interactions in the queue. Label names must be unique within the queue and match the pattern `^[a-zA-Z0-9_-]+$`. Each label must have a valid type: score, categorical, boolean, or text.

    PUT /api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema

  • Destructive

    Delete Agent Observability experiments

    Delete one or more Agent Observability experiments.

    POST /api/v2/llm-obs/v1/experiments/delete

  • Destructive

    Delete Agent Observability projects

    Delete one or more Agent Observability projects.

    POST /api/v2/llm-obs/v1/projects/delete

  • Destructive

    Delete an Agent Observability prompt

    Soft-delete an Agent Observability prompt. The prompt's version rows are retained, but they are no longer accessible through the public prompt registry endpoints.

    DELETE /api/v2/llm-obs/v1/prompts/{prompt_id}

  • Destructive

    Create or update a patterns configuration

    Create a new patterns configuration, or update an existing one when a configuration ID is provided.

    PUT /api/v2/llm-obs/v1/topic-discovery-configs

  • Destructive

    Delete a patterns configuration

    Delete a patterns configuration by its ID.

    DELETE /api/v2/llm-obs/v1/topic-discovery-configs/{config_id}

  • Destructive

    Delete Agent Observability datasets

    Delete one or more Agent Observability datasets within the specified project.

    POST /api/v2/llm-obs/v1/{project_id}/datasets/delete

  • Destructive

    Batch update Agent Observability dataset records

    Insert, update, and delete records in a single dataset operation. By default, a new dataset version is created when the batch is applied.

    POST /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/batch_update

  • Destructive

    Delete Agent Observability dataset records

    Delete one or more records from an Agent Observability dataset.

    POST /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records/delete

  • Destructive

    Restore an Agent Observability dataset version

    Restore a dataset to a previous version. The dataset's current version is bumped, and its records are replaced with the records from the specified prior version.

    POST /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/restore

  • Destructive

    Upload records to an Agent Observability dataset

    Upload records to a dataset from a file. The request is a `multipart/form-data` upload containing a single `file` part. Currently only CSV is supported. The CSV must include an `input` column. Optional columns are `id`, `expected_output`, `metadata`, and `tags`. The response is a Server-Sent Events stream (`text/event-stream`) emitting progress updates while records are processed. The stream emits the following named events: - `progress`: incremental record counts written so far. - `completed`: terminal event with a JSON body containing `records_created`. - `error`: terminal event with a JSON body containing an error `message`.

    POST /api/v2/llm-obs/v2/{project_id}/datasets/{dataset_id}/records/upload

Actions Datastores

  • Read

    List datastores

    Lists all datastores for the organization.

    GET /api/v2/actions-datastores

  • Read

    Get datastore

    Retrieves a specific datastore by its ID.

    GET /api/v2/actions-datastores/{datastore_id}

  • Read

    List datastore items

    Lists items from a datastore. You can filter the results by specifying either an item key or a filter query parameter, but not both at the same time. Supports server-side pagination for large datasets.

    GET /api/v2/actions-datastores/{datastore_id}/items

  • Write

    Create datastore

    Creates a new datastore.

    POST /api/v2/actions-datastores

  • Write

    Update datastore

    Updates an existing datastore's attributes.

    PATCH /api/v2/actions-datastores/{datastore_id}

  • Write

    Update datastore item

    Partially updates an item in a datastore by its key.

    PATCH /api/v2/actions-datastores/{datastore_id}/items

  • Destructive

    Delete datastore

    Deletes a datastore by its unique identifier.

    DELETE /api/v2/actions-datastores/{datastore_id}

  • Destructive

    Delete datastore item

    Deletes an item from a datastore by its key.

    DELETE /api/v2/actions-datastores/{datastore_id}/items

  • Destructive

    Bulk delete datastore items

    Deletes multiple items from a datastore by their keys in a single operation.

    DELETE /api/v2/actions-datastores/{datastore_id}/items/bulk

  • Destructive

    Bulk write datastore items

    Creates or replaces multiple items in a datastore by their keys in a single operation.

    POST /api/v2/actions-datastores/{datastore_id}/items/bulk

Action Connection

  • Read

    List App Key Registrations

    List App Key Registrations

    GET /api/v2/actions/app_key_registrations

  • Read

    Get an existing App Key Registration

    Get an existing App Key Registration

    GET /api/v2/actions/app_key_registrations/{app_key_id}

  • Read

    Get an existing Action Connection

    Get an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).

    GET /api/v2/actions/connections/{connection_id}

  • Write

    Create a new Action Connection

    Create a new Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).

    POST /api/v2/actions/connections

  • Destructive

    Unregister an App Key

    Unregister an App Key

    DELETE /api/v2/actions/app_key_registrations/{app_key_id}

  • Destructive

    Register a new App Key

    Register a new App Key

    PUT /api/v2/actions/app_key_registrations/{app_key_id}

  • Destructive

    Delete an existing Action Connection

    Delete an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    DELETE /api/v2/actions/connections/{connection_id}

  • Destructive

    Update an existing Action Connection

    Update an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).

    PATCH /api/v2/actions/connections/{connection_id}

Execution Policy

  • Read

    List execution policies

    Retrieve a list of execution policies for the current organization.

    GET /api/v2/actions/execution-policies

  • Read

    Get an execution policy

    Retrieve an existing execution policy by ID.

    GET /api/v2/actions/execution-policies/{policy_id}

  • Write

    Create an execution policy

    Create a new execution policy.

    POST /api/v2/actions/execution-policies

  • Destructive

    Delete an execution policy

    Delete a specific execution policy.

    DELETE /api/v2/actions/execution-policies/{policy_id}

  • Destructive

    Update an execution policy

    Update an existing execution policy. Returns the execution policy object when the request is successful.

    PUT /api/v2/actions/execution-policies/{policy_id}

Agent Health

  • Read

    List active Agent Health issues

    Returns the active Agent Health issues for a node Agent or Cluster Agent resource.

    GET /api/v2/agenthealth/hosts/{resource_id}/issues

Agentless Scanning

  • Read

    List AWS scan options

    Fetches the scan options configured for AWS accounts.

    GET /api/v2/agentless_scanning/accounts/aws

  • Read

    Get AWS scan options

    Fetches the Agentless scan options for an activated account.

    GET /api/v2/agentless_scanning/accounts/aws/{account_id}

  • Read

    List Azure scan options

    Fetches the scan options configured for Azure accounts.

    GET /api/v2/agentless_scanning/accounts/azure

  • Read

    Get Azure scan options

    Fetches the Agentless scan options for an activated subscription.

    GET /api/v2/agentless_scanning/accounts/azure/{subscription_id}

  • Read

    List GCP scan options

    Fetches the scan options configured for all GCP projects.

    GET /api/v2/agentless_scanning/accounts/gcp

  • Read

    Get GCP scan options

    Fetches the Agentless scan options for an activated GCP project.

    GET /api/v2/agentless_scanning/accounts/gcp/{project_id}

  • Read

    List AWS on demand tasks

    Fetches the most recent 1000 AWS on demand tasks.

    GET /api/v2/agentless_scanning/ondemand/aws

  • Read

    Get AWS on demand task

    Fetch the data of a specific on demand task.

    GET /api/v2/agentless_scanning/ondemand/aws/{task_id}

  • Write

    Create AWS scan options

    Activate Agentless scan options for an AWS account.

    POST /api/v2/agentless_scanning/accounts/aws

  • Write

    Update AWS scan options

    Update the Agentless scan options for an activated account.

    PATCH /api/v2/agentless_scanning/accounts/aws/{account_id}

  • Write

    Create Azure scan options

    Activate Agentless scan options for an Azure subscription.

    POST /api/v2/agentless_scanning/accounts/azure

  • Write

    Update Azure scan options

    Update the Agentless scan options for an activated subscription.

    PATCH /api/v2/agentless_scanning/accounts/azure/{subscription_id}

  • Write

    Create GCP scan options

    Activate Agentless scan options for a GCP project.

    POST /api/v2/agentless_scanning/accounts/gcp

  • Write

    Update GCP scan options

    Update the Agentless scan options for an activated GCP project.

    PATCH /api/v2/agentless_scanning/accounts/gcp/{project_id}

  • Write

    Create AWS on demand task

    Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan.

    POST /api/v2/agentless_scanning/ondemand/aws

  • Destructive

    Delete AWS scan options

    Delete Agentless scan options for an AWS account.

    DELETE /api/v2/agentless_scanning/accounts/aws/{account_id}

  • Destructive

    Delete Azure scan options

    Delete Agentless scan options for an Azure subscription.

    DELETE /api/v2/agentless_scanning/accounts/azure/{subscription_id}

  • Destructive

    Delete GCP scan options

    Delete Agentless scan options for a GCP project.

    DELETE /api/v2/agentless_scanning/accounts/gcp/{project_id}

Delivery Performance

  • Read

    Get a list of deployment events

    Use this API endpoint to get a list of deployment events.

    POST /api/v2/dora/deployments

  • Read

    Get a deployment event

    Use this API endpoint to get a deployment event.

    GET /api/v2/dora/deployments/{deployment_id}

  • Read

    Get a list of incident events

    Use this API endpoint to get a list of incident events.

    POST /api/v2/dora/failures

  • Read

    Get an incident event

    Use this API endpoint to get an incident event.

    GET /api/v2/dora/failures/{failure_id}

  • Write

    Send AI tool user activity

    Send daily AI coding tool activity for one or more users. Each entry records whether a user was active on a given day, along with the AI tools and models they used. An entry is stored once per tool, and sending the same user, day, and tool again overwrites the previous value.

    POST /api/v2/ai_impact/user_activity

  • Write

    Send a deployment event

    Use this API endpoint to provide deployment data. This is necessary for: - Deployment Frequency - Change Lead Time - Change Failure Rate - Failed Deployment Recovery Time

    POST /api/v2/dora/deployment

  • Write

    Mark a deployment as failed by version

    Update a deployment's change failure status, identifying the deployment by its service, environment, and version instead of its ID. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation. If multiple deployments match the given service, environment, and version, the most recently finished one is updated.

    PATCH /api/v2/dora/deployments

  • Write

    Mark a deployment as failed by ID

    Update a deployment's change failure status. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation.

    PATCH /api/v2/dora/deployments/{deployment_id}

  • Write

    Send an incident event

    Use this API endpoint to provide incident data for DORA Metrics. Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency.

    POST /api/v2/dora/failure

  • Write

    Send an incident event (legacy) (deprecated)

    **Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead. Use this API endpoint to provide incident data. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents.

    POST /api/v2/dora/incident

  • Destructive

    Delete a deployment event

    Use this API endpoint to delete a deployment event.

    DELETE /api/v2/dora/deployment/{deployment_id}

  • Destructive

    Delete an incident event

    Use this API endpoint to delete an incident event.

    DELETE /api/v2/dora/failure/{failure_id}

Annotations

  • Read

    List annotations

    Returns a flat list of annotations matching the given page, time window, and optional widget filter.

    GET /api/v2/annotation

  • Read

    Get annotations for a page

    Returns all annotations on a specific page for a given time window, grouped by widget. Unlike `ListAnnotations`, this endpoint returns a single structured object with annotations indexed by their ID and a widget-to-annotation mapping for easy UI rendering.

    GET /api/v2/annotation/page/{page_id}

  • Write

    Create an annotation

    Creates a new annotation on a dashboard or notebook page. Valid `color` values: `gray`, `blue`, `purple`, `green`, `yellow`, `red`. Valid `type` values: `pointInTime` (marks a single moment) or `timeRegion` (spans a range and requires `end_time`).

    POST /api/v2/annotation

  • Destructive

    Delete an annotation

    Deletes an existing annotation by ID. Returns `204 No Content` if the annotation does not exist (idempotent).

    DELETE /api/v2/annotation/{annotation_id}

  • Destructive

    Update an annotation

    Updates an existing annotation. Valid `color` values: `gray`, `blue`, `purple`, `green`, `yellow`, `red`. Valid `type` values: `pointInTime` (marks a single moment) or `timeRegion` (spans a range and requires `end_time`).

    PUT /api/v2/annotation/{annotation_id}

API Management

  • Read

    List APIs (deprecated)

    List APIs and their IDs.

    GET /api/v2/apicatalog/api

  • Read

    Get an API (deprecated)

    Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html) format file.

    GET /api/v2/apicatalog/api/{id}/openapi

  • Write

    Create a new API (deprecated)

    Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html) specification given. See the [API Catalog documentation](https://docs.datadoghq.com/api_catalog/add_metadata/) for additional information about the possible metadata. It returns the created API ID.

    POST /api/v2/apicatalog/openapi

  • Destructive

    Delete an API (deprecated)

    Delete a specific API by ID.

    DELETE /api/v2/apicatalog/api/{id}

  • Destructive

    Update an API (deprecated)

    Update information about a specific API. The given content will replace all API content of the given ID. The ID is returned by the create API, or can be found in the URL in the API catalog UI.

    PUT /api/v2/apicatalog/api/{id}/openapi

Spans Metrics

  • Read

    Get all span-based metrics

    Get the list of configured span-based metrics with their definitions.

    GET /api/v2/apm/config/metrics

  • Read

    Get a span-based metric

    Get a specific span-based metric from your organization.

    GET /api/v2/apm/config/metrics/{metric_id}

  • Write

    Create a span-based metric

    Create a metric based on your ingested spans in your organization. Returns the span-based metric object from the request body when the request is successful.

    POST /api/v2/apm/config/metrics

  • Write

    Update a span-based metric

    Update a specific span-based metric from your organization. Returns the span-based metric object from the request body when the request is successful.

    PATCH /api/v2/apm/config/metrics/{metric_id}

  • Destructive

    Delete a span-based metric

    Delete a specific span-based metric from your organization.

    DELETE /api/v2/apm/config/metrics/{metric_id}

APM Retention Filters

  • Read

    List all APM retention filters

    Get the list of APM retention filters.

    GET /api/v2/apm/config/retention-filters

  • Read

    Get a given APM retention filter

    Get an APM retention filter.

    GET /api/v2/apm/config/retention-filters/{filter_id}

  • Write

    Create a retention filter

    Create a retention filter to index spans in your organization. Returns the retention filter definition when the request is successful. Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created.

    POST /api/v2/apm/config/retention-filters

  • Destructive

    Re-order retention filters

    Re-order the execution order of retention filters.

    PUT /api/v2/apm/config/retention-filters-execution-order

  • Destructive

    Delete a retention filter

    Delete a specific retention filter from your organization. Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted.

    DELETE /api/v2/apm/config/retention-filters/{filter_id}

  • Destructive

    Update a retention filter

    Update a retention filter from your organization. Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed.

    PUT /api/v2/apm/config/retention-filters/{filter_id}

APM

  • Read

    Get service list

    GET /api/v2/apm/services

    GET /api/v2/apm/services

App Builder

  • Read

    List Apps

    List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    GET /api/v2/app-builder/apps

  • Read

    Get App

    Get the full definition of an app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    GET /api/v2/app-builder/apps/{app_id}

  • Read

    List App Versions

    List the versions of an app. This endpoint is paginated.

    GET /api/v2/app-builder/apps/{app_id}/versions

  • Read

    Get Blueprint

    Retrieve an app blueprint by its ID.

    GET /api/v2/app-builder/blueprint/{blueprint_id}

  • Read

    List Blueprints

    List available app blueprints.

    GET /api/v2/app-builder/blueprints

  • Read

    Get Blueprints by Integration ID

    List app blueprints associated with a specific integration ID.

    GET /api/v2/app-builder/blueprints/integration-id/{integration_id}

  • Read

    Get Blueprints by Slugs

    Retrieve app blueprints by their slugs.

    GET /api/v2/app-builder/blueprints/slugs/{slugs}

  • Read

    List Tags

    List all tags associated with the authenticated user's apps.

    GET /api/v2/app-builder/tags

  • Write

    Create App

    Create a new app, returning the app ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    POST /api/v2/app-builder/apps

  • Write

    Publish App

    Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    POST /api/v2/app-builder/apps/{app_id}/deployment

  • Write

    Update App Favorite Status

    Add or remove an app from the current user's favorites. Favorited apps can be filtered for using the `filter[favorite]` query parameter on the [List Apps](https://docs.datadoghq.com/api/latest/app-builder/#list-apps) endpoint.

    PATCH /api/v2/app-builder/apps/{app_id}/favorite

  • Write

    Update App Protection Level

    Update the publication protection level of an app. When set to `approval_required`, future publishes must go through an approval workflow before going live.

    PATCH /api/v2/app-builder/apps/{app_id}/protection-level

  • Write

    Create Publish Request

    Create a publish request to ask for approval to publish an app whose protection level is `approval_required`. Publishing happens automatically once the request is approved by a user with the appropriate permissions.

    POST /api/v2/app-builder/apps/{app_id}/publish-request

  • Write

    Revert App

    Revert an app to a previous version. The version to revert to is selected through the `version` query parameter. The reverted version becomes the new latest version of the app.

    POST /api/v2/app-builder/apps/{app_id}/revert

  • Write

    Update App Self-Service Status

    Enable or disable self-service for an app. Self-service apps can be discovered and run by users in your organization without explicit access being granted.

    PATCH /api/v2/app-builder/apps/{app_id}/self-service

  • Write

    Name App Version

    Assign a human-readable name to a specific version of an app. The version is selected through the `version` query parameter.

    PATCH /api/v2/app-builder/apps/{app_id}/version-name

  • Destructive

    Delete Multiple Apps

    Delete multiple apps in a single request from a list of app IDs. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    DELETE /api/v2/app-builder/apps

  • Destructive

    Delete App

    Delete a single app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    DELETE /api/v2/app-builder/apps/{app_id}

  • Destructive

    Update App

    Update an existing app. This creates a new version of the app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    PATCH /api/v2/app-builder/apps/{app_id}

  • Destructive

    Unpublish App

    Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a `deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    DELETE /api/v2/app-builder/apps/{app_id}/deployment

  • Destructive

    Update App Tags

    Replace the tags on an app. The provided list overwrites the existing tags entirely; tags not present in the request body are removed.

    PATCH /api/v2/app-builder/apps/{app_id}/tags

Audit

  • Read

    Get a list of Audit Logs events

    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

    GET /api/v2/audit/events

  • Read

    Search Audit Logs events

    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

    POST /api/v2/audit/events/search

Auth N Mappings

  • Read

    List all AuthN Mappings

    List all AuthN Mappings in the organization.

    GET /api/v2/authn_mappings

  • Read

    Get an AuthN Mapping by UUID

    Get an AuthN Mapping specified by the AuthN Mapping UUID.

    GET /api/v2/authn_mappings/{authn_mapping_id}

  • Write

    Create an AuthN Mapping

    Create an AuthN Mapping.

    POST /api/v2/authn_mappings

  • Write

    Edit an AuthN Mapping

    Edit an AuthN Mapping.

    PATCH /api/v2/authn_mappings/{authn_mapping_id}

  • Destructive

    Delete an AuthN Mapping

    Delete an AuthN Mapping specified by AuthN Mapping UUID.

    DELETE /api/v2/authn_mappings/{authn_mapping_id}

Bits AI

  • Read

    List Bits AI investigations

    List all Bits AI investigations for the organization.

    GET /api/v2/bits-ai/investigations

  • Read

    Get a Bits AI investigation

    Get a specific Bits AI investigation by ID.

    GET /api/v2/bits-ai/investigations/{id}

  • Write

    Trigger a Bits AI investigation

    Trigger a Bits AI investigation from a monitor alert or a general investigation. This endpoint requires the `bits_investigations_write` permission. When the trigger type is `monitor_alert_trigger`, the `monitors_read` permission is also required.

    POST /api/v2/bits-ai/investigations

Case Management

  • Read

    Search cases

    Search work items.

    GET /api/v2/cases

  • Read

    Count cases

    Returns work item counts, optionally grouped by one or more fields (for example, status, priority). Supports a query filter to narrow the scope.

    GET /api/v2/cases/count

  • Read

    Get all projects

    Get all projects.

    GET /api/v2/cases/projects

  • Read

    List project favorites

    Returns the list of Work Management projects that the current authenticated user has marked as favorites.

    GET /api/v2/cases/projects/favorites

  • Read

    Get the details of a project

    Get the details of a project by `project_id`.

    GET /api/v2/cases/projects/{project_id}

  • Read

    Get notification rules

    Get all notification rules for a project.

    GET /api/v2/cases/projects/{project_id}/notification_rules

  • Read

    List automation rules

    Returns all automation rules configured for a project. Automation rules allow automatic actions to be triggered by work item events like creation, status transitions, or attribute changes.

    GET /api/v2/cases/projects/{project_id}/rules

  • Read

    Get an automation rule

    Returns a single automation rule identified by its UUID, including its trigger, action, and current state (enabled/disabled).

    GET /api/v2/cases/projects/{project_id}/rules/{rule_id}

  • Read

    List case views

    Returns all saved work item views for a given project. Views are saved search queries that allow quick access to filtered lists of work items.

    GET /api/v2/cases/views

  • Read

    Get a case view

    Returns a single saved work item view identified by its UUID, including its query, associated project, and timestamps.

    GET /api/v2/cases/views/{view_id}

  • Read

    Get the details of a case

    Get the details of a work item by `case_id`.

    GET /api/v2/cases/{case_id}

  • Read

    Get case timeline

    Returns the timeline of events for a work item, including comments, status changes, and other activity. Supports pagination and sort order.

    GET /api/v2/cases/{case_id}/timelines

  • Read

    List case watchers

    Returns the list of users who are watching a work item. Watchers receive notifications about updates to the work item.

    GET /api/v2/cases/{case_id}/watchers

  • Read

    List maintenance windows

    Returns all configured maintenance windows for event management work items. Maintenance windows define time periods during which work item notifications and automation rules are suppressed for work items matching a given query.

    GET /api/v2/maintenance_windows

  • Write

    Create a case

    Create a work item

    POST /api/v2/cases

  • Write

    Aggregate cases

    Performs an aggregation query over work items, grouping results by specified fields and returning counts per group along with a total. Useful for dashboards and analytics.

    POST /api/v2/cases/aggregate

  • Write

    Bulk update cases

    Applies a single action (such as changing priority, status, assignment, or archiving) to multiple work items at once. The list of work item IDs and the action type with its payload are specified in the request body.

    POST /api/v2/cases/bulk

  • Write

    Create a project

    Create a project.

    POST /api/v2/cases/projects

  • Write

    Update a project

    Update a project.

    PATCH /api/v2/cases/projects/{project_id}

  • Write

    Favorite a project

    Marks a Work Management project as a favorite for the current authenticated user.

    POST /api/v2/cases/projects/{project_id}/favorites

  • Write

    Create a notification rule

    Create a notification rule for a project.

    POST /api/v2/cases/projects/{project_id}/notification_rules

  • Write

    Create an automation rule

    Creates an automation rule for a project. The rule defines a trigger event (for example, work item created, status transitioned) and an action to execute.

    POST /api/v2/cases/projects/{project_id}/rules

  • Write

    Disable an automation rule

    Disables an automation rule so it no longer triggers on work item events. The rule configuration is preserved.

    POST /api/v2/cases/projects/{project_id}/rules/{rule_id}/disable

  • Write

    Enable an automation rule

    Enables a previously disabled automation rule so it triggers on matching work item events.

    POST /api/v2/cases/projects/{project_id}/rules/{rule_id}/enable

  • Write

    Create a case view

    Creates a new saved work item view with a name, filter query, and associated project. Optionally, a notification rule can be linked to the view.

    POST /api/v2/cases/views

  • Write

    Assign case

    Assign work item to a user

    POST /api/v2/cases/{case_id}/assign

  • Write

    Update case attributes

    Update work item attributes

    POST /api/v2/cases/{case_id}/attributes

  • Write

    Comment case

    Add a comment to a work item.

    POST /api/v2/cases/{case_id}/comment

  • Write

    Update case custom attribute

    Update work item custom attribute

    POST /api/v2/cases/{case_id}/custom_attributes/{custom_attribute_key}

  • Write

    Update case description

    Update work item description

    POST /api/v2/cases/{case_id}/description

  • Write

    Update case due date

    Sets or updates the due date for a work item. The due date is a calendar date (without a time component) indicating when the work item should be resolved.

    POST /api/v2/cases/{case_id}/due_date

  • Write

    Update case priority

    Update work item priority

    POST /api/v2/cases/{case_id}/priority

  • Write

    Link incident to case

    Link an incident to a work item

    POST /api/v2/cases/{case_id}/relationships/incidents

  • Write

    Link existing Jira issue to case

    Link an existing Jira issue to a work item

    PATCH /api/v2/cases/{case_id}/relationships/jira_issues

  • Write

    Create Jira issue for case

    Create a new Jira issue and link it to a work item

    POST /api/v2/cases/{case_id}/relationships/jira_issues

  • Write

    Create investigation notebook for case

    Create a new investigation notebook and link it to a work item

    POST /api/v2/cases/{case_id}/relationships/notebook

  • Write

    Update case project

    Update the project associated with a work item

    PATCH /api/v2/cases/{case_id}/relationships/project

  • Write

    Create ServiceNow ticket for case

    Create a new ServiceNow incident ticket and link it to a work item

    POST /api/v2/cases/{case_id}/relationships/servicenow_tickets

  • Write

    Update case resolved reason

    Sets the resolved reason for a security work item (for example, FALSE_POSITIVE, TRUE_POSITIVE). Applicable to security-type work items.

    POST /api/v2/cases/{case_id}/resolved_reason

  • Write

    Update case status

    Update work item status

    POST /api/v2/cases/{case_id}/status

  • Write

    Update case title

    Update work item title

    POST /api/v2/cases/{case_id}/title

  • Write

    Unarchive case

    Unarchive work item

    POST /api/v2/cases/{case_id}/unarchive

  • Write

    Unassign case

    Unassign work item

    POST /api/v2/cases/{case_id}/unassign

  • Write

    Watch a case

    Adds a user (identified by their UUID) as a watcher of a work item. The user receives notifications about subsequent updates to the work item.

    POST /api/v2/cases/{case_id}/watchers/{user_uuid}

  • Write

    Create a maintenance window

    Creates a maintenance window for event management work items with a name, work item filter query, and time range (start and end).

    POST /api/v2/maintenance_windows

  • Destructive

    Remove a project

    Remove a project using the project's `id`.

    DELETE /api/v2/cases/projects/{project_id}

  • Destructive

    Unfavorite a project

    Removes a Work Management project from the current user's favorites list.

    DELETE /api/v2/cases/projects/{project_id}/favorites

  • Destructive

    Delete a notification rule

    Delete a notification rule using the notification rule's `id`.

    DELETE /api/v2/cases/projects/{project_id}/notification_rules/{notification_rule_id}

  • Destructive

    Update a notification rule

    Update a notification rule.

    PUT /api/v2/cases/projects/{project_id}/notification_rules/{notification_rule_id}

  • Destructive

    Delete an automation rule

    Permanently deletes an automation rule from a project.

    DELETE /api/v2/cases/projects/{project_id}/rules/{rule_id}

  • Destructive

    Update an automation rule

    Updates the trigger, action, name, or state of an existing automation rule.

    PUT /api/v2/cases/projects/{project_id}/rules/{rule_id}

  • Destructive

    Delete a case view

    Permanently deletes a saved work item view.

    DELETE /api/v2/cases/views/{view_id}

  • Destructive

    Update a case view

    Updates the name, query, or notification rule of an existing work item view.

    PUT /api/v2/cases/views/{view_id}

  • Destructive

    Archive case

    Archive work item

    POST /api/v2/cases/{case_id}/archive

  • Destructive

    Delete case comment

    Delete work item comment

    DELETE /api/v2/cases/{case_id}/comment/{cell_id}

  • Destructive

    Update case comment

    Updates the text content of an existing comment on a work item timeline. The comment is identified by its cell ID.

    PUT /api/v2/cases/{case_id}/comment/{cell_id}

  • Destructive

    Delete custom attribute from case

    Delete custom attribute from work item

    DELETE /api/v2/cases/{case_id}/custom_attributes/{custom_attribute_key}

  • Destructive

    Remove insights from a case

    Removes one or more previously added insights from a work item by specifying their type and resource identifier in the request body.

    DELETE /api/v2/cases/{case_id}/insights

  • Destructive

    Add insights to a case

    Adds one or more insights to a work item. Insights are references to related Datadog resources (such as monitors, security signals, incidents, or error tracking issues) that provide investigative context. Up to 100 insights can be added per request. Each insight requires a type (see `CaseInsightType` for allowed values), a ref (URL path to the resource), and a resource_id.

    PUT /api/v2/cases/{case_id}/insights

  • Destructive

    Remove Jira issue link from case

    Remove the link between a Jira issue and a work item

    DELETE /api/v2/cases/{case_id}/relationships/jira_issues

  • Destructive

    Unwatch a case

    Removes a user from the watchers list of a work item. The user no longer receives notifications about updates to the work item.

    DELETE /api/v2/cases/{case_id}/watchers/{user_uuid}

  • Destructive

    Delete a maintenance window

    Permanently deletes a maintenance window.

    DELETE /api/v2/maintenance_windows/{maintenance_window_id}

  • Destructive

    Update a maintenance window

    Updates the name, query, start time, or end time of an existing maintenance window.

    PUT /api/v2/maintenance_windows/{maintenance_window_id}

Case Management Type

  • Read

    Get all case types

    Get all work item types

    GET /api/v2/cases/types

  • Write

    Create a case type

    Create a work item type.

    POST /api/v2/cases/types

  • Destructive

    Delete a case type

    Delete a work item type

    DELETE /api/v2/cases/types/{case_type_id}

  • Destructive

    Update a case type

    Updates the name, emoji, or description of an existing work item type.

    PUT /api/v2/cases/types/{case_type_id}

Case Management Attribute

  • Read

    Get all custom attributes

    Get all custom attributes

    GET /api/v2/cases/types/custom_attributes

  • Read

    Get all custom attributes config of case type

    Get custom attribute configurations for a work item type.

    GET /api/v2/cases/types/{case_type_id}/custom_attributes

  • Write

    Create custom attribute config for a case type

    Create a custom attribute configuration for a work item type.

    POST /api/v2/cases/types/{case_type_id}/custom_attributes

  • Destructive

    Delete custom attributes config

    Delete custom attribute config

    DELETE /api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}

  • Destructive

    Update custom attribute config

    Updates the display name, description, type, or options of an existing custom attribute configuration for a work item type.

    PUT /api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}

Software Catalog

  • Read

    Get a list of entities

    Get a list of entities from Software Catalog.

    GET /api/v2/catalog/entity

  • Read

    Preview catalog entities

    POST /api/v2/catalog/entity/preview

    POST /api/v2/catalog/entity/preview

  • Read

    Get a list of entity kinds

    Get a list of entity kinds from Software Catalog.

    GET /api/v2/catalog/kind

  • Read

    Get a list of entity relations

    Get a list of entity relations from Software Catalog.

    GET /api/v2/catalog/relation

  • Write

    Create or update entities

    Create or update entities in Software Catalog.

    POST /api/v2/catalog/entity

  • Write

    Create or update kinds

    Create or update kinds in Software Catalog.

    POST /api/v2/catalog/kind

  • Destructive

    Delete a single entity

    Delete a single entity in Software Catalog.

    DELETE /api/v2/catalog/entity/{entity_id}

  • Destructive

    Delete a single kind

    Delete a single kind in Software Catalog.

    DELETE /api/v2/catalog/kind/{kind_id}

Change Management

  • Read

    Get a change request

    Get the details of a change request by its ID.

    GET /api/v2/change-management/change-request/{change_request_id}

  • Write

    Create a change request

    Create a new change request.

    POST /api/v2/change-management/change-request

  • Write

    Update a change request

    Update the properties of a change request.

    PATCH /api/v2/change-management/change-request/{change_request_id}

  • Write

    Create a change request branch

    Create a new branch in a repository for a change request.

    POST /api/v2/change-management/change-request/{change_request_id}/branch

  • Write

    Update a change request decision

    Update a decision on a change request, such as approving or declining it.

    PATCH /api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}

  • Destructive

    Delete a change request decision

    Delete a decision from a change request.

    DELETE /api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}

CI Visibility Git Hub Accounts

  • Read

    List GitHub CI Visibility status

    Retrieve the list of GitHub accounts (organizations or users) available to this Datadog organization through its GitHub App installation, along with each account's and repository's CI Visibility opt-in status.

    GET /api/v2/ci/github/accounts

  • Write

    Update GitHub CI Visibility status

    Enable or disable CI Visibility for a GitHub account, one of its repositories, or both in the same request. The account (and, optionally, repository) are identified by name. Account-level and repository-level changes are independent and may both be supplied in the same request. At least one of `enabled` or `repository.enabled` must be provided. If the account name matches installations on more than one host, `host` must be supplied to disambiguate, otherwise a 409 is returned. Returns a 404 if the CI Visibility GitHub integration is not enabled for this organization, or if the given account or repository cannot be found by name.

    PATCH /api/v2/ci/github/accounts

CI Visibility Pipelines

  • Read

    Get a list of pipelines events

    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.

    GET /api/v2/ci/pipelines/events

  • Read

    Search pipelines events

    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.

    POST /api/v2/ci/pipelines/events/search

  • Write

    Send pipeline event

    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/). Multiple events can be sent in an array (up to 1000). Pipeline events can be submitted with a timestamp that is up to 18 hours in the past. The duration between the event start and end times cannot exceed 1 year.

    POST /api/v2/ci/pipeline

  • Write

    Aggregate pipelines events

    Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries.

    POST /api/v2/ci/pipelines/analytics/aggregate

Test Optimization

  • Read

    Get Flaky Tests Management policies

    Retrieve Flaky Tests Management repository-level policies for the given repository.

    POST /api/v2/ci/test-optimization/settings/policies

  • Read

    Get Test Optimization service settings

    Retrieve Test Optimization settings for a specific service identified by repository, service name, and environment.

    POST /api/v2/ci/test-optimization/settings/service

  • Read

    Search flaky tests

    List endpoint returning flaky tests from Flaky Test Management. Results are paginated. The response includes comprehensive test information including: - Test identification and metadata (module, suite, name) - Flaky state and categorization - First and last flake occurrences (timestamp, branch, commit SHA) - Test execution statistics from the last 7 days (failure rate) - Pipeline impact metrics (failed pipelines count, total lost time) - Complete status change history (optional, ordered from most recent to oldest) Set `include_history` to `true` in the request to receive the status change history for each test. History is disabled by default for better performance. Results support filtering by various facets including service, environment, repository, branch, and test state.

    POST /api/v2/test/flaky-test-management/tests

  • Write

    Update Flaky Tests Management policies

    Partially update Flaky Tests Management repository-level policies for the given repository. Only provided policy blocks are updated; omitted blocks are left unchanged.

    PATCH /api/v2/ci/test-optimization/settings/policies

  • Write

    Update Test Optimization service settings

    Partially update Test Optimization settings for a specific service identified by repository, service name, and environment. Only provided fields are updated; setting a field to `null` is a no-op. To reset a setting to inherit from the repository level, use the corresponding `<setting>_inherit` field. The `pr_comments_enabled` field is ignored as it cannot be overridden at the service level.

    PATCH /api/v2/ci/test-optimization/settings/service

  • Write

    Update flaky test states

    Update the state of multiple flaky tests in Flaky Test Management.

    PATCH /api/v2/test/flaky-test-management/tests

  • Destructive

    Delete Test Optimization service settings

    Delete Test Optimization settings for a specific service identified by repository, service name, and environment.

    DELETE /api/v2/ci/test-optimization/settings/service

CI Visibility Tests

  • Read

    Get a list of tests events

    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.

    GET /api/v2/ci/tests/events

  • Read

    Search tests events

    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.

    POST /api/v2/ci/tests/events/search

  • Write

    Aggregate tests events

    The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries.

    POST /api/v2/ci/tests/analytics/aggregate

CI Visibility Logs

  • Write

    Send CI job logs

    Send log lines for a CI job over HTTP. See the [CI Visibility Pipelines API](https://docs.datadoghq.com/api/latest/ci-visibility-pipelines/send-pipeline-event/) for submitting the associated pipeline and job events. A request can contain one log object or an array of up to 1,000 log objects. The maximum uncompressed request body size is 5.1 MiB. You can stream log lines while a CI job runs or send them after it finishes. After you submit the completed job event, 20 seconds without a new log line marks the job's logs as complete. Lines sent after that may not appear. A job can have up to 128 additional attributes and 256 tags. Additional attributes are top-level fields with string, number, Boolean, or null values. Nested objects and arrays are rejected. Additional attributes and `ddtags` apply to all log lines in the job. If an additional attribute has different values on different lines, the first value received is used. Tags supplied on different lines are combined. A job can contain up to 2,000,000 log records or 1 GiB of message bytes in total. To reduce request size, send gzip-compressed JSON with the `Content-Encoding: gzip` header. Retry requests after a 408, 429, 500, or 503 response.

    POST /api/v2/cilogs

Storage Management

  • Destructive

    Enable Storage Management for a bucket

    Enable Storage Management for an S3 bucket, GCS bucket, or Azure container by registering the destination that holds its inventory reports. Set `data.id` to the cloud provider (`aws`, `gcp`, or `azure`) and provide the matching settings under data.attributes. Calling this endpoint with the same provider replaces the existing configuration.

    PUT /api/v2/cloudinventoryservice/syncconfigs

  • Destructive

    Delete a Storage Management configuration

    Delete a Storage Management configuration by its unique identifier. Deleting a configuration stops inventory file synchronization for the associated cloud account.

    DELETE /api/v2/cloudinventoryservice/syncconfigs/{id}

Code Coverage

  • Read

    Get code coverage summary for a branch

    Retrieve aggregated code coverage statistics for a specific branch in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service and code owner.

    POST /api/v2/code-coverage/branch/summary

  • Read

    Get code coverage summary for a commit

    Retrieve aggregated code coverage statistics for a specific commit in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service and code owner. The commit SHA must be a 40-character hexadecimal string (SHA-1 hash).

    POST /api/v2/code-coverage/commit/summary

  • Read

    Get per-file code coverage data

    Retrieve per-file code coverage data for a specific commit, branch, or pull request. Exactly one of `commit_sha`, `branch`, or `pr_number` must be provided. Optionally filter by `service`, `codeowner`, or `flag` (at most one).

    POST /api/v2/code-coverage/files

  • Read

    Get code coverage summary for a pull request

    Retrieve aggregated code coverage statistics for a specific pull request in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service and code owner.

    POST /api/v2/code-coverage/pr/summary

Compliance

  • Read

    Get the rule-based view of compliance findings (deprecated)

    **This endpoint is deprecated.** Use the [Security Monitoring - Search Security Findings](https://docs.datadoghq.com/api/latest/security-monitoring/search-security-findings/) endpoint instead. Get an aggregated view of compliance rules with their pass, fail, and muted finding counts. Supports filtering by compliance framework, framework version, and additional query filters.

    GET /api/v2/compliance_findings/rule_based_view

Container Images

  • Read

    Get all Container Images

    Get all Container Images for your organization. **Note**: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint.

    GET /api/v2/container_images

Containers

  • Read

    Get All Containers

    Get all containers for your organization. Use `group_by` to return container groups with counts. Grouped results are limited by `page[size]` and do not support pagination. To get CPU or memory metrics, use a `container` data source query with `/api/v2/query/scalar` or `/api/v2/query/timeseries`.

    GET /api/v2/containers

Cloud Cost Management

  • Read

    Get account filters

    Get the account filters for a cloud account (AWS CUR 1.0/2.0, OCI, and other clouds).

    GET /api/v2/cost/account_filters/{cloud_account_id}

  • Read

    List cost anomalies

    List detected Cloud Cost Management anomalies for the organization.

    GET /api/v2/cost/anomalies

  • Read

    Get cost anomaly

    Get a detected Cloud Cost Management anomaly by UUID.

    GET /api/v2/cost/anomalies/{anomaly_id}

  • Read

    List custom allocation rules

    List all custom allocation rules - Retrieve a list of all custom allocation rules for the organization

    GET /api/v2/cost/arbitrary_rule

  • Read

    List custom allocation rule statuses

    List the processing status of all custom allocation rules. Returns only the ID and processing status for each rule.

    GET /api/v2/cost/arbitrary_rule/status

  • Read

    Get custom allocation rule

    Get a specific custom allocation rule - Retrieve a specific custom allocation rule by its ID

    GET /api/v2/cost/arbitrary_rule/{rule_id}

  • Read

    List Cloud Cost Management AWS CUR configs

    List the AWS CUR configs.

    GET /api/v2/cost/aws_cur_config

  • Read

    Get cost AWS CUR config

    Get a specific AWS CUR config.

    GET /api/v2/cost/aws_cur_config/{cloud_account_id}

  • Read

    List Cloud Cost Management Azure configs

    List the Azure configs.

    GET /api/v2/cost/azure_uc_config

  • Read

    Get cost Azure UC config

    Get a specific Azure config.

    GET /api/v2/cost/azure_uc_config/{cloud_account_id}

  • Read

    Validate CSV budget

    POST /api/v2/cost/budget/csv/validate

    POST /api/v2/cost/budget/csv/validate

  • Read

    Validate budget

    Validate a budget configuration without creating or modifying it

    POST /api/v2/cost/budget/validate

  • Read

    Get budget

    Get a budget by ID. Pass `actual=true` or `forecast=true` to include cost data in the response. Use `start` and `end` (millisecond epochs, both required) to set the cost window. When `forecast=true`, each entry also includes `ootb_forecast` (the ML forecast before overrides) and `custom_forecast` (`null` if no override is set, a number if one is).

    GET /api/v2/cost/budget/{budget_id}

  • Read

    Get a budget's custom forecast

    Get the custom forecast for a budget.

    GET /api/v2/cost/budget/{budget_id}/custom-forecast

  • Read

    List budgets

    List budgets.

    GET /api/v2/cost/budgets

  • Read

    List Cloud Cost Management cloud accounts

    List the OCI and AWS CUR 2.0 cloud accounts for your organization, including account IDs, status, and validation errors. Use `filter[cloud]=oci` or `filter[cloud]=aws_cur2` to return a single cloud. When omitted or empty, both clouds are returned. AWS CUR 1.0, Azure, and GCP accounts are available through their dedicated configuration endpoints. Archived accounts are excluded. The response contains all matching accounts and is not paginated. This endpoint replaces `GET /api/v2/cost/oci_config`. To migrate, use `filter[cloud]=oci` and update clients to accept the `cloud_account` resource type instead of `oci_config`. Account IDs and the existing attributes are preserved; each account also includes the `cloud` attribute.

    GET /api/v2/cost/cloud_accounts

  • Read

    Get commitments list

    Get a list of individual cloud commitments (Reserved Instances or Savings Plans) with their utilization details. The response schema varies based on the provider, product, and commitment type.

    GET /api/v2/cost/commitments/commitment-list

  • Read

    Get commitments coverage (scalar)

    Get scalar coverage metrics for cloud commitment programs, including hours and cost coverage percentages.

    GET /api/v2/cost/commitments/coverage/scalar

  • Read

    Get commitments coverage (timeseries)

    Get timeseries coverage metrics for cloud commitment programs, broken down by coverage type (Reserved Instances, Savings Plans, On-Demand, and Spot) for both hours and cost.

    GET /api/v2/cost/commitments/coverage/timeseries

  • Read

    Get commitments on-demand hot spots (scalar)

    Get scalar on-demand hot-spots data for cloud commitment programs, showing per-dimension breakdowns of on-demand spending with coverage metrics and potential savings.

    GET /api/v2/cost/commitments/on-demand-hot-spots/scalar

  • Read

    Get commitments savings (scalar)

    Get scalar savings metrics for cloud commitment programs, including realized savings and effective savings rate.

    GET /api/v2/cost/commitments/savings/scalar

  • Read

    Get commitments savings (timeseries)

    Get timeseries savings metrics for cloud commitment programs, including actual cost, on-demand equivalent cost, realized savings, and effective savings rate over time.

    GET /api/v2/cost/commitments/savings/timeseries

  • Read

    Get commitments utilization (scalar)

    Get scalar utilization metrics for cloud commitment programs, including utilization percentage and unused cost.

    GET /api/v2/cost/commitments/utilization/scalar

  • Read

    Get commitments utilization (timeseries)

    Get timeseries utilization metrics for cloud commitment programs, including used and unused cost series over time.

    GET /api/v2/cost/commitments/utilization/timeseries

  • Read

    List Custom Costs files

    List the Custom Costs files.

    GET /api/v2/cost/custom_costs

  • Read

    Get Custom Costs file

    Fetch the specified Custom Costs file.

    GET /api/v2/cost/custom_costs/{file_id}

  • Read

    List Google Cloud Usage Cost configs

    List the Google Cloud Usage Cost configs.

    GET /api/v2/cost/gcp_uc_config

  • Read

    Get Google Cloud Usage Cost config

    Get a specific Google Cloud Usage Cost config.

    GET /api/v2/cost/gcp_uc_config/{cloud_account_id}

  • Read

    List Cloud Cost Management OCI configs (deprecated)

    **Note**: This endpoint is deprecated. Use [List Cloud Cost Management cloud accounts](https://docs.datadoghq.com/api/latest/cloud-cost-management/#list-cloud-cost-management-cloud-accounts) with `filter[cloud]=oci` instead. Update clients to accept the `cloud_account` resource type instead of `oci_config`. Account IDs and the existing attributes are preserved; each account also includes the `cloud` attribute. List the OCI configs.

    GET /api/v2/cost/oci_config

  • Read

    Search cost recommendations

    List cost recommendations matching a filter, with pagination and sorting.

    POST /api/v2/cost/recommendations

  • Read

    List Cloud Cost Management tag descriptions

    List Cloud Cost Management tag key descriptions for the organization. Use `filter[cloud]` to scope the result to a single cloud provider; when omitted, both cross-cloud defaults and cloud-specific descriptions are returned.

    GET /api/v2/cost/tag_descriptions

  • Read

    Get a Cloud Cost Management tag description

    Get the Cloud Cost Management description for a single tag key. Use `filter[cloud]` to scope the lookup to a specific cloud provider; when omitted, the response resolves the description in fallback order (cloud-specific organization override, then cloudless organization default, then Datadog's global default).

    GET /api/v2/cost/tag_descriptions/{tag_key}

  • Read

    Generate a Cloud Cost Management tag description

    Use AI to draft a Cloud Cost Management tag key description based on associated cost data. The generated description is returned in the response and is not persisted by this endpoint; follow up with `UpsertCostTagDescriptionByKey` to save it.

    GET /api/v2/cost/tag_descriptions/{tag_key}/generate

  • Read

    List Cloud Cost Management tag keys

    List Cloud Cost Management tag keys.

    GET /api/v2/cost/tag_keys

  • Read

    Get a Cloud Cost Management tag key

    Get details for a specific Cloud Cost Management tag key, including example tag values and description.

    GET /api/v2/cost/tag_keys/{tag_key}

  • Read

    List Cloud Cost Management tag key metadata

    List Cloud Cost Management tag key metadata, including row counts, cost covered, cardinality, and a sample of top tag values per cloud account. Use `filter[daily]=true` to return daily rows instead of the default monthly roll-up.

    GET /api/v2/cost/tag_metadata

  • Read

    Get the Cloud Cost Management billing currency

    Get the dominant billing currency observed in Cloud Cost Management data for the requested period. The response wraps the currency in a JSON:API `data` array containing at most one entry; the array is empty when no currency data is available.

    GET /api/v2/cost/tag_metadata/currency

  • Read

    List available Cloud Cost Management metrics

    List Cloud Cost Management metrics that have data for the requested period.

    GET /api/v2/cost/tag_metadata/metrics

  • Read

    List Cloud Cost Management tag metadata months

    List months that have Cloud Cost Management tag metadata for a given provider, ordered most-recent first. The response is capped at 36 months.

    GET /api/v2/cost/tag_metadata/months

  • Read

    List Cloud Cost Management orchestrators

    List container orchestrators (for example, `kubernetes`, `ecs`) detected in Cloud Cost Management data for the requested period.

    GET /api/v2/cost/tag_metadata/orchestrators

  • Read

    List Cloud Cost Management tag sources

    List Cloud Cost Management tag keys observed for the requested period, along with the origin sources that produced them (for example, `aws-user-defined`, `custom`).

    GET /api/v2/cost/tag_metadata/tag_sources

  • Read

    List Cloud Cost Management tags

    List Cloud Cost Management tags for a given metric.

    GET /api/v2/cost/tags

  • Read

    List unit costs

    List the ROI metrics (unit costs) for the authenticated organization.

    GET /api/v2/cost/unit_costs

  • Read

    Get a unit cost

    Retrieve an ROI metric (unit cost) by UUID.

    GET /api/v2/cost/unit_costs/{unit_cost_id}

  • Read

    List tag pipeline rulesets

    List all tag pipeline rulesets - Retrieve a list of all tag pipeline rulesets for the organization

    GET /api/v2/tags/enrichment

  • Read

    List tag pipeline ruleset statuses

    List the processing status of all tag pipeline rulesets. Returns only the ID and processing status for each ruleset.

    GET /api/v2/tags/enrichment/status

  • Read

    Validate query

    Validate a tag pipeline query - Validate the syntax and structure of a tag pipeline query

    POST /api/v2/tags/enrichment/validate-query

  • Read

    Get a tag pipeline ruleset

    Get a specific tag pipeline ruleset - Retrieve a specific tag pipeline ruleset by its ID

    GET /api/v2/tags/enrichment/{ruleset_id}

  • Write

    Update account filters

    Update the account filters for a cloud account (AWS CUR 1.0/2.0, OCI, and other clouds).

    PATCH /api/v2/cost/account_filters/{cloud_account_id}

  • Write

    Create custom allocation rule

    Create a new custom allocation rule with the specified filters and allocation strategy. **Strategy Methods:** - **PROPORTIONAL/EVEN**: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters. - **PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES**: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys. - **PERCENT**: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations). **Filter Conditions:** - Use **value** for single-value conditions: "is", "is not", "contains", "=", "!=", "like", "not like" - Use **values** for multi-value conditions: "in", "not in" - Cannot use both value and values simultaneously. **Supported operators**: is, is not, contains, in, not in, =, !=, like, not like

    POST /api/v2/cost/arbitrary_rule

  • Write

    Reorder custom allocation rules

    Reorder custom allocation rules - Change the execution order of custom allocation rules. **Important**: You must provide the **complete list** of all rule IDs in the desired execution order. The API will reorder ALL rules according to the provided sequence. Rules are executed in the order specified, with lower indices (earlier in the array) having higher priority. **Example**: If you have rules with IDs [123, 456, 789] and want to change order from 123→456→789 to 456→123→789, send: [{"id": "456"}, {"id": "123"}, {"id": "789"}]

    POST /api/v2/cost/arbitrary_rule/reorder

  • Write

    Update custom allocation rule

    Update an existing custom allocation rule with new filters and allocation strategy. **Strategy Methods:** - **PROPORTIONAL/EVEN**: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters. - **PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES**: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys. - **PERCENT**: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations). - **USAGE_METRIC**: Allocates based on usage metrics (implementation varies). **Filter Conditions:** - Use **value** for single-value conditions: "is", "is not", "contains", "=", "!=", "like", "not like" - Use **values** for multi-value conditions: "in", "not in" - Cannot use both value and values simultaneously. **Supported operators**: is, is not, contains, in, not in, =, !=, like, not like

    PATCH /api/v2/cost/arbitrary_rule/{rule_id}

  • Write

    Create Cloud Cost Management AWS CUR config

    Create a Cloud Cost Management account for an AWS CUR config.

    POST /api/v2/cost/aws_cur_config

  • Write

    Update Cloud Cost Management AWS CUR config

    Update the status (active/archived) and/or account filtering configuration of an AWS CUR config.

    PATCH /api/v2/cost/aws_cur_config/{cloud_account_id}

  • Write

    Create Cloud Cost Management Azure configs

    Create a Cloud Cost Management account for an Azure config.

    POST /api/v2/cost/azure_uc_config

  • Write

    Update Cloud Cost Management Azure config

    Update the status of an Azure config (active/archived).

    PATCH /api/v2/cost/azure_uc_config/{cloud_account_id}

  • Write

    Create Google Cloud Usage Cost config

    Create a Cloud Cost Management account for an Google Cloud Usage Cost config.

    POST /api/v2/cost/gcp_uc_config

  • Write

    Update Google Cloud Usage Cost config

    Update the status of an Google Cloud Usage Cost config (active/archived).

    PATCH /api/v2/cost/gcp_uc_config/{cloud_account_id}

  • Write

    Create a unit cost

    Create an ROI metric (unit cost) using the given numerator and denominator queries.

    POST /api/v2/cost/unit_costs

  • Write

    Create tag pipeline ruleset

    Create a new tag pipeline ruleset with the specified rules and configuration

    POST /api/v2/tags/enrichment

  • Write

    Reorder tag pipeline rulesets

    Reorder tag pipeline rulesets - Change the execution order of tag pipeline rulesets

    POST /api/v2/tags/enrichment/reorder

  • Write

    Update tag pipeline ruleset

    Update a tag pipeline ruleset - Update an existing tag pipeline ruleset with new rules and configuration

    PATCH /api/v2/tags/enrichment/{ruleset_id}

  • Destructive

    Delete custom allocation rule

    Delete a custom allocation rule - Delete an existing custom allocation rule by its ID

    DELETE /api/v2/cost/arbitrary_rule/{rule_id}

  • Destructive

    Delete Cloud Cost Management AWS CUR config

    Archive a Cloud Cost Management Account.

    DELETE /api/v2/cost/aws_cur_config/{cloud_account_id}

  • Destructive

    Delete Cloud Cost Management Azure config

    Archive a Cloud Cost Management Account.

    DELETE /api/v2/cost/azure_uc_config/{cloud_account_id}

  • Destructive

    Create or update a budget

    Create a new budget or update an existing one.

    PUT /api/v2/cost/budget

  • Destructive

    Create or replace a budget's custom forecast

    Create or replace the custom forecast for an existing budget. Pass an empty `entries` list to delete the custom forecast for the budget.

    PUT /api/v2/cost/budget/custom-forecast

  • Destructive

    Delete budget

    Delete a budget

    DELETE /api/v2/cost/budget/{budget_id}

  • Destructive

    Delete a budget's custom forecast

    Delete the custom forecast for a budget.

    DELETE /api/v2/cost/budget/{budget_id}/custom-forecast

  • Destructive

    Upload Custom Costs file

    Upload a Custom Costs file.

    PUT /api/v2/cost/custom_costs

  • Destructive

    Delete Custom Costs file

    Delete the specified Custom Costs file.

    DELETE /api/v2/cost/custom_costs/{file_id}

  • Destructive

    Delete Google Cloud Usage Cost config

    Archive a Cloud Cost Management account.

    DELETE /api/v2/cost/gcp_uc_config/{cloud_account_id}

  • Destructive

    Delete a Cloud Cost Management tag description

    Delete a Cloud Cost Management tag key description. When `cloud` is omitted, deletes every description for the tag key, falling back to Datadog's global default when available. When `cloud` is provided, deletes only the description scoped to that cloud provider.

    DELETE /api/v2/cost/tag_descriptions/{tag_key}

  • Destructive

    Upsert a Cloud Cost Management tag description

    Create or update a Cloud Cost Management tag key description. The new description and optional cloud scoping are supplied in the request body. Omit `cloud` to set a cross-cloud default for the tag key.

    PUT /api/v2/cost/tag_descriptions/{tag_key}

  • Destructive

    Delete a unit cost

    Delete an ROI metric (unit cost).

    DELETE /api/v2/cost/unit_costs/{unit_cost_id}

  • Destructive

    Update a unit cost

    Replace an ROI metric (unit cost) with a new set of attributes.

    PUT /api/v2/cost/unit_costs/{unit_cost_id}

  • Destructive

    Delete tag pipeline ruleset

    Delete a tag pipeline ruleset - Delete an existing tag pipeline ruleset by its ID

    DELETE /api/v2/tags/enrichment/{ruleset_id}

CSM Agents

  • Read

    Get all CSM Agents

    Get the list of all CSM Agents running on your hosts and containers.

    GET /api/v2/csm/onboarding/agents

  • Read

    Get all CSM Serverless Agents

    Get the list of all CSM Serverless Agents running on your hosts and containers.

    GET /api/v2/csm/onboarding/serverless/agents

CSM Coverage Analysis

  • Read

    Get the CSM Cloud Accounts Coverage Analysis

    Get the CSM Coverage Analysis of your Cloud Accounts. This is calculated based on the number of your Cloud Accounts that are scanned for security issues.

    GET /api/v2/csm/onboarding/coverage_analysis/cloud_accounts

  • Read

    Get the CSM Hosts and Containers Coverage Analysis

    Get the CSM Coverage Analysis of your Hosts and Containers. This is calculated based on the number of agents running on your Hosts and Containers with CSM feature(s) enabled.

    GET /api/v2/csm/onboarding/coverage_analysis/hosts_and_containers

  • Read

    Get the CSM Serverless Coverage Analysis

    Get the CSM Coverage Analysis of your Serverless Resources. This is calculated based on the number of agents running on your Serverless Resources with CSM feature(s) enabled.

    GET /api/v2/csm/onboarding/coverage_analysis/serverless

CSM Ownership

  • Read

    Get ownership settings for the org

    Get ownership settings for the org. When settings are unset, the API returns the default opt-out configuration with `auto_tag` set to `true` and `confidence_level` set to `high`.

    GET /api/v2/csm/ownership/settings

  • Read

    Count untagged findings by ownership confidence

    Count findings with no team tag, grouped by ownership confidence level.

    GET /api/v2/csm/ownership/settings/untagged

  • Read

    List ownership inferences for a resource

    Get all current ownership inferences for a resource, one per owner type (`user`, `team`, `service`, `unknown`).

    GET /api/v2/security/ownership/{resource_id}

  • Read

    List ownership inference history for a resource

    List inference history entries for a resource across all owner types, ordered from most recent to oldest. Uses cursor-based pagination.

    GET /api/v2/security/ownership/{resource_id}/history

  • Read

    Get an ownership inference by owner type

    Get the current ownership inference for a resource for a specific owner type. This endpoint supports ETag-based caching. Pass the previously returned `ETag` value in the `If-None-Match` request header to receive a `304 Not Modified` response when the inference has not changed.

    GET /api/v2/security/ownership/{resource_id}/{owner_type}

  • Read

    Get the evidence for an ownership inference

    Get the evidence versions backing the current ownership inference for a resource and owner type. This endpoint supports weak ETag caching. Pass the previously returned `ETag` value in the `If-None-Match` request header to receive a `304 Not Modified` response when the evidence has not changed.

    GET /api/v2/security/ownership/{resource_id}/{owner_type}/evidence

  • Read

    List ownership history by owner type

    List inference history entries for a resource filtered by owner type, ordered from most recent to oldest. Uses cursor-based pagination.

    GET /api/v2/security/ownership/{resource_id}/{owner_type}/history

  • Write

    Update ownership settings for the org

    Update ownership settings for the org.

    POST /api/v2/csm/ownership/settings

  • Write

    Submit feedback on an ownership inference

    Submit feedback on the current ownership inference for a resource and owner type. Valid actions are `confirm`, `reject`, `correct`, and `persist`. The request must include the current inference `checksum` in `inference_checksum`. If the checksum does not match the current inference state, the endpoint returns `409 Conflict`. When `action` is `correct`, `corrected_owner_handle` and `corrected_owner_type` are required.

    POST /api/v2/security/ownership/{resource_id}/{owner_type}/feedback

CSM Settings

  • Read

    List agentless hosts

    Get the list of agentless hosts for CSM, with optional pagination and filtering.

    GET /api/v2/csm/settings/agentless_hosts

  • Read

    Get agentless host facet info

    Get the value distribution for a specific agentless host facet, with optional search and filtering.

    GET /api/v2/csm/settings/agentless_hosts/facet_info

  • Read

    List agentless host facets

    Get the list of available facets for filtering agentless hosts.

    GET /api/v2/csm/settings/agentless_hosts/facets

  • Read

    List unified hosts

    Get the list of unified hosts for CSM, combining agent and agentless host data, with optional pagination and filtering.

    GET /api/v2/csm/settings/hosts

  • Read

    Get unified host facet info

    Get the value distribution for a specific unified host facet, with optional search and filtering.

    GET /api/v2/csm/settings/hosts/facet_info

  • Read

    List unified host facets

    Get the list of available facets for filtering unified hosts.

    GET /api/v2/csm/settings/hosts/facets

Dashboard Sharing

  • Read

    List shared dashboards for a dashboard

    Retrieve shared dashboards associated with the specified dashboard.

    GET /api/v2/dashboard/{dashboard_id}/shared

Dashboard Secure Embed

  • Read

    Get a secure embed for a dashboard

    Retrieve an existing secure embed configuration for a dashboard.

    GET /api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}

  • Write

    Create a secure embed for a dashboard

    Create a secure embed share for a dashboard. The response includes a one-time `credential` used for HMAC-SHA256 signing. Store it securely — it cannot be retrieved again.

    POST /api/v2/dashboard/{dashboard_id}/shared/secure-embed

  • Write

    Update a secure embed for a dashboard

    Partially update a secure embed configuration. All fields are optional (PATCH semantics).

    PATCH /api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}

  • Destructive

    Delete a secure embed for a dashboard

    Delete a secure embed share for a dashboard.

    DELETE /api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}

Data Observability

  • Read

    Get data observability monitor run status

    Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.

    GET /api/v2/data-observability/monitors/runs/{run_id}/status

  • Write

    Run a data observability monitor

    Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.

    POST /api/v2/data-observability/monitors/{monitor_id}/run

Datasets

  • Read

    Get all datasets

    Get all datasets that have been configured for an organization.

    GET /api/v2/datasets

  • Read

    Get a single dataset by ID

    Retrieves the dataset associated with the ID.

    GET /api/v2/datasets/{dataset_id}

  • Write

    Create a dataset

    Create a dataset with the configurations in the request.

    POST /api/v2/datasets

  • Destructive

    Delete a dataset

    Deletes the dataset associated with the ID.

    DELETE /api/v2/datasets/{dataset_id}

  • Destructive

    Edit a dataset

    Edits the dataset associated with the ID.

    PUT /api/v2/datasets/{dataset_id}

DDSQL

  • Read

    Fetch the result of a DDSQL query

    Poll a previously submitted DDSQL query for results. Pass the opaque `query_id` returned by a prior `ExecuteDdsqlTabularQuery` (or by a prior `FetchDdsqlTabularQuery` that returned `state: running`) and the server returns either a `running` state to poll again or a `completed` state with the column-major result set inlined. For a scoped application key, include `timeseries_query` in its scopes. Fetch results as the same user and organization that submitted the query. The user or service account that owns the application key must have the data access permissions required by the queried data sources through their roles.

    POST /api/v2/ddsql/query/tabular/fetch

  • Write

    Execute a tabular DDSQL query

    Submit a DDSQL statement and return either a `running` state with an opaque `query_id` for the client to poll, or a `completed` state with the column-major result set inlined when the query finishes quickly enough to be served synchronously. For a scoped application key, include `timeseries_query` in its scopes. A query that does not read a data source, such as `SELECT 1`, requires no additional data-source permissions. Queries that read data sources also require the user or service account that owns the application key to have the corresponding data access permissions through their roles. The `timeseries_query` permission does not grant access to the underlying data sources.

    POST /api/v2/ddsql/query/tabular

Data Deletion

  • Read

    Gets a list of data deletion requests

    Gets a list of data deletion requests based on several filter parameters.

    GET /api/v2/deletion/requests

  • Destructive

    Creates a data deletion request

    Creates a data deletion request by providing a query and a timeframe targeting the proper data.

    POST /api/v2/deletion/data/{product}

  • Destructive

    Cancels a data deletion request

    Cancels a data deletion request by providing its ID.

    PUT /api/v2/deletion/requests/{id}/cancel

DEM

  • Read

    Search inferred DEM journeys

    Search for inferred DEM journeys by status. Returns candidates (status=candidate, the default) or ignored journeys (status=ignored). Supports optional fuzzy name filtering and app ID filtering.

    GET /api/v2/dem/journeys/inferred/search

  • Read

    Search DEM journeys

    Search for DEM journeys with optional filtering by query, creator, team, and app.

    GET /api/v2/dem/journeys/search

  • Read

    Batch get DEM journeys by test suite IDs

    Return DEM journeys associated with multiple given test suite IDs.

    POST /api/v2/dem/journeys/suites/batch

  • Read

    Get a DEM journey

    Retrieve a single DEM journey by its ID.

    GET /api/v2/dem/journeys/{journey_id}

  • Read

    Get recommended tests for a DEM journey

    Retrieve AI-recommended synthetic tests for a DEM journey. Returns an empty list when no recommendation is available.

    GET /api/v2/dem/journeys/{journey_id}/recommended-tests

  • Write

    Create a DEM journey

    Create a DEM journey.

    POST /api/v2/dem/journeys

  • Write

    Ignore an inferred DEM journey

    Mark an inferred DEM journey as ignored so it no longer appears in the candidate list.

    POST /api/v2/dem/journeys/inferred/{journey_id}/ignore

  • Write

    Create a DEM journey variant

    Create a variant for a DEM journey.

    POST /api/v2/dem/journeys/{journey_id}/variants

  • Write

    Create a test suite for a DEM journey

    Trigger test suite creation for a given DEM journey.

    POST /api/v2/dem/journeys/{public_journey_id}/suite

  • Destructive

    Delete an ignored inferred DEM journey

    Remove an ignored inferred DEM journey, making it eligible to appear as a candidate again.

    DELETE /api/v2/dem/journeys/inferred/ignored/{journey_id}

  • Destructive

    Delete a DEM journey variant

    Delete a variant from a DEM journey.

    DELETE /api/v2/dem/journeys/variants/{variant_id}

  • Destructive

    Update a DEM journey variant

    Update an existing variant of a DEM journey.

    PUT /api/v2/dem/journeys/variants/{variant_id}

  • Destructive

    Delete a DEM journey

    Delete a DEM journey by its ID.

    DELETE /api/v2/dem/journeys/{journey_id}

  • Destructive

    Update a DEM journey

    Update an existing DEM journey by its ID.

    PUT /api/v2/dem/journeys/{journey_id}

Deployment Gates

  • Read

    Get all deployment gates

    Returns a paginated list of all deployment gates for the organization. Use `page[cursor]` and `page[size]` query parameters to paginate through results.

    GET /api/v2/deployment_gates

  • Read

    List deployment gate evaluations

    Returns deployment gate evaluations started in a maximum 30-day window (the default is the previous 24 hours). Results are ordered by start time, newest first. In-progress state is near-real-time and mutable. Finished state is eventually consistent.

    GET /api/v2/deployment_gates/evaluations

  • Read

    List deployment gate rule evaluations

    Returns rule evaluations whose gate evaluation started in a maximum 30-day window (the default is the previous 24 hours). Filter by gate, rule, gate evaluation, or rule evaluation ID; omit IDs for cross-evaluation searches. Results are ordered by start time, newest first. In-progress state is near-real-time and mutable. Finished state is eventually consistent. Gate-level and rule-level dry-run states are independent. Pagination is deterministic but not snapshot isolated; clients should deduplicate by rule evaluation ID.

    GET /api/v2/deployment_gates/evaluations/rules

  • Read

    Get rules for a deployment gate

    Endpoint to get rules for a deployment gate.

    GET /api/v2/deployment_gates/{gate_id}/rules

  • Read

    Get deployment rule

    Endpoint to get a deployment rule.

    GET /api/v2/deployment_gates/{gate_id}/rules/{id}

  • Read

    Get deployment gate

    Endpoint to get a deployment gate.

    GET /api/v2/deployment_gates/{id}

  • Read

    Get a deployment gate evaluation result

    Retrieves the result of a deployment gate evaluation by its evaluation ID. If the evaluation is still in progress, `data.attributes.gate_status` will be `in_progress`; continue polling until it returns `pass` or `fail`. Polling every 10-20 seconds is recommended. The endpoint may return a 404 if called too soon after triggering; retry after a few seconds.

    GET /api/v2/deployments/gates/evaluation/{id}

  • Write

    Create deployment gate

    Endpoint to create a deployment gate.

    POST /api/v2/deployment_gates

  • Write

    Create deployment rule

    Endpoint to create a deployment rule. A gate for the rule must already exist.

    POST /api/v2/deployment_gates/{gate_id}/rules

  • Write

    Trigger a deployment gate evaluation

    Triggers an asynchronous deployment gate evaluation for the given service and environment. Returns an evaluation ID that can be used to poll for the result via the `GET /api/v2/deployments/gates/evaluation/{id}` endpoint. When the `configuration` attribute is provided, rules are evaluated inline from that configuration and no pre-configured gate is required. When `configuration` is omitted, rules are resolved from the gate pre-configured for the given service and environment through the Datadog UI, API, or Terraform.

    POST /api/v2/deployments/gates/evaluation

  • Destructive

    Delete deployment rule

    Endpoint to delete a deployment rule.

    DELETE /api/v2/deployment_gates/{gate_id}/rules/{id}

  • Destructive

    Update deployment rule

    Endpoint to update a deployment rule.

    PUT /api/v2/deployment_gates/{gate_id}/rules/{id}

  • Destructive

    Delete deployment gate

    Endpoint to delete a deployment gate. Rules associated with the gate are also deleted.

    DELETE /api/v2/deployment_gates/{id}

  • Destructive

    Update deployment gate

    Endpoint to update a deployment gate.

    PUT /api/v2/deployment_gates/{id}

Domain Allowlist

  • Read

    Get Domain Allowlist

    Get the domain allowlist for an organization.

    GET /api/v2/domain_allowlist

  • Write

    Sets Domain Allowlist

    Update the domain allowlist for an organization.

    PATCH /api/v2/domain_allowlist

Error Tracking

  • Read

    Search error tracking issues

    Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request.

    POST /api/v2/error-tracking/issues/search

  • Read

    Get the details of an error tracking issue

    Retrieve the full details for a specific error tracking issue, including attributes and relationships.

    GET /api/v2/error-tracking/issues/{issue_id}

  • Destructive

    Remove the assignee of an issue

    Remove the assignee of an issue by `issue_id`.

    DELETE /api/v2/error-tracking/issues/{issue_id}/assignee

  • Destructive

    Update the assignee of an issue

    Update the assignee of an issue by `issue_id`.

    PUT /api/v2/error-tracking/issues/{issue_id}/assignee

  • Destructive

    Update the state of an issue

    Update the state of an issue by `issue_id`. Use this endpoint to move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`.

    PUT /api/v2/error-tracking/issues/{issue_id}/state

Experiments

  • Read

    List experiments

    List experiments. Returns a paginated list of experiments and their structured metadata for the organization. Supports filtering and pagination. Use Get experiment for variants, decision metrics, traffic exposure, and assignment configuration.

    GET /api/v2/experiments

  • Read

    List exposure SQL models

    List exposure SQL models. Returns a paginated list of the SQL models that experiment exposures are read from for the organization. Models maintained by Datadog are not included: they cannot be modified and cannot be used as an experiment's assignment source.

    GET /api/v2/experiments/exposure-sql-models

  • Read

    Get exposure SQL model

    Get an exposure SQL model. Returns a single model by its ID for the organization, including its subject types and properties.

    GET /api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}

  • Read

    List metric collections

    List metric collections for the organization. Collections are reusable ordered metric sets; attaching one to an experiment creates an independent snapshot.

    GET /api/v2/experiments/metric-collections

  • Read

    Get metric collection

    Get metric collection.

    GET /api/v2/experiments/metric-collections/{metric_collection_id}

  • Read

    List metric SQL models

    List metric SQL models. Returns a paginated list of the SQL models that metrics are defined on for the organization.

    GET /api/v2/experiments/metric-sql-models

  • Read

    Get metric SQL model

    Get a metric SQL model. Returns a single model by its ID for the organization, including its subject types, measures and properties.

    GET /api/v2/experiments/metric-sql-models/{metric_sql_model_id}

  • Read

    List metrics

    List metrics. Returns a paginated list of the experiment metrics defined for the organization.

    GET /api/v2/experiments/metrics

  • Read

    Get metric

    Get a metric. Returns a single experiment metric by its ID for the organization.

    GET /api/v2/experiments/metrics/{metric_id}

  • Read

    List experiment protocols

    List draft, published, and archived experiment protocols. Omit filter[status] to return all statuses. Only published protocols can be used to create experiments.

    GET /api/v2/experiments/protocols

  • Read

    Get experiment protocol

    Get a draft, published, or archived experiment protocol by ID.

    GET /api/v2/experiments/protocols/{protocol_id}

  • Read

    List subject types

    List subject types. Returns a paginated list of the subject types defined for the organization.

    GET /api/v2/experiments/subject-types

  • Read

    Get subject type

    Get a subject type. Returns a single subject type by its ID for the organization.

    GET /api/v2/experiments/subject-types/{subject_type_id}

  • Read

    Get experiment

    Get a complete experiment by ID. The response includes structured metadata, related links, and, when a complete setup exists, decision metrics, variants, `warehouse_exposure_configuration`, `datadog_flag_configuration`, STATIC or STEPS traffic exposure, and assignment and event dates. STEPS describes the configured plan rather than wall-clock history; Datadog step durations exclude pauses. The list endpoint omits these setup details.

    GET /api/v2/experiments/{experiment_id}

  • Read

    Get experiment analysis plan

    Get the effective public statistical analysis settings for an experiment. has_custom_analysis_settings compares only settings the caller can edit; protocol-required differences from company defaults do not make the plan custom.

    GET /api/v2/experiments/{experiment_id}/analysis-plan

  • Read

    Get experiment diagnostics

    Get the diagnostics produced by an experiment's latest analysis run. Each diagnostic includes its category, and the response includes an overall diagnostic or pipeline lifecycle status.

    GET /api/v2/experiments/{experiment_id}/diagnostics

  • Read

    List experiment metric groups

    List every decision and non-decision metric group attached to an experiment. Metric references are returned in their stored order. An incomplete draft can have no decision group and returns only the groups that exist.

    GET /api/v2/experiments/{experiment_id}/metric-groups

  • Read

    Get experiment results

    Get an experiment's computed results: per-variant statistical analysis for the latest successful run. A historical run cannot be selected. Unavailable analysis statistics, including `p_value` and `confidence_interval`, are omitted. The `numerator`, `denominator`, and `variant_metric_value` fields can be null when their values are unavailable. Do not treat an omitted or null value as zero.

    GET /api/v2/experiments/{experiment_id}/results

  • Read

    Get experiment traffic summary

    Get an experiment's traffic summary: per-variant exposure counts and a sample-ratio-mismatch flag (is_traffic_imbalanced). SRM statistics live on the diagnostics endpoint.

    GET /api/v2/experiments/{experiment_id}/traffic-summary

  • Write

    Create experiment

    Create a draft experiment. `name` is required. `structured_metadata` identifies each metadata field by `field_key`; use `freetext_value` for free-text fields and `enum_values` for enum fields. When this attribute is present, the request must include a value for every required metadata field. When `protocol_id` is present, the published protocol supplies the subject type, decision metrics, analysis-plan defaults, and configuration and enforcement baselines. The request may also include hypothesis, tags, teams, related links, and assignment or event date overrides that satisfy the protocol's duration rules; omit subject_type_id, decision_metrics, variants, warehouse_exposure_configuration, datadog_flag_configuration, traffic_exposure, split_by_properties, and structured_metadata. The protocol association cannot be changed after creation. Without `protocol_id`, a complete Warehouse or Datadog configuration saves the experiment and its configuration in one transaction. For Datadog flag configuration, send `name`, `subject_type_id`, `decision_metrics`, `variants`, `traffic_exposure`, `assignments_start_date`, `assignments_end_date`, `events_start_date`, and `events_end_date`. The four date fields can be null. Inside `datadog_flag_configuration`, send `feature_flag_id`, `environment_id`, `targeting_rules`, and `entry_point`. Use `targeting_rules: []` and `entry_point: null` when unused. This creates one saved draft allocation that does not serve traffic. Omit all configuration fields to create an experiment without an allocation. This endpoint is not idempotent.

    POST /api/v2/experiments

  • Write

    Create exposure SQL model

    Create an exposure SQL model. Requires at least one subject type. The warehouse connection is resolved from the organization, which has exactly one.

    POST /api/v2/experiments/exposure-sql-models

  • Write

    Unarchive exposure SQL model

    Unarchive an exposure SQL model. Restores an archived model to the default list.

    POST /api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}/unarchive

  • Write

    Create metric collection

    Create metric collection.

    POST /api/v2/experiments/metric-collections

  • Write

    Update metric collection

    Update metric collection.

    PATCH /api/v2/experiments/metric-collections/{metric_collection_id}

  • Write

    Create metric SQL model

    Create a metric SQL model. Requires at least one subject type, whose subject_type_id must already exist for the organization (list them with GET /api/v2/experiments/subject-types). The model is created against the organization's warehouse connection, which is resolved server-side. Only customer-defined measures belong in measures. The response provides unique_subject_count_measure_id for each subject type and event_count_measure_id for use in metric aggregations. column_type is required for every measure and property. Certification is read-only and cannot be changed through this endpoint.

    POST /api/v2/experiments/metric-sql-models

  • Write

    Create metric

    Create a metric. The metric's type is derived from the aggregation shape: a numerator alone is SIMPLE, a numerator with a denominator is RATIO, and a percentile aggregation is PERCENTILE. Warehouse aggregations reference measures by UUID. Property filters use property_id or measure_id UUIDs returned by the same metric SQL model; every reference must belong to the aggregation's data source. The is_certified attribute is rejected. Certification cannot be changed through this endpoint.

    POST /api/v2/experiments/metrics

  • Write

    Update metric

    Update a metric. Certified metrics are read-only through this endpoint. This is a partial update: every attribute is optional and an omitted attribute keeps its stored value, so a body carrying only the fields being changed is enough. `guardrail_cutoff_threshold` is nullable -- send null to clear it, omit it to leave it alone. Omitting the aggregation leaves the metric's definition untouched; supplying one replaces it wholesale, and the metric's type is re-derived from the shape supplied. Property filters use property_id or measure_id UUIDs from the aggregation's data source. Attributes that are computed rather than stored (short_id, metric_type, certified_at, experiment_count, created_at, updated_at) are rejected rather than ignored, so a body copied from GET must have them removed. The is_certified attribute is rejected. Certification cannot be changed through this endpoint.

    PATCH /api/v2/experiments/metrics/{metric_id}

  • Write

    Create experiment protocol

    Create a draft protocol with a name and optional description and migration metadata. The organization's default subject type is selected. Use PATCH to configure the draft, then publish it before creating experiments from it.

    POST /api/v2/experiments/protocols

  • Write

    Publish experiment protocol

    Publish a valid draft protocol. The protocol must have a name and subject type. Supplied references and settings must be valid. An exposure schedule or targeting rules require an environment. Enabled limits require their values. Configurable template fields must have a value before they can be locked. Independent configuration errors are returned together in the JSON:API errors array with source.pointer values that identify the fields. Earlier request and reference checks can stop on the first error. A failed request leaves the protocol unchanged.

    POST /api/v2/experiments/protocols/{protocol_id}/publish

  • Write

    Refresh experiment results for org

    Trigger a results refresh across the organization's active experiments. Returns the count of experiments whose refresh was triggered (meta.experiments_updated) plus a per-experiment breakdown of what happened to each (meta.results).

    POST /api/v2/experiments/results/refresh

  • Write

    Create subject type

    Create a subject type for the organization.

    POST /api/v2/experiments/subject-types

  • Write

    Patch subject type

    Update mutable fields on a subject type. Only the fields present in the body are changed. Any subject type can be updated, including the organization's default one, but the is_default flag itself is read-only here: which subject type is the default cannot be changed through this endpoint.

    PATCH /api/v2/experiments/subject-types/{subject_type_id}

  • Write

    Set default subject type

    Make this subject type the organization's default. Experiment creation uses the default when the request names no subject type. Promoting one subject type demotes the previous default in the same transaction, so the organization always has exactly one. The call is idempotent: promoting the current default succeeds and changes nothing. There is no matching demote, because an organization cannot have no default; promote a different subject type instead.

    POST /api/v2/experiments/subject-types/{subject_type_id}/default

  • Write

    Update experiment analysis plan attributes

    Update selected statistical analysis settings. Omitted attributes remain unchanged and nullable attributes can be cleared with null. Protocol-locked settings cannot be changed.

    PATCH /api/v2/experiments/{experiment_id}/analysis-plan

  • Write

    Conclude experiment

    Conclude an experiment on a winning variant. The experiment moves to DECISION_MADE status, the outcome is recorded in its conclusion, and for a flag-backed experiment the winning variant is rolled out to 100% of the linked feature flag allocation. `decision_variant_key` must match a variant in the experiment. Only an experiment that is currently running or ready for a decision can be concluded. Concluding is not reversible and is not idempotent: concluding an already-concluded experiment returns 409.

    POST /api/v2/experiments/{experiment_id}/conclude

  • Write

    Create experiment metric group

    Create a non-decision metric group. The optional metrics array is ordered. Decision groups remain managed through decision_metrics on the experiment resource. This operation does not synchronously recompute results.

    POST /api/v2/experiments/{experiment_id}/metric-groups

  • Write

    Create experiment metric group from collection

    Copy a metric collection into a new non-decision metric group. The group is a request-time snapshot: later changes to the collection do not affect the experiment. Metric order is preserved. The operation is not idempotent, and incompatible or empty collections are rejected without creating a group.

    POST /api/v2/experiments/{experiment_id}/metric-groups/from-collection/{metric_collection_id}

  • Write

    Refresh experiment results

    Request a results refresh for one experiment. HTTP 202 confirms acceptance, not completed results. The response identifies the experiment and does not include a job ID. Read experiment results to check freshness. A request while a refresh is queued or running returns 409. After completion, another request can start another refresh.

    POST /api/v2/experiments/{experiment_id}/results/refresh

  • Write

    Start experiment

    Start an experiment. The experiment is started exactly as it is configured; this endpoint accepts no attributes, and a request body carrying any is rejected rather than ignored. Set the run window, duration, or variants with PATCH /api/v2/experiments/{experiment_id} before starting. An unconfigured draft returns HTTP 409. Configure either warehouse_exposure_configuration or datadog_flag_configuration, plus the required experiment fields, before starting. Start validation errors can include meta.configuration_pointer to identify a field on the experiment to correct. For a flag-backed experiment this enables the linked feature flag's environment, clears any stored variant override on it, and starts the allocation's rollout. The request is idempotent: an experiment that is already running or ready for a decision still returns 204, so a retry after a timeout is safe. One exception: an experiment scheduled to start is accepted only when it is backed by your own feature flag; a Datadog-flag experiment in that state returns 409 because its stored state and flag allocation disagree. Cancel and conclude are not idempotent and return 409 when repeated.

    POST /api/v2/experiments/{experiment_id}/start

  • Destructive

    Update exposure SQL model

    Replace an exposure SQL model. This is a full replacement and is destructive: any subject type or property not present in the body is deleted, and properties are matched on name, column_name and column_type together, so changing one of those replaces the property rather than editing it. Send the complete set you want to keep. Anything removed is listed under meta.removed_subject_type_ids and meta.removed_property_names in the response. The warehouse connection is not settable and is left as stored.

    PUT /api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}

  • Destructive

    Archive exposure SQL model

    Archive an exposure SQL model. Archived models are hidden from the default list and are no longer refreshed for new feature flags. Experiments already reading from the model keep working. Archiving is how a model that is in use by an experiment, and therefore cannot be deleted, is retired.

    POST /api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}/archive

  • Destructive

    Delete metric collection

    Delete metric collection.

    DELETE /api/v2/experiments/metric-collections/{metric_collection_id}

  • Destructive

    Update metric SQL model

    Replace a metric SQL model. This is a destructive full replace: subject types, customer-defined measures, and properties absent from the body are deleted, so send the complete set. Properties are matched by name; changing a property's column, type, or description preserves its ID. column_type is required for every measure and property. Removing a measure or property that an active metric references returns 409 Conflict. Server-generated IDs returned by GET are read-only and can be left in a replayed body. The response reports removals in meta.deleted_subject_types, meta.deleted_measures, and meta.deleted_properties. Certification is read-only. Certified models cannot be replaced through this endpoint.

    PUT /api/v2/experiments/metric-sql-models/{metric_sql_model_id}

  • Destructive

    Delete metric

    Delete a metric. Certified metrics are read-only through this endpoint. The record is soft-deleted and stops appearing in reads. A metric still referenced by an experiment cannot be deleted; detach it from those experiments first.

    DELETE /api/v2/experiments/metrics/{metric_id}

  • Destructive

    Delete experiment protocol

    Delete a protocol with no linked experiments. Draft, published, and archived protocols can be deleted. Returns 204 with no response body.

    DELETE /api/v2/experiments/protocols/{protocol_id}

  • Destructive

    Update experiment protocol

    Update the supplied fields of a draft protocol. Published protocols accept only name, description, and migration_metadata changes through PATCH. Use PUT to replace their settings. Archived protocols cannot be edited. Omitted fields keep their current values, including fields inside analysis_plan, exposure_schedule, and enforcement. Arrays replace the stored arrays. Supported null values clear fields; see the request schema. Use primary_metric_id to select the primary metric and default_duration_days to set the experiment analysis duration. Nested metric is_primary and analysis_plan.target_duration_days fields are rejected.

    PATCH /api/v2/experiments/protocols/{protocol_id}

  • Destructive

    Replace experiment protocol

    Replace the template of a published protocol. Draft and archived protocols return 409. Send subject_type_id, all four required boolean settings, and metric_groups. Omitted optional template fields are cleared. Omitted enforcement keeps the existing locks. Use primary_metric_id to select the primary metric. Use default_duration_days to set target_duration_days on experiments created from the protocol. The nested metric is_primary and analysis_plan.target_duration_days fields are rejected. An unchanged GET response can be sent as the request body. Response-only fields are ignored. Independent configuration errors are returned together in the JSON:API errors array. Each error identifies the field in source.pointer. Earlier request and reference checks can stop on the first error. A failed request leaves the protocol unchanged. Changes apply to future experiments; existing experiments keep their settings.

    PUT /api/v2/experiments/protocols/{protocol_id}

  • Destructive

    Archive experiment protocol

    Archive a draft or published protocol. Archived protocols cannot be edited or used to create new experiments. Existing experiments keep their settings. Archiving an already archived protocol returns 409.

    POST /api/v2/experiments/protocols/{protocol_id}/archive

  • Destructive

    Delete subject type

    Delete a subject type. The record is soft-deleted and stops appearing in reads. The call is idempotent: deleting the same subject type again also returns 204. The organization's default subject type cannot be deleted; make another one the default first. A subject type that experiments, exposure SQL models, metric SQL models or protocols still reference cannot be deleted either; the refusal names the blockers.

    DELETE /api/v2/experiments/subject-types/{subject_type_id}

  • Destructive

    Delete experiment

    Delete an experiment and its linked feature flag allocations in one database transaction. After deletion, the experiment is no longer returned by the API. If the transaction fails, neither the experiment nor its allocations are deleted. Deleting an experiment cannot be undone.

    DELETE /api/v2/experiments/{experiment_id}

  • Destructive

    Patch experiment

    Update mutable experiment fields. State and protocol restrictions apply. **PATCH behavior** - Omitted fields stay unchanged, including fields inside `datadog_flag_configuration`. - Supplied `tags`, `teams`, `related_links`, `decision_metrics`, and `variants` replace their stored lists. - Validation can return several field errors before saving any changes. The response is HTTP 400 if any error concerns invalid input. It is HTTP 409 if all errors concern state or protocol conflicts. **Result refreshes** This endpoint does not start a pipeline run. `meta.needs_pipeline_refresh` states whether the edit requires a run. When true, POST to `meta.refresh_endpoint` after finishing your edits. Its `full_refresh` query parameter selects the run type. Keep refresh requirements across edits. A later false value does not clear an earlier requirement. Any `full_refresh=true` requirement takes priority. After start, STATIC and STEPS exposure changes for warehouse experiments without a Datadog flag attempt to recalculate stored results. Changes to decision metrics or the control variant also attempt recalculation when results exist. If stored data is insufficient or recalculation fails, the edit stays saved and `meta.needs_pipeline_refresh` is true. **Exposure rules** - Draft experiments can replace the full STATIC or STEPS plan through `traffic_exposure`. - Warehouse steps start at `assignments_start_date` and can have different durations. - Running warehouse experiments can replace step fractions, durations, and exposure mode. Retained variant weights cannot change through this API. You can send unchanged values again. - After a warehouse experiment ends, configuration replacement supports only STATIC fraction changes. - New Datadog plans have at most five steps. The first fraction must be positive. All steps except the last have equal durations. Durations exclude pauses. - The last step has a null duration. Its fraction stays in effect until assignment ends. - After start, use the experiment UI to change traffic exposure for experiments linked to a Datadog flag. **Metadata** `structured_metadata` updates fields by `field_key`. Use `freetext_value: ""` or `enum_values: []` to clear an optional field. Omitted fields stay unchanged. A null or empty `structured_metadata` attribute makes no change. **Flag changes** Before start, a Datadog update creates or edits the saved draft allocation. To add or replace a flag, send `variants` and `traffic_exposure`. Inside `datadog_flag_configuration`, send `feature_flag_id`, `environment_id`, `targeting_rules`, and `entry_point`. Use `targeting_rules: []` and `entry_point: null` when unused. To replace a flag, also set `reset_on_feature_flag_change: true` inside that object. The server deletes the old draft and creates a new one in the same transaction. The response includes a `datadog_flag_configuration_reset` warning in `meta.warnings`. Set `datadog_flag_configuration: null` to delete the draft allocation. This also clears the experiment's flag association, variants, assignment sources, and entry point. The experiment remains. Flag replacement and removal require a draft experiment without warehouse exposure. These actions do not convert hybrid experiments.

    PATCH /api/v2/experiments/{experiment_id}

  • Destructive

    Cancel experiment

    Cancel an experiment, ending it without a winning variant. The experiment moves to CANCELLED status, the supplied reason is recorded in its conclusion as the decision reason, and the experiment is unlinked from the feature flag allocations that exposed it, which stops its exposure. An experiment that has already completed its rollout, had its code removed, or been canceled cannot be canceled again. Canceling is not reversible: an experiment cannot be returned to a running state afterward. It is also not idempotent: canceling an already-canceled experiment returns 409, so a retry after a timeout cannot be distinguished from a cancellation made by someone else.

    POST /api/v2/experiments/{experiment_id}/cancel

  • Destructive

    Delete experiment metric group

    Delete a non-decision metric group and its memberships. Decision groups remain managed through the experiment resource. This operation does not start a pipeline. Read experiment results after deletion to check stale metadata, then explicitly refresh results when required.

    DELETE /api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}

  • Destructive

    Update experiment metric group

    Update a non-decision metric group. Omitted attributes are unchanged; a supplied metrics array is the complete ordered replacement. Decision groups remain managed through the experiment resource. This operation does not synchronously recompute results.

    PATCH /api/v2/experiments/{experiment_id}/metric-groups/{metric_group_id}

Feature Flags

  • Read

    List feature flags

    Returns a paginated list of feature flags for the organization. Supports filtering by key, tags, teams, SDK availability, production status, and other flag properties. Use `page[limit]` and `page[offset]` to paginate, or follow the `next` link in the response.

    GET /api/v2/feature-flags

  • Read

    List environments

    Returns a list of environments for the organization. Supports filtering by name, key, and DD_ENV.

    GET /api/v2/feature-flags/environments

  • Read

    Get an environment

    Returns the details of a specific environment.

    GET /api/v2/feature-flags/environments/{environment_id}

  • Read

    Get a saved filter

    Returns a saved filter by ID, including its full targeting rules, conditions, and values. Supports both saved lists and saved rules. Targeting rules are combined with OR, and conditions within each rule are combined with AND. Returns the stored filter definition rather than evaluating it against users or organizations. Archived filters can be retrieved. Filters that are deleted or belong to another organization return a not found error.

    GET /api/v2/feature-flags/saved-filters/{saved_filter_id}

  • Read

    Get a feature flag

    Returns the details of a specific feature flag including variants and environment status.

    GET /api/v2/feature-flags/{feature_flag_id}

  • Write

    Create a feature flag

    Creates a new feature flag with variants.

    POST /api/v2/feature-flags

  • Write

    Create an environment

    Creates a new environment for organizing feature flags.

    POST /api/v2/feature-flags/environments

  • Write

    Pause a progressive rollout

    Pauses a progressive rollout while preserving rollout state.

    POST /api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/pause

  • Write

    Resume a progressive rollout

    Resumes progression for a previously paused progressive rollout.

    POST /api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/resume

  • Write

    Start a progressive rollout

    Starts a progressive rollout and begins progression.

    POST /api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/start

  • Write

    Stop a progressive rollout

    Stops a progressive rollout and marks it as aborted.

    POST /api/v2/feature-flags/exposure-schedules/{exposure_schedule_id}/stop

  • Write

    Create targeting rules for a flag env

    Creates a new targeting rule (allocation) for a specific feature flag in a specific environment.

    POST /api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/allocations

  • Write

    Enable a feature flag in an environment

    Enable a feature flag in a specific environment.

    POST /api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/enable

  • Write

    Unarchive a feature flag

    Unarchives a previously archived feature flag, making it visible in the main list again.

    POST /api/v2/feature-flags/{feature_flag_id}/unarchive

  • Write

    Add a variant to a feature flag

    Adds a single new variant to an existing feature flag. This endpoint is additive-only: it never modifies existing variants. A request whose `key` already exists on the flag is rejected with `409 Conflict`; a `value` whose type does not match the flag's `value_type` is rejected with `400`. The server generates the variant UUID and returns it in the response body; callers (for example, the flag-migration tool) need this UUID to reference the new variant in subsequent allocation syncs.

    POST /api/v2/feature-flags/{feature_flag_id}/variants

  • Destructive

    Delete an environment

    Deletes an environment. This operation cannot be undone.

    DELETE /api/v2/feature-flags/environments/{environment_id}

  • Destructive

    Update an environment

    Updates an existing environment's metadata such as name and description.

    PUT /api/v2/feature-flags/environments/{environment_id}

  • Destructive

    Patch a saved filter

    Partially updates a saved filter. Supports both `LIST` and `RULES` filters. Supply at least one of `name`, `description`, or `targeting_rules`. Omitted or null fields are preserved. Supplying `targeting_rules` replaces the entire collection and propagates changes to every feature flag that references the saved filter. Metadata-only updates do not require edit permission or approval on those feature flags. Rule updates require edit permission on all consumer flags and are rejected when approval is required, unless the caller has the `feature_flag_approvals_override` permission. The optional `last_updated_at` field detects stale updates. It does not set the update time.

    PATCH /api/v2/feature-flags/saved-filters/{saved_filter_id}

  • Destructive

    Update a feature flag

    Updates an existing feature flag's metadata such as name and description. Does not modify targeting rules or allocations. To change the owning team, update `tags` and include a tag of the form `team:<team-handle>` in the array. `tags` is a full replacement of the existing tag set (including any `team:` tag), so include every tag you want to keep, not just the ones you're adding.

    PUT /api/v2/feature-flags/{feature_flag_id}

  • Destructive

    Archive a feature flag

    Archives a feature flag. Archived flags are hidden from the main list but remain accessible and can be unarchived.

    POST /api/v2/feature-flags/{feature_flag_id}/archive

  • Destructive

    Update targeting rules for a flag

    Updates targeting rules (allocations) for a specific feature flag in a specific environment. This operation replaces the existing allocation set with the request payload.

    PUT /api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/allocations

  • Destructive

    Disable a feature flag in an environment

    Disable a feature flag in a specific environment.

    POST /api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/disable

  • Destructive

    Delete a variant

    Deletes a variant from a feature flag. When backend approvals are enabled and the flag requires approval, this endpoint creates and returns a `FlagSuggestion` with `201 Created` instead of deleting the variant immediately. If a pending suggestion already exists for this flag's variant property, the endpoint returns `409 Conflict`.

    DELETE /api/v2/feature-flags/{feature_flag_id}/variants/{variant_id}

  • Destructive

    Update a variant

    Updates the name and value of an existing variant on a feature flag. When backend approvals are enabled and the flag requires approval, this endpoint creates and returns a `FlagSuggestion` with `201 Created` instead of applying the change immediately. Use the returned suggestion `id` to approve or reject the change. If a pending suggestion already exists for this flag's variant property, the endpoint returns `409 Conflict`.

    PUT /api/v2/feature-flags/{feature_flag_id}/variants/{variant_id}

Forms

  • Read

    List forms

    Get all forms for the authenticated user's organization.

    GET /api/v2/forms

  • Read

    Get a form

    Get a form definition by its ID.

    GET /api/v2/forms/{form_id}

  • Write

    Create a form

    Create a new form. The form is created in draft mode and must be published before it can be used. This also creates a new datastore for form responses and links it to the form.

    POST /api/v2/forms

  • Write

    Create and publish a form

    Creates a new form and immediately publishes its initial version. This also creates a new datastore for form responses and links it to the form.

    POST /api/v2/forms/create_and_publish

  • Write

    Update a form

    Update a form's properties such as its name, description, or datastore configuration.

    PATCH /api/v2/forms/{form_id}

  • Write

    Clone a form

    Clone an existing form. The clone is created in draft mode using the source form's latest version.

    POST /api/v2/forms/{form_id}/clone

  • Write

    Publish a form version

    Publish a specific version of a form, making it available for submissions.

    POST /api/v2/forms/{form_id}/publish

  • Write

    Create or update a form version

    Create or update the latest draft version of a form. The `upsert_params` field controls optimistic concurrency behavior.

    POST /api/v2/forms/{form_id}/versions

  • Write

    Upsert and publish a form version

    Upsert the latest form version and publish it in a single atomic transaction.

    POST /api/v2/forms/{form_id}/versions/upsert_and_publish

  • Destructive

    Delete a form

    Delete a form by its ID. This will also try to delete the associated datastore.

    DELETE /api/v2/forms/{form_id}

Governance Console

  • Read

    Get the Governance Console configuration

    Retrieve the Governance Console configuration for the organization, including whether the Console is enabled, whether assignment notifications are enabled, and whether usage attribution is configured.

    GET /api/v2/governance/config

  • Read

    List controls

    Retrieve the list of governance controls configured for the organization. Each control pairs a detection definition with the organization's current detection, notification, and mitigation configuration, along with counts of active and mitigated detections.

    GET /api/v2/governance/control

  • Read

    Get a control

    Retrieve a single governance control by its detection type, including the organization's current detection, notification, and mitigation configuration and detection counts.

    GET /api/v2/governance/control/{detection_type}

  • Read

    List control detections

    Retrieve the detections produced by the governance control with the given detection type. Results can be filtered by state and free-text query, sorted, and paginated.

    GET /api/v2/governance/control/{detection_type}/detections

  • Read

    Get control notification settings

    Retrieve the notification settings for the governance control with the given detection type, including, for each supported event type, whether notifications are enabled and which destinations receive them.

    GET /api/v2/governance/control/{detection_type}/notification_settings

  • Read

    Get a detection

    Retrieve a single governance detection by its unique identifier.

    GET /api/v2/governance/detections/{detection_id}

  • Read

    List insights

    Retrieve the list of governance insights available to the organization. Each insight reports the query used to compute it, so that the value can be computed client-side. Insights can be filtered by product.

    GET /api/v2/governance/insights

  • Read

    Get notification settings

    Retrieve the organization-wide governance notification settings, including whether users are notified when detections are assigned to them.

    GET /api/v2/governance/notification_settings

  • Write

    Update a control

    Update the detection, notification, and mitigation configuration of a governance control. Only the attributes present in the request are modified. Changing the mitigation type or its parameters may require additional permissions.

    PATCH /api/v2/governance/control/{detection_type}

  • Write

    Mitigate detections

    Apply a mitigation to a set of governance detections of a given detection type. When the mitigation type is omitted, the control's configured mitigation is used. The request is accepted for asynchronous processing.

    POST /api/v2/governance/detections/mitigate

  • Write

    Update a detection

    Update a governance detection by its unique identifier. Only the attributes present in the request are modified, allowing a detection to be acknowledged as an exception, reopened, reassigned, or deferred for mitigation.

    PATCH /api/v2/governance/detections/{detection_id}

  • Write

    Update notification settings

    Update the organization-wide governance notification settings. Only the attributes present in the request are modified.

    PATCH /api/v2/governance/notification_settings

  • Destructive

    Update control notification settings

    Replace the notification settings for the governance control with the given detection type, setting, for each supported event type, whether notifications are enabled and which destinations receive them.

    PUT /api/v2/governance/control/{detection_type}/notification_settings

Tag Rules

  • Read

    List tag rules

    Retrieve all tag rules for the organization. Optionally include disabled or deleted rules, filter by telemetry source, and include each rule's current compliance score via the `include=score` query parameter.

    GET /api/v2/governance/tag_rules

  • Read

    Get a tag rule

    Retrieve a single tag rule by ID. Optionally include the rule's current compliance score via the `include=score` query parameter. Rules belonging to other organizations cannot be retrieved.

    GET /api/v2/governance/tag_rules/{rule_id}

  • Read

    Get a tag rule compliance score

    Retrieve the compliance score for a single tag rule. The score is computed over the requested time window (or a source-appropriate default) and represents the percentage of telemetry within that window that conforms to the rule. A `null` score indicates that no relevant telemetry was found.

    GET /api/v2/governance/tag_rules/{rule_id}/score

  • Write

    Create a tag rule

    Create a new tag rule for the organization. The caller's organization is derived from the authenticated user; cross-organization creation is not supported. Fields such as `rule_id`, `version`, and the timestamp/audit fields are assigned by the server.

    POST /api/v2/governance/tag_rules

  • Write

    Update a tag rule

    Update one or more attributes of an existing tag rule. Only the fields supplied in the request body are modified; omitted fields retain their current values. The rule's `source` cannot be changed after creation.

    PATCH /api/v2/governance/tag_rules/{rule_id}

  • Destructive

    Delete a tag rule

    Delete a tag rule. By default the rule is soft-deleted so it can be recovered later and so that historical score data remains queryable. Pass `hard_delete=true` to remove the rule permanently.

    DELETE /api/v2/governance/tag_rules/{rule_id}

High Availability Multi Region

  • Read

    Get HAMR organization connection

    Retrieve the High Availability Multi-Region (HAMR) organization connection details for the authenticated organization. This endpoint returns information about the HAMR connection configuration, including the target organization, datacenter, status, and whether this is the primary or secondary organization in the HAMR relationship.

    GET /api/v2/hamr

  • Write

    Create or update HAMR organization connection

    Create or update the High Availability Multi-Region (HAMR) organization connection. This endpoint allows you to configure the HAMR connection between the authenticated organization and a target organization, including setting the connection status (ONBOARDING, PASSIVE, FAILOVER, ACTIVE, RECOVERY)

    POST /api/v2/hamr

Identity Providers

  • Read

    List identity providers

    Get all identity providers available for the current organization.

    GET /api/v2/identity_providers

  • Read

    List users with an identity provider override

    Get all users in the organization whose login method has been overridden to use the specified identity provider.

    GET /api/v2/identity_providers/{idp_id}/users

  • Destructive

    Update an identity provider

    Enable or disable an identity provider for the current organization.

    PATCH /api/v2/identity_providers/{idp_id}

Entity Integration Configs

  • Read

    Get an entity integration configuration

    Retrieve the configuration currently stored for a given integration in the caller's organization.

    GET /api/v2/idp/entity_integrations/{integration_id}

  • Destructive

    Delete an entity integration configuration

    Delete the configuration stored for a given integration in the caller's organization.

    DELETE /api/v2/idp/entity_integrations/{integration_id}

  • Destructive

    Create or update entity integration configuration

    Create or replace the configuration for a given integration in the caller's organization. The shape of `data.attributes.config` depends on the integration: - For `github`: `config` must contain an `enabled_repos` array of objects with `hostname`, `github_org_name`, and `repo_name`. - For `jira`: `config` must contain an `enabled_projects` array of objects with `hostname`, `account_id`, and `project_key`. - For `pagerduty`: `config` must contain an `accounts` array of objects with a required `enabled` boolean and an optional `subdomain` string.

    PUT /api/v2/idp/entity_integrations/{integration_id}

Incidents

  • Read

    Get a list of incidents

    Get all incidents for the user's organization.

    GET /api/v2/incidents

  • Read

    List global incident handles

    Retrieve a list of global incident handles.

    GET /api/v2/incidents/config/global/incident-handles

  • Read

    Get global incident settings

    Retrieve global incident settings for the organization.

    GET /api/v2/incidents/config/global/settings

  • Read

    List incident impact fields

    List all impact fields for incidents.

    GET /api/v2/incidents/config/impact-fields

  • Read

    List incident notification rules

    Lists all notification rules for the organization. Optionally filter by incident type.

    GET /api/v2/incidents/config/notification-rules

  • Read

    Get an incident notification rule

    Retrieves a specific notification rule by its ID.

    GET /api/v2/incidents/config/notification-rules/{id}

  • Read

    List incident notification templates

    Lists all notification templates. Optionally filter by incident type.

    GET /api/v2/incidents/config/notification-templates

  • Read

    Get incident notification template

    Retrieves a specific notification template by its ID.

    GET /api/v2/incidents/config/notification-templates/{id}

  • Read

    List postmortem templates

    Retrieve a list of all postmortem templates for incidents.

    GET /api/v2/incidents/config/postmortem-templates

  • Read

    Get postmortem template

    Retrieve details of a specific postmortem template.

    GET /api/v2/incidents/config/postmortem-templates/{template_id}

  • Read

    List incident rules

    List all incident rules.

    GET /api/v2/incidents/config/rules

  • Read

    Get an incident rule

    Get a single incident rule by ID.

    GET /api/v2/incidents/config/rules/{rule_id}

  • Read

    Get a list of incident types

    Get all incident types.

    GET /api/v2/incidents/config/types

  • Read

    List incident type org settings

    List org settings for all incident types.

    GET /api/v2/incidents/config/types/org-settings

  • Read

    Get incident type details

    Get incident type details.

    GET /api/v2/incidents/config/types/{incident_type_id}

  • Read

    Get org settings by incident type

    Get the org settings for a specific incident type.

    GET /api/v2/incidents/config/types/{incident_type_id}/org-settings

  • Read

    Get a list of incident user-defined fields

    Get a list of all incident user-defined fields.

    GET /api/v2/incidents/config/user-defined-fields

  • Read

    Get an incident user-defined field

    Get details of an incident user-defined field.

    GET /api/v2/incidents/config/user-defined-fields/{field_id}

  • Read

    List incident user-defined roles

    List all user-defined roles for incidents.

    GET /api/v2/incidents/config/user-defined-roles

  • Read

    Get an incident user-defined role

    Retrieve a single user-defined role for incidents.

    GET /api/v2/incidents/config/user-defined-roles/{role_id}

  • Read

    Search for incidents

    Search for incidents matching a certain query.

    GET /api/v2/incidents/search

  • Read

    Get the details of an incident

    Get the details of an incident by `incident_id`.

    GET /api/v2/incidents/{incident_id}

  • Read

    Get an AI-generated incident postmortem

    Generate an AI postmortem for an incident.

    POST /api/v2/incidents/{incident_id}/ai/postmortem

  • Read

    List incident attachments

    List incident attachments.

    GET /api/v2/incidents/{incident_id}/attachments

  • Read

    List an incident's impacts

    Get all impacts for an incident.

    GET /api/v2/incidents/{incident_id}/impacts

  • Read

    Get a list of an incident's integration metadata

    Get all integration metadata for an incident.

    GET /api/v2/incidents/{incident_id}/relationships/integrations

  • Read

    Get incident integration metadata details

    Get incident integration metadata details.

    GET /api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}

  • Read

    Get a list of an incident's todos

    Get all todos for an incident.

    GET /api/v2/incidents/{incident_id}/relationships/todos

  • Read

    Get incident todo details

    Get incident todo details.

    GET /api/v2/incidents/{incident_id}/relationships/todos/{todo_id}

  • Read

    List incident responders

    List all responders for an incident.

    GET /api/v2/incidents/{incident_id}/responders

  • Read

    Get an incident responder

    Get a single responder for an incident.

    GET /api/v2/incidents/{incident_id}/responders/{responder_id}

  • Read

    List incident timestamp overrides

    List all timestamp overrides for an incident.

    GET /api/v2/incidents/{incident_id}/timestamp-overrides

  • Write

    Create an incident

    Create an incident.

    POST /api/v2/incidents

  • Write

    Create global incident handle

    Create a new global incident handle.

    POST /api/v2/incidents/config/global/incident-handles

  • Write

    Update global incident settings

    Update global incident settings for the organization.

    PATCH /api/v2/incidents/config/global/settings

  • Write

    Create an incident Google Chat configuration

    Create a Google Chat configuration for incidents.

    POST /api/v2/incidents/config/google-chat-configurations

  • Write

    Update an incident Google Chat configuration

    Update a Google Chat configuration for incidents.

    PATCH /api/v2/incidents/config/google-chat-configurations/{id}

  • Write

    Create an incident Google Meet configuration

    Create a Google Meet configuration for incidents.

    POST /api/v2/incidents/config/google-meet-configurations

  • Write

    Update an incident Google Meet configuration

    Update a Google Meet configuration for incidents.

    PATCH /api/v2/incidents/config/google-meet-configurations/{id}

  • Write

    Create an incident impact field

    Create an impact field for incidents.

    POST /api/v2/incidents/config/impact-fields

  • Write

    Create an incident notification rule

    Creates a new notification rule.

    POST /api/v2/incidents/config/notification-rules

  • Write

    Create incident notification template

    Creates a new notification template.

    POST /api/v2/incidents/config/notification-templates

  • Write

    Update incident notification template

    Updates an existing notification template's attributes.

    PATCH /api/v2/incidents/config/notification-templates/{id}

  • Write

    Create postmortem template

    Create a new postmortem template for incidents.

    POST /api/v2/incidents/config/postmortem-templates

  • Write

    Update postmortem template

    Update an existing postmortem template.

    PATCH /api/v2/incidents/config/postmortem-templates/{template_id}

  • Write

    Create an incident rule

    Create an incident rule.

    POST /api/v2/incidents/config/rules

  • Write

    Update an incident rule

    Update an incident rule.

    PATCH /api/v2/incidents/config/rules/{rule_id}

  • Write

    Create an incident type

    Create an incident type.

    POST /api/v2/incidents/config/types

  • Write

    Update an incident type

    Update an incident type.

    PATCH /api/v2/incidents/config/types/{incident_type_id}

  • Write

    Create an incident user-defined field

    Create an incident user-defined field.

    POST /api/v2/incidents/config/user-defined-fields

  • Write

    Update an incident user-defined field

    Update an incident user-defined field.

    PATCH /api/v2/incidents/config/user-defined-fields/{field_id}

  • Write

    Create an incident user-defined role

    Create a new user-defined role for incidents.

    POST /api/v2/incidents/config/user-defined-roles

  • Write

    Update an incident user-defined role

    Update an existing user-defined role for incidents.

    PATCH /api/v2/incidents/config/user-defined-roles/{role_id}

  • Write

    Import an incident

    Import an incident from an external system. This endpoint allows you to create incidents with historical data such as custom timestamps for detection, declaration, and resolution. Imported incidents do not execute integrations or notification rules.

    POST /api/v2/incidents/import

  • Write

    Update an existing incident

    Updates an incident. Provide only the attributes that should be updated as this request is a partial update.

    PATCH /api/v2/incidents/{incident_id}

  • Write

    Create incident attachment

    Create an incident attachment.

    POST /api/v2/incidents/{incident_id}/attachments

  • Write

    Create postmortem attachment

    Create a postmortem attachment for an incident. The endpoint accepts markdown for notebooks created in Confluence or Google Docs. Postmortems created from notebooks need to be formatted using frontend notebook cells, in addition to markdown format.

    POST /api/v2/incidents/{incident_id}/attachments/postmortems

  • Write

    Update incident attachment

    PATCH /api/v2/incidents/{incident_id}/attachments/{attachment_id}

    PATCH /api/v2/incidents/{incident_id}/attachments/{attachment_id}

  • Write

    Create a page from an incident (deprecated)

    Create a page from an incident using the Cases service. **Deprecated**: This endpoint is deprecated. Use [Create an on-call page from an incident](#create-an-on-call-page-from-an-incident) instead.

    POST /api/v2/incidents/{incident_id}/cases/page

  • Write

    Update an incident configuration

    Update a configuration for an incident.

    PATCH /api/v2/incidents/{incident_id}/configurations

  • Write

    Create an incident configuration

    Create a configuration for an incident.

    POST /api/v2/incidents/{incident_id}/configurations

  • Write

    Create an incident impact

    Create an impact for an incident.

    POST /api/v2/incidents/{incident_id}/impacts

  • Write

    Update an incident impact

    Update an incident impact.

    PATCH /api/v2/incidents/{incident_id}/impacts/{impact_id}

  • Write

    Create an on-call page from an incident

    Create an on-call page directly from an incident.

    POST /api/v2/incidents/{incident_id}/page

  • Write

    Link a page to an incident

    Link an existing on-call page to an incident.

    POST /api/v2/incidents/{incident_id}/pages/link

  • Write

    Create an incident integration metadata

    Create an incident integration metadata.

    POST /api/v2/incidents/{incident_id}/relationships/integrations

  • Write

    Update an existing incident integration metadata

    Update an existing incident integration metadata.

    PATCH /api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}

  • Write

    Create an incident todo

    Create an incident todo.

    POST /api/v2/incidents/{incident_id}/relationships/todos

  • Write

    Update an incident todo

    Update an incident todo.

    PATCH /api/v2/incidents/{incident_id}/relationships/todos/{todo_id}

  • Write

    Create an incident responder

    Add a responder to an incident.

    POST /api/v2/incidents/{incident_id}/responders

  • Write

    Create an incident ServiceNow record

    Create a ServiceNow record for an incident.

    POST /api/v2/incidents/{incident_id}/servicenow-records

  • Write

    Create an incident timestamp override

    Create a timestamp override for an incident.

    POST /api/v2/incidents/{incident_id}/timestamp-overrides

  • Write

    Update an incident timestamp override

    Update a timestamp override for an incident.

    PATCH /api/v2/incidents/{incident_id}/timestamp-overrides/{id}

  • Destructive

    Delete global incident handle

    Delete a global incident handle.

    DELETE /api/v2/incidents/config/global/incident-handles

  • Destructive

    Update global incident handle

    Update an existing global incident handle.

    PUT /api/v2/incidents/config/global/incident-handles

  • Destructive

    Delete an incident impact field

    Delete an impact field for incidents.

    DELETE /api/v2/incidents/config/impact-fields/{field_id}

  • Destructive

    Update an incident impact field

    Update an impact field for incidents.

    PUT /api/v2/incidents/config/impact-fields/{field_id}

  • Destructive

    Delete an incident notification rule

    Deletes a notification rule by its ID.

    DELETE /api/v2/incidents/config/notification-rules/{id}

  • Destructive

    Update an incident notification rule

    Updates an existing notification rule with a complete replacement.

    PUT /api/v2/incidents/config/notification-rules/{id}

  • Destructive

    Delete a notification template

    Deletes a notification template by its ID.

    DELETE /api/v2/incidents/config/notification-templates/{id}

  • Destructive

    Delete postmortem template

    Delete a postmortem template.

    DELETE /api/v2/incidents/config/postmortem-templates/{template_id}

  • Destructive

    Delete an incident rule

    Delete an incident rule.

    DELETE /api/v2/incidents/config/rules/{rule_id}

  • Destructive

    Delete an incident type

    Delete an incident type.

    DELETE /api/v2/incidents/config/types/{incident_type_id}

  • Destructive

    Delete an incident user-defined field

    Delete an incident user-defined field.

    DELETE /api/v2/incidents/config/user-defined-fields/{field_id}

  • Destructive

    Delete an incident user-defined role

    Delete an existing user-defined role for incidents.

    DELETE /api/v2/incidents/config/user-defined-roles/{role_id}

  • Destructive

    Delete an existing incident

    Deletes an existing incident from the users organization.

    DELETE /api/v2/incidents/{incident_id}

  • Destructive

    Delete incident attachment

    DELETE /api/v2/incidents/{incident_id}/attachments/{attachment_id}

    DELETE /api/v2/incidents/{incident_id}/attachments/{attachment_id}

  • Destructive

    Delete an incident impact

    Delete an incident impact.

    DELETE /api/v2/incidents/{incident_id}/impacts/{impact_id}

  • Destructive

    Delete an incident integration metadata

    Delete an incident integration metadata.

    DELETE /api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}

  • Destructive

    Delete an incident todo

    Delete an incident todo.

    DELETE /api/v2/incidents/{incident_id}/relationships/todos/{todo_id}

  • Destructive

    Delete an incident responder

    Remove a responder from an incident.

    DELETE /api/v2/incidents/{incident_id}/responders/{responder_id}

  • Destructive

    Delete an incident timestamp override

    Delete a timestamp override for an incident.

    DELETE /api/v2/incidents/{incident_id}/timestamp-overrides/{id}

Databricks Integration

  • Read

    List Databricks integration accounts

    List Databricks integration accounts.

    GET /api/v2/integration-interfaces/databricks/accounts

  • Read

    Get a Databricks integration account

    Get a Databricks integration account.

    GET /api/v2/integration-interfaces/databricks/accounts/{account_id}

  • Write

    Create a Databricks integration account

    Create a Databricks integration account.

    POST /api/v2/integration-interfaces/databricks/accounts

  • Destructive

    Delete a Databricks integration account

    Delete a Databricks integration account.

    DELETE /api/v2/integration-interfaces/databricks/accounts/{account_id}

  • Destructive

    Update a Databricks integration account

    Update a Databricks integration account. Only the fields provided are changed.

    PATCH /api/v2/integration-interfaces/databricks/accounts/{account_id}

Elastic Cloud Integration

  • Read

    List Elastic Cloud integration accounts

    List Elastic Cloud integration accounts.

    GET /api/v2/integration-interfaces/elastic-cloud/accounts

  • Read

    Get an Elastic Cloud integration account

    Get an Elastic Cloud integration account.

    GET /api/v2/integration-interfaces/elastic-cloud/accounts/{account_id}

  • Write

    Create an Elastic Cloud integration account

    Create an Elastic Cloud integration account.

    POST /api/v2/integration-interfaces/elastic-cloud/accounts

  • Write

    Update an Elastic Cloud integration account

    Update an Elastic Cloud integration account. Only the fields provided are changed.

    PATCH /api/v2/integration-interfaces/elastic-cloud/accounts/{account_id}

  • Destructive

    Delete an Elastic Cloud integration account

    Delete an Elastic Cloud integration account.

    DELETE /api/v2/integration-interfaces/elastic-cloud/accounts/{account_id}

Snowflake Integration

  • Read

    List Snowflake integration accounts

    List Snowflake integration accounts.

    GET /api/v2/integration-interfaces/snowflake/accounts

  • Read

    Get a Snowflake integration account

    Get a Snowflake integration account.

    GET /api/v2/integration-interfaces/snowflake/accounts/{account_id}

  • Write

    Create a Snowflake integration account

    Create a Snowflake integration account.

    POST /api/v2/integration-interfaces/snowflake/accounts

  • Destructive

    Delete a Snowflake integration account

    Delete a Snowflake integration account.

    DELETE /api/v2/integration-interfaces/snowflake/accounts/{account_id}

  • Destructive

    Update a Snowflake integration account

    Update a Snowflake integration account. Only the fields provided are changed.

    PATCH /api/v2/integration-interfaces/snowflake/accounts/{account_id}

Twilio Integration

  • Read

    List Twilio integration accounts

    List Twilio integration accounts.

    GET /api/v2/integration-interfaces/twilio/accounts

  • Read

    Get a Twilio integration account

    Get a Twilio integration account.

    GET /api/v2/integration-interfaces/twilio/accounts/{account_id}

  • Write

    Create a Twilio integration account

    Create a Twilio integration account.

    POST /api/v2/integration-interfaces/twilio/accounts

  • Write

    Update a Twilio integration account

    Update a Twilio integration account. Only the fields provided are changed.

    PATCH /api/v2/integration-interfaces/twilio/accounts/{account_id}

  • Destructive

    Delete a Twilio integration account

    Delete a Twilio integration account.

    DELETE /api/v2/integration-interfaces/twilio/accounts/{account_id}

Google Chat Integration

  • Read

    Get all Google Chat organization bindings

    Get a list of all Google Chat organization bindings in the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations

  • Read

    Get space information by display name

    Get the resource name and organization binding ID of a space in the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations/app/named-spaces/{domain_name}/{space_display_name}

  • Read

    Get a Google Chat organization binding

    Get a Google Chat organization binding from the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations/{organization_binding_id}

  • Read

    Get the delegated user

    Get the delegated user for a Google Chat organization binding in the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations/{organization_binding_id}/delegated-user

  • Read

    Get all organization handles

    Get a list of all organization handles from the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles

  • Read

    Get organization handle

    Get an organization handle from the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}

  • Read

    Get all target audiences

    Get a list of all target audiences for a Google Chat organization binding in the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences

  • Read

    Get a target audience

    Get a target audience for a Google Chat organization binding in the Datadog Google Chat integration.

    GET /api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}

  • Write

    Create organization handle

    Create an organization handle in the Datadog Google Chat integration.

    POST /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles

  • Write

    Update organization handle

    Update an organization handle from the Datadog Google Chat integration.

    PATCH /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}

  • Write

    Create a target audience

    Create a target audience for a Google Chat organization binding in the Datadog Google Chat integration.

    POST /api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences

  • Write

    Update a target audience

    Update a target audience for a Google Chat organization binding in the Datadog Google Chat integration.

    PATCH /api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}

  • Destructive

    Delete a Google Chat organization binding

    Delete a Google Chat organization binding from the Datadog Google Chat integration.

    DELETE /api/v2/integration/google-chat/organizations/{organization_binding_id}

  • Destructive

    Delete the delegated user

    Delete the delegated user for a Google Chat organization binding from the Datadog Google Chat integration.

    DELETE /api/v2/integration/google-chat/organizations/{organization_binding_id}/delegated-user

  • Destructive

    Delete organization handle

    Delete an organization handle from the Datadog Google Chat integration.

    DELETE /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}

  • Destructive

    Delete a target audience

    Delete a target audience from a Google Chat organization binding in the Datadog Google Chat integration.

    DELETE /api/v2/integration/google-chat/organizations/{organization_binding_id}/target-audiences/{target_audience_id}

Jira Integration

  • Read

    List Jira accounts

    Get all Jira accounts for the organization.

    GET /api/v2/integration/jira/accounts

  • Read

    List Jira issue templates

    Get all Jira issue templates for the organization.

    GET /api/v2/integration/jira/issue-templates

  • Read

    Get Jira issue template

    Get a Jira issue template by ID.

    GET /api/v2/integration/jira/issue-templates/{issue_template_id}

  • Write

    Create Jira issue template

    Create a new Jira issue template.

    POST /api/v2/integration/jira/issue-templates

  • Write

    Update Jira issue template

    Update a Jira issue template by ID.

    PATCH /api/v2/integration/jira/issue-templates/{issue_template_id}

  • Destructive

    Delete Jira account

    Delete a Jira account by ID.

    DELETE /api/v2/integration/jira/accounts/{account_id}

  • Destructive

    Delete Jira issue template

    Delete a Jira issue template by ID.

    DELETE /api/v2/integration/jira/issue-templates/{issue_template_id}

Microsoft Teams Integration

  • Read

    Get channel information by name

    Get the tenant, team, and channel ID of a channel in the Datadog Microsoft Teams integration.

    GET /api/v2/integration/ms-teams/configuration/channel/{tenant_name}/{team_name}/{channel_name}

  • Read

    Get all tenant-based handles

    Get a list of all tenant-based handles from the Datadog Microsoft Teams integration.

    GET /api/v2/integration/ms-teams/configuration/tenant-based-handles

  • Read

    Get tenant-based handle information

    Get the tenant, team, and channel information of a tenant-based handle from the Datadog Microsoft Teams integration.

    GET /api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}

  • Read

    Get all Workflows webhook handles

    Get a list of all Workflows webhook handles from the Datadog Microsoft Teams integration.

    GET /api/v2/integration/ms-teams/configuration/workflows-webhook-handles

  • Read

    Get Workflows webhook handle information

    Get the name of a Workflows webhook handle from the Datadog Microsoft Teams integration.

    GET /api/v2/integration/ms-teams/configuration/workflows-webhook-handles/{handle_id}

  • Write

    Create tenant-based handle

    Create a tenant-based handle in the Datadog Microsoft Teams integration.

    POST /api/v2/integration/ms-teams/configuration/tenant-based-handles

  • Write

    Update tenant-based handle

    Update a tenant-based handle from the Datadog Microsoft Teams integration.

    PATCH /api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}

  • Write

    Create Workflows webhook handle

    Create a Workflows webhook handle in the Datadog Microsoft Teams integration.

    POST /api/v2/integration/ms-teams/configuration/workflows-webhook-handles

  • Write

    Update Workflows webhook handle

    Update a Workflows webhook handle from the Datadog Microsoft Teams integration.

    PATCH /api/v2/integration/ms-teams/configuration/workflows-webhook-handles/{handle_id}

  • Destructive

    Delete tenant-based handle

    Delete a tenant-based handle from the Datadog Microsoft Teams integration.

    DELETE /api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}

  • Destructive

    Delete user binding

    Delete the user binding for a given tenant from the Datadog Microsoft Teams integration.

    DELETE /api/v2/integration/ms-teams/configuration/user-binding/{tenant_id}

  • Destructive

    Delete Workflows webhook handle

    Delete a Workflows webhook handle from the Datadog Microsoft Teams integration.

    DELETE /api/v2/integration/ms-teams/configuration/workflows-webhook-handles/{handle_id}

OCI Integration

  • Read

    List tenancy products

    Lists the products for a given tenancy. Returns the enabled/disabled status of Datadog products (such as Cloud Security Posture Management) for specific OCI tenancies.

    GET /api/v2/integration/oci/products

  • Read

    Get tenancy configs

    Get a list of all configured OCI tenancy integrations. Returns basic information about each tenancy including authentication credentials, region settings, and collection preferences for metrics, logs, and resources.

    GET /api/v2/integration/oci/tenancies

  • Read

    Get tenancy config

    Get a single tenancy config object by its OCID. Returns detailed configuration including authentication credentials, enabled services, region settings, and collection preferences.

    GET /api/v2/integration/oci/tenancies/{tenancy_ocid}

  • Write

    Create tenancy config

    Create a new tenancy config to establish monitoring and data collection from your OCI environment. Requires OCI authentication credentials and tenancy details. Warning: Datadog recommends interacting with this endpoint only through the Datadog web UI to ensure all necessary OCI resources have been created and configured properly.

    POST /api/v2/integration/oci/tenancies

  • Write

    Update tenancy config

    Update an existing tenancy config. You can modify authentication credentials, enable/disable collection types, update service filters, and change region settings. Warning: We recommend using the Datadog web UI to avoid unintended update effects.

    PATCH /api/v2/integration/oci/tenancies/{tenancy_ocid}

  • Destructive

    Delete tenancy config

    Delete an existing tenancy config. This will stop all data collection from the specified OCI tenancy and remove the stored configuration. This operation cannot be undone.

    DELETE /api/v2/integration/oci/tenancies/{tenancy_ocid}

Opsgenie Integration

  • Read

    Get all Opsgenie accounts

    Get a list of all Opsgenie accounts from the Datadog Opsgenie integration.

    GET /api/v2/integration/opsgenie/accounts

  • Read

    Get all service objects

    Get a list of all services from the Datadog Opsgenie integration.

    GET /api/v2/integration/opsgenie/services

  • Read

    Get a single service object

    Get a single service from the Datadog Opsgenie integration.

    GET /api/v2/integration/opsgenie/services/{integration_service_id}

  • Write

    Create a new Opsgenie account

    Create a new Opsgenie account in the Datadog Opsgenie integration.

    POST /api/v2/integration/opsgenie/accounts

  • Write

    Update an Opsgenie account

    Update a single Opsgenie account in the Datadog Opsgenie integration.

    PATCH /api/v2/integration/opsgenie/accounts/{account_id}

  • Write

    Create a new service object

    Create a new service object in the Opsgenie integration.

    POST /api/v2/integration/opsgenie/services

  • Write

    Update a single service object

    Update a single service object in the Datadog Opsgenie integration.

    PATCH /api/v2/integration/opsgenie/services/{integration_service_id}

  • Destructive

    Delete an Opsgenie account

    Delete a single Opsgenie account from the Datadog Opsgenie integration.

    DELETE /api/v2/integration/opsgenie/accounts/{account_id}

  • Destructive

    Delete a single service object

    Delete a single service object in the Datadog Opsgenie integration.

    DELETE /api/v2/integration/opsgenie/services/{integration_service_id}

Salesforce Integration

  • Read

    Get all Salesforce incident templates (deprecated)

    Get all Salesforce incident templates configured for your organization.

    GET /api/v2/integration/salesforce-incidents/incident-templates

  • Read

    Get all connected Salesforce organizations (deprecated)

    Get all Salesforce organizations connected to your Datadog organization through the Salesforce integration. Salesforce organizations are connected through the OAuth setup flow in the Datadog Salesforce integration page.

    GET /api/v2/integration/salesforce-incidents/organizations

  • Write

    Create a Salesforce incident template (deprecated)

    Create a new Salesforce incident template for your organization. Template names must be unique within an organization.

    POST /api/v2/integration/salesforce-incidents/incident-templates

  • Write

    Update a Salesforce incident template (deprecated)

    Update a single Salesforce incident template in your organization.

    PATCH /api/v2/integration/salesforce-incidents/incident-templates/{incident_template_id}

  • Destructive

    Delete a Salesforce incident template (deprecated)

    Delete a single Salesforce incident template from your organization.

    DELETE /api/v2/integration/salesforce-incidents/incident-templates/{incident_template_id}

  • Destructive

    Delete a connected Salesforce organization (deprecated)

    Disconnect a Salesforce organization from your Datadog organization. This also deletes any incident templates referencing the organization.

    DELETE /api/v2/integration/salesforce-incidents/organizations/{salesforce_org_id}

Service Now Integration

  • Read

    List ServiceNow assignment groups

    Get all assignment groups for a ServiceNow instance.

    GET /api/v2/integration/servicenow/assignment_groups/{instance_id}

  • Read

    List ServiceNow business services

    Get all business services for a ServiceNow instance.

    GET /api/v2/integration/servicenow/business_services/{instance_id}

  • Read

    List ServiceNow templates

    Get all ServiceNow templates for the organization.

    GET /api/v2/integration/servicenow/handles

  • Read

    Get ServiceNow template

    Get a ServiceNow template by ID.

    GET /api/v2/integration/servicenow/handles/{template_id}

  • Read

    List ServiceNow instances

    Get all ServiceNow instances for the organization.

    GET /api/v2/integration/servicenow/instances

  • Read

    List ServiceNow users

    Get all users for a ServiceNow instance.

    GET /api/v2/integration/servicenow/users/{instance_id}

  • Write

    Create ServiceNow template

    Create a new ServiceNow template.

    POST /api/v2/integration/servicenow/handles

  • Destructive

    Delete ServiceNow template

    Delete a ServiceNow template by ID.

    DELETE /api/v2/integration/servicenow/handles/{template_id}

  • Destructive

    Update ServiceNow template

    Update a ServiceNow template by ID.

    PUT /api/v2/integration/servicenow/handles/{template_id}

Statuspage Integration

  • Read

    Get the Statuspage account

    Get the Statuspage account configured for your organization.

    GET /api/v2/integration/statuspage/account

  • Read

    Get all Statuspage URL settings

    Get all Statuspage URL settings configured for your organization.

    GET /api/v2/integration/statuspage/url_settings

  • Write

    Update the Statuspage account

    Update the Statuspage account configured for your organization.

    PATCH /api/v2/integration/statuspage/account

  • Write

    Create the Statuspage account

    Create a Statuspage account for your organization. Only one Statuspage account can be configured per organization.

    POST /api/v2/integration/statuspage/account

  • Write

    Create a Statuspage URL setting

    Create a Statuspage URL setting for your organization.

    POST /api/v2/integration/statuspage/url_settings

  • Write

    Update a Statuspage URL setting

    Update a single Statuspage URL setting in your organization.

    PATCH /api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}

  • Destructive

    Delete the Statuspage account

    Delete the Statuspage account configured for your organization.

    DELETE /api/v2/integration/statuspage/account

  • Destructive

    Delete a Statuspage URL setting

    Delete a single Statuspage URL setting from your organization.

    DELETE /api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}

Integrations

  • Read

    List Integrations

    GET /api/v2/integrations

    GET /api/v2/integrations

Cloudflare Integration

  • Read

    List Cloudflare accounts

    List Cloudflare accounts.

    GET /api/v2/integrations/cloudflare/accounts

  • Read

    Get Cloudflare account

    Get a Cloudflare account.

    GET /api/v2/integrations/cloudflare/accounts/{account_id}

  • Write

    Add Cloudflare account

    Create a Cloudflare account.

    POST /api/v2/integrations/cloudflare/accounts

  • Write

    Update Cloudflare account

    Update a Cloudflare account.

    PATCH /api/v2/integrations/cloudflare/accounts/{account_id}

  • Destructive

    Delete Cloudflare account

    Delete a Cloudflare account.

    DELETE /api/v2/integrations/cloudflare/accounts/{account_id}

Confluent Cloud

  • Read

    List Confluent accounts

    List Confluent accounts.

    GET /api/v2/integrations/confluent-cloud/accounts

  • Read

    Get Confluent account

    Get the Confluent account with the provided account ID.

    GET /api/v2/integrations/confluent-cloud/accounts/{account_id}

  • Read

    List Confluent Account resources

    Get a Confluent resource for the account associated with the provided ID.

    GET /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources

  • Read

    Get resource from Confluent account

    Get a Confluent resource with the provided resource id for the account associated with the provided account ID.

    GET /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}

  • Write

    Add Confluent account

    Create a Confluent account.

    POST /api/v2/integrations/confluent-cloud/accounts

  • Write

    Update Confluent account

    Update the Confluent account with the provided account ID.

    PATCH /api/v2/integrations/confluent-cloud/accounts/{account_id}

  • Write

    Add resource to Confluent account

    Create a Confluent resource for the account associated with the provided ID.

    POST /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources

  • Write

    Update resource in Confluent account

    Update a Confluent resource with the provided resource id for the account associated with the provided account ID.

    PATCH /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}

  • Destructive

    Delete Confluent account

    Delete a Confluent account with the provided account ID.

    DELETE /api/v2/integrations/confluent-cloud/accounts/{account_id}

  • Destructive

    Delete resource from Confluent account

    Delete a Confluent resource with the provided resource id for the account associated with the provided account ID.

    DELETE /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}

Fastly Integration

  • Read

    List Fastly accounts

    List Fastly accounts.

    GET /api/v2/integrations/fastly/accounts

  • Read

    Get Fastly account

    Get a Fastly account.

    GET /api/v2/integrations/fastly/accounts/{account_id}

  • Read

    List Fastly services

    List Fastly services for an account.

    GET /api/v2/integrations/fastly/accounts/{account_id}/services

  • Read

    Get Fastly service

    Get a Fastly service for an account.

    GET /api/v2/integrations/fastly/accounts/{account_id}/services/{service_id}

  • Write

    Add Fastly account

    Create a Fastly account.

    POST /api/v2/integrations/fastly/accounts

  • Write

    Update Fastly account

    Update a Fastly account.

    PATCH /api/v2/integrations/fastly/accounts/{account_id}

  • Write

    Add Fastly service

    Create a Fastly service for an account.

    POST /api/v2/integrations/fastly/accounts/{account_id}/services

  • Write

    Update Fastly service

    Update a Fastly service for an account.

    PATCH /api/v2/integrations/fastly/accounts/{account_id}/services/{service_id}

  • Destructive

    Delete Fastly account

    Delete a Fastly account.

    DELETE /api/v2/integrations/fastly/accounts/{account_id}

  • Destructive

    Delete Fastly service

    Delete a Fastly service for an account.

    DELETE /api/v2/integrations/fastly/accounts/{account_id}/services/{service_id}

Okta Integration

  • Read

    List Okta accounts

    List Okta accounts.

    GET /api/v2/integrations/okta/accounts

  • Read

    Get Okta account

    Get an Okta account.

    GET /api/v2/integrations/okta/accounts/{account_id}

  • Write

    Add Okta account

    Create an Okta account.

    POST /api/v2/integrations/okta/accounts

  • Write

    Update Okta account

    Update an Okta account.

    PATCH /api/v2/integrations/okta/accounts/{account_id}

  • Destructive

    Delete Okta account

    Delete an Okta account.

    DELETE /api/v2/integrations/okta/accounts/{account_id}

IP Allowlist

  • Read

    Get IP Allowlist

    Returns the IP allowlist and its enabled or disabled state.

    GET /api/v2/ip_allowlist

  • Destructive

    Update IP Allowlist

    Edit the entries in the IP allowlist, and enable or disable it.

    PATCH /api/v2/ip_allowlist

Logs Archive Searches

  • Read

    List Archive Searches

    List the organization's Archive Searches that haven't expired, up to 5,000. When more exist, `meta.truncated` is `true`.

    GET /api/v2/logs/archive_searches

  • Read

    Get an Archive Search

    Get a single Archive Search, including its status and the amount of archive data scanned when the search finishes.

    GET /api/v2/logs/archive_searches/{archive_search_id}

  • Write

    Create an Archive Search

    Start a search over the logs stored in an archive. Without a `rehydration` object, the search only scans the archive and reports how much data matched. With one, the matched logs are also indexed into a retained historical view, which requires the `logs_write_historical_view` permission.

    POST /api/v2/logs/archive_searches

  • Write

    Rehydrate an Archive Search

    Turn a plain Archive Search into a Search & Rehydration by indexing the matched logs into a retained historical view. Rehydration is the only thing this endpoint can change, and it only applies to a search that has already finished scanning.

    PATCH /api/v2/logs/archive_searches/{archive_search_id}

  • Destructive

    Cancel an Archive Search

    Cancel a running Archive Search. Cancelling an Archive Search that has already finished is a no-op: it returns the resource unchanged instead of returning an error.

    POST /api/v2/logs/archive_searches/{archive_search_id}/cancel

Logs Archives

  • Read

    Get archive order

    Get the current order of your archives. This endpoint takes no JSON arguments.

    GET /api/v2/logs/config/archive-order

  • Read

    Get all archives

    Get the list of configured logs archives with their definitions.

    GET /api/v2/logs/config/archives

  • Read

    Get an archive

    Get a specific archive from your organization.

    GET /api/v2/logs/config/archives/{archive_id}

  • Read

    List read roles for an archive

    Returns all read roles a given archive is restricted to.

    GET /api/v2/logs/config/archives/{archive_id}/readers

  • Write

    Grant role to an archive

    Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))

    POST /api/v2/logs/config/archives/{archive_id}/readers

  • Destructive

    Update archive order

    Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. **Note**: Using the `PUT` method updates your archive's order by replacing the current order with the new one.

    PUT /api/v2/logs/config/archive-order

  • Destructive

    Create an archive

    Create an archive in your organization.

    POST /api/v2/logs/config/archives

  • Destructive

    Delete an archive

    Delete a given archive from your organization.

    DELETE /api/v2/logs/config/archives/{archive_id}

  • Destructive

    Update an archive

    Update a given archive configuration. **Note**: Using this method updates your archive configuration by **replacing** your current configuration with the new one sent to your Datadog organization.

    PUT /api/v2/logs/config/archives/{archive_id}

  • Destructive

    Revoke role from an archive

    Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))

    DELETE /api/v2/logs/config/archives/{archive_id}/readers

Logs Custom Destinations

  • Read

    Get all custom destinations

    Get the list of configured custom destinations in your organization with their definitions.

    GET /api/v2/logs/config/custom-destinations

  • Read

    Get a custom destination

    Get a specific custom destination in your organization.

    GET /api/v2/logs/config/custom-destinations/{custom_destination_id}

  • Write

    Create a custom destination

    Create a custom destination in your organization.

    POST /api/v2/logs/config/custom-destinations

  • Write

    Update a custom destination

    Update the given fields of a specific custom destination in your organization.

    PATCH /api/v2/logs/config/custom-destinations/{custom_destination_id}

  • Destructive

    Delete a custom destination

    Delete a specific custom destination in your organization.

    DELETE /api/v2/logs/config/custom-destinations/{custom_destination_id}

Logs Metrics

  • Read

    Get all log-based metrics

    Get the list of configured log-based metrics with their definitions.

    GET /api/v2/logs/config/metrics

  • Read

    Get a log-based metric

    Get a specific log-based metric from your organization.

    GET /api/v2/logs/config/metrics/{metric_id}

  • Write

    Create a log-based metric

    Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful.

    POST /api/v2/logs/config/metrics

  • Write

    Update a log-based metric

    Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful.

    PATCH /api/v2/logs/config/metrics/{metric_id}

  • Destructive

    Delete a log-based metric

    Delete a specific log-based metric from your organization.

    DELETE /api/v2/logs/config/metrics/{metric_id}

Logs Restriction Queries

  • Read

    List restriction queries

    Returns all restriction queries, including their names and IDs.

    GET /api/v2/logs/config/restriction_queries

  • Read

    Get restriction query for a given role

    Get restriction query for a given role.

    GET /api/v2/logs/config/restriction_queries/role/{role_id}

  • Read

    Get all restriction queries for a given user

    Get all restriction queries for a given user.

    GET /api/v2/logs/config/restriction_queries/user/{user_id}

  • Read

    Get a restriction query

    Get a restriction query in the organization specified by the restriction query's `restriction_query_id`.

    GET /api/v2/logs/config/restriction_queries/{restriction_query_id}

  • Read

    List roles for a restriction query

    Returns all roles that have a given restriction query.

    GET /api/v2/logs/config/restriction_queries/{restriction_query_id}/roles

  • Write

    Create a restriction query

    Create a new restriction query for your organization.

    POST /api/v2/logs/config/restriction_queries

  • Write

    Update a restriction query

    Edit a restriction query.

    PATCH /api/v2/logs/config/restriction_queries/{restriction_query_id}

  • Write

    Grant role to a restriction query

    Adds a role to a restriction query. **Note**: This operation automatically grants the `logs_read_data` permission to the role if it doesn't already have it.

    POST /api/v2/logs/config/restriction_queries/{restriction_query_id}/roles

  • Destructive

    Delete a restriction query

    Deletes a restriction query.

    DELETE /api/v2/logs/config/restriction_queries/{restriction_query_id}

  • Destructive

    Replace a restriction query

    Replace a restriction query.

    PUT /api/v2/logs/config/restriction_queries/{restriction_query_id}

  • Destructive

    Revoke role from a restriction query

    Removes a role from a restriction query.

    DELETE /api/v2/logs/config/restriction_queries/{restriction_query_id}/roles

Model Lab API

  • Read

    Get Model Lab artifact content

    Download the raw content of a Model Lab artifact file.

    GET /api/v2/model-lab-api/artifacts/content

  • Read

    List Model Lab run facet keys

    List all available facet keys for filtering Model Lab runs.

    GET /api/v2/model-lab-api/facet-keys

  • Read

    List Model Lab run facet values

    List available facet values for a specific run facet key.

    GET /api/v2/model-lab-api/facet-values

  • Read

    List Model Lab project facet keys

    List all available facet keys for filtering Model Lab projects.

    GET /api/v2/model-lab-api/project-facet-keys

  • Read

    List Model Lab project facet values

    List available facet values for a specific project facet key.

    GET /api/v2/model-lab-api/project-facet-values

  • Read

    List Model Lab projects

    List all Model Lab projects for the current organization.

    GET /api/v2/model-lab-api/projects

  • Read

    Get a Model Lab project

    Get a single Model Lab project by its ID.

    GET /api/v2/model-lab-api/projects/{project_id}

  • Read

    List Model Lab project artifacts

    List all artifact files for a specific Model Lab project.

    GET /api/v2/model-lab-api/projects/{project_id}/artifacts

  • Read

    List Model Lab runs

    List all Model Lab runs for the current organization.

    GET /api/v2/model-lab-api/runs

  • Read

    Get a Model Lab run

    Get a single Model Lab run by its ID.

    GET /api/v2/model-lab-api/runs/{run_id}

  • Read

    List Model Lab run artifacts

    List artifact files for a specific Model Lab run.

    GET /api/v2/model-lab-api/runs/{run_id}/artifacts

  • Write

    Star a Model Lab project

    Star a Model Lab project for the current user.

    POST /api/v2/model-lab-api/projects/{project_id}/star

  • Write

    Pin a Model Lab run

    Pin a Model Lab run for the current user.

    POST /api/v2/model-lab-api/runs/{run_id}/pin

  • Destructive

    Remove star from a Model Lab project

    Remove the star from a Model Lab project for the current user.

    DELETE /api/v2/model-lab-api/projects/{project_id}/star

  • Destructive

    Delete a Model Lab run

    Delete a Model Lab run by its ID.

    DELETE /api/v2/model-lab-api/runs/{run_id}

  • Destructive

    Unpin a Model Lab run

    Remove the pin from a Model Lab run for the current user.

    DELETE /api/v2/model-lab-api/runs/{run_id}/pin

Network Device Monitoring

  • Read

    Get the list of devices

    Get the list of devices.

    GET /api/v2/ndm/devices

  • Read

    Get the device details

    Get the device details.

    GET /api/v2/ndm/devices/{device_id}

  • Read

    Get the list of interfaces of the device

    Get the list of interfaces of the device.

    GET /api/v2/ndm/interfaces

  • Read

    Get the list of tags for a device

    Get the list of tags for a device.

    GET /api/v2/ndm/tags/devices/{device_id}

  • Read

    List tags for an interface

    Returns the tags associated with the specified interface.

    GET /api/v2/ndm/tags/interfaces/{interface_id}

  • Write

    Update the tags for a device

    Update the tags for a device. A device supports up to 20 user tags by default. To request a higher limit for your organization, [contact Support](https://docs.datadoghq.com/help/).

    PATCH /api/v2/ndm/tags/devices/{device_id}

  • Write

    Update the tags for an interface

    Updates the tags associated with the specified interface.

    PATCH /api/v2/ndm/tags/interfaces/{interface_id}

Cloud Network Monitoring

  • Read

    Get all aggregated connections

    Get all aggregated connections.

    GET /api/v2/network/connections/aggregate

  • Read

    Get all aggregated DNS traffic

    Get all aggregated DNS traffic.

    GET /api/v2/network/dns/aggregate

OAuth2 Client Public

  • Read

    Get OpenID Connect provider metadata

    Retrieve OpenID Connect provider metadata for the OAuth2 v2 token endpoint.

    GET /api/v2/oauth2/.well-known/openid-configuration

  • Read

    Get OAuth2 well-known sites

    Retrieve the list of public OAuth2 sites available for the current environment. This endpoint is used for OAuth2 discovery and returns sites where users can authenticate.

    GET /api/v2/oauth2/.well-known/sites

  • Read

    Get an OAuth2 client scopes restriction

    Get the scopes restriction configured for the OAuth2 client.

    GET /api/v2/oauth2/clients/{client_uuid}/scopes_restriction

  • Write

    Upsert an OAuth2 client scopes restriction

    Create or update the scopes restriction configured for the OAuth2 client.

    POST /api/v2/oauth2/clients/{client_uuid}/scopes_restriction

  • Write

    Register an OAuth2 client

    Register an OAuth2 client using the Dynamic Client Registration protocol defined in RFC 7591.

    POST /api/v2/oauth2/register

  • Destructive

    Delete an OAuth2 client scopes restriction

    Delete the scopes restriction configured for the OAuth2 client.

    DELETE /api/v2/oauth2/clients/{client_uuid}/scopes_restriction

Observability Pipelines

  • Read

    List pipelines

    Retrieve a list of pipelines.

    GET /api/v2/obs-pipelines/pipelines

  • Read

    Validate an observability pipeline

    Validates a pipeline configuration without creating or updating any resources. Returns a list of validation errors, if any.

    POST /api/v2/obs-pipelines/pipelines/validate

  • Read

    Get a specific pipeline

    Get a specific pipeline by its ID.

    GET /api/v2/obs-pipelines/pipelines/{pipeline_id}

  • Destructive

    Create a new pipeline

    Create a new pipeline.

    POST /api/v2/obs-pipelines/pipelines

  • Destructive

    Delete a pipeline

    Delete a pipeline.

    DELETE /api/v2/obs-pipelines/pipelines/{pipeline_id}

  • Destructive

    Update a pipeline

    Update a pipeline.

    PUT /api/v2/obs-pipelines/pipelines/{pipeline_id}

On Call

  • Read

    List On-Call escalation policies

    Retrieve a paginated list of On-Call escalation policies, sorted by name.

    GET /api/v2/on-call/escalation-policies

  • Read

    Get On-Call escalation policy

    Get an On-Call escalation policy

    GET /api/v2/on-call/escalation-policies/{policy_id}

  • Read

    List On-Call schedules

    Retrieve a list of On-Call schedules.

    GET /api/v2/on-call/schedules

  • Read

    Get On-Call schedule

    Get an On-Call schedule

    GET /api/v2/on-call/schedules/{schedule_id}

  • Read

    List On-Call schedule overrides

    Retrieve a list of overrides for the specified On-Call schedule within a given time range.

    GET /api/v2/on-call/schedules/{schedule_id}/overrides

  • Read

    Get on-call responders for a schedule

    Retrieves the on-call responders for the specified schedule, grouped by position (previous, current, next), at a given time. Supports schedules with multiple concurrent on-call responders at a position, by returning a list of shifts per position.

    GET /api/v2/on-call/schedules/{schedule_id}/responders

  • Read

    Get team on-call users

    Get a team's on-call users at a given time

    GET /api/v2/on-call/teams/{team_id}/on-call

  • Read

    Get On-Call team routing rules

    Get a team's On-Call routing rules

    GET /api/v2/on-call/teams/{team_id}/routing-rules

  • Read

    List On-Call notification channels for a user

    List the notification channels for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    GET /api/v2/on-call/users/{user_id}/notification-channels

  • Read

    Get an On-Call notification channel for a user

    Get a notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    GET /api/v2/on-call/users/{user_id}/notification-channels/{channel_id}

  • Read

    List On-Call notification rules for a user

    List the notification rules for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    GET /api/v2/on-call/users/{user_id}/notification-rules

  • Read

    Get an On-Call notification rule for a user

    Get a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    GET /api/v2/on-call/users/{user_id}/notification-rules/{rule_id}

  • Write

    Create On-Call escalation policy

    Create a new On-Call escalation policy

    POST /api/v2/on-call/escalation-policies

  • Write

    Create On-Call schedule

    Create a new On-Call schedule

    POST /api/v2/on-call/schedules

  • Write

    Create On-Call schedule overrides

    Create one or more overrides for the specified On-Call schedule.

    POST /api/v2/on-call/schedules/{schedule_id}/overrides

  • Write

    Create an On-Call notification channel for a user

    Create a new notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    POST /api/v2/on-call/users/{user_id}/notification-channels

  • Write

    Create an On-Call notification rule for a user

    Create a new notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    POST /api/v2/on-call/users/{user_id}/notification-rules

  • Destructive

    Delete On-Call escalation policy

    Delete an On-Call escalation policy

    DELETE /api/v2/on-call/escalation-policies/{policy_id}

  • Destructive

    Update On-Call escalation policy

    Update an On-Call escalation policy

    PUT /api/v2/on-call/escalation-policies/{policy_id}

  • Destructive

    Delete On-Call schedule

    Delete an On-Call schedule

    DELETE /api/v2/on-call/schedules/{schedule_id}

  • Destructive

    Update On-Call schedule

    Update a new On-Call schedule

    PUT /api/v2/on-call/schedules/{schedule_id}

  • Destructive

    Delete On-Call schedule override

    Delete an override from the specified On-Call schedule.

    DELETE /api/v2/on-call/schedules/{schedule_id}/overrides/{override_id}

  • Destructive

    Set On-Call team routing rules

    Set a team's On-Call routing rules

    PUT /api/v2/on-call/teams/{team_id}/routing-rules

  • Destructive

    Delete an On-Call notification channel for a user

    Delete a notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    DELETE /api/v2/on-call/users/{user_id}/notification-channels/{channel_id}

  • Destructive

    Delete an On-Call notification rule for a user

    Delete a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    DELETE /api/v2/on-call/users/{user_id}/notification-rules/{rule_id}

  • Destructive

    Update an On-Call notification rule for a user

    Update a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission

    PUT /api/v2/on-call/users/{user_id}/notification-rules/{rule_id}

On-Call

  • Read

    List On-Call Pages

    Retrieve a paginated list of On-Call Pages, optionally filtered by a search query and sorted by a field.

    GET /api/v2/on-call/pages

  • Read

    Get On-Call Page

    Get the details of an On-Call Page.

    GET /api/v2/on-call/pages/{page_id}

  • Read

    Get scheduled on-call user (deprecated)

    Retrieves the user who is on-call for the specified schedule at a given time. This endpoint does not support schedules with multiple concurrent on-call responders at a position. Deprecated. Use `Get on-call responders for a schedule` instead.

    GET /api/v2/on-call/schedules/{schedule_id}/on-call

On Call Paging

  • Write

    Create On-Call Page

    Trigger a new On-Call Page.

    POST /api/v2/on-call/pages

  • Write

    Acknowledge On-Call Page

    Acknowledges an On-Call Page.

    POST /api/v2/on-call/pages/{page_id}/acknowledge

  • Write

    Escalate On-Call Page

    Escalates an On-Call Page.

    POST /api/v2/on-call/pages/{page_id}/escalate

  • Write

    Resolve On-Call Page

    Resolves an On-Call Page.

    POST /api/v2/on-call/pages/{page_id}/resolve

On-Call Paging

  • Write

    Reroute On-Call Page

    Reroutes an On-Call Page.

    POST /api/v2/on-call/pages/{page_id}/reroute

Customer Org

  • Write

    Disable the authenticated customer organization

    Disable the Datadog organization associated with the authenticated user or API key. The request body uses JSON:API format. If `org_uuid` is supplied, it must match the authenticated org or the request is rejected. Successful calls disable the org and return the resulting state from the downstream service. Requires the `org_management` permission. **Limitations**: - **Organization age**: Only organizations created within the last 10 days can be disabled through this endpoint. This restriction is a safeguard against accidentally disabling long-running organizations. Attempting to disable an older organization returns a `403 Forbidden`. - **Feature flag**: The feature flag `org_disable_self_service_enabled` must be enabled for the target organization or one of its ancestor organizations. Contact [Datadog support](https://docs.datadoghq.com/help/) to enable this for your organization. Requests for organizations without this flag return a `403 Forbidden`. - **Already-disabled organizations**: If the target organization is already disabled, the request returns a `409 Conflict`.

    POST /api/v2/org/disable

Org Authorized Clients

  • Read

    List org authorized clients

    Get a list of all OAuth2 clients authorized for the current organization.

    GET /api/v2/org_authorized_clients

  • Read

    Get an org authorized client

    Get a single OAuth2 client authorized for the current organization.

    GET /api/v2/org_authorized_clients/{org_authorized_client_id}

  • Read

    List user authorizations for a client

    Get a list of user authorizations for the specified OAuth2 client in the current organization.

    GET /api/v2/org_authorized_clients/{org_authorized_client_id}/user_authorized_clients

  • Write

    Update an org authorized client

    Enable or disable an OAuth2 client authorization for the current organization.

    PATCH /api/v2/org_authorized_clients/{org_authorized_client_id}

  • Destructive

    Delete an org authorized client

    Disable an OAuth2 client authorization for the current organization, revoking access for all users.

    DELETE /api/v2/org_authorized_clients/{org_authorized_client_id}

  • Destructive

    Delete a user's authorizations for a client

    Disable all authorizations for a specific user for the specified OAuth2 client in the current organization.

    DELETE /api/v2/org_authorized_clients/{org_authorized_client_id}/user/{user_id}

  • Destructive

    Delete a user authorization for a client

    Disable a specific user authorization for the specified OAuth2 client in the current organization.

    DELETE /api/v2/org_authorized_clients/{org_authorized_client_id}/user_authorized_clients/{user_authorized_client_id}

Org Connections

  • Read

    List Org Connections

    Returns a list of org connections.

    GET /api/v2/org_connections

  • Write

    Create Org Connection

    Create a new org connection between the current org and a target org.

    POST /api/v2/org_connections

  • Write

    Update Org Connection

    Update an existing org connection.

    PATCH /api/v2/org_connections/{connection_id}

  • Destructive

    Delete Org Connection

    Delete an existing org connection.

    DELETE /api/v2/org_connections/{connection_id}

Org Groups

  • Read

    List org group memberships

    List organization group memberships. Filter by org group ID or org UUID. At least one of `filter[org_group_id]` or `filter[org_uuid]` must be provided. When filtering by org UUID, returns a single-item list with the membership for that org.

    GET /api/v2/org_group_memberships

  • Read

    Get an org group membership

    Get a specific organization group membership by its ID.

    GET /api/v2/org_group_memberships/{org_group_membership_id}

  • Read

    List org group policies

    List policies for an organization group. Requires a filter on org group ID.

    GET /api/v2/org_group_policies

  • Read

    Get an org group policy

    Get a specific organization group policy by its ID.

    GET /api/v2/org_group_policies/{org_group_policy_id}

  • Read

    List org group policy configs

    List all org configs that are eligible to be used as organization group policies.

    GET /api/v2/org_group_policy_configs

  • Read

    List org group policy overrides

    List policy overrides for an organization group. Requires a filter on org group ID. Optionally filter by policy ID.

    GET /api/v2/org_group_policy_overrides

  • Read

    Get an org group policy override

    Get a specific organization group policy override by its ID.

    GET /api/v2/org_group_policy_overrides/{org_group_policy_override_id}

  • Read

    List org group policy suggestions

    List suggested organization group policies. Requires a filter on org group ID.

    GET /api/v2/org_group_policy_suggestions

  • Read

    List org groups

    List all organization groups that the requesting organization has access to.

    GET /api/v2/org_groups

  • Read

    Get an org group

    Get a specific organization group by its ID.

    GET /api/v2/org_groups/{org_group_id}

  • Write

    Create org group memberships

    Add a batch of organizations to an existing organization group. This operation is not supported for organization groups with `group_type` set to `config_management`. This is an atomic operation: either all organizations are added or none are. Each request must include between 1 and 100 organizations. Each organization must be identified by a unique `org_uuid` and `org_site` pair, and must be in the same site as the requesting organization. The requesting organization must own the organization group.

    POST /api/v2/org_group_memberships

  • Write

    Bulk update org group memberships

    Move a batch of organizations from one organization group to another. This is an atomic operation. Each request must include between 1 and 100 organizations. Each organization must be identified by a unique `org_uuid` and `org_site` pair, and must be in the same site as the requesting organization.

    PATCH /api/v2/org_group_memberships/bulk

  • Write

    Update an org group membership

    Move an organization to a different org group by updating its membership.

    PATCH /api/v2/org_group_memberships/{org_group_membership_id}

  • Write

    Create an org group policy

    Create a new policy for an organization group.

    POST /api/v2/org_group_policies

  • Write

    Update an org group policy

    Update an existing organization group policy.

    PATCH /api/v2/org_group_policies/{org_group_policy_id}

  • Write

    Create an org group policy override

    Create a new policy override for an organization within an org group.

    POST /api/v2/org_group_policy_overrides

  • Write

    Update an org group policy override

    Update an existing organization group policy override.

    PATCH /api/v2/org_group_policy_overrides/{org_group_policy_override_id}

  • Write

    Create an org group

    Create a new organization group.

    POST /api/v2/org_groups

  • Write

    Update an org group

    Update the name of an existing organization group.

    PATCH /api/v2/org_groups/{org_group_id}

  • Destructive

    Bulk delete org group memberships

    Delete a batch of memberships from an organization group. This operation is not supported for organization groups with `group_type` set to `config_management`. The memberships to delete are provided as membership resource identifiers, and the organization group they belong to must be specified using `filter[org_group_id]`. Each request must include between 1 and 100 unique membership IDs, and the requesting organization must own the organization group. The request does not fail if a membership ID refers to a membership that has already been deleted, does not exist, or does not belong to the organization group.

    POST /api/v2/org_group_memberships/bulk_delete

  • Destructive

    Delete an org group membership

    Remove an organization from an organization group by deleting its membership. This operation is not supported for organization groups with `group_type` set to `config_management`. The organization group that the membership belongs to must be specified using `filter[org_group_id]`, and the requesting organization must own that organization group. Returns `404` if the membership does not exist, was already removed, or does not belong to the organization group.

    DELETE /api/v2/org_group_memberships/{org_group_membership_id}

  • Destructive

    Delete an org group policy

    Delete an organization group policy by its ID.

    DELETE /api/v2/org_group_policies/{org_group_policy_id}

  • Destructive

    Delete an org group policy override

    Delete an organization group policy override by its ID.

    DELETE /api/v2/org_group_policy_overrides/{org_group_policy_override_id}

  • Destructive

    Delete an org group

    Delete an organization group by its ID.

    DELETE /api/v2/org_groups/{org_group_id}

Roles

  • Read

    List permissions

    Returns a list of all permissions, including name, description, and ID.

    GET /api/v2/permissions

  • Read

    List roles

    Returns all roles, including their names and their unique identifiers.

    GET /api/v2/roles

  • Read

    List role templates

    List all role templates

    GET /api/v2/roles/templates

  • Read

    Get a role

    Get a role in the organization specified by the role’s `role_id`.

    GET /api/v2/roles/{role_id}

  • Read

    List permissions for a role

    Returns a list of all permissions for a single role.

    GET /api/v2/roles/{role_id}/permissions

  • Read

    Get all users of a role

    Gets all users of a role.

    GET /api/v2/roles/{role_id}/users

  • Write

    Create role

    Create a new role for your organization. [Restricted permissions](https://docs.datadoghq.com/account_management/rbac/permissions/#restricted-permissions), such as Dashboards Read and Monitors Read, are added to every new role by default, even if they are omitted from the request. To exclude them, set `default_permissions_opt_out` to `true`.

    POST /api/v2/roles

  • Write

    Create a new role by cloning an existing role

    Clone an existing role

    POST /api/v2/roles/{role_id}/clone

  • Write

    Grant permission to a role

    Adds a permission to a role.

    POST /api/v2/roles/{role_id}/permissions

  • Write

    Add a user to a role

    Adds a user to a role.

    POST /api/v2/roles/{role_id}/users

  • Destructive

    Delete role

    Disables a role.

    DELETE /api/v2/roles/{role_id}

  • Destructive

    Update a role

    Edit a role. Can only be used with application keys belonging to administrators. [Restricted permissions](https://docs.datadoghq.com/account_management/rbac/permissions/#restricted-permissions), such as Dashboards Read and Monitors Read, remain on the role by default, even if they are omitted from the request. To exclude them, set `default_permissions_opt_out` to `true`. Omitting the `permissions` relationship from the request leaves the role's existing permissions unchanged. Sending `"permissions": {"data": []}` removes all permissions except restricted default permissions, which remain unless `default_permissions_opt_out` is `true`. Some restricted permissions can only be excluded after Minimal Access Roles is enabled for the organization.

    PATCH /api/v2/roles/{role_id}

  • Destructive

    Revoke permission

    Removes a permission from a role.

    DELETE /api/v2/roles/{role_id}/permissions

  • Destructive

    Remove a user from a role

    Removes a user from a role.

    DELETE /api/v2/roles/{role_id}/users

Powerpack

  • Read

    Get all powerpacks

    Get a list of all powerpacks.

    GET /api/v2/powerpacks

  • Read

    Get a Powerpack

    Get a powerpack.

    GET /api/v2/powerpacks/{powerpack_id}

  • Write

    Create a new powerpack

    Create a powerpack.

    POST /api/v2/powerpacks

  • Write

    Update a powerpack

    Update a powerpack.

    PATCH /api/v2/powerpacks/{powerpack_id}

  • Destructive

    Delete a powerpack

    Delete a powerpack.

    DELETE /api/v2/powerpacks/{powerpack_id}

Processes

  • Read

    Get all processes

    Get processes collected by Live Processes for your organization. One request covers a window of at most 1 hour that starts within the past 36 hours. To cover a longer period, make one request per hour. Older data is not available from this endpoint. When a process includes `identifying_tags`, pass them as `tag_filters` in a `process` data source query to `/api/v2/query/scalar` or `/api/v2/query/timeseries` to get CPU or memory metrics for that one process. If absent, don't substitute an empty filter, which would query all processes.

    GET /api/v2/processes

Product Analytics

  • Read

    List analytics events

    List the individual event records matching an analytics query. Use `columns` to choose the attributes returned on each row, `sort` to order the rows, and `limit` to cap how many are returned.

    POST /api/v2/product-analytics/analytics/list

  • Read

    Compute scalar analytics

    Compute scalar analytics results for Product Analytics data. Returns aggregated values (counts, averages, percentiles) optionally grouped by facets.

    POST /api/v2/product-analytics/analytics/scalar

  • Read

    Compute timeseries analytics

    Compute timeseries analytics results for Product Analytics data. Returns time-bucketed values for charts and trend analysis. The `compute.interval` field (milliseconds) is required for time bucketing.

    POST /api/v2/product-analytics/analytics/timeseries

  • Read

    Compute journey funnel analysis

    Compute a funnel over an ordered sequence of Product Analytics events. Returns the per-step conversion counts, conversion rates, and elapsed times, optionally segmented by group-by facets.

    POST /api/v2/product-analytics/journey/funnel

  • Read

    List journey entities

    Return the individual sessions that reached, or dropped off at, a given step of the journey. Each row contains the identity join key, the event timestamp, and the columns requested in `entity_columns`.

    POST /api/v2/product-analytics/journey/list

  • Read

    Compute journey scalar analytics

    Compute scalar results for a journey query, such as the conversion count, the conversion rate, or the time to convert, optionally segmented by group-by facets.

    POST /api/v2/product-analytics/journey/scalar

  • Read

    Compute journey timeseries analytics

    Compute timeseries results for a journey query. Returns one series per group-by combination, bucketed by the requested interval.

    POST /api/v2/product-analytics/journey/timeseries

  • Read

    Compute a retention grid

    Compute a retention grid, showing how much of each cohort came back over each subsequent period. Rows are cohorts, columns are return periods, and each cell holds the count and rate of entities that returned.

    POST /api/v2/product-analytics/retention/grid

  • Read

    List the entities behind a retention cell

    List the individual users or accounts counted in one cell of the retention grid. Set `computation_scope` to the cohort and return period you want to examine.

    POST /api/v2/product-analytics/retention/list

  • Read

    Compute retention scalar values

    Compute retention as a single value per group, suitable for a query value or top list widget.

    POST /api/v2/product-analytics/retention/scalar

  • Read

    Compute retention timeseries

    Compute retention as a series of values over time, using the same query definition as the retention grid.

    POST /api/v2/product-analytics/retention/timeseries

  • Read

    Compute a Sankey diagram

    Compute a Sankey diagram of how sessions flow between the values of two facets, showing where users continue and where they drop off at each step.

    POST /api/v2/product-analytics/sankey

  • Write

    Send server-side events

    Send server-side events to Product Analytics. Server-side events are retained for 15 months. Server-Side events in Product Analytics are helpful for tracking events that occur on the server, as opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs. This allows for a more comprehensive view of the user journey by including actions that happen on the server. Typical examples could be `checkout.completed` or `payment.processed`. Ingested server-side events are integrated into Product Analytics to allow users to select and filter these events in the event picker, similar to how views or actions are handled. **Requirements:** - At least one of `usr`, `account`, or `session` must be provided with a valid ID. - The `application.id` must reference a Product Analytics-enabled application. **Custom Attributes:** Any additional fields in the payload are flattened and searchable as facets. For example, a payload with `{"customer": {"tier": "premium"}}` is searchable with the syntax `@customer.tier:premium` in Datadog. The status codes answered by the HTTP API are: - 202: Accepted: The request has been accepted for processing - 400: Bad request (likely an issue in the payload formatting) - 401: Unauthorized (likely a missing API Key) - 403: Permission issue (likely using an invalid API Key) - 408: Request Timeout, request should be retried after some time - 413: Payload too large (batch is above 5MB uncompressed) - 429: Too Many Requests, request should be retried after some time - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time

    POST /api/v2/prodlytics

Rum Audience Management

  • Read

    Get account facet info

    Get facet information for account attributes including possible values and counts

    POST /api/v2/product-analytics/accounts/facet_info

  • Read

    Query accounts

    Query accounts with flexible filtering by account properties

    POST /api/v2/product-analytics/accounts/query

  • Read

    Query event filtered users

    Query users filtered by both user properties and event platform data

    POST /api/v2/product-analytics/users/event_filtered_query

  • Read

    Get user facet info

    Get facet information for user attributes including possible values and counts

    POST /api/v2/product-analytics/users/facet_info

  • Read

    Query users

    Query users with flexible filtering by user properties, with optional wildcard search

    POST /api/v2/product-analytics/users/query

  • Read

    Get mapping

    Get entity mapping configuration including all available attributes and their properties

    GET /api/v2/product-analytics/{entity}/mapping

  • Read

    List connections

    List all data connections for an entity

    GET /api/v2/product-analytics/{entity}/mapping/connections

  • Write

    Create connection

    Create a new data connection and its fields for an entity

    POST /api/v2/product-analytics/{entity}/mapping/connection

  • Destructive

    Update connection

    Update an existing data connection by adding, updating, or deleting fields

    PUT /api/v2/product-analytics/{entity}/mapping/connection

  • Destructive

    Delete connection

    Delete an existing data connection for an entity

    DELETE /api/v2/product-analytics/{entity}/mapping/connection/{id}

Product Catalog

  • Read

    List SKUs

    Get every generally available Datadog SKU, with the pricing and allotment metadata that applies to it, for the Datadog site serving the request. A SKU is generally available when it is billed through a metered commitment or through automatic billing; SKUs in any other phase are not returned. Prices, allotments, and pricing tiers are returned as they were in effect on `as_of_date`, which defaults to the date of the request. Prices are public list prices: they do not reflect discounts, commitments, or negotiated rates on an account. Each SKU is a separate resource in `data`, identified by its SKU code, and sorted by that code in ascending order. The whole catalog is returned in a single response, so this endpoint is not paginated.

    GET /api/v2/product-catalog/skus

APM Trace

  • Read

    Get a pruned trace by ID

    Retrieve a pruned, hierarchical view of an APM trace by its trace ID. The trace is summarized as a tree of spans rooted at the trace root and reduced in size to keep rendering large traces in the UI practical. A `400 Bad Request` response means the trace ID is malformed. A `404 Not Found` response means no trace with this ID is available, such as when the trace is outside the retention period. This endpoint is rate limited to `60` requests per minute per organization.

    GET /api/v2/pruned_trace/{trace_id}

  • Read

    Get a trace by ID

    Retrieve a full APM trace by its trace ID, including every span in the trace. Traces are returned from live storage when available and fall back to longer-term storage. A `400 Bad Request` response means the trace ID is malformed. A `404 Not Found` response means no trace with this ID is available, such as when the trace is outside the retention period. This endpoint is rate limited to `60` requests per minute per organization.

    GET /api/v2/trace/{trace_id}

Reference Tables

  • Read

    List tables

    List all reference tables in this organization.

    GET /api/v2/reference-tables/tables

  • Read

    Get table

    Get a reference table by ID

    GET /api/v2/reference-tables/tables/{id}

  • Read

    Get rows by id

    Get reference table rows by their primary key values.

    GET /api/v2/reference-tables/tables/{id}/rows

  • Read

    List rows

    List all rows in a reference table using cursor-based pagination. Pass the `page[continuation_token]` from the previous response to fetch the next page on the same consistent snapshot. Returns 400 for tables with more than 10,000,000 rows.

    GET /api/v2/reference-tables/tables/{id}/rows/list

  • Write

    Batch rows query

    Batch query reference table rows by their primary key values. Returns only found rows in the included array.

    POST /api/v2/reference-tables/queries/batch-rows

  • Write

    Create reference table

    Creates a reference table. You can provide data in two ways: 1. Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the CSV data (not the file itself) in chunks to each URL in the request body. Finally, call this POST endpoint with `upload_id` in `file_metadata`. 2. Provide `access_details` in `file_metadata` pointing to a CSV file in cloud storage.

    POST /api/v2/reference-tables/tables

  • Write

    Update reference table

    Update a reference table by ID. You can update the table's data, description, and tags. Note: The source type cannot be changed after table creation. For data updates: For existing tables of type `source:LOCAL_FILE`, call POST api/v2/reference-tables/uploads first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint with the upload_id in file_metadata. For existing tables with `source:` types of `S3`, `GCS`, or `AZURE`, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage.

    PATCH /api/v2/reference-tables/tables/{id}

  • Write

    Upsert rows

    Create or update rows in a Reference Table by their primary key values. If a row with the specified primary key exists, it is updated; otherwise, a new row is created.

    POST /api/v2/reference-tables/tables/{id}/rows

  • Write

    Create reference table upload

    Create a reference table upload for bulk data ingestion

    POST /api/v2/reference-tables/uploads

  • Destructive

    Delete table

    Delete a reference table by ID

    DELETE /api/v2/reference-tables/tables/{id}

  • Destructive

    Delete rows

    Delete multiple rows from a Reference Table by their primary key values.

    DELETE /api/v2/reference-tables/tables/{id}/rows

Application Security

  • Read

    List all WAF custom rules

    Retrieve a list of WAF custom rule.

    GET /api/v2/remote_config/products/asm/waf/custom_rules

  • Read

    Get a WAF custom rule

    Retrieve a WAF custom rule by ID.

    GET /api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}

  • Read

    List all WAF exclusion filters

    Retrieve a list of WAF exclusion filters.

    GET /api/v2/remote_config/products/asm/waf/exclusion_filters

  • Read

    Get a WAF exclusion filter

    Retrieve a specific WAF exclusion filter using its identifier.

    GET /api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}

  • Read

    List all WAF policies

    Retrieve a list of WAF policies.

    GET /api/v2/remote_config/products/asm/waf/policies

  • Read

    Get a WAF Policy

    Retrieve a WAF policy by ID.

    GET /api/v2/remote_config/products/asm/waf/policies/{policy_id}

  • Read

    Get Application Security details for a service

    Retrieve Application Security details for services matching the given name. Returns Application Security activation, compatibility, and product enablement information for each matching `(service, environment)` pair, along with a count of services that have Application Security Management (Threats) enabled.

    GET /api/v2/security/asm/services/{service_filter}

  • Write

    Create a WAF custom rule

    Create a new WAF custom rule with the given parameters.

    POST /api/v2/remote_config/products/asm/waf/custom_rules

  • Write

    Create a WAF exclusion filter

    Create a new WAF exclusion filter with the given parameters. A request matched by an exclusion filter will be ignored by the Application Security WAF product. Go to https://app.datadoghq.com/security/appsec/passlist to review existing exclusion filters (also called passlist entries).

    POST /api/v2/remote_config/products/asm/waf/exclusion_filters

  • Write

    Create a WAF Policy

    Create a new WAF policy.

    POST /api/v2/remote_config/products/asm/waf/policies

  • Destructive

    Delete a WAF Custom Rule

    Delete a specific WAF custom rule.

    DELETE /api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}

  • Destructive

    Update a WAF Custom Rule

    Update a specific WAF custom Rule. Returns the Custom Rule object when the request is successful.

    PUT /api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}

  • Destructive

    Delete a WAF exclusion filter

    Delete a specific WAF exclusion filter using its identifier.

    DELETE /api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}

  • Destructive

    Update a WAF exclusion filter

    Update a specific WAF exclusion filter using its identifier. Returns the exclusion filter object when the request is successful.

    PUT /api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}

  • Destructive

    Delete a WAF Policy

    Delete a specific WAF policy.

    DELETE /api/v2/remote_config/products/asm/waf/policies/{policy_id}

  • Destructive

    Update a WAF Policy

    Update a specific WAF policy. Returns the policy object when the request is successful.

    PUT /api/v2/remote_config/products/asm/waf/policies/{policy_id}

CSM Threats

  • Read

    Get all Workload Protection agent rules

    Get the list of Workload Protection agent rules. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    GET /api/v2/remote_config/products/cws/agent_rules

  • Read

    Get a Workload Protection agent rule

    Get the details of a specific Workload Protection agent rule. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    GET /api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}

  • Read

    Get all Workload Protection policies

    Get the list of Workload Protection policies. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    GET /api/v2/remote_config/products/cws/policy

  • Read

    Download the Workload Protection policy

    The download endpoint generates a Workload Protection policy file from your currently active Workload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to your agents to update the policy running in your environment. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    GET /api/v2/remote_config/products/cws/policy/download

  • Read

    Get a Workload Protection policy

    Get the details of a specific Workload Protection policy. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    GET /api/v2/remote_config/products/cws/policy/{policy_id}

  • Read

    Download the Workload Protection policy (US1-FED)

    The download endpoint generates a Workload Protection policy file from your currently active Workload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to your agents to update the policy running in your environment. **Note**: This endpoint should only be used for the Government (US1-FED) site.

    GET /api/v2/security/cloud_workload/policy/download

  • Read

    Get all Workload Protection agent rules (US1-FED)

    Get the list of agent rules. **Note**: This endpoint should only be used for the Government (US1-FED) site.

    GET /api/v2/security_monitoring/cloud_workload_security/agent_rules

  • Read

    Get a Workload Protection agent rule (US1-FED)

    Get the details of a specific agent rule. **Note**: This endpoint should only be used for the Government (US1-FED) site.

    GET /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}

  • Write

    Create a Workload Protection agent rule

    Create a new Workload Protection agent rule with the given parameters. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    POST /api/v2/remote_config/products/cws/agent_rules

  • Write

    Update a Workload Protection agent rule

    Update a specific Workload Protection Agent rule. Returns the agent rule object when the request is successful. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    PATCH /api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}

  • Write

    Create a Workload Protection policy

    Create a new Workload Protection policy with the given parameters. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    POST /api/v2/remote_config/products/cws/policy

  • Write

    Update a Workload Protection policy

    Update a specific Workload Protection policy. Returns the policy object when the request is successful. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    PATCH /api/v2/remote_config/products/cws/policy/{policy_id}

  • Write

    Create a Workload Protection agent rule (US1-FED)

    Create a new agent rule with the given parameters. **Note**: This endpoint should only be used for the Government (US1-FED) site.

    POST /api/v2/security_monitoring/cloud_workload_security/agent_rules

  • Write

    Update a Workload Protection agent rule (US1-FED)

    Update a specific agent rule. Returns the agent rule object when the request is successful. **Note**: This endpoint should only be used for the Government (US1-FED) site.

    PATCH /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}

  • Destructive

    Delete a Workload Protection agent rule

    Delete a specific Workload Protection agent rule. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    DELETE /api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}

  • Destructive

    Delete a Workload Protection policy

    Delete a specific Workload Protection policy. **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below.

    DELETE /api/v2/remote_config/products/cws/policy/{policy_id}

  • Destructive

    Delete a Workload Protection agent rule (US1-FED)

    Delete a specific agent rule. **Note**: This endpoint should only be used for the Government (US1-FED) site.

    DELETE /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}

RUM Remote Config

  • Read

    Get a RUM SDK configuration

    Retrieve a RUM SDK configuration by its identifier.

    GET /api/v2/remote_config/products/rum/configs/{config_id}

  • Destructive

    Update a RUM SDK configuration

    Update an existing RUM SDK configuration by its identifier. Returns the updated configuration when successful.

    PUT /api/v2/remote_config/products/rum/configs/{config_id}

Rum Replay Heatmaps

  • Read

    List replay heatmap snapshots

    List heatmap snapshots.

    GET /api/v2/replay/heatmap/snapshots

  • Write

    Create replay heatmap snapshot

    Create a heatmap snapshot.

    POST /api/v2/replay/heatmap/snapshots

  • Write

    Update replay heatmap snapshot

    Update a heatmap snapshot.

    PATCH /api/v2/replay/heatmap/snapshots/{snapshot_id}

  • Destructive

    Delete replay heatmap snapshot

    Delete a heatmap snapshot.

    DELETE /api/v2/replay/heatmap/snapshots/{snapshot_id}

Report Schedules

  • Read

    List dataset report schedules

    Retrieve all report schedules for a given published dataset. Returns report schedules belonging to the authenticated user's organization that target the specified dataset. Requires the `generate_log_reports` or `manage_log_reports` permission.

    GET /api/v2/reporting/dataset/{dataset_id}/schedules

  • Read

    List report schedules

    List dashboard and integration dashboard report schedules for the organization. The response is paginated and can be filtered by title, author UUID, or recipients. Requires the `generate_dashboard_reports` permission.

    GET /api/v2/reporting/schedule/list

  • Read

    Get report schedules for a resource

    Get all report schedules that target a dashboard or integration dashboard resource. Requires a reporting read permission appropriate to the targeted resource type.

    GET /api/v2/reporting/schedule/{resource_type}/{resource_id}

  • Read

    Get a report schedule

    Get a report schedule by its unique identifier. Requires a reporting read permission appropriate to the targeted resource type.

    GET /api/v2/reporting/schedule/{schedule_uuid}

  • Write

    Print a report

    Initiate a one-off, print-only report for a dashboard or integration dashboard. The report is rendered as a PDF and made available for download through the URL returned in the response. Requires a reporting permission appropriate to the targeted resource type.

    POST /api/v2/reporting/print

  • Write

    Create a report schedule

    Create a new scheduled report. A schedule renders a dashboard or integration dashboard on a recurring cadence and delivers it to the configured recipients over email, Slack, or Microsoft Teams. Requires the `generate_dashboard_reports` permission.

    POST /api/v2/reporting/schedule

  • Write

    Toggle a report schedule

    Activate or pause a report schedule by setting its status to `active` or `inactive`. Requires a reporting write permission appropriate to the targeted resource type and schedule ownership.

    PATCH /api/v2/reporting/schedule/{schedule_uuid}/toggle

  • Destructive

    Delete a report schedule

    Delete a report schedule by its unique identifier. The response returns the deleted schedule. Requires a reporting write permission appropriate to the targeted resource type and schedule ownership.

    DELETE /api/v2/reporting/schedule/{schedule_uuid}

  • Destructive

    Update a report schedule

    Update an existing scheduled report by its identifier. The editable attributes are replaced with the supplied values; the targeted resource (`resource_id` and `resource_type`) cannot be changed after creation. Requires the `generate_dashboard_reports` permission and schedule ownership.

    PATCH /api/v2/reporting/schedule/{schedule_uuid}

Restriction Policies

  • Read

    Get a restriction policy

    Retrieves the restriction policy associated with a specified resource.

    GET /api/v2/restriction_policy/{resource_id}

  • Destructive

    Delete a restriction policy

    Deletes the restriction policy associated with a specified resource.

    DELETE /api/v2/restriction_policy/{resource_id}

  • Destructive

    Update a restriction policy

    Updates the restriction policy associated with a resource. #### Supported resources Restriction policies can be applied to the following resources: - Dashboards: `dashboard` - Integration Services: `integration-service` - Integration Webhooks: `integration-webhook` - Notebooks: `notebook` - Powerpacks: `powerpack` - Reference Tables: `reference-table` - Security Rules: `security-rule` - Service Level Objectives: `slo` - Synthetic Global Variables: `synthetics-global-variable` - Synthetic Tests: `synthetics-test` - Synthetic Private Locations: `synthetics-private-location` - Monitors: `monitor` - Workflows: `workflow` - App Builder Apps: `app-builder-app` - Connections: `connection` - Connection Groups: `connection-group` - RUM Applications: `rum-application` - Cross Org Connections: `cross-org-connection` - Spreadsheets: `spreadsheet` - On-Call Schedules: `on-call-schedule` - On-Call Escalation Policies: `on-call-escalation-policy` - On-Call Team Routing Rules: `on-call-team-routing-rules` - Logs Pipelines: `logs-pipeline` - Case Management Projects: `case-management-project` - Monitor Notification Rules: `monitor-notification-rule` - Status Pages: `status-page` - Feature Flags: `feature-flag` - Network Path Configs: `network-path-config` #### Supported relations for resources Resource Type | Supported Relations ----------------------------|-------------------------- Dashboards | `viewer`, `editor` Integration Services | `viewer`, `editor` Integration Webhooks | `viewer`, `editor` Notebooks | `viewer`, `editor` Powerpacks | `viewer`, `editor` Security Rules | `viewer`, `editor` Service Level Objectives | `viewer`, `editor` Synthetic Global Variables | `viewer`, `editor` Synthetic Tests | `viewer`, `editor` Synthetic Private Locations | `viewer`, `editor` Monitors | `viewer`, `editor` Reference Tables | `viewer`, `editor` Workflows | `viewer`, `runner`, `editor` App Builder Apps | `viewer`, `editor` Connections | `viewer`, `resolver`, `editor` Connection Groups | `viewer`, `editor` RUM Application | `viewer`, `editor` Cross Org Connections | `viewer`, `editor` Spreadsheets | `viewer`, `editor` On-Call Schedules | `viewer`, `overrider`, `editor` On-Call Escalation Policies | `viewer`, `editor` On-Call Team Routing Rules | `viewer`, `editor` Logs Pipelines | `viewer`, `processors_editor`, `editor` Case Management Projects | `viewer`, `contributor`, `manager` Monitor Notification Rules | `viewer`, `editor` Status Pages | `viewer`, `responder`, `manager` Feature Flags | `viewer`, `contributor`, `editor` Network Path Configs | `viewer`, `editor`

    POST /api/v2/restriction_policy/{resource_id}

RUM

  • Read

    List all the RUM applications

    List all the RUM applications in your organization.

    GET /api/v2/rum/applications

  • Read

    Get a RUM application

    Get the RUM application with given ID in your organization.

    GET /api/v2/rum/applications/{id}

  • Read

    Get a list of RUM events

    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

    GET /api/v2/rum/events

  • Read

    Search RUM events

    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

    POST /api/v2/rum/events/search

  • Read

    Get a JavaScript source map

    Retrieves the content of a specific JavaScript source map file. Provide either `debug_id` with a UUID, or all three of `filename`, `service`, and `version`. When `debug_id` is provided, filename, service, and version are not required and are ignored. **Examples:** the following commands use the US1 API host. Replace the host with the API host for your site, and the filename, service, version, and debug ID with values from your organization. Use `--get` so curl sends the parameters in the query string. **1. Retrieve a source map by debug ID** Provide `debug_id` with a UUID. No filename, service, or version is required. ```bash curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ --data-urlencode "debug_id=00000000-0000-4000-8000-000000000001" ``` **2. Retrieve a source map by service and version** Provide `filename` together with `service` and `version`. ```bash curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ --data-urlencode "filename=js/bundle.min.js.map" \ --data-urlencode "service=my-web-service" \ --data-urlencode "version=1.0.0" ```

    GET /api/v2/sourcemaps

  • Read

    List source maps

    Retrieves a paginated list of source maps. Send filters as query parameters, not in a JSON request body. `mapkind` defaults to `js`. For JavaScript source maps, choose one of the three request shapes below. **Examples:** the following commands use the US1 API host. Replace the host with the API host for your site, and the service, version, debug ID, and cursor with values from your organization. Use `--get` so curl sends the filters in the query string; `-X GET` with `--data-urlencode` sends them in the request body instead. **1. List by service and version** Provide both `filter[service]` and `filter[version]` to search source maps indexed by service and version. Omit `search_by`. **Pagination:** prefer cursor pagination. Omit `page[after]` and `page[number]` on the first request. To get the next page, pass `meta.page.next_cursor` as `page[after]`, keeping the same filters. Continue until `meta.page.has_more_results` is `false`. Do not decode or modify the cursor. Legacy page-number pagination is also supported, starting at `page[number]=1`. ```bash curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ --data-urlencode "mapkind=js" \ --data-urlencode "filter[service]=my-web-service" \ --data-urlencode "filter[version]=1.0.0" \ --data-urlencode "page[size]=10" ``` **2. Find a specific JavaScript debug ID** Provide `filter[debug_id]` with a UUID. Service and version filters are not required. Omit `search_by`. **Pagination:** the lookup returns at most one result, so no pagination is needed. `page[after]` is not supported. ```bash curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ --data-urlencode "mapkind=js" \ --data-urlencode "filter[debug_id]=00000000-0000-4000-8000-000000000001" ``` **3. Browse source maps indexed by debug ID** Set `search_by=debug_id` without specifying a debug ID. Do not send service, version, or filename filters in this mode. **Pagination:** this mode requires cursor pagination; `page[number]` is not supported. Omit `page[after]` on the first request. To get the next page, pass `meta.page.next_cursor` as `page[after]`, keeping the same search mode and filters. Continue until `meta.page.has_more_results` is `false`. Do not decode or modify the cursor. First page: ```bash curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ --data-urlencode "mapkind=js" \ --data-urlencode "search_by=debug_id" \ --data-urlencode "page[size]=10" ``` Next page: ```bash curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ --data-urlencode "mapkind=js" \ --data-urlencode "search_by=debug_id" \ --data-urlencode "page[size]=10" \ --data-urlencode "page[after]=<meta.page.next_cursor>" ``` For other map kinds, use `page[number]`, starting at 1.

    GET /api/v2/sourcemaps/list

  • Read

    Get service repository information

    Returns the repository URL and commit SHA associated with a debug ID or a given service and version. Provide either `debug_id`, or both `service` and `version`. When `debug_id` is set, it takes precedence.

    POST /api/v2/sourcemaps/service_repository_info

  • Write

    Aggregate RUM events

    The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries.

    POST /api/v2/rum/analytics/aggregate

  • Write

    Create a new RUM application

    Create a new RUM application in your organization.

    POST /api/v2/rum/applications

  • Write

    Update a RUM application

    Update the RUM application with given ID in your organization.

    PATCH /api/v2/rum/applications/{id}

  • Write

    Restore source maps

    Restores previously deleted source maps matching the specified filter criteria. Supports dry-run mode to preview which source maps would be restored without performing the actual restoration.

    PATCH /api/v2/sourcemaps/restore

  • Destructive

    Delete a RUM application

    Delete an existing RUM application in your organization.

    DELETE /api/v2/rum/applications/{id}

  • Destructive

    Delete source maps

    Deletes source maps matching the specified filter criteria. Supports dry-run mode to preview which source maps would be deleted without performing the actual deletion.

    DELETE /api/v2/sourcemaps

Rum Retention Filters

  • Read

    Get all RUM retention filters

    Get the list of RUM retention filters for a RUM application.

    GET /api/v2/rum/applications/{app_id}/retention_filters

  • Read

    Get all RUM exclusion filters

    Get the list of exclusion filters for a RUM application. The built-in Error Tracking exclusion filter (`error_tracking_exclusion_filter`) is always returned first.

    GET /api/v2/rum/applications/{app_id}/retention_filters/exclusion

  • Read

    Get a RUM exclusion filter

    Get a single exclusion filter for a RUM application.

    GET /api/v2/rum/applications/{app_id}/retention_filters/exclusion/{ef_id}

  • Read

    Get all permanent RUM retention filters

    Get the list of permanent RUM retention filters for a RUM application. Permanent retention filters are predefined filters that cannot be created or deleted. For each filter, the `editability` block indicates which cross-product fields can be updated.

    GET /api/v2/rum/applications/{app_id}/retention_filters/permanent

  • Read

    Get a permanent RUM retention filter

    Get a permanent RUM retention filter for a RUM application by its identifier.

    GET /api/v2/rum/applications/{app_id}/retention_filters/permanent/{permanent_rf_id}

  • Read

    Get a RUM retention filter

    Get a RUM retention filter for a RUM application.

    GET /api/v2/rum/applications/{app_id}/retention_filters/{rf_id}

  • Write

    Order RUM retention filters

    Order RUM retention filters for a RUM application. Returns RUM retention filter objects without attributes from the request body when the request is successful.

    PATCH /api/v2/rum/applications/{app_id}/relationships/retention_filters

  • Write

    Create a RUM retention filter

    Create a RUM retention filter for a RUM application. Returns RUM retention filter objects from the request body when the request is successful.

    POST /api/v2/rum/applications/{app_id}/retention_filters

  • Write

    Create a RUM exclusion filter

    Create an exclusion filter for a RUM application. Returns the created exclusion filter when the request is successful.

    POST /api/v2/rum/applications/{app_id}/retention_filters/exclusion

  • Write

    Update a RUM exclusion filter

    Update an exclusion filter for a RUM application. For the built-in Error Tracking exclusion filter (`error_tracking_exclusion_filter`), only `enabled` can be updated; `name`, `event_type`, and `query` must be omitted. Returns the updated exclusion filter when the request is successful.

    PATCH /api/v2/rum/applications/{app_id}/retention_filters/exclusion/{ef_id}

  • Write

    Update a permanent RUM retention filter

    Update the cross-product sampling configuration of a permanent RUM retention filter for a RUM application. Only fields marked as editable in the `editability` block of the filter can be updated. Updating a non-editable field returns a `400` response.

    PATCH /api/v2/rum/applications/{app_id}/retention_filters/permanent/{permanent_rf_id}

  • Write

    Update a RUM retention filter

    Update a RUM retention filter for a RUM application. Returns RUM retention filter objects from the request body when the request is successful.

    PATCH /api/v2/rum/applications/{app_id}/retention_filters/{rf_id}

  • Destructive

    Delete a RUM exclusion filter

    Delete an exclusion filter for a RUM application. The built-in Error Tracking exclusion filter (`error_tracking_exclusion_filter`) cannot be deleted; attempting to do so returns a `405 Method Not Allowed` response.

    DELETE /api/v2/rum/applications/{app_id}/retention_filters/exclusion/{ef_id}

  • Destructive

    Delete a RUM retention filter

    Delete a RUM retention filter for a RUM application.

    DELETE /api/v2/rum/applications/{app_id}/retention_filters/{rf_id}

RUM Config

  • Read

    Get the RUM configuration

    Get the RUM configuration for your organization.

    GET /api/v2/rum/config

  • Write

    Update the RUM configuration

    Update the RUM configuration for your organization. Returns the RUM configuration object from the request body when the request is successful.

    PATCH /api/v2/rum/config

  • Write

    Create the RUM configuration

    Create the RUM configuration for your organization. Returns the RUM configuration object from the request body when the request is successful.

    POST /api/v2/rum/config

Rum Metrics

  • Read

    Get all RUM-based metrics

    Get the list of configured RUM-based metrics with their definitions.

    GET /api/v2/rum/config/metrics

  • Read

    Get a RUM-based metric

    Get a specific RUM-based metric from your organization.

    GET /api/v2/rum/config/metrics/{metric_id}

  • Write

    Create a RUM-based metric

    Create a metric based on your organization's RUM data. Returns the RUM-based metric object from the request body when the request is successful.

    POST /api/v2/rum/config/metrics

  • Write

    Update a RUM-based metric

    Update a specific RUM-based metric from your organization. Returns the RUM-based metric object from the request body when the request is successful.

    PATCH /api/v2/rum/config/metrics/{metric_id}

  • Destructive

    Delete a RUM-based metric

    Delete a specific RUM-based metric from your organization.

    DELETE /api/v2/rum/config/metrics/{metric_id}

RUM Retention Quotas

  • Read

    Get a RUM retention quota configuration

    Get the RUM retention quota configuration for a given scope.

    GET /api/v2/rum/config/retention-quota/{scope_type}/{scope_id}

  • Destructive

    Delete a RUM retention quota configuration

    Delete the RUM retention quota configuration for a given scope.

    DELETE /api/v2/rum/config/retention-quota/{scope_type}/{scope_id}

  • Destructive

    Create or update a RUM retention quota config

    Create or update the RUM retention quota configuration for a given scope. Returns the retention quota configuration object when the request is successful.

    PUT /api/v2/rum/config/retention-quota/{scope_type}/{scope_id}

Rum Teams Ownership

  • Read

    List teams ownership mappings

    Get the list of teams ownership mappings for your organization, optionally filtered.

    GET /api/v2/rum/config/teams-ownership/mappings

  • Read

    Get a teams ownership mapping

    Get a specific teams ownership mapping from your organization.

    GET /api/v2/rum/config/teams-ownership/mappings/{id}

  • Read

    List teams ownership rules

    Get the list of teams ownership rules for your organization, optionally filtered. Rules group the underlying mappings by `view_name`, `application_id`, `service`, and `match_type`, collapsing every team that owns the same view into a single entry.

    GET /api/v2/rum/config/teams-ownership/rules

  • Write

    Create a teams ownership mapping

    Create a teams ownership mapping for your organization. Returns the teams ownership mapping object from the request body when the request is successful.

    POST /api/v2/rum/config/teams-ownership/mappings

  • Destructive

    Bulk create and remove teams ownership mappings

    Add and remove teams ownership mappings for your organization in a single atomic request, following the JSON:API [atomic operations extension](https://jsonapi.org/ext/atomic/). Operations are applied together: if any operation is invalid, none of the operations are applied. Add operations are processed before remove operations, so results may not appear in the same order as the request.

    POST /api/v2/rum/config/teams-ownership/mappings/operations

  • Destructive

    Delete a teams ownership mapping

    Delete a specific teams ownership mapping from your organization.

    DELETE /api/v2/rum/config/teams-ownership/mappings/{id}

RUM Operations

  • Read

    Get a RUM operation by name

    Retrieve a specific RUM operation by its unique name.

    GET /api/v2/rum/operations/by-name/{name}

  • Read

    Search RUM operations

    Search RUM operations for your organization. Supports filtering by query, creator, team, journey, and application.

    GET /api/v2/rum/operations/search

  • Read

    Get a RUM operation

    Retrieve a specific RUM operation by its unique identifier.

    GET /api/v2/rum/operations/{rum_operation_id}

  • Write

    Create a RUM operation

    Create a new RUM operation, defining the journey used to detect it from RUM events.

    POST /api/v2/rum/operations

  • Destructive

    Delete a RUM operation

    Delete a RUM operation.

    DELETE /api/v2/rum/operations/{rum_operation_id}

  • Destructive

    Update a RUM operation

    Update an existing RUM operation. Fields omitted from the request body keep their existing value, with the exception of `journey_rum`, which is required and fully replaced on every update.

    PUT /api/v2/rum/operations/{rum_operation_id}

RUM Insights

  • Read

    Query aggregated long tasks

    Get aggregated long task data for a RUM view, grouped by invoker type and sampled across multiple view instances.

    POST /api/v2/rum/query/insight/aggregated_long_tasks

  • Read

    Query aggregated waterfall

    Get aggregated network resource waterfall data for a RUM view, sampled across multiple view instances.

    POST /api/v2/rum/query/insight/aggregated_waterfall

Rum Replay Playlists

  • Read

    List RUM replay playlists

    List playlists.

    GET /api/v2/rum/replay/playlists

  • Read

    Get RUM replay playlist

    Get a playlist.

    GET /api/v2/rum/replay/playlists/{playlist_id}

  • Read

    List RUM replay playlist sessions

    List sessions in a playlist.

    GET /api/v2/rum/replay/playlists/{playlist_id}/sessions

  • Write

    Create RUM replay playlist

    Create a playlist.

    POST /api/v2/rum/replay/playlists

  • Destructive

    Delete RUM replay playlist

    Delete a playlist.

    DELETE /api/v2/rum/replay/playlists/{playlist_id}

  • Destructive

    Update RUM replay playlist

    Update a playlist.

    PUT /api/v2/rum/replay/playlists/{playlist_id}

  • Destructive

    Bulk remove RUM replay playlist sessions

    Remove sessions from a playlist.

    DELETE /api/v2/rum/replay/playlists/{playlist_id}/sessions

  • Destructive

    Remove RUM replay session from playlist

    Remove a session from a playlist.

    DELETE /api/v2/rum/replay/playlists/{playlist_id}/sessions/{session_id}

  • Destructive

    Add RUM replay session to playlist

    Add a session to a playlist.

    PUT /api/v2/rum/replay/playlists/{playlist_id}/sessions/{session_id}

Rum Replay Sessions

  • Read

    Get segments

    Get segments for a view.

    GET /api/v2/rum/replay/sessions/{session_id}/views/{view_id}/segments

Rum Replay Viewership

  • Read

    List RUM replay session watchers

    List session watchers.

    GET /api/v2/rum/replay/sessions/{session_id}/watchers

  • Read

    List RUM replay viewership history sessions

    List watched sessions.

    GET /api/v2/rum/replay/viewership-history/sessions

  • Write

    Create RUM replay session watch

    Record a session watch.

    POST /api/v2/rum/replay/sessions/{session_id}/watches

  • Destructive

    Delete RUM replay session watch

    Delete session watch history.

    DELETE /api/v2/rum/replay/sessions/{session_id}/watches

Scorecards

  • Read

    List all campaigns

    Fetches all scorecard campaigns.

    GET /api/v2/scorecard/campaigns

  • Read

    Get a campaign

    Fetches a single campaign by ID or key.

    GET /api/v2/scorecard/campaigns/{campaign_id}

  • Read

    List all rule outcomes

    Fetches all rule outcomes.

    GET /api/v2/scorecard/outcomes

  • Read

    List all rules

    Fetch all rules.

    GET /api/v2/scorecard/rules

  • Read

    List all scorecards

    Fetches all scorecards.

    GET /api/v2/scorecard/scorecards

  • Read

    List all scores

    Returns a list of scorecard scores for each aggregation type, with score breakdowns.

    GET /api/v2/scorecard/scores/{aggregation}

  • Write

    Create a new campaign

    Creates a new scorecard campaign.

    POST /api/v2/scorecard/campaigns

  • Write

    Update Scorecard outcomes

    Updates multiple scorecard rule outcomes in a single batched request.

    POST /api/v2/scorecard/outcomes

  • Write

    Create outcomes batch (deprecated)

    Sets multiple service-rule outcomes in a single batched request.

    POST /api/v2/scorecard/outcomes/batch

  • Write

    Create a new rule

    Creates a new rule.

    POST /api/v2/scorecard/rules

  • Destructive

    Delete a campaign

    Deletes a single campaign by ID or key.

    DELETE /api/v2/scorecard/campaigns/{campaign_id}

  • Destructive

    Update a campaign

    Updates an existing campaign.

    PUT /api/v2/scorecard/campaigns/{campaign_id}

  • Destructive

    Delete a rule

    Deletes a single rule.

    DELETE /api/v2/scorecard/rules/{rule_id}

  • Destructive

    Update an existing scorecard rule

    Updates an existing rule.

    PUT /api/v2/scorecard/rules/{rule_id}

Seats

  • Read

    Get users with seats

    Get the list of users assigned seats for a product code.

    GET /api/v2/seats/users

  • Write

    Assign seats to users

    Assign seats to users for a product code.

    POST /api/v2/seats/users

  • Destructive

    Unassign seats from users

    Unassign seats from users for a product code.

    DELETE /api/v2/seats/users

Entity Risk Scores

  • Read

    List Entity Risk Scores

    Get a list of entity risk scores for your organization. Entity risk scores provide security risk assessment for entities like cloud resources, identities, or services based on detected signals, misconfigurations, and identity risks.

    GET /api/v2/security-entities/risk-scores

  • Read

    Get Entity Risk Score

    Get the risk score for a specific entity by its ID. Returns security risk assessment including risk score, severity, detected signals, misconfigurations, and identity risks.

    GET /api/v2/security-entities/risk-scores/{entity_id}

Threat Intelligence

  • Write

    Ingest STIX threat intelligence

    Ingest a STIX 2.1 bundle containing threat intelligence indicators. Only indicator objects are processed. Supported indicator patterns contain IPv4 addresses, IPv6 addresses, domain names, or SHA-256 file hashes. Non-indicator objects are ignored and are not included in the response counters. Indicator objects with unsupported STIX versions or patterns that produce no supported observable values increment the `unsupported` counter. Patterns that cannot be parsed increment the `invalid` counter. Processing is best effort, so valid supported indicators in the same bundle are still added. A successful response means ingestion has completed. Reference-table materialization and enrichment happen asynchronously. Requests are limited to 50 MB as received, 100 MB after decompression, and 10 requests per second per API key. Gzip-compressed request bodies are supported.

    POST /api/v2/security/threat-intel/stix

Sensitive Data Scanner

  • Read

    List Scanning Groups

    List all the Scanning groups in your organization.

    GET /api/v2/sensitive-data-scanner/config

  • Read

    List standard patterns

    Returns all standard patterns.

    GET /api/v2/sensitive-data-scanner/config/standard-patterns

  • Write

    Reorder Groups

    Reorder the list of groups.

    PATCH /api/v2/sensitive-data-scanner/config

  • Write

    Create Scanning Group

    Create a scanning group. The request MAY include a configuration relationship. A rules relationship can be omitted entirely, but if it is included it MUST be null or an empty array (rules cannot be created at the same time). The new group will be ordered last within the configuration.

    POST /api/v2/sensitive-data-scanner/config/groups

  • Write

    Update Scanning Group

    Update a group, including the order of the rules. Rules within the group are reordered by including a rules relationship. If the rules relationship is present, its data section MUST contain linkages for all of the rules currently in the group, and MUST NOT contain any others.

    PATCH /api/v2/sensitive-data-scanner/config/groups/{group_id}

  • Write

    Create Scanning Rule

    Create a scanning rule in a sensitive data scanner group, ordered last. The posted rule MUST include a group relationship. It MUST include either a standard_pattern relationship or a regex attribute, but not both. If included_attributes is empty or missing, we will scan all attributes except excluded_attributes. If both are missing, we will scan the whole event.

    POST /api/v2/sensitive-data-scanner/config/rules

  • Write

    Update Scanning Rule

    Update a scanning rule. The request body MUST NOT include a standard_pattern relationship, as that relationship is non-editable. Trying to edit the regex attribute of a rule with a standard_pattern relationship will also result in an error.

    PATCH /api/v2/sensitive-data-scanner/config/rules/{rule_id}

  • Destructive

    Delete Scanning Group

    Delete a given group.

    DELETE /api/v2/sensitive-data-scanner/config/groups/{group_id}

  • Destructive

    Delete Scanning Rule

    Delete a given rule.

    DELETE /api/v2/sensitive-data-scanner/config/rules/{rule_id}

Service Accounts

  • Read

    List access tokens for a service account

    List all access tokens for a specific service account.

    GET /api/v2/service_accounts/{service_account_id}/access_tokens

  • Read

    Get an access token for a service account

    Get a specific access token for a service account by its ID.

    GET /api/v2/service_accounts/{service_account_id}/access_tokens/{token_id}

  • Read

    List application keys for this service account

    List all application keys available for this service account.

    GET /api/v2/service_accounts/{service_account_id}/application_keys

  • Read

    Get one application key for this service account

    Get an application key owned by this service account.

    GET /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id}

  • Write

    Create a service account

    Create a service account for your organization.

    POST /api/v2/service_accounts

  • Write

    Create an access token for a service account

    Create an access token for a service account.

    POST /api/v2/service_accounts/{service_account_id}/access_tokens

  • Write

    Update an access token for a service account

    Update a specific access token for a service account.

    PATCH /api/v2/service_accounts/{service_account_id}/access_tokens/{token_id}

  • Write

    Create an application key for this service account

    Create an application key for this service account.

    POST /api/v2/service_accounts/{service_account_id}/application_keys

  • Write

    Edit an application key for this service account

    Edit an application key owned by this service account.

    PATCH /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id}

  • Destructive

    Revoke an access token for a service account

    Revoke a specific access token for a service account.

    DELETE /api/v2/service_accounts/{service_account_id}/access_tokens/{token_id}

  • Destructive

    Delete an application key for this service account

    Delete an application key owned by this service account.

    DELETE /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id}

Service Definition

  • Read

    Get all service definitions

    Get a list of all service definitions from the Datadog Service Catalog.

    GET /api/v2/services/definitions

  • Read

    Get a single service definition

    Get a single service definition from the Datadog Service Catalog.

    GET /api/v2/services/definitions/{service_name}

  • Write

    Create or update service definition

    Create or update service definition in the Datadog Service Catalog.

    POST /api/v2/services/definitions

  • Destructive

    Delete a single service definition

    Delete a single service definition in the Datadog Service Catalog.

    DELETE /api/v2/services/definitions/{service_name}

Reporting And Sharing

  • Write

    Create a graph snapshot

    Create a snapshot of a graph widget. The snapshot is rendered asynchronously; the returned URL can be polled until the image is ready.

    POST /api/v2/snapshot

Spans

  • Read

    Get a list of spans

    List endpoint returns spans that match a span search query. [Results are paginated][1]. Use this endpoint to see your latest spans. This endpoint is rate limited to `300` requests per hour. [1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api

    GET /api/v2/spans/events

  • Read

    Search spans

    List endpoint returns spans that match a span search query. [Results are paginated][1]. Use this endpoint to build complex spans filtering and search. This endpoint is rate limited to `300` requests per hour. [1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api

    POST /api/v2/spans/events/search

  • Write

    Aggregate spans

    The API endpoint to aggregate spans into buckets and compute metrics and timeseries. This endpoint is rate limited to `300` requests per hour. A request can generate at most 10,000 groups across all `group_by` entries, or 400,000 groups including time buckets when a `timeseries` compute is used. Set `limit` on each `group_by` entry to stay within these bounds. Requests over long time ranges or with many groups are more resource-intensive and can fail. To reduce load, narrow the time range or lower the `limit` on each `group_by` entry.

    POST /api/v2/spans/analytics/aggregate

Static Analysis

  • Read

    Retrieve a dependency scan result

    GET /api/v2/static-analysis-sca/dependencies/scan/{job_id}

    GET /api/v2/static-analysis-sca/dependencies/scan/{job_id}

  • Read

    Get the list of SPDX licenses

    GET /api/v2/static-analysis-sca/licenses/list

    GET /api/v2/static-analysis-sca/licenses/list

  • Read

    List AI memory violation results

    Get all AI memory violation results for the authenticated organization.

    GET /api/v2/static-analysis/ai/memory

  • Read

    List AI prompts

    Get all AI prompts, including default prompts and custom AI rule prompts for the authenticated organization.

    GET /api/v2/static-analysis/ai/prompts

  • Read

    List AI custom rulesets

    Get all AI custom rulesets for the authenticated organization.

    GET /api/v2/static-analysis/ai/rulesets

  • Read

    Get an AI custom ruleset

    Get an AI custom ruleset by name.

    GET /api/v2/static-analysis/ai/rulesets/{ruleset_name}

  • Read

    Get an AI custom rule

    Get an AI custom rule by name within a ruleset.

    GET /api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}

  • Read

    List AI custom rule revisions

    Get all revisions for an AI custom rule.

    GET /api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions

  • Read

    Get an AI custom rule revision

    Get a specific revision of an AI custom rule.

    GET /api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions/{id}

  • Read

    List Custom Rulesets

    Get all custom rulesets for the authenticated organization.

    GET /api/v2/static-analysis/custom/rulesets

  • Read

    Show Custom Ruleset

    Get a custom ruleset by name

    GET /api/v2/static-analysis/custom/rulesets/{ruleset_name}

  • Read

    Show Custom Rule

    Get a custom rule by name

    GET /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}

  • Read

    List Custom Rule Revisions

    Get all revisions for a custom rule

    GET /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}/revisions

  • Read

    Show Custom Rule Revision

    Get a specific revision of a custom rule

    GET /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}/revisions/{id}

  • Write

    Post dependencies for analysis

    POST /api/v2/static-analysis-sca/dependencies

    POST /api/v2/static-analysis-sca/dependencies

  • Write

    Submit libraries for vulnerability scanning

    POST /api/v2/static-analysis-sca/dependencies/scan

    POST /api/v2/static-analysis-sca/dependencies/scan

  • Write

    POST request to resolve vulnerable symbols

    POST /api/v2/static-analysis-sca/vulnerabilities/resolve-vulnerable-symbols

    POST /api/v2/static-analysis-sca/vulnerabilities/resolve-vulnerable-symbols

  • Write

    Create an AI memory violation result

    Add a new AI memory violation result for the authenticated organization.

    POST /api/v2/static-analysis/ai/memory

  • Write

    Create an AI custom ruleset

    Create a new AI custom ruleset for the authenticated organization.

    POST /api/v2/static-analysis/ai/rulesets

  • Write

    Update an AI custom ruleset

    Update the description of an existing AI custom ruleset.

    PATCH /api/v2/static-analysis/ai/rulesets/{ruleset_name}

  • Write

    Create an AI custom rule

    Create a new AI custom rule within a ruleset.

    POST /api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules

  • Write

    Create an AI custom rule revision

    Create a new revision for an AI custom rule.

    POST /api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}/revisions

  • Write

    Update Custom Ruleset

    Update an existing custom ruleset

    PATCH /api/v2/static-analysis/custom/rulesets/{ruleset_name}

  • Write

    Revert Custom Rule Revision

    Revert a custom rule to a previous revision

    POST /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}/revisions/revert

  • Destructive

    Delete an AI memory violation result

    Delete an AI memory violation result by its numeric identifier.

    DELETE /api/v2/static-analysis/ai/memory/{id}

  • Destructive

    Delete an AI custom ruleset

    Delete an AI custom ruleset by name.

    DELETE /api/v2/static-analysis/ai/rulesets/{ruleset_name}

  • Destructive

    Delete an AI custom rule

    Delete an AI custom rule by name within a ruleset.

    DELETE /api/v2/static-analysis/ai/rulesets/{ruleset_name}/rules/{rule_name}

  • Destructive

    Create Custom Ruleset

    Create a new custom ruleset for the authenticated organization.

    PUT /api/v2/static-analysis/custom/rulesets

  • Destructive

    Delete Custom Ruleset

    Delete a custom ruleset

    DELETE /api/v2/static-analysis/custom/rulesets/{ruleset_name}

  • Destructive

    Create Custom Rule

    Create a new custom rule within a ruleset

    PUT /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules

  • Destructive

    Delete Custom Rule

    Delete a custom rule

    DELETE /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}

  • Destructive

    Create Custom Rule Revision

    Create a new revision for a custom rule

    PUT /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}/revisions

Status Pages

  • Read

    List status pages

    Lists all status pages for the organization.

    GET /api/v2/statuspages

  • Read

    List degradations

    Lists all degradations for the organization. Optionally filter by status and page.

    GET /api/v2/statuspages/degradations

  • Read

    List maintenances

    Lists all maintenances for the organization. Optionally filter by status and page.

    GET /api/v2/statuspages/maintenances

  • Read

    Get status page

    Retrieves a specific status page by its ID.

    GET /api/v2/statuspages/{page_id}

  • Read

    List components

    Lists all components for a status page.

    GET /api/v2/statuspages/{page_id}/components

  • Read

    Get component

    Retrieves a specific component by its ID.

    GET /api/v2/statuspages/{page_id}/components/{component_id}

  • Read

    List degradation templates

    Lists all degradation templates for a status page.

    GET /api/v2/statuspages/{page_id}/degradation_templates

  • Read

    Get degradation template

    Retrieves a specific degradation template by its ID.

    GET /api/v2/statuspages/{page_id}/degradation_templates/{template_id}

  • Read

    Get degradation

    Retrieves a specific degradation by its ID.

    GET /api/v2/statuspages/{page_id}/degradations/{degradation_id}

  • Read

    List maintenance templates

    Lists all maintenance templates for a status page.

    GET /api/v2/statuspages/{page_id}/maintenance_templates

  • Read

    Get maintenance template

    Retrieves a specific maintenance template by its ID.

    GET /api/v2/statuspages/{page_id}/maintenance_templates/{template_id}

  • Read

    Get maintenance

    Retrieves a specific maintenance by its ID.

    GET /api/v2/statuspages/{page_id}/maintenances/{maintenance_id}

  • Write

    Create status page

    Creates a new status page in an unpublished state. Use the dedicated [publish](#publish-status-page) status page endpoint to publish the page after creation.

    POST /api/v2/statuspages

  • Write

    Create component

    Creates a new component.

    POST /api/v2/statuspages/{page_id}/components

  • Write

    Update component

    Updates an existing component's attributes.

    PATCH /api/v2/statuspages/{page_id}/components/{component_id}

  • Write

    Create degradation template

    Creates a new degradation template.

    POST /api/v2/statuspages/{page_id}/degradation_templates

  • Write

    Update degradation template

    Updates an existing degradation template's attributes.

    PATCH /api/v2/statuspages/{page_id}/degradation_templates/{template_id}

  • Write

    Create degradation

    Creates a new degradation.

    POST /api/v2/statuspages/{page_id}/degradations

  • Write

    Create backfilled degradation

    Creates a backfilled degradation with predefined updates.

    POST /api/v2/statuspages/{page_id}/degradations/backfill

  • Write

    Update degradation

    Updates an existing degradation's attributes.

    PATCH /api/v2/statuspages/{page_id}/degradations/{degradation_id}

  • Write

    Edit degradation update

    Edits a specific degradation update.

    PATCH /api/v2/statuspages/{page_id}/degradations/{degradation_id}/updates/{update_id}

  • Write

    Create maintenance template

    Creates a new maintenance template.

    POST /api/v2/statuspages/{page_id}/maintenance_templates

  • Write

    Update maintenance template

    Updates an existing maintenance template's attributes.

    PATCH /api/v2/statuspages/{page_id}/maintenance_templates/{template_id}

  • Write

    Schedule maintenance

    Schedules a new maintenance.

    POST /api/v2/statuspages/{page_id}/maintenances

  • Write

    Create backfilled maintenance

    Creates a backfilled maintenance with predefined updates.

    POST /api/v2/statuspages/{page_id}/maintenances/backfill

  • Write

    Update maintenance

    Updates an existing maintenance's attributes.

    PATCH /api/v2/statuspages/{page_id}/maintenances/{maintenance_id}

  • Write

    Edit maintenance update

    Edits the message of a specific maintenance update. Editing is allowed regardless of the parent maintenance's status, including completed and canceled maintenances.

    PATCH /api/v2/statuspages/{page_id}/maintenances/{maintenance_id}/updates/{update_id}

  • Write

    Publish status page

    Publishes a status page. For pages of type `public`, makes the status page available on the public internet and requires the `status_pages_public_page_publish` permission. For pages of type `internal`, makes the status page available under the `status-pages/$domain_prefix/view` route within the Datadog organization and requires the `status_pages_internal_page_publish` permission.

    POST /api/v2/statuspages/{page_id}/publish

  • Destructive

    Delete status page

    Deletes a status page by its ID.

    DELETE /api/v2/statuspages/{page_id}

  • Destructive

    Update status page

    Updates an existing status page's attributes. To publish and unpublish status pages, use the dedicated [publish](#publish-status-page) and [unpublish](#unpublish-status-page) status page endpoints.

    PATCH /api/v2/statuspages/{page_id}

  • Destructive

    Delete component

    Deletes a component by its ID.

    DELETE /api/v2/statuspages/{page_id}/components/{component_id}

  • Destructive

    Delete degradation template

    Deletes a degradation template by its ID (soft delete).

    DELETE /api/v2/statuspages/{page_id}/degradation_templates/{template_id}

  • Destructive

    Delete degradation

    Deletes a degradation by its ID.

    DELETE /api/v2/statuspages/{page_id}/degradations/{degradation_id}

  • Destructive

    Soft delete degradation update

    Soft-deletes a degradation update.

    DELETE /api/v2/statuspages/{page_id}/degradations/{degradation_id}/updates/{update_id}

  • Destructive

    Delete maintenance template

    Deletes a maintenance template by its ID (soft delete).

    DELETE /api/v2/statuspages/{page_id}/maintenance_templates/{template_id}

  • Destructive

    Unpublish status page

    Unpublishes a status page. For pages of type `public`, removes the status page from the public internet and requires the `status_pages_public_page_publish` permission. For pages of type `internal`, removes the `status-pages/$domain_prefix/view` route from the Datadog organization and requires the `status_pages_internal_page_publish` permission.

    POST /api/v2/statuspages/{page_id}/unpublish

Stegadography

  • Read

    Get widgets from an image

    Extracts watermarks from a PNG image and returns the cached widget data associated with each watermark found. The image must be uploaded as a `multipart/form-data` request with the file in the `image` field. Only widgets belonging to the authenticated organization are returned.

    POST /api/v2/stegadography/get-widgets

Teams

  • Read

    Get all teams

    Get all teams. Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters.

    GET /api/v2/team

  • Read

    List team connections

    Returns all team connections.

    GET /api/v2/team/connections

  • Read

    Get team sync configurations

    Get all team synchronization configurations. Returns a list of configurations used for linking or provisioning teams with external sources like GitHub or ServiceNow.

    GET /api/v2/team/sync

  • Read

    Get all member teams (deprecated)

    Get all member teams. **Note**: This API is deprecated. For team hierarchy relationships (parent-child teams), use the team hierarchy links API: `GET /api/v2/team-hierarchy-links`.

    GET /api/v2/team/{super_team_id}/member_teams

  • Read

    Get a team

    Get a single team using the team's `id`.

    GET /api/v2/team/{team_id}

  • Read

    Get team hierarchy members

    List the direct and inherited members of a team, deduplicated by user. Members of descendant teams are included unless `filter[is_direct_only]` is true. Datadog support users are always excluded. Use `page[number]` and `page[size]` to paginate through the results. Invalid query parameters return a JSON:API error with status 400. Invalid or unknown team UUIDs return status 404.

    GET /api/v2/team/{team_id}/members

  • Read

    Get team memberships

    Get a paginated list of members for a team

    GET /api/v2/team/{team_id}/memberships

  • Read

    Get team notification rules

    GET /api/v2/team/{team_id}/notification-rules

    GET /api/v2/team/{team_id}/notification-rules

  • Read

    Get team notification rule

    GET /api/v2/team/{team_id}/notification-rules/{rule_id}

    GET /api/v2/team/{team_id}/notification-rules/{rule_id}

  • Read

    Get permission settings for a team

    Get all permission settings for a given team.

    GET /api/v2/team/{team_id}/permission-settings

  • Read

    Get user memberships

    Get a list of memberships for a user

    GET /api/v2/users/{user_uuid}/memberships

  • Write

    Create a team

    Create a new team. User IDs passed through the `users` relationship field are added to the team.

    POST /api/v2/team

  • Write

    Create team connections

    Create multiple team connections.

    POST /api/v2/team/connections

  • Write

    Link teams with external teams

    This endpoint configures synchronization between your existing Datadog teams and teams from GitHub or ServiceNow by matching team names. It evaluates all current Datadog teams and compares them against teams in the external source connected to your Datadog account. This operation is read-only on the external source side, no teams will be modified or created there. This only creates new teams in Datadog when type is set to `provision`. Optionally, provide `selection_state` to limit synchronization to specific teams or organizations and their subtrees, instead of syncing all teams. **GitHub**: [A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/), and the GitHub App integrated with Datadog must have the `Members Read` permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug (lowercased and kebab-cased) using a normalized exact match; case is ignored and spaces are removed. **ServiceNow**: [The ServiceNow integration must be configured for your Datadog account](https://docs.datadoghq.com/integrations/servicenow/). Active assignment groups from every configured ServiceNow instance are synchronized, and the ServiceNow group hierarchy is preserved. When `sync_membership` is enabled, group members are matched to Datadog users by email address.

    POST /api/v2/team/sync

  • Write

    Add a member team (deprecated)

    Add a member team. Adds the team given by the `id` in the body as a member team of the super team. **Note**: This API is deprecated. For creating team hierarchy links, use the team hierarchy links API: `POST /api/v2/team-hierarchy-links`.

    POST /api/v2/team/{super_team_id}/member_teams

  • Write

    Add a user to a team

    Add a user to a team. **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).

    POST /api/v2/team/{team_id}/memberships

  • Write

    Update a user's membership attributes on a team

    Update a user's membership attributes on a team. **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).

    PATCH /api/v2/team/{team_id}/memberships/{user_id}

  • Write

    Create team notification rule

    POST /api/v2/team/{team_id}/notification-rules

    POST /api/v2/team/{team_id}/notification-rules

  • Destructive

    Delete team connections

    Delete multiple team connections.

    DELETE /api/v2/team/connections

  • Destructive

    Remove a member team (deprecated)

    Remove a super team's member team identified by `member_team_id`. **Note**: This API is deprecated. For deleting team hierarchy links, use the team hierarchy links API: `DELETE /api/v2/team-hierarchy-links/{link_id}`.

    DELETE /api/v2/team/{super_team_id}/member_teams/{member_team_id}

  • Destructive

    Remove a team

    Remove a team using the team's `id`.

    DELETE /api/v2/team/{team_id}

  • Destructive

    Update a team

    Update a team using the team's `id`. If the `team_links` relationship is present, the associated links are updated to be in the order they appear in the array, and any existing team links not present are removed.

    PATCH /api/v2/team/{team_id}

  • Destructive

    Remove a user from a team

    Remove a user from a team. **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).

    DELETE /api/v2/team/{team_id}/memberships/{user_id}

  • Destructive

    Delete team notification rule

    DELETE /api/v2/team/{team_id}/notification-rules/{rule_id}

    DELETE /api/v2/team/{team_id}/notification-rules/{rule_id}

  • Destructive

    Update team notification rule

    PUT /api/v2/team/{team_id}/notification-rules/{rule_id}

    PUT /api/v2/team/{team_id}/notification-rules/{rule_id}

  • Destructive

    Update permission setting for team

    Update a team permission setting for a given team.

    PUT /api/v2/team/{team_id}/permission-settings/{action}

Timeseries Anomaly Investigations

  • Write

    Investigate a timeseries anomaly

    Investigates a metrics timeseries request for its most significant anomalies and returns deterministic findings. Metrics queries with or without grouping are supported. This API version accepts exactly one request and returns at most three anomalies.

    POST /api/v2/timeseries-anomaly-investigations

User Authorized Clients

  • Read

    List user authorized clients

    Get a list of all OAuth2 clients authorized by the current user.

    GET /api/v2/user_authorized_clients

  • Read

    Get a user authorized client

    Get a single OAuth2 client authorization for the current user.

    GET /api/v2/user_authorized_clients/{user_authorized_client_id}

  • Destructive

    Delete all user authorized clients for a client

    Disable all authorizations the current user has granted to the specified OAuth2 client.

    DELETE /api/v2/user_authorized_clients/client/{client_id}

  • Destructive

    Delete a user authorized client

    Disable the current user's authorization for the specified OAuth2 client.

    DELETE /api/v2/user_authorized_clients/{user_authorized_client_id}

Web Integrations

  • Read

    List web integration accounts

    List accounts for a given web integration.

    GET /api/v2/web-integrations/{integration_name}/accounts

  • Read

    Get a web integration account

    Get a single account for a given web integration.

    GET /api/v2/web-integrations/{integration_name}/accounts/{account_id}

  • Write

    Create a web integration account

    Create a new account for a given web integration.

    POST /api/v2/web-integrations/{integration_name}/accounts

  • Write

    Update a web integration account

    Update an existing account for a given web integration.

    PATCH /api/v2/web-integrations/{integration_name}/accounts/{account_id}

  • Destructive

    Delete a web integration account

    Delete an account for a given web integration.

    DELETE /api/v2/web-integrations/{integration_name}/accounts/{account_id}

Widgets

  • Read

    Search widgets

    Search and list widgets for a given experience type, with filtering, sorting, and pagination. **Response meta** carries totals scoped to the current filter: - `filtered_total` — widgets matching the filter. - `created_by_you_total` — among the matches, how many the current user created. - `favorited_by_you_total` — among the matches, how many the current user has favorited. - `created_by_anyone_total` — total widgets in the experience type, ignoring filters. Each returned widget includes `is_favorited` reflecting the current user's favorite status. Favoriting itself is performed through the shared favorites API, not this endpoint.

    GET /api/v2/widgets/{experience_type}

  • Read

    Get a widget

    Retrieve a widget by its UUID for a given experience type.

    GET /api/v2/widgets/{experience_type}/{uuid}

  • Write

    Create a widget

    Create a new widget for a given experience type.

    POST /api/v2/widgets/{experience_type}

  • Destructive

    Delete a widget

    Soft-delete a widget by its UUID for a given experience type.

    DELETE /api/v2/widgets/{experience_type}/{uuid}

  • Destructive

    Update a widget

    Update a widget by its UUID for a given experience type. This performs a full replacement of the widget definition.

    PUT /api/v2/widgets/{experience_type}/{uuid}

Cloud Authentication

  • Read

    List AWS cloud authentication persona mappings

    List all AWS cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate AWS IAM principals with Datadog users.

    GET /api/v2/wif/aws/persona_mapping

  • Read

    Get an AWS cloud authentication persona mapping

    Get a specific AWS cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates an AWS IAM principal with a Datadog user.

    GET /api/v2/wif/aws/persona_mapping/{persona_mapping_id}

  • Read

    List GitHub cloud authentication intake mappings

    List all GitHub cloud authentication intake mappings. This endpoint retrieves all configured intake mappings that entitle matching GitHub Actions OIDC principals to request Datadog API keys.

    GET /api/v2/wif/github/intake_mapping

  • Read

    Get a GitHub cloud authentication intake mapping

    Get a specific GitHub cloud authentication intake mapping by ID. This endpoint retrieves a single configured intake mapping that entitles a matching GitHub Actions OIDC principal to request Datadog API keys.

    GET /api/v2/wif/github/intake_mapping/{intake_mapping_id}

  • Read

    List GitHub cloud authentication persona mappings

    List all GitHub cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate GitHub Actions OpenID Connect (OIDC) principals with Datadog users. Mapped principals can request impersonation tokens.

    GET /api/v2/wif/github/persona_mapping

  • Read

    Get a GitHub cloud authentication persona mapping

    Get a specific GitHub cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates a GitHub Actions OIDC principal with a Datadog user. The mapped principal can request an impersonation token.

    GET /api/v2/wif/github/persona_mapping/{persona_mapping_id}

  • Write

    Create an AWS cloud authentication persona mapping

    Create an AWS cloud authentication persona mapping. This endpoint associates an AWS IAM principal with a Datadog user.

    POST /api/v2/wif/aws/persona_mapping

  • Write

    Create a GitHub cloud auth intake mapping

    Create a GitHub cloud authentication intake mapping. This endpoint entitles a matching GitHub Actions OIDC principal to request Datadog API keys.

    POST /api/v2/wif/github/intake_mapping

  • Write

    Create a GitHub cloud auth persona mapping

    Create a GitHub cloud authentication persona mapping. This endpoint associates a GitHub Actions OIDC principal with a Datadog user. The mapped principal can request an impersonation token.

    POST /api/v2/wif/github/persona_mapping

  • Destructive

    Delete an AWS cloud authentication persona mapping

    Delete an AWS cloud authentication persona mapping by ID. This removes the association between an AWS IAM principal and a Datadog user.

    DELETE /api/v2/wif/aws/persona_mapping/{persona_mapping_id}

  • Destructive

    Delete a GitHub cloud auth intake mapping

    Delete a GitHub cloud authentication intake mapping by ID. This removes a GitHub Actions OIDC principal's entitlement to request Datadog API keys.

    DELETE /api/v2/wif/github/intake_mapping/{intake_mapping_id}

  • Destructive

    Delete a GitHub cloud auth persona mapping

    Delete a GitHub cloud authentication persona mapping by ID. This removes the association between a GitHub Actions OIDC principal and a Datadog user.

    DELETE /api/v2/wif/github/persona_mapping/{persona_mapping_id}

Workflow Automation

  • Read

    List workflows

    List all workflows in your organization. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    GET /api/v2/workflows

  • Read

    Get an existing Workflow

    Get a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    GET /api/v2/workflows/{workflow_id}

  • Read

    List workflow instances

    List all instances of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    GET /api/v2/workflows/{workflow_id}/instances

  • Read

    Get a workflow instance

    Get a specific execution of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    GET /api/v2/workflows/{workflow_id}/instances/{instance_id}

  • Write

    Create a Workflow

    Create a new workflow, returning the workflow ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    POST /api/v2/workflows

  • Write

    Update an existing Workflow

    Update a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    PATCH /api/v2/workflows/{workflow_id}

  • Write

    Execute a workflow

    Execute the given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    POST /api/v2/workflows/{workflow_id}/instances

  • Destructive

    Delete an existing Workflow

    Delete a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    DELETE /api/v2/workflows/{workflow_id}

  • Destructive

    Cancel a workflow instance

    Cancels a specific execution of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).

    PUT /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel

Spa

  • Read

    Get SPA recommendations v2 (deprecated)

    This endpoint is experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job. The caller (Spark Gateway) provides a service name and the job's raw arguments.

  • Read

    Get SPA Recommendations (deprecated)

    This endpoint is currently experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job. The caller (Spark Gateway or DJM UI) provides a service name and SPA returns structured recommendations for driver and executor resources.

  • Read

    Get SPA Recommendations with a shard parameter (deprecated)

    This endpoint is currently experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job.

See How connections work for access and permissions, or browse all integrations.