Skip to content

Commit 7da16f1

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Create OpenAPI for HAMR endpoints (#3104)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent d42d896 commit 7da16f1

19 files changed

+1023
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25944,6 +25944,171 @@ components:
2594425944
- type
2594525945
- value
2594625946
type: object
25947+
HamrOrgConnectionAttributesRequest:
25948+
properties:
25949+
hamr_status:
25950+
$ref: '#/components/schemas/HamrOrgConnectionStatus'
25951+
is_primary:
25952+
description: 'Indicates whether this organization is the primary organization
25953+
in the HAMR relationship.
25954+
25955+
If true, this is the primary organization. If false, this is the secondary/backup
25956+
organization.'
25957+
example: true
25958+
type: boolean
25959+
modified_by:
25960+
description: Username or identifier of the user who last modified this HAMR
25961+
connection.
25962+
example: admin@example.com
25963+
type: string
25964+
target_org_datacenter:
25965+
description: Datacenter location of the target organization (e.g., us1,
25966+
eu1, us5).
25967+
example: us1
25968+
type: string
25969+
target_org_name:
25970+
description: Name of the target organization in the HAMR relationship.
25971+
example: Production Backup Org
25972+
type: string
25973+
target_org_uuid:
25974+
description: UUID of the target organization in the HAMR relationship.
25975+
example: 660f9511-f3ac-52e5-b827-557766551111
25976+
type: string
25977+
required:
25978+
- target_org_uuid
25979+
- target_org_name
25980+
- target_org_datacenter
25981+
- hamr_status
25982+
- is_primary
25983+
- modified_by
25984+
type: object
25985+
HamrOrgConnectionAttributesResponse:
25986+
properties:
25987+
hamr_status:
25988+
$ref: '#/components/schemas/HamrOrgConnectionStatus'
25989+
is_primary:
25990+
description: 'Indicates whether this organization is the primary organization
25991+
in the HAMR relationship.
25992+
25993+
If true, this is the primary organization. If false, this is the secondary/backup
25994+
organization.'
25995+
example: true
25996+
type: boolean
25997+
modified_at:
25998+
description: Timestamp of when this HAMR connection was last modified (RFC3339
25999+
format).
26000+
example: '2026-01-13T17:26:48.830968Z'
26001+
type: string
26002+
modified_by:
26003+
description: Username or identifier of the user who last modified this HAMR
26004+
connection.
26005+
example: admin@example.com
26006+
type: string
26007+
target_org_datacenter:
26008+
description: Datacenter location of the target organization (e.g., us1,
26009+
eu1, us5).
26010+
example: us1
26011+
type: string
26012+
target_org_name:
26013+
description: Name of the target organization in the HAMR relationship.
26014+
example: Production Backup Org
26015+
type: string
26016+
target_org_uuid:
26017+
description: UUID of the target organization in the HAMR relationship.
26018+
example: 660f9511-f3ac-52e5-b827-557766551111
26019+
type: string
26020+
required:
26021+
- target_org_uuid
26022+
- target_org_name
26023+
- target_org_datacenter
26024+
- hamr_status
26025+
- is_primary
26026+
- modified_at
26027+
- modified_by
26028+
type: object
26029+
HamrOrgConnectionDataRequest:
26030+
properties:
26031+
attributes:
26032+
$ref: '#/components/schemas/HamrOrgConnectionAttributesRequest'
26033+
id:
26034+
description: The organization UUID for this HAMR connection. Must match
26035+
the authenticated organization's UUID.
26036+
example: 550e8400-e29b-41d4-a716-446655440000
26037+
type: string
26038+
type:
26039+
$ref: '#/components/schemas/HamrOrgConnectionType'
26040+
required:
26041+
- id
26042+
- type
26043+
- attributes
26044+
type: object
26045+
HamrOrgConnectionDataResponse:
26046+
properties:
26047+
attributes:
26048+
$ref: '#/components/schemas/HamrOrgConnectionAttributesResponse'
26049+
id:
26050+
description: The organization UUID for this HAMR connection.
26051+
example: 550e8400-e29b-41d4-a716-446655440000
26052+
type: string
26053+
type:
26054+
$ref: '#/components/schemas/HamrOrgConnectionType'
26055+
required:
26056+
- id
26057+
- type
26058+
- attributes
26059+
type: object
26060+
HamrOrgConnectionRequest:
26061+
properties:
26062+
data:
26063+
$ref: '#/components/schemas/HamrOrgConnectionDataRequest'
26064+
required:
26065+
- data
26066+
type: object
26067+
HamrOrgConnectionResponse:
26068+
properties:
26069+
data:
26070+
$ref: '#/components/schemas/HamrOrgConnectionDataResponse'
26071+
required:
26072+
- data
26073+
type: object
26074+
HamrOrgConnectionStatus:
26075+
description: 'Status of the HAMR connection:
26076+
26077+
- 0: UNSPECIFIED - Connection status not specified
26078+
26079+
- 1: ONBOARDING - Initial setup of HAMR connection
26080+
26081+
- 2: PASSIVE - Secondary organization in passive standby mode
26082+
26083+
- 3: FAILOVER - Liminal status between PASSIVE and ACTIVE
26084+
26085+
- 4: ACTIVE - Organization is an active failover
26086+
26087+
- 5: RECOVERY - Recovery operation in progress'
26088+
enum:
26089+
- 0
26090+
- 1
26091+
- 2
26092+
- 3
26093+
- 4
26094+
- 5
26095+
example: 4
26096+
type: integer
26097+
x-enum-varnames:
26098+
- UNSPECIFIED
26099+
- ONBOARDING
26100+
- PASSIVE
26101+
- FAILOVER
26102+
- ACTIVE
26103+
- RECOVERY
26104+
HamrOrgConnectionType:
26105+
description: Type of the HAMR organization connection resource.
26106+
enum:
26107+
- hamr_org_connections
26108+
example: hamr_org_connections
26109+
type: string
26110+
x-enum-varnames:
26111+
- HAMR_ORG_CONNECTIONS
2594726112
HourlyUsage:
2594826113
description: Hourly usage for a product family for an org.
2594926114
properties:
@@ -71733,6 +71898,105 @@ paths:
7173371898
operator: OR
7173471899
permissions:
7173571900
- events_read
71901+
/api/v2/hamr:
71902+
get:
71903+
description: 'Retrieve the High Availability Multi-Region (HAMR) organization
71904+
connection details for the authenticated organization.
71905+
71906+
This endpoint returns information about the HAMR connection configuration,
71907+
including the target organization,
71908+
71909+
datacenter, status, and whether this is the primary or secondary organization
71910+
in the HAMR relationship.'
71911+
operationId: GetHamrOrgConnection
71912+
responses:
71913+
'200':
71914+
content:
71915+
application/json:
71916+
schema:
71917+
$ref: '#/components/schemas/HamrOrgConnectionResponse'
71918+
description: OK
71919+
'400':
71920+
content:
71921+
application/json:
71922+
schema:
71923+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71924+
description: Bad Request
71925+
'403':
71926+
content:
71927+
application/json:
71928+
schema:
71929+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71930+
description: Forbidden
71931+
'404':
71932+
content:
71933+
application/json:
71934+
schema:
71935+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71936+
description: Not Found
71937+
'429':
71938+
$ref: '#/components/responses/TooManyRequestsResponse'
71939+
security:
71940+
- apiKeyAuth: []
71941+
appKeyAuth: []
71942+
summary: Get HAMR organization connection
71943+
tags:
71944+
- High Availability MultiRegion
71945+
x-unstable: '**Note**: This endpoint is in public beta and is subject to change.
71946+
71947+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
71948+
post:
71949+
description: 'Create or update the High Availability Multi-Region (HAMR) organization
71950+
connection.
71951+
71952+
This endpoint allows you to configure the HAMR connection between the authenticated
71953+
organization
71954+
71955+
and a target organization, including setting the connection status (ONBOARDING,
71956+
PASSIVE, FAILOVER, ACTIVE, RECOVERY)'
71957+
operationId: CreateHamrOrgConnection
71958+
requestBody:
71959+
content:
71960+
application/json:
71961+
schema:
71962+
$ref: '#/components/schemas/HamrOrgConnectionRequest'
71963+
required: true
71964+
responses:
71965+
'200':
71966+
content:
71967+
application/json:
71968+
schema:
71969+
$ref: '#/components/schemas/HamrOrgConnectionResponse'
71970+
description: OK
71971+
'400':
71972+
content:
71973+
application/json:
71974+
schema:
71975+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71976+
description: Bad Request
71977+
'403':
71978+
content:
71979+
application/json:
71980+
schema:
71981+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71982+
description: Forbidden
71983+
'429':
71984+
$ref: '#/components/responses/TooManyRequestsResponse'
71985+
'500':
71986+
content:
71987+
application/json:
71988+
schema:
71989+
$ref: '#/components/schemas/JSONAPIErrorResponse'
71990+
description: Internal Server Error
71991+
security:
71992+
- apiKeyAuth: []
71993+
appKeyAuth: []
71994+
summary: Create or update HAMR organization connection
71995+
tags:
71996+
- High Availability MultiRegion
71997+
x-unstable: '**Note**: This endpoint is in public beta and is subject to change.
71998+
71999+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
7173672000
/api/v2/incidents:
7173772001
get:
7173872002
description: Get all incidents for the user's organization.
@@ -94116,6 +94380,14 @@ tags:
9411694380
externalDocs:
9411794381
url: https://docs.datadoghq.com/integrations/google_cloud_platform
9411894382
name: GCP Integration
94383+
- description: 'Configure High Availability Multi-Region (HAMR) connections between
94384+
Datadog organizations.
94385+
94386+
HAMR provides disaster recovery capabilities by maintaining synchronized data
94387+
between primary
94388+
94389+
and secondary organizations across different datacenters.'
94390+
name: High Availability MultiRegion
9411994391
- description: 'The IP allowlist API is used to manage the IP addresses that
9412094392

9412194393
can access the Datadog API and web UI. It does not block

docs/datadog_api_client.v2.api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,13 @@ datadog\_api\_client.v2.api.gcp\_integration\_api module
277277
:members:
278278
:show-inheritance:
279279

280+
datadog\_api\_client.v2.api.high\_availability\_multi\_region\_api module
281+
-------------------------------------------------------------------------
282+
283+
.. automodule:: datadog_api_client.v2.api.high_availability_multi_region_api
284+
:members:
285+
:show-inheritance:
286+
280287
datadog\_api\_client.v2.api.incident\_services\_api module
281288
----------------------------------------------------------
282289

docs/datadog_api_client.v2.model.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10861,6 +10861,62 @@ datadog\_api\_client.v2.model.group\_tags module
1086110861
:members:
1086210862
:show-inheritance:
1086310863

10864+
datadog\_api\_client.v2.model.hamr\_org\_connection\_attributes\_request module
10865+
-------------------------------------------------------------------------------
10866+
10867+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_attributes_request
10868+
:members:
10869+
:show-inheritance:
10870+
10871+
datadog\_api\_client.v2.model.hamr\_org\_connection\_attributes\_response module
10872+
--------------------------------------------------------------------------------
10873+
10874+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_attributes_response
10875+
:members:
10876+
:show-inheritance:
10877+
10878+
datadog\_api\_client.v2.model.hamr\_org\_connection\_data\_request module
10879+
-------------------------------------------------------------------------
10880+
10881+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_data_request
10882+
:members:
10883+
:show-inheritance:
10884+
10885+
datadog\_api\_client.v2.model.hamr\_org\_connection\_data\_response module
10886+
--------------------------------------------------------------------------
10887+
10888+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_data_response
10889+
:members:
10890+
:show-inheritance:
10891+
10892+
datadog\_api\_client.v2.model.hamr\_org\_connection\_request module
10893+
-------------------------------------------------------------------
10894+
10895+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_request
10896+
:members:
10897+
:show-inheritance:
10898+
10899+
datadog\_api\_client.v2.model.hamr\_org\_connection\_response module
10900+
--------------------------------------------------------------------
10901+
10902+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_response
10903+
:members:
10904+
:show-inheritance:
10905+
10906+
datadog\_api\_client.v2.model.hamr\_org\_connection\_status module
10907+
------------------------------------------------------------------
10908+
10909+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_status
10910+
:members:
10911+
:show-inheritance:
10912+
10913+
datadog\_api\_client.v2.model.hamr\_org\_connection\_type module
10914+
----------------------------------------------------------------
10915+
10916+
.. automodule:: datadog_api_client.v2.model.hamr_org_connection_type
10917+
:members:
10918+
:show-inheritance:
10919+
1086410920
datadog\_api\_client.v2.model.hourly\_usage module
1086510921
--------------------------------------------------
1086610922

0 commit comments

Comments
 (0)