Get org settings by incident type

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/incidents/config/types/{incident_type_id}/org-settingshttps://api.ap2.datadoghq.com/api/v2/incidents/config/types/{incident_type_id}/org-settingshttps://api.datadoghq.eu/api/v2/incidents/config/types/{incident_type_id}/org-settingshttps://api.ddog-gov.com/api/v2/incidents/config/types/{incident_type_id}/org-settingshttps://api.us2.ddog-gov.com/api/v2/incidents/config/types/{incident_type_id}/org-settingshttps://api.uk1.datadoghq.com/api/v2/incidents/config/types/{incident_type_id}/org-settingshttps://api.datadoghq.com/api/v2/incidents/config/types/{incident_type_id}/org-settingshttps://api.us3.datadoghq.com/api/v2/incidents/config/types/{incident_type_id}/org-settingshttps://api.us5.datadoghq.com/api/v2/incidents/config/types/{incident_type_id}/org-settings

Overview

Get the org settings for a specific incident type. This endpoint requires any of the following permissions:

  • incident_settings_read
  • incident_read

  • OAuth apps require the incident_read authorization scope to access this endpoint.

    Arguments

    Path Parameters

    Name

    Type

    Description

    incident_type_id [required]

    string

    The UUID of the incident type.

    Query Strings

    Name

    Type

    Description

    include

    string

    Comma-separated list of related resources to include in the response.

    Response

    OK

    Response with a single incident org settings resource.

    Expand All

    Field

    Type

    Description

    data [required]

    object

    Incident org settings data in a response.

    attributes [required]

    object

    Attributes of an incident org settings resource in a response.

    created [required]

    date-time

    Timestamp when the settings were created.

    modified [required]

    date-time

    Timestamp when the settings were last modified.

    settings [required]

    object

    The settings configuration for an incident org settings resource.

    id [required]

    uuid

    The org settings identifier.

    relationships

    object

    Relationships for an incident org settings resource.

    incident_type

    object

    Relationship to an incident type.

    data [required]

    object

    Relationship to incident type object.

    id [required]

    string

    The incident type's ID.

    type [required]

    enum

    Incident type resource type. Allowed enum values: incident_types

    default: incident_types

    type [required]

    enum

    Incident org settings resource type. Allowed enum values: incident_org_settings

    {
      "data": {
        "attributes": {
          "created": "2024-01-01T00:00:00.000Z",
          "modified": "2024-01-01T00:00:00.000Z",
          "settings": {
            "allow_anonymous_incident_declaration": false,
            "allow_guest_incident_declaration": false,
            "pagerduty_paging": true,
            "private_incidents_by_default": false
          }
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "relationships": {
          "incident_type": {
            "data": {
              "id": "00000000-0000-0000-0000-000000000000",
              "type": "incident_types"
            }
          }
        },
        "type": "incident_org_settings"
      }
    }

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Unauthorized

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "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 incident_type_id="CHANGE_ME"
    # 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/incidents/config/types/${incident_type_id}/org-settings" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"