---
title: "Update a Temporal Cloud OpenMetrics account"
method: PATCH
path: "/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id}"
tags: ["Temporal Cloud OpenMetrics Integration"]
---

# Update a Temporal Cloud OpenMetrics account

`PATCH /api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id}`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id}`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token`
- TypeScript: <https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/:account_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update a Temporal Cloud OpenMetrics integration account. Only the fields provided are changed.

## Path parameters

- `account_id` string, required

## Request body

- TemporalCloudOpenMetricsIntegrationAccountUpdateRequest: Request payload to update a Temporal Cloud OpenMetrics integration account.
  - `data` TemporalCloudOpenMetricsIntegrationAccountUpdateData, required: Data envelope for updating a Temporal Cloud OpenMetrics integration account.
    - `attributes` TemporalCloudOpenMetricsIntegrationAccountUpdateAttributes, required: Writable attributes used to update a Temporal Cloud OpenMetrics integration account. Every field is optional. Only the fields provided are changed.
      - `authentication` TemporalCloudOpenMetricsIntegrationAccountAuthenticationUpdate: Bearer token authentication. Use the API key of a Temporal Cloud service account with the Metrics Read-Only account-level role. Only the fields provided are changed. Omit `token` to keep the stored one.
        - `auth_type` 'bearer_token', required: The authentication method type.
        - `token` string: Secret token used to authenticate with Temporal Cloud.
      - `name` string: Human-readable name of the Temporal Cloud OpenMetrics integration account.
      - `settings` TemporalCloudOpenMetricsIntegrationAccountSettingsUpdate: Settings for updating the Temporal Cloud OpenMetrics integration account. Only the fields provided are changed.
        - `include_opt_in_labels` boolean: When enabled, Datadog collects Temporal Cloud's [opt-in labels](https://docs.temporal.io/cloud/metrics/openmetrics/metrics-reference#opt-in-labels) (activity type, worker deployment name, and worker build ID) for more granularity on your existing metrics. Enabling them may increase metric collection latency.
        - `namespaces_to_include` string: Comma-separated list of Temporal Cloud namespaces to collect metrics for. An entry can use `*` as a wildcard. For example, `prod-*` matches every namespace starting with `prod-`. Entries may contain only lowercase letters, digits, hyphens, periods, and `*`. Any other value is rejected with a `422` response. Omit this field or leave it empty to collect metrics for all namespaces.
    - `id` string, required: Unique identifier of the Temporal Cloud OpenMetrics integration account to update.
    - `type` 'integration-account', required: The type of the integration account resource. Always `integration-account`.

## Response `200`

OK

- TemporalCloudOpenMetricsIntegrationAccountResponse: Response payload for a single Temporal Cloud OpenMetrics integration account.
  - `data` TemporalCloudOpenMetricsIntegrationAccountResponseData, required: Data envelope of a Temporal Cloud OpenMetrics integration account, including server-assigned identity.
    - `attributes` TemporalCloudOpenMetricsIntegrationAccountResponseAttributes, required: Attributes of a Temporal Cloud OpenMetrics integration account returned in responses.
      - `authentication` TemporalCloudOpenMetricsIntegrationAccountAuthenticationResponse: The bearer token authentication method configured on the account.
        - `auth_type` 'bearer_token', required: The authentication method type.
      - `dataflows` TemporalCloudOpenMetricsIntegrationDataflowsResponse: Data Datadog collects from Temporal Cloud OpenMetrics, keyed by dataflow ID.
        - `temporal-cloud-openmetrics-metrics` TemporalCloudOpenMetricsMetricsIntegrationDataflowResponse: Temporal Cloud operational metrics for your namespaces, workflows, and task queues, such as workflow and activity rates, task polling, and service request latency, collected from Temporal Cloud's OpenMetrics endpoint. This is the integration's only collection: it is always on and cannot be turned off, which is why it appears only in responses.
          - `enabled` boolean: Whether Datadog collects this data. Always `true`, because this collection cannot be turned off.
          - `status` IntegrationAccountDataflowStatus: Read-only collection status of a dataflow.
            - `health` 'DATAFLOW_HEALTH_OK' | 'DATAFLOW_HEALTH_BROKEN' | 'DATAFLOW_HEALTH_UNKNOWN': Collection health of a single dataflow.
            - `message` string: Human-readable detail, populated when the dataflow is not healthy.
            - `updated_at` string, date-time: Time the status was last computed.
      - `name` string, required: Human-readable name of the Temporal Cloud OpenMetrics integration account.
      - `settings` TemporalCloudOpenMetricsIntegrationAccountSettingsResponse, required: Settings configured on the Temporal Cloud OpenMetrics integration account.
        - `include_opt_in_labels` boolean: When enabled, Datadog collects Temporal Cloud's [opt-in labels](https://docs.temporal.io/cloud/metrics/openmetrics/metrics-reference#opt-in-labels) (activity type, worker deployment name, and worker build ID) for more granularity on your existing metrics. Enabling them may increase metric collection latency.
        - `namespaces_to_include` string: Comma-separated list of Temporal Cloud namespaces to collect metrics for. An entry can use `*` as a wildcard. For example, `prod-*` matches every namespace starting with `prod-`. Empty or absent when metrics are collected for all namespaces.
    - `id` string, required: Server-generated unique identifier of the Temporal Cloud OpenMetrics integration account.
    - `type` 'integration-account', required: The type of the integration account resource. Always `integration-account`.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `422`: The server cannot process the request because it contains invalid data.
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)