Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
PATCH https://api.ap1.datadoghq.com/api/v2/org_group_policy_overrides/{org_group_policy_override_id} https://api.ap2.datadoghq.com/api/v2/org_group_policy_overrides/{org_group_policy_override_id} https://api.datadoghq.eu/api/v2/org_group_policy_overrides/{org_group_policy_override_id} https://api.ddog-gov.com/api/v2/org_group_policy_overrides/{org_group_policy_override_id} https://api.us2.ddog-gov.com/api/v2/org_group_policy_overrides/{org_group_policy_override_id} https://api.datadoghq.com/api/v2/org_group_policy_overrides/{org_group_policy_override_id} https://api.us3.datadoghq.com/api/v2/org_group_policy_overrides/{org_group_policy_override_id} https://api.us5.datadoghq.com/api/v2/org_group_policy_overrides/{org_group_policy_override_id}
Overview Update an existing organization group policy override.
This endpoint requires the org_group_write permission.
Arguments Path Parameters org_group_policy_override_id [required ]
The ID of the org group policy override.
Request Body Data (required)
Expand All
Data for updating a policy override.
Attributes for updating a policy override. The org_uuid and org_site fields must match the existing override and cannot be changed.
The site of the organization.
The UUID of the organization.
The ID of the policy override.
Org group policy overrides resource type.
Allowed enum values: org_group_policy_overrides
{
"data" : {
"attributes" : {
"org_site" : "us1" ,
"org_uuid" : "c3d4e5f6-a7b8-9012-cdef-012345678901"
},
"id" : "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ,
"type" : "org_group_policy_overrides"
}
} Response OK
Response containing a single org group policy override.
Expand All
An org group policy override resource.
Attributes of an org group policy override.
The override content as key-value pairs.
Timestamp when the override was created.
Timestamp when the override was last modified.
The site of the organization that has the override.
The UUID of the organization that has the override.
The ID of the policy override.
Relationships of an org group policy override.
Relationship to a single org group.
A reference to an org group.
Org groups resource type.
Allowed enum values: org_groups
Relationship to a single org group policy.
A reference to an org group policy.
Org group policies resource type.
Allowed enum values: org_group_policies
Org group policy overrides resource type.
Allowed enum values: org_group_policy_overrides
{
"data" : {
"attributes" : {
"content" : {},
"created_at" : "2024-01-15T10:30:00Z" ,
"modified_at" : "2024-01-15T10:30:00Z" ,
"org_site" : "us1" ,
"org_uuid" : "c3d4e5f6-a7b8-9012-cdef-012345678901"
},
"id" : "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ,
"relationships" : {
"org_group" : {
"data" : {
"id" : "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ,
"type" : "org_groups"
}
},
"org_group_policy" : {
"data" : {
"id" : "1a2b3c4d-5e6f-7890-abcd-ef0123456789" ,
"type" : "org_group_policies"
}
}
},
"type" : "org_group_policy_overrides"
}
} 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"
}
]
} Not Found
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
#
# Path parameters export org_group_policy_override_id = "9f8e7d6c-5b4a-3210-fedc-ba0987654321" # Curl command curl -X PATCH "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_group_policy_overrides/${org_group_policy_override_id} " \
-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": {
"org_site": "us1",
"org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
},
"id": "9f8e7d6c-5b4a-3210-fedc-ba0987654321",
"type": "org_group_policy_overrides"
}
}
EOF
"""
Update an org group policy override returns "OK" 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_policy_override_type import OrgGroupPolicyOverrideType
from datadog_api_client.v2.model.org_group_policy_override_update_attributes import (
OrgGroupPolicyOverrideUpdateAttributes ,
)
from datadog_api_client.v2.model.org_group_policy_override_update_data import OrgGroupPolicyOverrideUpdateData
from datadog_api_client.v2.model.org_group_policy_override_update_request import OrgGroupPolicyOverrideUpdateRequest
from uuid import UUID
body = OrgGroupPolicyOverrideUpdateRequest (
data = OrgGroupPolicyOverrideUpdateData (
attributes = OrgGroupPolicyOverrideUpdateAttributes (
org_site = "us1" ,
org_uuid = UUID ( "c3d4e5f6-a7b8-9012-cdef-012345678901" ),
),
id = UUID ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ),
type = OrgGroupPolicyOverrideType . ORG_GROUP_POLICY_OVERRIDES ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "update_org_group_policy_override" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = OrgGroupsApi ( api_client )
response = api_instance . update_org_group_policy_override (
org_group_policy_override_id = UUID ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ), 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"
# Update an org group policy override returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.update_org_group_policy_override" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: OrgGroupsAPI . new
body = DatadogAPIClient :: V2 :: OrgGroupPolicyOverrideUpdateRequest . new ({
data : DatadogAPIClient :: V2 :: OrgGroupPolicyOverrideUpdateData . new ({
attributes : DatadogAPIClient :: V2 :: OrgGroupPolicyOverrideUpdateAttributes . new ({
org_site : "us1" ,
org_uuid : "c3d4e5f6-a7b8-9012-cdef-012345678901" ,
}),
id : "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ,
type : DatadogAPIClient :: V2 :: OrgGroupPolicyOverrideType :: ORG_GROUP_POLICY_OVERRIDES ,
}),
})
p api_instance . update_org_group_policy_override ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" , 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"
// Update an org group policy override 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"
"github.com/google/uuid"
)
func main () {
body := datadogV2 . OrgGroupPolicyOverrideUpdateRequest {
Data : datadogV2 . OrgGroupPolicyOverrideUpdateData {
Attributes : datadogV2 . OrgGroupPolicyOverrideUpdateAttributes {
OrgSite : "us1" ,
OrgUuid : uuid . MustParse ( "c3d4e5f6-a7b8-9012-cdef-012345678901" ),
},
Id : uuid . MustParse ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ),
Type : datadogV2 . ORGGROUPPOLICYOVERRIDETYPE_ORG_GROUP_POLICY_OVERRIDES ,
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.UpdateOrgGroupPolicyOverride" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewOrgGroupsApi ( apiClient )
resp , r , err := api . UpdateOrgGroupPolicyOverride ( ctx , uuid . MustParse ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ), body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `OrgGroupsApi.UpdateOrgGroupPolicyOverride`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `OrgGroupsApi.UpdateOrgGroupPolicyOverride`:\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"
// Update an org group policy override returns "OK" 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.OrgGroupPolicyOverrideResponse ;
import com.datadog.api.client.v2.model.OrgGroupPolicyOverrideType ;
import com.datadog.api.client.v2.model.OrgGroupPolicyOverrideUpdateAttributes ;
import com.datadog.api.client.v2.model.OrgGroupPolicyOverrideUpdateData ;
import com.datadog.api.client.v2.model.OrgGroupPolicyOverrideUpdateRequest ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.updateOrgGroupPolicyOverride" , true );
OrgGroupsApi apiInstance = new OrgGroupsApi ( defaultClient );
OrgGroupPolicyOverrideUpdateRequest body =
new OrgGroupPolicyOverrideUpdateRequest ()
. data (
new OrgGroupPolicyOverrideUpdateData ()
. attributes (
new OrgGroupPolicyOverrideUpdateAttributes ()
. orgSite ( "us1" )
. orgUuid ( UUID . fromString ( "c3d4e5f6-a7b8-9012-cdef-012345678901" )))
. id ( UUID . fromString ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ))
. type ( OrgGroupPolicyOverrideType . ORG_GROUP_POLICY_OVERRIDES ));
try {
OrgGroupPolicyOverrideResponse result =
apiInstance . updateOrgGroupPolicyOverride (
UUID . fromString ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ), body );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling OrgGroupsApi#updateOrgGroupPolicyOverride" );
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"
// Update an org group policy override returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_org_groups ::OrgGroupsAPI ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupPolicyOverrideType ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupPolicyOverrideUpdateAttributes ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupPolicyOverrideUpdateData ;
use datadog_api_client ::datadogV2 ::model ::OrgGroupPolicyOverrideUpdateRequest ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let body = OrgGroupPolicyOverrideUpdateRequest ::new ( OrgGroupPolicyOverrideUpdateData ::new (
OrgGroupPolicyOverrideUpdateAttributes ::new (
"us1" . to_string (),
Uuid ::parse_str ( "c3d4e5f6-a7b8-9012-cdef-012345678901" ). expect ( "invalid UUID" ),
),
Uuid ::parse_str ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ). expect ( "invalid UUID" ),
OrgGroupPolicyOverrideType ::ORG_GROUP_POLICY_OVERRIDES ,
));
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.UpdateOrgGroupPolicyOverride" , true );
let api = OrgGroupsAPI ::with_config ( configuration );
let resp = api
. update_org_group_policy_override (
Uuid ::parse_str ( "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ). expect ( "invalid UUID" ),
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
/**
* Update an org group policy override returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.updateOrgGroupPolicyOverride" ] = true ;
const apiInstance = new v2 . OrgGroupsApi ( configuration );
const params : v2.OrgGroupsApiUpdateOrgGroupPolicyOverrideRequest = {
body : {
data : {
attributes : {
orgSite : "us1" ,
orgUuid : "c3d4e5f6-a7b8-9012-cdef-012345678901" ,
},
id : "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ,
type : "org_group_policy_overrides" ,
},
},
orgGroupPolicyOverrideId : "9f8e7d6c-5b4a-3210-fedc-ba0987654321" ,
};
apiInstance
. updateOrgGroupPolicyOverride ( params )
. then (( data : v2.OrgGroupPolicyOverrideResponse ) => {
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"