---
title: Get tenancy configs
description: Get a list of all configured OCI tenancy integrations.
breadcrumbs: Docs > API > Get tenancy configs
---

> For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt).

# Get tenancy configs

## v2 (latest)

| Datadog site      | API endpoint                                                       |
| ----------------- | ------------------------------------------------------------------ |
| app.datadoghq.com | GET https://api.datadoghq.com/api/v2/integration/oci/tenancies     |
| us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/integration/oci/tenancies |
| us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies |
| app.datadoghq.eu  | GET https://api.datadoghq.eu/api/v2/integration/oci/tenancies      |
| ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/integration/oci/tenancies |
| ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/integration/oci/tenancies |
| uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/integration/oci/tenancies |
| app.ddog-gov.com  | GET https://api.ddog-gov.com/api/v2/integration/oci/tenancies      |
| us2.ddog-gov.com  | GET https://api.us2.ddog-gov.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

{% tabs %}
{% tab label="200" %}
OK

{% tabs %}
{% tab label="Model" %}
Response containing a list of OCI tenancy integration configurations.

| Parent field         | Field                            | Type     | Description                                                                                                                        |
| -------------------- | -------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|                      | data [*required*]                | [object] | List of OCI tenancy integration configuration objects.                                                                             |
| data                 | attributes                       | object   | Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. |
| attributes           | account_tags                     | [string] | List of Datadog tags applied to data collected from the tenancy.                                                                   |
| attributes           | billing_plan_id                  | int32    | The identifier of the billing plan associated with the OCI tenancy.                                                                |
| attributes           | config_version                   | int64    | Version number of the integration the tenancy is integrated with                                                                   |
| attributes           | cost_collection_enabled          | boolean  | Whether cost data collection from OCI is enabled for the tenancy.                                                                  |
| attributes           | dd_compartment_id                | string   | The OCID of the OCI compartment used by the Datadog integration stack.                                                             |
| attributes           | dd_iac_version                   | string   | The version of the Datadog infrastructure-as-code stack applied to the tenancy (for example, 1.2.0).                               |
| attributes           | dd_stack_id                      | string   | The OCID of the OCI Resource Manager stack used by the Datadog integration.                                                        |
| attributes           | defined_tags                     | [string] | List of OCI defined tags applied to the Datadog-managed connector hubs.                                                            |
| attributes           | events_collection_enabled        | boolean  | Whether resource change events collection from OCI is enabled for the tenancy.                                                     |
| attributes           | grace_resource                   | object   | Access control details for the tenancy configuration, used to determine whether the requesting user can edit it.                   |
| grace_resource       | resource_id                      | string   | The identifier of the access control resource for the tenancy configuration.                                                       |
| grace_resource       | user_can_edit                    | boolean  | Whether the requesting user has permission to edit the tenancy configuration.                                                      |
| attributes           | home_region                      | string   | The home region of the OCI tenancy (for example, us-ashburn-1).                                                                    |
| attributes           | logs_config                      | object   | Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled.           |
| logs_config          | compartment_tag_filters          | [string] | List of compartment tag filters scoping log collection to specific compartments.                                                   |
| logs_config          | enabled                          | boolean  | Whether log collection is enabled for the tenancy.                                                                                 |
| logs_config          | enabled_services                 | [string] | List of OCI service names for which log collection is enabled.                                                                     |
| logs_config          | resource_tag_filters             | object   | Map of OCI service names to the resource tag filters that scope log collection for that service.                                   |
| additionalProperties | <any-key>                        | [string] | List of resource tag filters for the OCI service.                                                                                  |
| attributes           | metrics_config                   | object   | Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded.          |
| metrics_config       | compartment_tag_filters          | [string] | List of compartment tag filters scoping metrics collection to specific compartments.                                               |
| metrics_config       | enabled                          | boolean  | Whether metrics collection is enabled for the tenancy.                                                                             |
| metrics_config       | excluded_services                | [string] | List of OCI service names excluded from metrics collection.                                                                        |
| metrics_config       | resource_tag_filters             | object   | Map of OCI service names to the resource tag filters that scope metrics collection for that service.                               |
| additionalProperties | <any-key>                        | [string] | List of resource tag filters for the OCI service.                                                                                  |
| attributes           | parent_tenancy_name              | string   | The name of the parent OCI tenancy, if applicable.                                                                                 |
| attributes           | regions_config                   | object   | Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection.         |
| regions_config       | available                        | [string] | List of OCI regions available for data collection in the tenancy. Returns `null` when no regions are set.                          |
| regions_config       | disabled                         | [string] | List of OCI regions explicitly disabled for data collection. Returns `null` when no regions are set.                               |
| regions_config       | enabled                          | [string] | List of OCI regions enabled for data collection. Returns `null` when no regions are set.                                           |
| attributes           | resource_collection_enabled      | boolean  | Whether resource collection from OCI is enabled for the tenancy.                                                                   |
| attributes           | service_quota_collection_enabled | boolean  | Whether service quota collection from OCI is enabled for the tenancy.                                                              |
| attributes           | tenancy_name                     | string   | The human-readable name of the OCI tenancy.                                                                                        |
| attributes           | user_ocid                        | string   | The OCID of the OCI user used by the Datadog integration for authentication.                                                       |
| data                 | id                               | string   | The OCID of the OCI tenancy.                                                                                                       |
| data                 | type [*required*]                | enum     | OCI tenancy resource type. Allowed enum values: `oci_tenancy`. Default: `oci_tenancy`.                                             |
{% /tab %}

{% tab label="Example" %}
```json
{
  "data": [
    {
      "attributes": {
        "account_tags": [
          "env:prod"
        ],
        "billing_plan_id": 2,
        "config_version": 2,
        "cost_collection_enabled": true,
        "dd_compartment_id": "ocid.compartment.test",
        "dd_iac_version": "1.2.0",
        "dd_stack_id": "ocid.stack.test",
        "defined_tags": [
          "Operations.CostCenter:42"
        ],
        "events_collection_enabled": false,
        "grace_resource": {
          "resource_id": "oci-integration-configuration:ocid.tenancy.test",
          "user_can_edit": true
        },
        "home_region": "us-ashburn-1",
        "logs_config": {
          "compartment_tag_filters": [
            "compartment.test"
          ],
          "enabled": true,
          "enabled_services": [
            "compute"
          ],
          "resource_tag_filters": {
            "compute": [
              "env:prod"
            ]
          }
        },
        "metrics_config": {
          "compartment_tag_filters": [
            "compartment.test"
          ],
          "enabled": true,
          "excluded_services": [
            "compute"
          ],
          "resource_tag_filters": {
            "compute": [
              "env:prod"
            ]
          }
        },
        "parent_tenancy_name": "parent-tenancy",
        "regions_config": {
          "available": [
            "us-ashburn-1",
            "us-phoenix-1"
          ],
          "disabled": [
            "us-phoenix-1"
          ],
          "enabled": [
            "us-ashburn-1"
          ]
        },
        "resource_collection_enabled": true,
        "service_quota_collection_enabled": false,
        "tenancy_name": "test-tenancy",
        "user_ocid": "ocid.user.test"
      },
      "id": "ocid.tenancy.test",
      "type": "oci_tenancy"
    }
  ]
}
```
{% /tab %}
{% /tabs %}
{% /tab %}

{% tab label="429" %}
Too many requests

{% tabs %}
{% tab label="Model" %}
API error response.

| Field               | Type     | Description       |
| ------------------- | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |
{% /tab %}

{% tab label="Example" %}
```json
{
  "errors": [
    "Bad Request"
  ]
}
```
{% /tab %}
{% /tabs %}
{% /tab %}
{% /tabs %}

### Code Example

{% tabs %}
{% tab label="Curl" %}
```bash
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/integration/oci/tenancies" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
```
{% /tab %}

{% tab label="Go" %}
```go
// Get tenancy configs returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewOCIIntegrationApi(apiClient)
	resp, r, err := api.GetTenancyConfigs(ctx)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OCIIntegrationApi.GetTenancyConfigs`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `OCIIntegrationApi.GetTenancyConfigs`:\n%s\n", responseContent)
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
```
{% /tab %}

{% tab label="Java" %}
```java
// Get tenancy configs returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OciIntegrationApi;
import com.datadog.api.client.v2.model.TenancyConfigList;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    OciIntegrationApi apiInstance = new OciIntegrationApi(defaultClient);

    try {
      TenancyConfigList result = apiInstance.getTenancyConfigs();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OciIntegrationApi#getTenancyConfigs");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
```
{% /tab %}

{% tab label="Python" %}
```python
"""
Get tenancy configs returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.oci_integration_api import OCIIntegrationApi

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = OCIIntegrationApi(api_client)
    response = api_instance.get_tenancy_configs()

    print(response)
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
```
{% /tab %}

{% tab label="Ruby" %}
```ruby
# Get tenancy configs returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::OCIIntegrationAPI.new
p api_instance.get_tenancy_configs()
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" ruby "example.rb"
```
{% /tab %}

{% tab label="Rust" %}
```rust
// Get tenancy configs returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_oci_integration::OCIIntegrationAPI;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = OCIIntegrationAPI::with_config(configuration);
    let resp = api.get_tenancy_configs().await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
```
{% /tab %}

{% tab label="TypeScript" %}
```typescript
/**
 * Get tenancy configs returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
const apiInstance = new v2.OCIIntegrationApi(configuration);

apiInstance
  .getTenancyConfigs()
  .then((data: v2.TenancyConfigList) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));
```

#### Instructions

First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands:

```bash
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" npx tsx "example.ts"
```
{% /tab %}
{% /tabs %}
