OCI Integration

GET https://api.ap1.datadoghq.com/api/v2/integration/oci/productshttps://api.ap2.datadoghq.com/api/v2/integration/oci/productshttps://api.datadoghq.eu/api/v2/integration/oci/productshttps://api.ddog-gov.com/api/v2/integration/oci/productshttps://api.datadoghq.com/api/v2/integration/oci/productshttps://api.us3.datadoghq.com/api/v2/integration/oci/productshttps://api.us5.datadoghq.com/api/v2/integration/oci/products

Overview

Lists the products for a given tenancy. Returns the enabled/disabled status of Datadog products (such as Cloud Security Posture Management) for specific OCI tenancies.

Arguments

Query Strings

Response

• 200
• 429

{
  "data": [
    {
      "attributes": {
        "products": [
          {
            "enabled": true,
            "product_key": "CLOUD_SECURITY_POSTURE_MANAGEMENT"
          }
        ]
      },
      "id": "ocid.tenancy.test",
      "type": "oci_tenancy_product"
    }
  ]
}

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

Code Example

                  # Required query arguments
export productKeys="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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/oci/products?productKeys=${productKeys}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

GET https://api.ap1.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.ap2.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.datadoghq.eu/api/v2/integration/oci/tenancieshttps://api.ddog-gov.com/api/v2/integration/oci/tenancieshttps://api.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.us3.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.us5.datadoghq.com/api/v2/integration/oci/tenancies

Overview

Get a list of all configured OCI tenancy integrations. Returns basic information about each tenancy including authentication credentials, region settings, and collection preferences for metrics, logs, and resources.

Response

• 200
• 429

{
  "data": [
    {
      "attributes": {
        "config_version": 2,
        "cost_collection_enabled": true,
        "dd_compartment_id": "ocid.compartment.test",
        "dd_stack_id": "ocid.stack.test",
        "home_region": "us-ashburn-1",
        "logs_config": {
          "compartment_tag_filters": [
            "compartment.test"
          ],
          "enabled": true,
          "enabled_services": [
            "compute"
          ]
        },
        "metrics_config": {
          "compartment_tag_filters": [
            "compartment.test"
          ],
          "enabled": true,
          "excluded_services": [
            "compute"
          ]
        },
        "regions_config": {
          "available": [
            "us-ashburn-1",
            "us-phoenix-1"
          ],
          "disabled": [
            "us-phoenix-1"
          ],
          "enabled": [
            "us-ashburn-1"
          ]
        },
        "resource_collection_enabled": true,
        "user_ocid": "ocid.user.test"
      },
      "id": "ocid.tenancy.test",
      "type": "oci_tenancy"
    }
  ]
}

{
  "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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

POST https://api.ap1.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.ap2.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.datadoghq.eu/api/v2/integration/oci/tenancieshttps://api.ddog-gov.com/api/v2/integration/oci/tenancieshttps://api.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.us3.datadoghq.com/api/v2/integration/oci/tenancieshttps://api.us5.datadoghq.com/api/v2/integration/oci/tenancies

Overview

Create a new tenancy config to establish monitoring and data collection from your OCI environment. Requires OCI authentication credentials and tenancy details. Warning: Datadog recommends interacting with this endpoint only through the Datadog web UI to ensure all necessary OCI resources have been created and configured properly.

Request

Body Data (required)

{
  "data": {
    "attributes": {
      "auth_credentials": {
        "fingerprint": "string",
        "private_key": ""
      },
      "config_version": "integer",
      "cost_collection_enabled": false,
      "dd_compartment_id": "string",
      "dd_stack_id": "string",
      "home_region": "",
      "logs_config": {
        "compartment_tag_filters": [],
        "enabled": false,
        "enabled_services": []
      },
      "metrics_config": {
        "compartment_tag_filters": [],
        "enabled": false,
        "excluded_services": []
      },
      "regions_config": {
        "available": [],
        "disabled": [],
        "enabled": []
      },
      "resource_collection_enabled": false,
      "user_ocid": ""
    },
    "id": "",
    "type": "oci_tenancy"
  }
}

Response

• 201
• 429

{
  "data": {
    "attributes": {
      "config_version": 2,
      "cost_collection_enabled": true,
      "dd_compartment_id": "ocid.compartment.test",
      "dd_stack_id": "ocid.stack.test",
      "home_region": "us-ashburn-1",
      "logs_config": {
        "compartment_tag_filters": [
          "compartment.test"
        ],
        "enabled": true,
        "enabled_services": [
          "compute"
        ]
      },
      "metrics_config": {
        "compartment_tag_filters": [
          "compartment.test"
        ],
        "enabled": true,
        "excluded_services": [
          "compute"
        ]
      },
      "regions_config": {
        "available": [
          "us-ashburn-1",
          "us-phoenix-1"
        ],
        "disabled": [
          "us-phoenix-1"
        ],
        "enabled": [
          "us-ashburn-1"
        ]
      },
      "resource_collection_enabled": true,
      "user_ocid": "ocid.user.test"
    },
    "id": "ocid.tenancy.test",
    "type": "oci_tenancy"
  }
}

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

Code Example

                  # 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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies" \
-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": {
      "auth_credentials": {
        "private_key": ""
      },
      "home_region": "",
      "user_ocid": ""
    },
    "id": "",
    "type": "oci_tenancy"
  }
}
EOF

                

DELETE https://api.ap1.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.ap2.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.datadoghq.eu/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.ddog-gov.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.us3.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}

Overview

Delete an existing tenancy config. This will stop all data collection from the specified OCI tenancy and remove the stored configuration. This operation cannot be undone.

Arguments

Path Parameters

Response

• 204
• 429

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

Code Example

                  # Path parameters
export tenancy_ocid="CHANGE_ME"
# 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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies/${tenancy_ocid}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

GET https://api.ap1.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.ap2.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.datadoghq.eu/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.ddog-gov.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.us3.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}

Overview

Get a single tenancy config object by its OCID. Returns detailed configuration including authentication credentials, enabled services, region settings, and collection preferences.

Arguments

Path Parameters

Response

• 200
• 429

{
  "data": {
    "attributes": {
      "config_version": 2,
      "cost_collection_enabled": true,
      "dd_compartment_id": "ocid.compartment.test",
      "dd_stack_id": "ocid.stack.test",
      "home_region": "us-ashburn-1",
      "logs_config": {
        "compartment_tag_filters": [
          "compartment.test"
        ],
        "enabled": true,
        "enabled_services": [
          "compute"
        ]
      },
      "metrics_config": {
        "compartment_tag_filters": [
          "compartment.test"
        ],
        "enabled": true,
        "excluded_services": [
          "compute"
        ]
      },
      "regions_config": {
        "available": [
          "us-ashburn-1",
          "us-phoenix-1"
        ],
        "disabled": [
          "us-phoenix-1"
        ],
        "enabled": [
          "us-ashburn-1"
        ]
      },
      "resource_collection_enabled": true,
      "user_ocid": "ocid.user.test"
    },
    "id": "ocid.tenancy.test",
    "type": "oci_tenancy"
  }
}

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

Code Example

                  # Path parameters
export tenancy_ocid="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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies/${tenancy_ocid}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

PATCH https://api.ap1.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.ap2.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.datadoghq.eu/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.ddog-gov.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.us3.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}

Overview

Update an existing tenancy config. You can modify authentication credentials, enable/disable collection types, update service filters, and change region settings. Warning: We recommend using the Datadog web UI to avoid unintended update effects.

Arguments

Path Parameters

Request

Body Data (required)

{
  "data": {
    "attributes": {
      "auth_credentials": {
        "fingerprint": "string",
        "private_key": ""
      },
      "cost_collection_enabled": false,
      "home_region": "string",
      "logs_config": {
        "compartment_tag_filters": [],
        "enabled": false,
        "enabled_services": []
      },
      "metrics_config": {
        "compartment_tag_filters": [],
        "enabled": false,
        "excluded_services": []
      },
      "regions_config": {
        "available": [],
        "disabled": [],
        "enabled": []
      },
      "resource_collection_enabled": false,
      "user_ocid": "string"
    },
    "id": "",
    "type": "oci_tenancy"
  }
}

Response

• 200
• 429

{
  "data": {
    "attributes": {
      "config_version": 2,
      "cost_collection_enabled": true,
      "dd_compartment_id": "ocid.compartment.test",
      "dd_stack_id": "ocid.stack.test",
      "home_region": "us-ashburn-1",
      "logs_config": {
        "compartment_tag_filters": [
          "compartment.test"
        ],
        "enabled": true,
        "enabled_services": [
          "compute"
        ]
      },
      "metrics_config": {
        "compartment_tag_filters": [
          "compartment.test"
        ],
        "enabled": true,
        "excluded_services": [
          "compute"
        ]
      },
      "regions_config": {
        "available": [
          "us-ashburn-1",
          "us-phoenix-1"
        ],
        "disabled": [
          "us-phoenix-1"
        ],
        "enabled": [
          "us-ashburn-1"
        ]
      },
      "resource_collection_enabled": true,
      "user_ocid": "ocid.user.test"
    },
    "id": "ocid.tenancy.test",
    "type": "oci_tenancy"
  }
}

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

Code Example

                  # Path parameters
export tenancy_ocid="CHANGE_ME"
# 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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies/${tenancy_ocid}" \
-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": {
      "auth_credentials": {
        "private_key": ""
      }
    },
    "id": "",
    "type": "oci_tenancy"
  }
}
EOF