Skip to content

Commit 31c91e3

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 02b940f of spec repo
1 parent f5048c3 commit 31c91e3

15 files changed

Lines changed: 849 additions & 0 deletions

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 278 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11004,6 +11004,68 @@ components:
1100411004
- type
1100511005
- attributes
1100611006
type: object
11007+
ArchiveSearchListResponse:
11008+
description: Response containing multiple Archive Searches.
11009+
properties:
11010+
data:
11011+
description: Array of Archive Searches.
11012+
items:
11013+
$ref: "#/components/schemas/ArchiveSearchResponseData"
11014+
type: array
11015+
meta:
11016+
$ref: "#/components/schemas/ArchiveSearchListResponseMeta"
11017+
required:
11018+
- data
11019+
type: object
11020+
ArchiveSearchListResponseMeta:
11021+
description: Metadata of the Archive Searches response.
11022+
properties:
11023+
truncated:
11024+
description: Whether more Archive Searches exist beyond the ones returned.
11025+
example: false
11026+
type: boolean
11027+
type: object
11028+
ArchiveSearchRehydrateRequest:
11029+
description: Request to rehydrate an Archive Search.
11030+
properties:
11031+
data:
11032+
$ref: "#/components/schemas/ArchiveSearchRehydrateRequestData"
11033+
required:
11034+
- data
11035+
type: object
11036+
ArchiveSearchRehydrateRequestAttributes:
11037+
description: Attributes accepted when rehydrating an Archive Search.
11038+
properties:
11039+
rehydration:
11040+
$ref: "#/components/schemas/ArchiveSearchRehydrateRequestRehydration"
11041+
required:
11042+
- rehydration
11043+
type: object
11044+
ArchiveSearchRehydrateRequestData:
11045+
description: Archive Search object to rehydrate.
11046+
properties:
11047+
attributes:
11048+
$ref: "#/components/schemas/ArchiveSearchRehydrateRequestAttributes"
11049+
type:
11050+
$ref: "#/components/schemas/ArchiveSearchType"
11051+
required:
11052+
- type
11053+
- attributes
11054+
type: object
11055+
ArchiveSearchRehydrateRequestRehydration:
11056+
description: Rehydration settings to apply.
11057+
properties:
11058+
retention_days:
11059+
description: Number of days the rehydrated logs are retained for.
11060+
example: 15
11061+
format: int64
11062+
type: integer
11063+
tier:
11064+
$ref: "#/components/schemas/ArchiveSearchRehydrationTier"
11065+
required:
11066+
- retention_days
11067+
- tier
11068+
type: object
1100711069
ArchiveSearchRehydration:
1100811070
description: |-
1100911071
Rehydration settings of the Archive Search. Absent when the search only scans the archive
@@ -199559,6 +199621,60 @@ paths:
199559199621
permissions:
199560199622
- logs_read_data
199561199623
/api/v2/logs/archive_searches:
199624+
get:
199625+
description: |-
199626+
List the organization's Archive Searches that haven't expired, up to 5,000. When more
199627+
exist, `meta.truncated` is `true`.
199628+
operationId: ListArchiveSearches
199629+
responses:
199630+
"200":
199631+
content:
199632+
application/json:
199633+
examples:
199634+
default:
199635+
value:
199636+
data:
199637+
- attributes:
199638+
archive_id: mhmyYmyLTOaFYKvhNadu1w
199639+
bytes_scanned: 0
199640+
created_at: "2026-01-02T12:00:00Z"
199641+
description: Investigating the checkout latency spike.
199642+
events_scanned: 0
199643+
expected_duration: 120
199644+
from: "2026-01-01T00:00:00Z"
199645+
name: checkout-latency-investigation
199646+
query: service:checkout status:error
199647+
status: RUNNING
199648+
to: "2026-01-02T00:00:00Z"
199649+
id: nv2eu4srgyzdkulggjzg2zkmmzifa2rum5iq
199650+
type: archive_search
199651+
meta:
199652+
truncated: false
199653+
schema:
199654+
$ref: "#/components/schemas/ArchiveSearchListResponse"
199655+
description: OK
199656+
"403":
199657+
content:
199658+
application/json:
199659+
schema:
199660+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199661+
description: Forbidden
199662+
"429":
199663+
$ref: "#/components/responses/TooManyRequestsResponse"
199664+
security:
199665+
- apiKeyAuth: []
199666+
appKeyAuth: []
199667+
- AuthZ: []
199668+
summary: List Archive Searches
199669+
tags:
199670+
- Logs Archive Searches
199671+
"x-permission":
199672+
operator: OR
199673+
permissions:
199674+
- logs_read_data
199675+
x-unstable: |-
199676+
**Note**: This endpoint is in preview and is subject to change.
199677+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
199562199678
post:
199563199679
description: |-
199564199680
Start a search over the logs stored in an archive.
@@ -199708,6 +199824,168 @@ paths:
199708199824
x-unstable: |-
199709199825
**Note**: This endpoint is in preview and is subject to change.
199710199826
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
199827+
patch:
199828+
description: |-
199829+
Turn a plain Archive Search into a Search & Rehydration by indexing the matched logs into a
199830+
retained historical view. Rehydration is the only thing this endpoint can change, and it only
199831+
applies to a search that has already finished scanning.
199832+
operationId: RehydrateArchiveSearch
199833+
parameters:
199834+
- description: Unique identifier of the Archive Search.
199835+
example: nv2eu4srgyzdkulggjzg2zkmmzifa2rum5iq
199836+
in: path
199837+
name: archive_search_id
199838+
required: true
199839+
schema:
199840+
type: string
199841+
requestBody:
199842+
content:
199843+
application/json:
199844+
schema:
199845+
$ref: "#/components/schemas/ArchiveSearchRehydrateRequest"
199846+
required: true
199847+
responses:
199848+
"200":
199849+
content:
199850+
application/json:
199851+
examples:
199852+
default:
199853+
value:
199854+
data:
199855+
attributes:
199856+
archive_id: mhmyYmyLTOaFYKvhNadu1w
199857+
bytes_scanned: 402764439
199858+
created_at: "2026-01-02T12:00:00Z"
199859+
description: Investigating the checkout latency spike.
199860+
events_scanned: 1500
199861+
from: "2026-01-01T00:00:00Z"
199862+
name: checkout-latency-investigation
199863+
query: service:checkout status:error
199864+
rehydration:
199865+
max_rehydrated_events: 100000
199866+
retention_days: 15
199867+
tier: standard
199868+
status: RUNNING
199869+
to: "2026-01-02T00:00:00Z"
199870+
id: nv2eu4srgyzdkulggjzg2zkmmzifa2rum5iq
199871+
type: archive_search
199872+
schema:
199873+
$ref: "#/components/schemas/ArchiveSearchResponse"
199874+
description: OK
199875+
"400":
199876+
content:
199877+
application/json:
199878+
schema:
199879+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199880+
description: Bad Request
199881+
"403":
199882+
content:
199883+
application/json:
199884+
schema:
199885+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199886+
description: Forbidden
199887+
"404":
199888+
content:
199889+
application/json:
199890+
schema:
199891+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199892+
description: Not Found
199893+
"412":
199894+
content:
199895+
application/json:
199896+
schema:
199897+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199898+
description: Precondition Failed
199899+
"429":
199900+
$ref: "#/components/responses/TooManyRequestsResponse"
199901+
security:
199902+
- apiKeyAuth: []
199903+
appKeyAuth: []
199904+
- AuthZ: []
199905+
summary: Rehydrate an Archive Search
199906+
tags:
199907+
- Logs Archive Searches
199908+
"x-permission":
199909+
operator: OR
199910+
permissions:
199911+
- logs_write_historical_view
199912+
x-unstable: |-
199913+
**Note**: This endpoint is in preview and is subject to change.
199914+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
199915+
/api/v2/logs/archive_searches/{archive_search_id}/cancel:
199916+
post:
199917+
description: |-
199918+
Cancel a running Archive Search. Cancelling an Archive Search that has already finished is a
199919+
no-op: it returns the resource unchanged instead of returning an error.
199920+
operationId: CancelArchiveSearch
199921+
parameters:
199922+
- description: Unique identifier of the Archive Search.
199923+
example: nv2eu4srgyzdkulggjzg2zkmmzifa2rum5iq
199924+
in: path
199925+
name: archive_search_id
199926+
required: true
199927+
schema:
199928+
type: string
199929+
responses:
199930+
"200":
199931+
content:
199932+
application/json:
199933+
examples:
199934+
default:
199935+
value:
199936+
data:
199937+
attributes:
199938+
archive_id: mhmyYmyLTOaFYKvhNadu1w
199939+
bytes_scanned: 102400
199940+
completed_at: "2026-01-02T12:05:00Z"
199941+
created_at: "2026-01-02T12:00:00Z"
199942+
description: Investigating the checkout latency spike.
199943+
events_scanned: 500
199944+
from: "2026-01-01T00:00:00Z"
199945+
name: checkout-latency-investigation
199946+
query: service:checkout status:error
199947+
status: CANCELLED
199948+
to: "2026-01-02T00:00:00Z"
199949+
id: nv2eu4srgyzdkulggjzg2zkmmzifa2rum5iq
199950+
type: archive_search
199951+
schema:
199952+
$ref: "#/components/schemas/ArchiveSearchResponse"
199953+
description: OK
199954+
"400":
199955+
content:
199956+
application/json:
199957+
schema:
199958+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199959+
description: Bad Request
199960+
"403":
199961+
content:
199962+
application/json:
199963+
schema:
199964+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199965+
description: Forbidden
199966+
"404":
199967+
content:
199968+
application/json:
199969+
schema:
199970+
$ref: "#/components/schemas/JSONAPIErrorResponse"
199971+
description: Not Found
199972+
"429":
199973+
$ref: "#/components/responses/TooManyRequestsResponse"
199974+
security:
199975+
- apiKeyAuth: []
199976+
appKeyAuth: []
199977+
- AuthZ: []
199978+
summary: Cancel an Archive Search
199979+
tags:
199980+
- Logs Archive Searches
199981+
"x-permission":
199982+
operator: OR
199983+
permissions:
199984+
- logs_write_historical_view
199985+
- logs_write_archive_search
199986+
x-unstable: |-
199987+
**Note**: This endpoint is in preview and is subject to change.
199988+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
199711199989
/api/v2/logs/config/archive-order:
199712199990
get:
199713199991
description: |-
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
"""
2+
Cancel an Archive Search returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.logs_archive_searches_api import LogsArchiveSearchesApi
8+
9+
configuration = Configuration()
10+
configuration.access_token = environ["DD_BEARER_TOKEN"]
11+
configuration.unstable_operations["cancel_archive_search"] = True
12+
with ApiClient(configuration) as api_client:
13+
api_instance = LogsArchiveSearchesApi(api_client)
14+
response = api_instance.cancel_archive_search(
15+
archive_search_id="archive_search_id",
16+
)
17+
18+
print(response)
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
List Archive Searches returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.logs_archive_searches_api import LogsArchiveSearchesApi
8+
9+
configuration = Configuration()
10+
configuration.access_token = environ["DD_BEARER_TOKEN"]
11+
configuration.unstable_operations["list_archive_searches"] = True
12+
with ApiClient(configuration) as api_client:
13+
api_instance = LogsArchiveSearchesApi(api_client)
14+
response = api_instance.list_archive_searches()
15+
16+
print(response)
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
"""
2+
Rehydrate an Archive Search returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.logs_archive_searches_api import LogsArchiveSearchesApi
8+
from datadog_api_client.v2.model.archive_search_rehydrate_request import ArchiveSearchRehydrateRequest
9+
from datadog_api_client.v2.model.archive_search_rehydrate_request_attributes import (
10+
ArchiveSearchRehydrateRequestAttributes,
11+
)
12+
from datadog_api_client.v2.model.archive_search_rehydrate_request_data import ArchiveSearchRehydrateRequestData
13+
from datadog_api_client.v2.model.archive_search_rehydrate_request_rehydration import (
14+
ArchiveSearchRehydrateRequestRehydration,
15+
)
16+
from datadog_api_client.v2.model.archive_search_rehydration_tier import ArchiveSearchRehydrationTier
17+
from datadog_api_client.v2.model.archive_search_type import ArchiveSearchType
18+
19+
body = ArchiveSearchRehydrateRequest(
20+
data=ArchiveSearchRehydrateRequestData(
21+
attributes=ArchiveSearchRehydrateRequestAttributes(
22+
rehydration=ArchiveSearchRehydrateRequestRehydration(
23+
retention_days=15,
24+
tier=ArchiveSearchRehydrationTier.STANDARD,
25+
),
26+
),
27+
type=ArchiveSearchType.ARCHIVE_SEARCH,
28+
),
29+
)
30+
31+
configuration = Configuration()
32+
configuration.access_token = environ["DD_BEARER_TOKEN"]
33+
configuration.unstable_operations["rehydrate_archive_search"] = True
34+
with ApiClient(configuration) as api_client:
35+
api_instance = LogsArchiveSearchesApi(api_client)
36+
response = api_instance.rehydrate_archive_search(archive_search_id="archive_search_id", body=body)
37+
38+
print(response)

‎src/datadog_api_client/configuration.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -710,8 +710,11 @@ def __init__(
710710
"v2.list_jira_accounts": False,
711711
"v2.list_jira_issue_templates": False,
712712
"v2.update_jira_issue_template": False,
713+
"v2.cancel_archive_search": False,
713714
"v2.create_archive_search": False,
714715
"v2.get_archive_search": False,
716+
"v2.list_archive_searches": False,
717+
"v2.rehydrate_archive_search": False,
715718
"v2.add_role_to_restriction_query": False,
716719
"v2.create_restriction_query": False,
717720
"v2.delete_restriction_query": False,

0 commit comments

Comments
 (0)