Skip to content

Add Team Connection API Documentation #2936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2025
Merged

Add Team Connection API Documentation #2936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
369 changes: 369 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,13 @@ datadog\_api\_client.v2.api.synthetics\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.team\_connections\_api module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.team_connections_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.teams\_api module
---------------------------------------------

Expand Down
119 changes: 119 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4484,6 +4484,27 @@ datadog\_api\_client.v2.model.confluent\_resources\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.connected\_team\_ref module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.connected_team_ref
:members:
:show-inheritance:

datadog\_api\_client.v2.model.connected\_team\_ref\_data module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.connected_team_ref_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.connected\_team\_ref\_data\_type module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.connected_team_ref_data_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.connection module
-----------------------------------------------

Expand Down Expand Up @@ -4512,6 +4533,20 @@ datadog\_api\_client.v2.model.connection\_group module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.connections\_page\_pagination module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.connections_page_pagination
:members:
:show-inheritance:

datadog\_api\_client.v2.model.connections\_response\_meta module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.connections_response_meta
:members:
:show-inheritance:

datadog\_api\_client.v2.model.container module
----------------------------------------------

Expand Down Expand Up @@ -22628,6 +22663,69 @@ datadog\_api\_client.v2.model.team\_attributes module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection module
-----------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection\_attributes module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection\_create\_data module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection_create_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection\_create\_request module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection\_delete\_request module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection_delete_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection\_delete\_request\_data\_item module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection_delete_request_data_item
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection\_relationships module
--------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection_relationships
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connection\_type module
-----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connection_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_connections\_response module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_connections_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_create module
-------------------------------------------------

Expand Down Expand Up @@ -22866,6 +22964,27 @@ datadog\_api\_client.v2.model.team\_permission\_settings\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_ref module
----------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_ref
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_ref\_data module
----------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_ref_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_ref\_data\_type module
----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.team_ref_data_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.team\_reference module
----------------------------------------------------

Expand Down
55 changes: 55 additions & 0 deletions examples/v2/team-connections/CreateTeamConnections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
"""
Create team connections returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi
from datadog_api_client.v2.model.connected_team_ref import ConnectedTeamRef
from datadog_api_client.v2.model.connected_team_ref_data import ConnectedTeamRefData
from datadog_api_client.v2.model.connected_team_ref_data_type import ConnectedTeamRefDataType
from datadog_api_client.v2.model.team_connection_attributes import TeamConnectionAttributes
from datadog_api_client.v2.model.team_connection_create_data import TeamConnectionCreateData
from datadog_api_client.v2.model.team_connection_create_request import TeamConnectionCreateRequest
from datadog_api_client.v2.model.team_connection_relationships import TeamConnectionRelationships
from datadog_api_client.v2.model.team_connection_type import TeamConnectionType
from datadog_api_client.v2.model.team_ref import TeamRef
from datadog_api_client.v2.model.team_ref_data import TeamRefData
from datadog_api_client.v2.model.team_ref_data_type import TeamRefDataType

# there is a valid "dd_team" in the system
DD_TEAM_DATA_ID = environ["DD_TEAM_DATA_ID"]

body = TeamConnectionCreateRequest(
data=[
TeamConnectionCreateData(
type=TeamConnectionType.TEAM_CONNECTION,
attributes=TeamConnectionAttributes(
source="github",
managed_by="datadog",
),
relationships=TeamConnectionRelationships(
team=TeamRef(
data=TeamRefData(
id=DD_TEAM_DATA_ID,
type=TeamRefDataType.TEAM,
),
),
connected_team=ConnectedTeamRef(
data=ConnectedTeamRefData(
id="@MyGitHubAccount/my-team-name",
type=ConnectedTeamRefDataType.GITHUB_TEAM,
),
),
),
),
],
)

configuration = Configuration()
configuration.unstable_operations["create_team_connections"] = True
with ApiClient(configuration) as api_client:
api_instance = TeamConnectionsApi(api_client)
response = api_instance.create_team_connections(body=body)

print(response)
24 changes: 24 additions & 0 deletions examples/v2/team-connections/DeleteTeamConnections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""
Delete team connections returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi
from datadog_api_client.v2.model.team_connection_delete_request import TeamConnectionDeleteRequest
from datadog_api_client.v2.model.team_connection_delete_request_data_item import TeamConnectionDeleteRequestDataItem
from datadog_api_client.v2.model.team_connection_type import TeamConnectionType

body = TeamConnectionDeleteRequest(
data=[
TeamConnectionDeleteRequestDataItem(
id="12345678-1234-5678-9abc-123456789012",
type=TeamConnectionType.TEAM_CONNECTION,
),
],
)

configuration = Configuration()
configuration.unstable_operations["delete_team_connections"] = True
with ApiClient(configuration) as api_client:
api_instance = TeamConnectionsApi(api_client)
api_instance.delete_team_connections(body=body)
14 changes: 14 additions & 0 deletions examples/v2/team-connections/ListTeamConnections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List team connections returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi

configuration = Configuration()
configuration.unstable_operations["list_team_connections"] = True
with ApiClient(configuration) as api_client:
api_instance = TeamConnectionsApi(api_client)
response = api_instance.list_team_connections()

print(response)
19 changes: 19 additions & 0 deletions examples/v2/team-connections/ListTeamConnections_1473516764.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
List team connections with filters returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi

configuration = Configuration()
configuration.unstable_operations["list_team_connections"] = True
with ApiClient(configuration) as api_client:
api_instance = TeamConnectionsApi(api_client)
response = api_instance.list_team_connections(
page_size=10,
filter_sources=[
"github",
],
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/team-connections/ListTeamConnections_2418873869.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List team connections returns "OK" response with pagination
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.team_connections_api import TeamConnectionsApi

configuration = Configuration()
configuration.unstable_operations["list_team_connections"] = True
with ApiClient(configuration) as api_client:
api_instance = TeamConnectionsApi(api_client)
items = api_instance.list_team_connections_with_pagination()
for item in items:
print(item)
3 changes: 3 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,9 @@ def __init__(
"v2.list_member_teams": False,
"v2.remove_member_team": False,
"v2.sync_teams": False,
"v2.create_team_connections": False,
"v2.delete_team_connections": False,
"v2.list_team_connections": False,
"v2.create_incident_team": False,
"v2.delete_incident_team": False,
"v2.get_incident_team": False,
Expand Down
Loading