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 Retention API

The Retention API from Datadog — 6 operation(s) for retention.

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

This API exposes 4 JSON Schema definitions.

Tagged areas include Retention. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.

This API exposes 12 operations across 6 paths, and defines 41 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

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

12 operations 6 paths 41 schemas 2 DELETE4 GET2 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.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 Retention API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 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 12

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

Retention 12
GET
/api/v2/apm/config/retention-filters
Datadog List All Apm Retention Filters
ListApmRetentionFilters → 200403429
POST
/api/v2/apm/config/retention-filters
Datadog Create a Retention Filter
CreateApmRetentionFilter body → 200400403409429
PUT
/api/v2/apm/config/retention-filters-execution-order
Datadog Re-order Retention Filters
ReorderApmRetentionFilters body → 200400403429
DELETE
/api/v2/apm/config/retention-filters/{filter_id}
Datadog Delete a Retention Filter
DeleteApmRetentionFilter 1 param → 200403404429
GET
/api/v2/apm/config/retention-filters/{filter_id}
Datadog Get a Given Apm Retention Filter
GetApmRetentionFilter 1 param → 200403404429
PUT
/api/v2/apm/config/retention-filters/{filter_id}
Datadog Update a Retention Filter
UpdateApmRetentionFilter 1 param body → 200400403404429
PATCH
/api/v2/rum/applications/{app_id}/relationships/retention_filters
Datadog Order Rum Retention Filters
OrderRetentionFilters 1 param body → 200400403429
GET
/api/v2/rum/applications/{app_id}/retention_filters
Datadog Get All Rum Retention Filters
ListRetentionFilters 1 param → 200403429
POST
/api/v2/rum/applications/{app_id}/retention_filters
Datadog Create a Rum Retention Filter
CreateRetentionFilter 1 param body → 201400403429
DELETE
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Datadog Delete a Rum Retention Filter
DeleteRetentionFilter 2 params → 204403404429
GET
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Datadog Get a Rum Retention Filter
GetRetentionFilter 2 params → 200403404429
PATCH
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Datadog Update a Rum Retention Filter
UpdateRetentionFilter 2 params body → 200400403404429

Schemas 41

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

RumRetentionFilterEnabled
boolean
Whether the retention filter is enabled.
SpansFilterCreate
object
The spans filter. Spans matching this filter will be indexed and stored.
1 property 1 required
RetentionFilterCreateAttributes
object
The object describing the configuration of the retention filter to create/update.
6 properties 5 required
RetentionFilterAll
object
The definition of the retention filter.
3 properties 3 required
RumRetentionFilterType
string
The type of the resource. The value should always be retentionfilters.
RumRetentionFiltersOrderData
object
The RUM retention filter data for ordering.
2 properties 2 required
RumRetentionFiltersOrderResponse
object
The list of RUM retention filter IDs along with type.
1 property
RumRetentionFilterUpdateAttributes
object
The object describing attributes of a RUM retention filter to update.
5 properties
RumRetentionFilterQuery
string
The query string for a RUM retention filter.
RetentionFilterAllType
string
The type of retention filter.
APIErrorResponse
object
API error response.
1 property 1 required
RumRetentionFilterCreateRequest
object
The RUM retention filter body to create.
1 property 1 required
ReorderRetentionFiltersRequest
object
A list of retention filters to reorder.
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
RumRetentionFilterEventType
string
The type of RUM events to filter on.
RetentionFilterResponse
object
The retention filters definition.
1 property
RetentionFilter
object
The definition of the retention filter.
3 properties 3 required
RetentionFilterCreateData
object
The body of the retention filter to be created.
2 properties 2 required
RumRetentionFilterCreateData
object
The new RUM retention filter properties to create.
2 properties 2 required
RumRetentionFilterSampleRate
integer
The sample rate for a RUM retention filter, between 0 and 100.
RetentionFilterUpdateData
object
The body of the retention filter to be updated.
3 properties 3 required
RetentionFilterAllAttributes
object
The attributes of the retention filter.
12 properties
RunRetentionFilterName
string
The name of a RUM retention filter.
RumRetentionFiltersOrderRequest
object
The list of RUM retention filter IDs along with their corresponding type to reorder. All retention filter IDs should be included in the list created for a RUM…
1 property
RumRetentionFilterID
string
ID of retention filter in UUID.
RetentionFilterUpdateAttributes
object
The object describing the configuration of the retention filter to create/update.
6 properties 5 required
RetentionFilterAttributes
object
The attributes of the retention filter.
12 properties
RumRetentionFilterUpdateRequest
object
The RUM retention filter body to update.
1 property 1 required
RumRetentionFilterData
object
The RUM retention filter.
3 properties
RumRetentionFilterAttributes
object
The object describing attributes of a RUM retention filter.
5 properties
ApmRetentionFilterType
string
The type of the resource.
RetentionFiltersResponse
object
An ordered list of retention filters.
1 property 1 required
RetentionFilterType
string
The type of retention filter. The value should always be spans-sampling-processor.
SpansFilter
object
The spans filter used to index spans.
1 property
RumRetentionFilterUpdateData
object
The new RUM retention filter properties to update.
3 properties 3 required
RetentionFilterCreateResponse
object
The retention filters definition.
1 property
RetentionFilterUpdateRequest
object
The body of the retention filter to be updated.
1 property 1 required
RumRetentionFiltersResponse
object
All RUM retention filters for a RUM application.
1 property
RumRetentionFilterCreateAttributes
object
The object describing attributes of a RUM retention filter to create.
5 properties 3 required
RumRetentionFilterResponse
object
The RUM retention filter object.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-retention-api-openapi.yml Raw ↑

Other APIs Datadog publishes across the network.

Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
Where this information came from

This is an independent, third-party profile of Datadog Retention 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.