---
title: Get tenancy config
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > API Reference > OCI Integration
---

# Get tenancy config{% #get-tenancy-config %}
Copy pageCopied
{% tab title="v2" %}

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

| Name                           | Type   | Description                                 |
| ------------------------------ | ------ | ------------------------------------------- |
| tenancy_ocid [*required*] | string | The OCID of the tenancy config to retrieve. |

### Response

{% tab title="200" %}
OK
{% tab title="Model" %}
Response containing a single OCI tenancy integration configuration.

| Parent field   | Field                       | Type     | Description                                                                                                                        |
| -------------- | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|                | data                        | object   | A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes.      |
| data           | attributes                  | object   | Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. |
| 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_stack_id                 | string   | The OCID of the OCI Resource Manager stack used by the Datadog integration.                                                        |
| 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.                                                                     |
| 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.                                                                        |
| 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.                                                                  |
| regions_config | disabled                    | [string] | List of OCI regions explicitly disabled for data collection.                                                                       |
| regions_config | enabled                     | [string] | List of OCI regions enabled for data collection.                                                                                   |
| attributes     | resource_collection_enabled | boolean  | Whether resource 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`                                                                      |

{% /tab %}

{% tab title="Example" %}

```json
{
  "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"
  }
}
```

{% /tab %}

{% /tab %}

{% tab title="429" %}
Too many requests
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

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

{% /tab %}

{% /tab %}

### Code Example

##### 
                  \# Path parameters export tenancy_ocid="CHANGE_ME" \# Curl command curl -X GET "https://api.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}" 
                
##### 

```python
"""
Get tenancy config returns "OK" response
"""

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

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = OCIIntegrationApi(api_client)
    response = api_instance.get_tenancy_config(
        tenancy_ocid="tenancy_ocid",
    )

    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:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
##### 

```ruby
# Get tenancy config returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OCIIntegrationAPI.new
p api_instance.get_tenancy_config("tenancy_ocid")
```

#### 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:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
##### 

```go
// Get tenancy config 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())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewOCIIntegrationApi(apiClient)
	resp, r, err := api.GetTenancyConfig(ctx, "tenancy_ocid")

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `OCIIntegrationApi.GetTenancyConfig`:\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:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
##### 

```java
// Get tenancy config 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.TenancyConfig;

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

    try {
      TenancyConfig result = apiInstance.getTenancyConfig("tenancy_ocid");
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OciIntegrationApi#getTenancyConfig");
      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:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
##### 

```rust
// Get tenancy config 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_config("tenancy_ocid".to_string()).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:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
##### 

```typescript
/**
 * Get tenancy config returns "OK" response
 */

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

const configuration = client.createConfiguration();
const apiInstance = new v2.OCIIntegrationApi(configuration);

const params: v2.OCIIntegrationApiGetTenancyConfigRequest = {
  tenancyOcid: "tenancy_ocid",
};

apiInstance
  .getTenancyConfig(params)
  .then((data: v2.TenancyConfig) => {
    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:
    DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
{% /tab %}
