List org group policy suggestions

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_suggestionshttps://api.ap2.datadoghq.com/api/v2/org_group_policy_suggestionshttps://api.datadoghq.eu/api/v2/org_group_policy_suggestionshttps://api.ddog-gov.com/api/v2/org_group_policy_suggestionshttps://api.us2.ddog-gov.com/api/v2/org_group_policy_suggestionshttps://api.uk1.datadoghq.com/api/v2/org_group_policy_suggestionshttps://api.datadoghq.com/api/v2/org_group_policy_suggestionshttps://api.us3.datadoghq.com/api/v2/org_group_policy_suggestionshttps://api.us5.datadoghq.com/api/v2/org_group_policy_suggestions

Overview

List suggested organization group policies. 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.

Response

OK

Response containing a list of org group policy suggestions.

Expand All

Field

Type

Description

data [required]

[object]

An array of org group policy suggestions.

attributes [required]

object

Attributes of an org group policy suggestion.

consensus_ratio [required]

double

The ratio of member orgs whose configuration agrees on the recommended value.

policy_name [required]

string

The name of the suggested policy.

recommended_value [required]

The recommended value for the policy, based on member org consensus.

status [required]

enum

The status of the policy suggestion. Allowed enum values: pending,accepted,dismissed

id [required]

string

The ID of the org group policy suggestion.

relationships

object

Relationships of an org group policy suggestion.

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 policy suggestions resource type. Allowed enum values: org_group_policy_suggestions

{
  "data": [
    {
      "attributes": {
        "consensus_ratio": 0.75,
        "policy_name": "monitor_timezone",
        "recommended_value": "UTC",
        "status": "pending"
      },
      "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        }
      },
      "type": "org_group_policy_suggestions"
    }
  ]
}

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.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/org_group_policy_suggestions?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}"