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

The Archive API from Datadog — 5 operation(s) for archive.

Datadog Archive 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 Archive. 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 10 operations across 5 paths, and defines 59 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}.

10 operations 5 paths 59 schemas 2 DELETE3 GET3 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 Archive 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 10

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

Archive 10
POST
/api/v2/cases/{case_id}/archive
Datadog Archive Case
ArchiveCase 1 param body → 200400401403404429
GET
/api/v2/logs/config/archive-order
Datadog Get Archive Order
GetLogsArchiveOrder → 200403429
PUT
/api/v2/logs/config/archive-order
Datadog Update Archive Order
UpdateLogsArchiveOrder body → 200400403422429
POST
/api/v2/logs/config/archives
Datadog Create an Archive
CreateLogsArchive body → 200400403429
DELETE
/api/v2/logs/config/archives/{archive_id}
Datadog Delete an Archive
DeleteLogsArchive 1 param → 204400403404429
GET
/api/v2/logs/config/archives/{archive_id}
Datadog Get an Archive
GetLogsArchive 1 param → 200400403404429
PUT
/api/v2/logs/config/archives/{archive_id}
Datadog Update an Archive
UpdateLogsArchive 1 param body → 200400403404429
DELETE
/api/v2/logs/config/archives/{archive_id}/readers
Datadog Revoke Role from an Archive
RemoveRoleFromArchive 1 param body → 204400403404429
GET
/api/v2/logs/config/archives/{archive_id}/readers
Datadog List Read Roles for an Archive
ListArchiveReadRoles 1 param → 200400403404429
POST
/api/v2/logs/config/archives/{archive_id}/readers
Datadog Grant Role to an Archive
AddReadRoleToArchive 1 param body → 204400403404429

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are CaseAttributes (12 properties), LogsArchiveAttributes (7 properties), LogsArchiveDestinationS3 (6 properties), LogsArchiveDestinationAzure (6 properties). Each schema is shown below with its type and property counts.

LogsArchiveDestinationGCS
object
The GCS archive destination.
4 properties 3 required
JiraIssueResult
object
Jira issue information
4 properties
LogsArchiveDestinationGCSType
string
Type of the GCS archive destination.
LogsArchiveDestinationAzure
object
The Azure archive destination.
6 properties 4 required
LogsArchiveDestinationS3
object
The S3 archive destination.
6 properties 3 required
PermissionsType
string
Permissions resource type.
ProjectResourceType
string
Project resource type
LogsArchiveOrderDefinitionType
string
Type of the archive order definition.
CaseStatus
string
Case status
LogsArchiveState
string
The state of the archive.
APIErrorResponse
object
API error response.
1 property 1 required
RelationshipToRole
object
Relationship to role.
1 property
CasePriority
string
Case priority
CaseEmpty
object
Case empty request data
1 property 1 required
LogsArchiveDestination
object
An archive's destination.
LogsArchiveAttributes
object
The attributes associated with the archive.
7 properties 3 required
Pagination
object
Pagination object.
2 properties
LogsArchiveStorageClassS3Type
string
The storage class where the archive will be stored.
CaseEmptyRequest
object
Case empty request
1 property 1 required
UserResourceType
string
User resource type.
CaseResponse
object
Case response
1 property
RoleResponseRelationships
object
Relationships of the role object returned by the API.
1 property
CaseRelationships
object
Resources related to a case
4 properties
NullableUserRelationship
object
Relationship to user.
1 property 1 required
ProjectRelationship
object
Relationship to project
1 property 1 required
LogsArchiveOrder
object
A ordered list of archive IDs.
1 property
LogsArchiveDefinition
object
The definition of an archive.
3 properties 1 required
CaseType
string
Case type
CaseAttributes
object
Case attributes
12 properties
LogsArchiveCreateRequestDestination
An archive's destination.
LogsArchiveOrderDefinition
object
The definition of an archive order.
2 properties 2 required
RoleAttributes
object
Attributes of the role.
4 properties
LogsArchiveOrderAttributes
object
The attributes associated with the archive order.
1 property 1 required
NullableUserRelationshipData
object
Relationship to user object.
2 properties 2 required
LogsArchiveEncryptionS3
object
The S3 encryption settings.
2 properties 1 required
LogsArchiveCreateRequest
object
The logs archive.
1 property
LogsArchiveEncryptionS3Type
string
Type of S3 encryption for a destination.
RolesResponse
object
Response containing information about multiple roles.
2 properties
RelationshipToRoleData
object
Relationship to role object.
2 properties
LogsArchiveDestinationS3Type
string
Type of the S3 archive destination.
LogsArchiveIntegrationAzure
object
The Azure archive's integration destination.
2 properties 2 required
JiraIssue
object
Jira issue attached to case
2 properties
ResponseMetaAttributes
object
Object describing meta attributes of response.
1 property
LogsArchiveIntegrationGCS
object
The GCS archive's integration destination.
2 properties 1 required
LogsArchive
object
The logs archive.
1 property
Case3rdPartyTicketStatus
string
Case status
CaseResourceType
string
Case resource type
LogsArchiveDestinationAzureType
string
Type of the Azure archive destination.
ProjectRelationshipData
object
Relationship to project object
2 properties 2 required
Role
object
Role object returned by the API.
4 properties 1 required
RolesType
string
Roles type.
LogsArchiveIntegrationS3
object
The S3 Archive's integration destination.
2 properties 2 required
Case
object
A case
4 properties 3 required
LogsArchiveCreateRequestDefinition
object
The definition of an archive.
2 properties 1 required
ServiceNowTicket
object
ServiceNow ticket attached to case
2 properties
ServiceNowTicketResult
object
ServiceNow ticket information
1 property
RelationshipToPermissions
object
Relationship to multiple permissions objects.
1 property
RelationshipToPermissionData
object
Relationship to permission object.
2 properties
LogsArchiveCreateRequestAttributes
object
The attributes associated with the archive.
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-archive-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 Archive 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.