Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
POST https://api.ap1.datadoghq.com/api/v2/org_groups https://api.ap2.datadoghq.com/api/v2/org_groups https://api.datadoghq.eu/api/v2/org_groups https://api.ddog-gov.com/api/v2/org_groups https://api.us2.ddog-gov.com/api/v2/org_groups https://api.datadoghq.com/api/v2/org_groups https://api.us3.datadoghq.com/api/v2/org_groups https://api.us5.datadoghq.com/api/v2/org_groups
Overview Create a new organization group.
This endpoint requires the org_group_write permission.
Request Body Data (required)
Expand All
Data for creating an org group.
Attributes for creating an org group.
The name of the org group.
Org groups resource type.
Allowed enum values: org_groups
{
"data" : {
"attributes" : {
"name" : "My Org Group"
},
"type" : "org_groups"
}
} Response Created
Response containing a single org group.
Expand All
Attributes of an org group.
Timestamp when the org group was created.
Timestamp when the org group was last modified.
The name of the org group.
owner_org_site [required ]
The site of the organization that owns this org group.
owner_org_uuid [required ]
The UUID of the organization that owns this org group.
Org groups resource type.
Allowed enum values: org_groups
{
"data" : {
"attributes" : {
"created_at" : "2024-01-15T10:30:00Z" ,
"modified_at" : "2024-01-15T10:30:00Z" ,
"name" : "My Org Group" ,
"owner_org_site" : "us1" ,
"owner_org_uuid" : "b2c3d4e5-f6a7-8901-bcde-f01234567890"
},
"id" : "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ,
"type" : "org_groups"
}
} Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Unauthorized
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Forbidden
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Conflict
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
## default
#
# Curl command curl -X POST "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_groups " \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"data": {
"attributes": {
"name": "My Org Group"
},
"type": "org_groups"
}
}
EOF
"""
Create an org group returns "Created" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.org_groups_api import OrgGroupsApi
from datadog_api_client.v2.model.org_group_create_attributes import OrgGroupCreateAttributes
from datadog_api_client.v2.model.org_group_create_data import OrgGroupCreateData
from datadog_api_client.v2.model.org_group_create_request import OrgGroupCreateRequest
from datadog_api_client.v2.model.org_group_type import OrgGroupType
body = OrgGroupCreateRequest (
data = OrgGroupCreateData (
attributes = OrgGroupCreateAttributes (
name = "My Org Group" ,
),
type = OrgGroupType . ORG_GROUPS ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "create_org_group" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = OrgGroupsApi ( api_client )
response = api_instance . create_org_group ( body = body )
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 = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# Create an org group returns "Created" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.create_org_group" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: OrgGroupsAPI . new
body = DatadogAPIClient :: V2 :: OrgGroupCreateRequest . new ({
data : DatadogAPIClient :: V2 :: OrgGroupCreateData . new ({
attributes : DatadogAPIClient :: V2 :: OrgGroupCreateAttributes . new ({
name : "My Org Group" ,
}),
type : DatadogAPIClient :: V2 :: OrgGroupType :: ORG_GROUPS ,
}),
})
p api_instance . create_org_group ( body )
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 = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// Create an org group returns "Created" 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 () {
body := datadogV2 . OrgGroupCreateRequest {
Data : datadogV2 . OrgGroupCreateData {
Attributes : datadogV2 . OrgGroupCreateAttributes {
Name : "My Org Group" ,
},
Type : datadogV2 . ORGGROUPTYPE_ORG_GROUPS ,
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.CreateOrgGroup" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewOrgGroupsApi ( apiClient )
resp , r , err := api . CreateOrgGroup ( ctx , body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `OrgGroupsApi.CreateOrgGroup`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `OrgGroupsApi.CreateOrgGroup`:\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 = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// Create an org group returns "Created" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.OrgGroupsApi ;
import com.datadog.api.client.v2.model.OrgGroupCreateAttributes ;
import com.datadog.api.client.v2.model.OrgGroupCreateData ;
import com.datadog.api.client.v2.model.OrgGroupCreateRequest ;
import com.datadog.api.client.v2.model.OrgGroupResponse ;
import com.datadog.api.client.v2.model.OrgGroupType ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.createOrgGroup" , true );
OrgGroupsApi apiInstance = new OrgGroupsApi ( defaultClient );
OrgGroupCreateRequest body =
new OrgGroupCreateRequest ()
. data (
new OrgGroupCreateData ()
. attributes ( new OrgGroupCreateAttributes (). name ( "My Org Group" ))
. type ( OrgGroupType . ORG_GROUPS ));
try {
OrgGroupResponse result = apiInstance . createOrgGroup ( body );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling OrgGroupsApi#createOrgGroup" );
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 = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
// Create an org group returns "Created" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_org_groups ::OrgGroupsAPI ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupCreateAttributes ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupCreateData ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupCreateRequest ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupType ;
#[tokio::main]
async fn main () {
let body = OrgGroupCreateRequest ::new ( OrgGroupCreateData ::new (
OrgGroupCreateAttributes ::new ( "My Org Group" . to_string ()),
OrgGroupType ::ORG_GROUPS ,
));
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.CreateOrgGroup" , true );
let api = OrgGroupsAPI ::with_config ( configuration );
let resp = api . create_org_group ( body ). 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 = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* Create an org group returns "Created" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.createOrgGroup" ] = true ;
const apiInstance = new v2 . OrgGroupsApi ( configuration );
const params : v2.OrgGroupsApiCreateOrgGroupRequest = {
body : {
data : {
attributes : {
name : "My Org Group" ,
},
type : "org_groups" ,
},
},
};
apiInstance
. createOrgGroup ( params )
. then (( data : v2.OrgGroupResponse ) => {
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 = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"