How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datadog APM Retention Filters API

Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters) for your organization. You need an API and application key with Admin rights to interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters) on the Trace Retention page for more information.

Datadog APM Retention Filters API is one of 8 APIs that Datadog APM publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include APM Retention Filters. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.

6 operations 3 paths 21 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.datadoghq.com
Authentication
OAuth 2.0, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Datadog APM Retention Filters API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 96 scopes. An API key is passed in the header as DD-API-KEY (apiKeyAuth). An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • AuthZ — This API uses OAuth 2 with the implicit grant flow.
  • apiKeyAuth — Your Datadog API Key.
  • appKeyAuth — Your Datadog APP Key.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

APM Retention Filters 6

Manage configuration of APM retention filters for your organization. You need an API and application key with Admin rights to interact with this endpoint. See retention filters on…

GET
/api/v2/apm/config/retention-filters
List all APM retention filters
ListApmRetentionFilters → 200403429
POST
/api/v2/apm/config/retention-filters
Create a retention filter
CreateApmRetentionFilter body → 200400403409429
PUT
/api/v2/apm/config/retention-filters-execution-order
Re-order retention filters
ReorderApmRetentionFilters body → 200400403429
DELETE
/api/v2/apm/config/retention-filters/{filter_id}
Delete a retention filter
DeleteApmRetentionFilter 1 param → 200403404429
GET
/api/v2/apm/config/retention-filters/{filter_id}
Get a given APM retention filter
GetApmRetentionFilter 1 param → 200403404429
PUT
/api/v2/apm/config/retention-filters/{filter_id}
Update a retention filter
UpdateApmRetentionFilter 1 param body → 200400403404429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are RetentionFilterAttributes (12 properties), RetentionFilterAllAttributes (12 properties), RetentionFilterUpdateAttributes (6 properties), RetentionFilterCreateAttributes (6 properties). Each schema is shown below with its type and property counts.

ReorderRetentionFiltersRequest
object
A list of retention filters to reorder.
1 property 1 required
RetentionFilterAllType
string
The type of retention filter.
RetentionFiltersResponse
object
An ordered list of retention filters.
1 property 1 required
RetentionFilterCreateAttributes
object
The object describing the configuration of the retention filter to create/update.
6 properties 5 required
SpansFilter
object
The spans filter used to index spans.
1 property
RetentionFilterCreateData
object
The body of the retention filter to be created.
2 properties 2 required
RetentionFilterUpdateData
object
The body of the retention filter to be updated.
3 properties 3 required
SpansFilterCreate
object
The spans filter. Spans matching this filter will be indexed and stored.
1 property 1 required
RetentionFilterCreateRequest
object
The body of the retention filter to be created.
1 property 1 required
RetentionFilterWithoutAttributes
object
The retention filter object .
2 properties 2 required
RetentionFilterUpdateRequest
object
The body of the retention filter to be updated.
1 property 1 required
RetentionFilterCreateResponse
object
The retention filters definition.
1 property
RetentionFilterAll
object
The definition of the retention filter.
3 properties 3 required
ApmRetentionFilterType
string
The type of the resource.
RetentionFilterAttributes
object
The attributes of the retention filter.
12 properties
RetentionFilterUpdateAttributes
object
The object describing the configuration of the retention filter to create/update.
6 properties 5 required
APIErrorResponse
object
API error response.
1 property 1 required
RetentionFilterType
string
The type of retention filter. The value should always be spans-sampling-processor.
RetentionFilter
object
The definition of the retention filter.
3 properties 3 required
RetentionFilterAllAttributes
object
The attributes of the retention filter.
12 properties
RetentionFilterResponse
object
The retention filters definition.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-apm-apm-retention-filters-api-openapi.yml Raw ↑

Other APIs Datadog APM publishes across the network.

Datadog APM Spans API
Datadog APM Spans Metrics API
Datadog MCP Server
Datadog APM API
Datadog APM Service Definition API
Datadog APM Service Level Objective Corrections API
Datadog APM Service Level Objectives API
Where this information came from

This is an independent, third-party profile of Datadog APM Retention Filters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.