Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

Org Groups

Manage organization groups, memberships, policies, policy overrides, and policy configurations.

List org groups

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_groupshttps://api.ap2.datadoghq.com/api/v2/org_groupshttps://api.datadoghq.eu/api/v2/org_groupshttps://api.ddog-gov.com/api/v2/org_groupshttps://api.us2.ddog-gov.com/api/v2/org_groupshttps://api.datadoghq.com/api/v2/org_groupshttps://api.us3.datadoghq.com/api/v2/org_groupshttps://api.us5.datadoghq.com/api/v2/org_groups

Overview

List all organization groups that the requesting organization has access to. This endpoint requires the org_group_read permission.

Arguments

Query Strings

Name

Type

Description

page[number]

integer

The page number to return.

page[size]

integer

The number of items per page. Maximum is 1000.

sort

enum

Field to sort org groups by. Supported values: name, uuid, -name, -uuid. Defaults to uuid.
Allowed enum values: name, -name, uuid, -uuid

Response

OK

Response containing a list of org groups.

Expand All

Field

Type

Description

data [required]

[object]

An array of org groups.

attributes [required]

object

Attributes of an org group.

created_at [required]

date-time

Timestamp when the org group was created.

modified_at [required]

date-time

Timestamp when the org group was last modified.

name [required]

string

The name of the org group.

owner_org_site [required]

string

The site of the organization that owns this org group.

owner_org_uuid [required]

uuid

The UUID of the organization that owns this org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

links

object

Pagination links for navigating between pages of an org group list response.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta

object

Pagination metadata for org group list responses.

page

object

Page-based pagination details for org group list responses.

first_number

int64

First page number.

last_number

int64

Last page number.

next_number

int64

Next page number.

number

int64

Page number.

prev_number

int64

Previous page number.

size

int64

Page size.

total

int64

Total number of results.

type

string

Pagination type.

{
  "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"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": "integer",
      "prev_number": "integer",
      "size": "integer",
      "total": "integer",
      "type": "number_size"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # 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_groups" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get an org group

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.ap2.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.datadoghq.eu/api/v2/org_groups/{org_group_id}https://api.ddog-gov.com/api/v2/org_groups/{org_group_id}https://api.us2.ddog-gov.com/api/v2/org_groups/{org_group_id}https://api.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.us3.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.us5.datadoghq.com/api/v2/org_groups/{org_group_id}

Overview

Get a specific organization group by its ID. This endpoint requires the org_group_read permission.

Arguments

Path Parameters

Name

Type

Description

org_group_id [required]

string

The ID of the org group.

Response

OK

Response containing a single org group.

Expand All

Field

Type

Description

data [required]

object

An org group resource.

attributes [required]

object

Attributes of an org group.

created_at [required]

date-time

Timestamp when the org group was created.

modified_at [required]

date-time

Timestamp when the org group was last modified.

name [required]

string

The name of the org group.

owner_org_site [required]

string

The site of the organization that owns this org group.

owner_org_uuid [required]

uuid

The UUID of the organization that owns this org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_group_id="a1b2c3d4-e5f6-7890-abcd-ef0123456789"
# 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_groups/${org_group_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Create an org group

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_groupshttps://api.ap2.datadoghq.com/api/v2/org_groupshttps://api.datadoghq.eu/api/v2/org_groupshttps://api.ddog-gov.com/api/v2/org_groupshttps://api.us2.ddog-gov.com/api/v2/org_groupshttps://api.datadoghq.com/api/v2/org_groupshttps://api.us3.datadoghq.com/api/v2/org_groupshttps://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

Field

Type

Description

data [required]

object

Data for creating an org group.

attributes [required]

object

Attributes for creating an org group.

name [required]

string

The name of the org group.

type [required]

enum

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

Field

Type

Description

data [required]

object

An org group resource.

attributes [required]

object

Attributes of an org group.

created_at [required]

date-time

Timestamp when the org group was created.

modified_at [required]

date-time

Timestamp when the org group was last modified.

name [required]

string

The name of the org group.

owner_org_site [required]

string

The site of the organization that owns this org group.

owner_org_uuid [required]

uuid

The UUID of the organization that owns this org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## 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

Update an org group

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_groups/{org_group_id}https://api.ap2.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.datadoghq.eu/api/v2/org_groups/{org_group_id}https://api.ddog-gov.com/api/v2/org_groups/{org_group_id}https://api.us2.ddog-gov.com/api/v2/org_groups/{org_group_id}https://api.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.us3.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.us5.datadoghq.com/api/v2/org_groups/{org_group_id}

Overview

Update the name of an existing organization group. This endpoint requires the org_group_write permission.

Arguments

Path Parameters

Name

Type

Description

org_group_id [required]

string

The ID of the org group.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for updating an org group.

attributes [required]

object

Attributes for updating an org group.

name [required]

string

The name of the org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

{
  "data": {
    "attributes": {
      "name": "Updated Org Group Name"
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
    "type": "org_groups"
  }
}

Response

OK

Response containing a single org group.

Expand All

Field

Type

Description

data [required]

object

An org group resource.

attributes [required]

object

Attributes of an org group.

created_at [required]

date-time

Timestamp when the org group was created.

modified_at [required]

date-time

Timestamp when the org group was last modified.

name [required]

string

The name of the org group.

owner_org_site [required]

string

The site of the organization that owns this org group.

owner_org_uuid [required]

uuid

The UUID of the organization that owns this org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export org_group_id="a1b2c3d4-e5f6-7890-abcd-ef0123456789"
# 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_groups/${org_group_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": {
      "name": "Updated Org Group Name"
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
    "type": "org_groups"
  }
}
EOF

Delete an org group

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

DELETE https://api.ap1.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.ap2.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.datadoghq.eu/api/v2/org_groups/{org_group_id}https://api.ddog-gov.com/api/v2/org_groups/{org_group_id}https://api.us2.ddog-gov.com/api/v2/org_groups/{org_group_id}https://api.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.us3.datadoghq.com/api/v2/org_groups/{org_group_id}https://api.us5.datadoghq.com/api/v2/org_groups/{org_group_id}

Overview

Delete an organization group by its ID. This endpoint requires the org_group_write permission.

Arguments

Path Parameters

Name

Type

Description

org_group_id [required]

string

The ID of the org group.

Response

No Content

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_group_id="a1b2c3d4-e5f6-7890-abcd-ef0123456789"
# Curl command
curl -X DELETE "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/${org_group_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List org group memberships

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_group_membershipshttps://api.ap2.datadoghq.com/api/v2/org_group_membershipshttps://api.datadoghq.eu/api/v2/org_group_membershipshttps://api.ddog-gov.com/api/v2/org_group_membershipshttps://api.us2.ddog-gov.com/api/v2/org_group_membershipshttps://api.datadoghq.com/api/v2/org_group_membershipshttps://api.us3.datadoghq.com/api/v2/org_group_membershipshttps://api.us5.datadoghq.com/api/v2/org_group_memberships

Overview

List organization group memberships. Filter by org group ID or org UUID. At least one of filter[org_group_id] or filter[org_uuid] must be provided. When filtering by org UUID, returns a single-item list with the membership for that org. This endpoint requires the org_group_read permission.

Arguments

Query Strings

Name

Type

Description

filter[org_group_id]

string

Filter memberships by org group ID. Required when filter[org_uuid] is not provided.

filter[org_uuid]

string

Filter memberships by org UUID. Returns a single-item list.

page[number]

integer

The page number to return.

page[size]

integer

The number of items per page. Maximum is 1000.

sort

enum

Field to sort memberships by. Supported values: name, uuid, -name, -uuid. Defaults to uuid.
Allowed enum values: name, -name, uuid, -uuid

Response

OK

Response containing a list of org group memberships.

Expand All

Field

Type

Description

data [required]

[object]

An array of org group memberships.

attributes [required]

object

Attributes of an org group membership.

created_at [required]

date-time

Timestamp when the membership was created.

modified_at [required]

date-time

Timestamp when the membership was last modified.

org_name [required]

string

The name of the member organization.

org_site [required]

string

The site of the member organization.

org_uuid [required]

uuid

The UUID of the member organization.

id [required]

uuid

The ID of the org group membership.

relationships

object

Relationships of an org group membership.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group memberships resource type. Allowed enum values: org_group_memberships

links

object

Pagination links for navigating between pages of an org group list response.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta

object

Pagination metadata for org group list responses.

page

object

Page-based pagination details for org group list responses.

first_number

int64

First page number.

last_number

int64

Last page number.

next_number

int64

Next page number.

number

int64

Page number.

prev_number

int64

Previous page number.

size

int64

Page size.

total

int64

Total number of results.

type

string

Pagination type.

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-15T10:30:00Z",
        "modified_at": "2024-01-15T10:30:00Z",
        "org_name": "Acme Corp",
        "org_site": "us1",
        "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
      },
      "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        }
      },
      "type": "org_group_memberships"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": "integer",
      "prev_number": "integer",
      "size": "integer",
      "total": "integer",
      "type": "number_size"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # 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_group_memberships" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get an org group membership

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.ap2.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.datadoghq.eu/api/v2/org_group_memberships/{org_group_membership_id}https://api.ddog-gov.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.us2.ddog-gov.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.us3.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.us5.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}

Overview

Get a specific organization group membership by its ID. This endpoint requires the org_group_read permission.

Arguments

Path Parameters

Name

Type

Description

org_group_membership_id [required]

string

The ID of the org group membership.

Response

OK

Response containing a single org group membership.

Expand All

Field

Type

Description

data [required]

object

An org group membership resource.

attributes [required]

object

Attributes of an org group membership.

created_at [required]

date-time

Timestamp when the membership was created.

modified_at [required]

date-time

Timestamp when the membership was last modified.

org_name [required]

string

The name of the member organization.

org_site [required]

string

The site of the member organization.

org_uuid [required]

uuid

The UUID of the member organization.

id [required]

uuid

The ID of the org group membership.

relationships

object

Relationships of an org group membership.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group memberships resource type. Allowed enum values: org_group_memberships

{
  "data": {
    "attributes": {
      "created_at": "2024-01-15T10:30:00Z",
      "modified_at": "2024-01-15T10:30:00Z",
      "org_name": "Acme Corp",
      "org_site": "us1",
      "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
    },
    "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_memberships"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_group_membership_id="f1e2d3c4-b5a6-7890-1234-567890abcdef"
# 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_group_memberships/${org_group_membership_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Update an org group membership

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_memberships/{org_group_membership_id}https://api.ap2.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.datadoghq.eu/api/v2/org_group_memberships/{org_group_membership_id}https://api.ddog-gov.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.us2.ddog-gov.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.us3.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}https://api.us5.datadoghq.com/api/v2/org_group_memberships/{org_group_membership_id}

Overview

Move an organization to a different org group by updating its membership. This endpoint requires the org_group_write permission.

Arguments

Path Parameters

Name

Type

Description

org_group_membership_id [required]

string

The ID of the org group membership.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for updating an org group membership.

id [required]

uuid

The ID of the membership.

relationships [required]

object

Relationships for updating a membership.

org_group [required]

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group memberships resource type. Allowed enum values: org_group_memberships

{
  "data": {
    "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_memberships"
  }
}

Response

OK

Response containing a single org group membership.

Expand All

Field

Type

Description

data [required]

object

An org group membership resource.

attributes [required]

object

Attributes of an org group membership.

created_at [required]

date-time

Timestamp when the membership was created.

modified_at [required]

date-time

Timestamp when the membership was last modified.

org_name [required]

string

The name of the member organization.

org_site [required]

string

The site of the member organization.

org_uuid [required]

uuid

The UUID of the member organization.

id [required]

uuid

The ID of the org group membership.

relationships

object

Relationships of an org group membership.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group memberships resource type. Allowed enum values: org_group_memberships

{
  "data": {
    "attributes": {
      "created_at": "2024-01-15T10:30:00Z",
      "modified_at": "2024-01-15T10:30:00Z",
      "org_name": "Acme Corp",
      "org_site": "us1",
      "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
    },
    "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_memberships"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export org_group_membership_id="f1e2d3c4-b5a6-7890-1234-567890abcdef"
# 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_memberships/${org_group_membership_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": {
    "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_memberships"
  }
}
EOF

Bulk update org group memberships

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_memberships/bulkhttps://api.ap2.datadoghq.com/api/v2/org_group_memberships/bulkhttps://api.datadoghq.eu/api/v2/org_group_memberships/bulkhttps://api.ddog-gov.com/api/v2/org_group_memberships/bulkhttps://api.us2.ddog-gov.com/api/v2/org_group_memberships/bulkhttps://api.datadoghq.com/api/v2/org_group_memberships/bulkhttps://api.us3.datadoghq.com/api/v2/org_group_memberships/bulkhttps://api.us5.datadoghq.com/api/v2/org_group_memberships/bulk

Overview

Move a batch of organizations from one org group to another. This is an atomic operation. Maximum 100 orgs per request. This endpoint requires the org_group_write permission.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for bulk updating org group memberships.

attributes [required]

object

Attributes for bulk updating org group memberships.

orgs [required]

[object]

List of organizations to move. Maximum 100 per request.

org_site [required]

string

The site of the organization.

org_uuid [required]

uuid

The UUID of the organization.

relationships [required]

object

Relationships for bulk updating memberships.

source_org_group [required]

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

target_org_group [required]

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group membership bulk update resource type. Allowed enum values: org_group_membership_bulk_updates

{
  "data": {
    "attributes": {
      "orgs": [
        {
          "org_site": "us1",
          "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
        }
      ]
    },
    "relationships": {
      "source_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      },
      "target_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_membership_bulk_updates"
  }
}

Response

OK

Response containing a list of org group memberships.

Expand All

Field

Type

Description

data [required]

[object]

An array of org group memberships.

attributes [required]

object

Attributes of an org group membership.

created_at [required]

date-time

Timestamp when the membership was created.

modified_at [required]

date-time

Timestamp when the membership was last modified.

org_name [required]

string

The name of the member organization.

org_site [required]

string

The site of the member organization.

org_uuid [required]

uuid

The UUID of the member organization.

id [required]

uuid

The ID of the org group membership.

relationships

object

Relationships of an org group membership.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group memberships resource type. Allowed enum values: org_group_memberships

links

object

Pagination links for navigating between pages of an org group list response.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta

object

Pagination metadata for org group list responses.

page

object

Page-based pagination details for org group list responses.

first_number

int64

First page number.

last_number

int64

Last page number.

next_number

int64

Next page number.

number

int64

Page number.

prev_number

int64

Previous page number.

size

int64

Page size.

total

int64

Total number of results.

type

string

Pagination type.

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-15T10:30:00Z",
        "modified_at": "2024-01-15T10:30:00Z",
        "org_name": "Acme Corp",
        "org_site": "us1",
        "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
      },
      "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        }
      },
      "type": "org_group_memberships"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": "integer",
      "prev_number": "integer",
      "size": "integer",
      "total": "integer",
      "type": "number_size"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# 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_memberships/bulk" \
-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": {
      "orgs": [
        {
          "org_site": "us1",
          "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
        }
      ]
    },
    "relationships": {
      "source_org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      },
      "target_org_group": {
        "data": {
          "id": "d4e5f6a7-b890-1234-cdef-567890abcdef",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_membership_bulk_updates"
  }
}
EOF

List org group policies

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_group_policieshttps://api.ap2.datadoghq.com/api/v2/org_group_policieshttps://api.datadoghq.eu/api/v2/org_group_policieshttps://api.ddog-gov.com/api/v2/org_group_policieshttps://api.us2.ddog-gov.com/api/v2/org_group_policieshttps://api.datadoghq.com/api/v2/org_group_policieshttps://api.us3.datadoghq.com/api/v2/org_group_policieshttps://api.us5.datadoghq.com/api/v2/org_group_policies

Overview

List policies for an organization group. Requires a filter on org group ID. This endpoint requires the org_group_read permission.

Arguments

Query Strings

Name

Type

Description

filter[org_group_id] [required]

string

Filter policies by org group ID.

filter[policy_name]

string

Filter policies by policy name.

page[number]

integer

The page number to return.

page[size]

integer

The number of items per page. Maximum is 1000.

sort

enum

Field to sort policies by. Supported values: id, name, -id, -name. Defaults to id.
Allowed enum values: id, -id, name, -name

Response

OK

Response containing a list of org group policies.

Expand All

Field

Type

Description

data [required]

[object]

An array of org group policies.

attributes [required]

object

Attributes of an org group policy.

content

object

The policy content as key-value pairs.

enforcement_tier [required]

enum

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. Allowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

modified_at [required]

date-time

Timestamp when the policy was last modified.

policy_name [required]

string

The name of the policy.

policy_type [required]

enum

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. Allowed enum values: org_config

default: org_config

id [required]

uuid

The ID of the org group policy.

relationships

object

Relationships of an org group policy.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

links

object

Pagination links for navigating between pages of an org group list response.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta

object

Pagination metadata for org group list responses.

page

object

Page-based pagination details for org group list responses.

first_number

int64

First page number.

last_number

int64

Last page number.

next_number

int64

Next page number.

number

int64

Page number.

prev_number

int64

Previous page number.

size

int64

Page size.

total

int64

Total number of results.

type

string

Pagination type.

{
  "data": [
    {
      "attributes": {
        "content": {
          "value": "UTC"
        },
        "enforcement_tier": "OVERRIDE_ALLOWED",
        "modified_at": "2024-01-15T10:30:00Z",
        "policy_name": "monitor_timezone",
        "policy_type": "org_config"
      },
      "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        }
      },
      "type": "org_group_policies"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": "integer",
      "prev_number": "integer",
      "size": "integer",
      "total": "integer",
      "type": "number_size"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Required query arguments
export filter[org_group_id]="a1b2c3d4-e5f6-7890-abcd-ef0123456789"
# 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_group_policies?filter[org_group_id]=${filter[org_group_id]}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get an org group policy

Note: This endpoint is in Preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.ap2.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.datadoghq.eu/api/v2/org_group_policies/{org_group_policy_id}https://api.ddog-gov.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us2.ddog-gov.com/api/v2/org_group_policies/{org_group_policy_id}https://api.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us3.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us5.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}

Overview

Get a specific organization group policy by its ID. This endpoint requires the org_group_read permission.

Arguments

Path Parameters

Name

Type

Description

org_group_policy_id [required]

string

The ID of the org group policy.

Response

OK

Response containing a single org group policy.

Expand All

Field

Type

Description

data [required]

object

An org group policy resource.

attributes [required]

object

Attributes of an org group policy.

content

object

The policy content as key-value pairs.

enforcement_tier [required]

enum

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. Allowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

modified_at [required]

date-time

Timestamp when the policy was last modified.

policy_name [required]

string

The name of the policy.

policy_type [required]

enum

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. Allowed enum values: org_config

default: org_config

id [required]

uuid

The ID of the org group policy.

relationships

object

Relationships of an org group policy.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

{
  "data": {
    "attributes": {
      "content": {
        "value": "UTC"
      },
      "enforcement_tier": "OVERRIDE_ALLOWED",
      "modified_at": "2024-01-15T10:30:00Z",
      "policy_name": "monitor_timezone",
      "policy_type": "org_config"
    },
    "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_policies"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_group_policy_id="1a2b3c4d-5e6f-7890-abcd-ef0123456789"
# 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_group_policies/${org_group_policy_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Create an org group policy

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_group_policieshttps://api.ap2.datadoghq.com/api/v2/org_group_policieshttps://api.datadoghq.eu/api/v2/org_group_policieshttps://api.ddog-gov.com/api/v2/org_group_policieshttps://api.us2.ddog-gov.com/api/v2/org_group_policieshttps://api.datadoghq.com/api/v2/org_group_policieshttps://api.us3.datadoghq.com/api/v2/org_group_policieshttps://api.us5.datadoghq.com/api/v2/org_group_policies

Overview

Create a new policy for an organization group. This endpoint requires the org_group_write permission.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for creating an org group policy.

attributes [required]

object

Attributes for creating an org group policy. If policy_type or enforcement_tier are not provided, they default to org_config and DEFAULT respectively.

content [required]

object

The policy content as key-value pairs.

enforcement_tier

enum

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. Allowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

policy_name [required]

string

The name of the policy.

policy_type

enum

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. Allowed enum values: org_config

default: org_config

relationships [required]

object

Relationships for creating a policy.

org_group [required]

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

{
  "data": {
    "attributes": {
      "content": {
        "value": "UTC"
      },
      "enforcement_tier": "OVERRIDE_ALLOWED",
      "policy_name": "monitor_timezone",
      "policy_type": "org_config"
    },
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_policies"
  }
}

Response

Created

Response containing a single org group policy.

Expand All

Field

Type

Description

data [required]

object

An org group policy resource.

attributes [required]

object

Attributes of an org group policy.

content

object

The policy content as key-value pairs.

enforcement_tier [required]

enum

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. Allowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

modified_at [required]

date-time

Timestamp when the policy was last modified.

policy_name [required]

string

The name of the policy.

policy_type [required]

enum

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. Allowed enum values: org_config

default: org_config

id [required]

uuid

The ID of the org group policy.

relationships

object

Relationships of an org group policy.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

{
  "data": {
    "attributes": {
      "content": {
        "value": "UTC"
      },
      "enforcement_tier": "OVERRIDE_ALLOWED",
      "modified_at": "2024-01-15T10:30:00Z",
      "policy_name": "monitor_timezone",
      "policy_type": "org_config"
    },
    "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_policies"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## 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_group_policies" \
-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": {
      "content": {
        "value": "UTC"
      },
      "enforcement_tier": "OVERRIDE_ALLOWED",
      "policy_name": "monitor_timezone",
      "policy_type": "org_config"
    },
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_policies"
  }
}
EOF

Update an org group policy

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_policies/{org_group_policy_id}https://api.ap2.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.datadoghq.eu/api/v2/org_group_policies/{org_group_policy_id}https://api.ddog-gov.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us2.ddog-gov.com/api/v2/org_group_policies/{org_group_policy_id}https://api.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us3.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us5.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}

Overview

Update an existing organization group policy. This endpoint requires the org_group_write permission.

Arguments

Path Parameters

Name

Type

Description

org_group_policy_id [required]

string

The ID of the org group policy.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for updating an org group policy.

attributes [required]

object

Attributes for updating an org group policy.

content

object

The policy content as key-value pairs.

enforcement_tier

enum

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. Allowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

id [required]

uuid

The ID of the policy.

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

{
  "data": {
    "attributes": {
      "content": {
        "value": "UTC"
      },
      "enforcement_tier": "OVERRIDE_ALLOWED"
    },
    "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
    "type": "org_group_policies"
  }
}

Response

OK

Response containing a single org group policy.

Expand All

Field

Type

Description

data [required]

object

An org group policy resource.

attributes [required]

object

Attributes of an org group policy.

content

object

The policy content as key-value pairs.

enforcement_tier [required]

enum

The enforcement tier of the policy. OVERRIDE_ALLOWED means the policy is set but member orgs may mutate it. GROUP_MANAGED means the policy is strictly controlled and mutations are blocked for affected orgs. DELEGATE means each member org controls its own value. Allowed enum values: OVERRIDE_ALLOWED,GROUP_MANAGED,DELEGATE

default: OVERRIDE_ALLOWED

modified_at [required]

date-time

Timestamp when the policy was last modified.

policy_name [required]

string

The name of the policy.

policy_type [required]

enum

The type of the policy. Only org_config is supported, indicating a policy backed by an organization configuration setting. Allowed enum values: org_config

default: org_config

id [required]

uuid

The ID of the org group policy.

relationships

object

Relationships of an org group policy.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

{
  "data": {
    "attributes": {
      "content": {
        "value": "UTC"
      },
      "enforcement_tier": "OVERRIDE_ALLOWED",
      "modified_at": "2024-01-15T10:30:00Z",
      "policy_name": "monitor_timezone",
      "policy_type": "org_config"
    },
    "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
    "relationships": {
      "org_group": {
        "data": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
          "type": "org_groups"
        }
      }
    },
    "type": "org_group_policies"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export org_group_policy_id="1a2b3c4d-5e6f-7890-abcd-ef0123456789"
# 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_policies/${org_group_policy_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": {
      "content": {
        "value": "US/Eastern"
      },
      "enforcement_tier": "GROUP_MANAGED"
    },
    "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
    "type": "org_group_policies"
  }
}
EOF

Delete an org group policy

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

DELETE https://api.ap1.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.ap2.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.datadoghq.eu/api/v2/org_group_policies/{org_group_policy_id}https://api.ddog-gov.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us2.ddog-gov.com/api/v2/org_group_policies/{org_group_policy_id}https://api.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us3.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}https://api.us5.datadoghq.com/api/v2/org_group_policies/{org_group_policy_id}

Overview

Delete an organization group policy by its ID. This endpoint requires the org_group_write permission.

Arguments

Path Parameters

Name

Type

Description

org_group_policy_id [required]

string

The ID of the org group policy.

Response

No Content

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_group_policy_id="1a2b3c4d-5e6f-7890-abcd-ef0123456789"
# Curl command
curl -X DELETE "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_policies/${org_group_policy_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List org group policy overrides

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_group_policy_overrideshttps://api.ap2.datadoghq.com/api/v2/org_group_policy_overrideshttps://api.datadoghq.eu/api/v2/org_group_policy_overrideshttps://api.ddog-gov.com/api/v2/org_group_policy_overrideshttps://api.us2.ddog-gov.com/api/v2/org_group_policy_overrideshttps://api.datadoghq.com/api/v2/org_group_policy_overrideshttps://api.us3.datadoghq.com/api/v2/org_group_policy_overrideshttps://api.us5.datadoghq.com/api/v2/org_group_policy_overrides

Overview

List policy overrides for an organization group. Requires a filter on org group ID. Optionally filter by policy ID. This endpoint requires the org_group_read permission.

Arguments

Query Strings

Name

Type

Description

filter[org_group_id] [required]

string

Filter policy overrides by org group ID.

filter[policy_id]

string

Filter policy overrides by policy ID.

page[number]

integer

The page number to return.

page[size]

integer

The number of items per page. Maximum is 1000.

sort

enum

Field to sort overrides by. Supported values: id, org_uuid, -id, -org_uuid. Defaults to id.
Allowed enum values: id, -id, org_uuid, -org_uuid

Response

OK

Response containing a list of org group policy overrides.

Expand All

Field

Type

Description

data [required]

[object]

An array of org group policy overrides.

attributes [required]

object

Attributes of an org group policy override.

content

object

The override content as key-value pairs.

created_at [required]

date-time

Timestamp when the override was created.

modified_at [required]

date-time

Timestamp when the override was last modified.

org_site [required]

string

The site of the organization that has the override.

org_uuid [required]

uuid

The UUID of the organization that has the override.

id [required]

uuid

The ID of the policy override.

relationships

object

Relationships of an org group policy override.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

org_group_policy

object

Relationship to a single org group policy.

data [required]

object

A reference to an org group policy.

id [required]

uuid

The ID of the policy.

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

type [required]

enum

Org group policy overrides resource type. Allowed enum values: org_group_policy_overrides

links

object

Pagination links for navigating between pages of an org group list response.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta

object

Pagination metadata for org group list responses.

page

object

Page-based pagination details for org group list responses.

first_number

int64

First page number.

last_number

int64

Last page number.

next_number

int64

Next page number.

number

int64

Page number.

prev_number

int64

Previous page number.

size

int64

Page size.

total

int64

Total number of results.

type

string

Pagination type.

{
  "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"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": "integer",
      "prev_number": "integer",
      "size": "integer",
      "total": "integer",
      "type": "number_size"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Required query arguments
export filter[org_group_id]="a1b2c3d4-e5f6-7890-abcd-ef0123456789"
# 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_group_policy_overrides?filter[org_group_id]=${filter[org_group_id]}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get an org group policy override

Note: This endpoint is in Preview and is subject to change. If you have any feedback, contact Datadog support.

GET 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

Get a specific organization group policy override by its ID. This endpoint requires the org_group_read permission.

Arguments

Path Parameters

Name

Type

Description

org_group_policy_override_id [required]

string

The ID of the org group policy override.

Response

OK

Response containing a single org group policy override.

Expand All

Field

Type

Description

data [required]

object

An org group policy override resource.

attributes [required]

object

Attributes of an org group policy override.

content

object

The override content as key-value pairs.

created_at [required]

date-time

Timestamp when the override was created.

modified_at [required]

date-time

Timestamp when the override was last modified.

org_site [required]

string

The site of the organization that has the override.

org_uuid [required]

uuid

The UUID of the organization that has the override.

id [required]

uuid

The ID of the policy override.

relationships

object

Relationships of an org group policy override.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

org_group_policy

object

Relationship to a single org group policy.

data [required]

object

A reference to an org group policy.

id [required]

uuid

The ID of the policy.

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

type [required]

enum

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_group_policy_override_id="9f8e7d6c-5b4a-3210-fedc-ba0987654321"
# 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_group_policy_overrides/${org_group_policy_override_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Create an org group policy override

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_group_policy_overrideshttps://api.ap2.datadoghq.com/api/v2/org_group_policy_overrideshttps://api.datadoghq.eu/api/v2/org_group_policy_overrideshttps://api.ddog-gov.com/api/v2/org_group_policy_overrideshttps://api.us2.ddog-gov.com/api/v2/org_group_policy_overrideshttps://api.datadoghq.com/api/v2/org_group_policy_overrideshttps://api.us3.datadoghq.com/api/v2/org_group_policy_overrideshttps://api.us5.datadoghq.com/api/v2/org_group_policy_overrides

Overview

Create a new policy override for an organization within an org group. This endpoint requires the org_group_write permission.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for creating an org group policy override.

attributes [required]

object

Attributes for creating a policy override.

org_site [required]

string

The site of the organization.

org_uuid [required]

uuid

The UUID of the organization to grant the override.

relationships [required]

object

Relationships for creating a policy override.

org_group [required]

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

org_group_policy [required]

object

Relationship to a single org group policy.

data [required]

object

A reference to an org group policy.

id [required]

uuid

The ID of the policy.

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

type [required]

enum

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"
    },
    "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"
  }
}

Response

Created

Response containing a single org group policy override.

Expand All

Field

Type

Description

data [required]

object

An org group policy override resource.

attributes [required]

object

Attributes of an org group policy override.

content

object

The override content as key-value pairs.

created_at [required]

date-time

Timestamp when the override was created.

modified_at [required]

date-time

Timestamp when the override was last modified.

org_site [required]

string

The site of the organization that has the override.

org_uuid [required]

uuid

The UUID of the organization that has the override.

id [required]

uuid

The ID of the policy override.

relationships

object

Relationships of an org group policy override.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

org_group_policy

object

Relationship to a single org group policy.

data [required]

object

A reference to an org group policy.

id [required]

uuid

The ID of the policy.

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

type [required]

enum

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## 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_group_policy_overrides" \
-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"
    },
    "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"
  }
}
EOF

Update an org group policy override

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

Name

Type

Description

org_group_policy_override_id [required]

string

The ID of the org group policy override.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data for updating a policy override.

attributes [required]

object

Attributes for updating a policy override. The org_uuid and org_site fields must match the existing override and cannot be changed.

org_site [required]

string

The site of the organization.

org_uuid [required]

uuid

The UUID of the organization.

id [required]

uuid

The ID of the policy override.

type [required]

enum

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

Field

Type

Description

data [required]

object

An org group policy override resource.

attributes [required]

object

Attributes of an org group policy override.

content

object

The override content as key-value pairs.

created_at [required]

date-time

Timestamp when the override was created.

modified_at [required]

date-time

Timestamp when the override was last modified.

org_site [required]

string

The site of the organization that has the override.

org_uuid [required]

uuid

The UUID of the organization that has the override.

id [required]

uuid

The ID of the policy override.

relationships

object

Relationships of an org group policy override.

org_group

object

Relationship to a single org group.

data [required]

object

A reference to an org group.

id [required]

uuid

The ID of the org group.

type [required]

enum

Org groups resource type. Allowed enum values: org_groups

org_group_policy

object

Relationship to a single org group policy.

data [required]

object

A reference to an org group policy.

id [required]

uuid

The ID of the policy.

type [required]

enum

Org group policies resource type. Allowed enum values: org_group_policies

type [required]

enum

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## 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

Delete an org group policy override

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

DELETE 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

Delete an organization group policy override by its ID. This endpoint requires the org_group_write permission.

Arguments

Path Parameters

Name

Type

Description

org_group_policy_override_id [required]

string

The ID of the org group policy override.

Response

No Content

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_group_policy_override_id="9f8e7d6c-5b4a-3210-fedc-ba0987654321"
# Curl command
curl -X DELETE "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 "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

List org group policy configs

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/org_group_policy_configshttps://api.ap2.datadoghq.com/api/v2/org_group_policy_configshttps://api.datadoghq.eu/api/v2/org_group_policy_configshttps://api.ddog-gov.com/api/v2/org_group_policy_configshttps://api.us2.ddog-gov.com/api/v2/org_group_policy_configshttps://api.datadoghq.com/api/v2/org_group_policy_configshttps://api.us3.datadoghq.com/api/v2/org_group_policy_configshttps://api.us5.datadoghq.com/api/v2/org_group_policy_configs

Overview

List all org configs that are eligible to be used as organization group policies. This endpoint requires the org_group_read permission.

Response

OK

Response containing a list of org group policy configs.

Expand All

Field

Type

Description

data [required]

[object]

An array of org group policy configs.

attributes [required]

object

Attributes of an org group policy config.

allowed_values [required]

[string]

The allowed values for this config.

default_value [required]

The default value for this config.

description [required]

string

The description of the policy config.

name [required]

string

The name of the policy config.

value_type [required]

string

The type of the value for this config.

id [required]

string

The identifier of the policy config (uses the config name).

type [required]

enum

Org group policy configs resource type. Allowed enum values: org_group_policy_configs

{
  "data": [
    {
      "attributes": {
        "allowed_values": [
          "UTC",
          "US/Eastern",
          "US/Pacific"
        ],
        "default_value": "UTC",
        "description": "The default timezone for monitors.",
        "name": "monitor_timezone",
        "value_type": "string"
      },
      "id": "monitor_timezone",
      "type": "org_group_policy_configs"
    }
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

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

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # 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_group_policy_configs" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"