GET https://api.ap1.datadoghq.com/api/v2/org_connections https://api.ap2.datadoghq.com/api/v2/org_connections https://api.datadoghq.eu/api/v2/org_connections https://api.ddog-gov.com/api/v2/org_connections https://api.us2.ddog-gov.com/api/v2/org_connections https://api.datadoghq.com/api/v2/org_connections https://api.us3.datadoghq.com/api/v2/org_connections https://api.us5.datadoghq.com/api/v2/org_connections
Overview Returns a list of org connections.
This endpoint requires the org_connections_read permission.
OAuth apps require the org_connections_read authorization scope to access this endpoint.
Arguments Query Strings The Org ID of the sink org.
The Org ID of the source org.
The limit of number of entries you want to return. Default is 1000.
The pagination offset which you want to query from. Default is 0.
Response OK
Response containing a list of org connections.
Expand All
Org connection attributes.
connection_types [required ]
List of connection types.
Timestamp when the connection was created.
The unique identifier of the org connection.
Related organizations and user.
The data for a user relationship.
The type of the user relationship.
Allowed enum values: users
The definition of OrgConnectionOrgRelationshipData object.
The type of the organization relationship.
Allowed enum values: orgs
The definition of OrgConnectionOrgRelationshipData object.
The type of the organization relationship.
Allowed enum values: orgs
Org connection type.
Allowed enum values: org_connection
Total number of org connections.
Total number of org connections matching the filter.
{
"data" : [
{
"attributes" : {
"connection_types" : [
"logs" ,
"metrics"
],
"created_at" : "2023-01-01T12:00:00Z"
},
"id" : "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a" ,
"relationships" : {
"created_by" : {
"data" : {
"id" : "usr123abc456" ,
"name" : "John Doe" ,
"type" : "users"
}
},
"sink_org" : {
"data" : {
"id" : "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a" ,
"name" : "Example Org" ,
"type" : "orgs"
}
},
"source_org" : {
"data" : {
"id" : "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a" ,
"name" : "Example Org" ,
"type" : "orgs"
}
}
},
"type" : "org_connection"
}
],
"meta" : {
"page" : {
"total_count" : 0 ,
"total_filtered_count" : 0
}
}
} Unauthorized
{
"errors" : [
"Bad Request"
]
} Forbidden
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/org_connections " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
List Org Connections returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.org_connections_api import OrgConnectionsApi
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = OrgConnectionsApi ( api_client )
response = api_instance . list_org_connections ()
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# List Org Connections returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: OrgConnectionsAPI . new
p api_instance . list_org_connections ()
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// List Org Connections returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewOrgConnectionsApi ( apiClient )
resp , r , err := api . ListOrgConnections ( ctx , * datadogV2 . NewListOrgConnectionsOptionalParameters ())
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `OrgConnectionsApi.ListOrgConnections`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `OrgConnectionsApi.ListOrgConnections`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// List Org Connections returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.OrgConnectionsApi ;
import com.datadog.api.client.v2.model.OrgConnectionListResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
OrgConnectionsApi apiInstance = new OrgConnectionsApi ( defaultClient );
try {
OrgConnectionListResponse result = apiInstance . listOrgConnections ();
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling OrgConnectionsApi#listOrgConnections" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// List Org Connections returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_org_connections ::ListOrgConnectionsOptionalParams ;
use datadog_api_client ::datadogV2 ::api_org_connections ::OrgConnectionsAPI ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = OrgConnectionsAPI ::with_config ( configuration );
let resp = api
. list_org_connections ( ListOrgConnectionsOptionalParams ::default ())
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* List Org Connections returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . OrgConnectionsApi ( configuration );
apiInstance
. listOrgConnections ()
. then (( data : v2.OrgConnectionListResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"