--- title: Update a Temporal Cloud OpenMetrics account description: Update a Temporal Cloud OpenMetrics integration account. Only the fields provided are changed. breadcrumbs: Docs > API > Update a Temporal Cloud OpenMetrics account --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Update a Temporal Cloud OpenMetrics account ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------------------------------------------ | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | uk1.datadoghq.com | PATCH https://api.uk1.datadoghq.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/{account_id} | ### Overview Update a Temporal Cloud OpenMetrics integration account. Only the fields provided are changed. This endpoint requires the `manage_integrations` permission. ### Arguments #### Path Parameters | Field | Type | Description | | ----------------------- | ------ | --------------------------------------------- | | account_id [*required*] | string | Unique identifier of the integration account. | ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------------------ | ------------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data envelope for updating a Temporal Cloud OpenMetrics integration account. | | data | attributes [*required*] | object | Writable attributes used to update a Temporal Cloud OpenMetrics integration account. Every field is optional. Only the fields provided are changed. | | attributes | authentication | | Authentication for updating the Temporal Cloud OpenMetrics integration account. Exactly one method is set. | | authentication | | object | 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 [*required*] | enum | The authentication method type. Allowed enum values: `bearer_token`. Default: `bearer_token`. | | | token | string | Secret token used to authenticate with Temporal Cloud. | | attributes | name | string | Human-readable name of the Temporal Cloud OpenMetrics integration account. | | attributes | settings | object | Settings for updating the Temporal Cloud OpenMetrics integration account. Only the fields provided are changed. | | settings | 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. | | settings | 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. | | data | id [*required*] | string | Unique identifier of the Temporal Cloud OpenMetrics integration account to update. | | data | type [*required*] | enum | The type of the integration account resource. Always `integration-account`. Allowed enum values: `integration-account`. Default: `integration-account`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "authentication": { "auth_type": "bearer_token", "token": "your-token" }, "name": "temporal-cloud-prod", "settings": { "include_opt_in_labels": false, "namespaces_to_include": "prod-*,billing.a1b2c" } }, "id": "7c2d4e91-5a3b-4f68-b0e2-9d1f6a8c3e57", "type": "integration-account" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response payload for a single Temporal Cloud OpenMetrics integration account. | Parent field | Field | Type | Description | | ---------------------------------- | ---------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data envelope of a Temporal Cloud OpenMetrics integration account, including server-assigned identity. | | data | attributes [*required*] | object | Attributes of a Temporal Cloud OpenMetrics integration account returned in responses. | | attributes | authentication | | Authentication configured on the Temporal Cloud OpenMetrics integration account. | | authentication | | object | The bearer token authentication method configured on the account. | | | auth_type [*required*] | enum | The authentication method type. Allowed enum values: `bearer_token`. Default: `bearer_token`. | | attributes | dataflows | object | Data Datadog collects from Temporal Cloud OpenMetrics, keyed by dataflow ID. | | dataflows | temporal-cloud-openmetrics-metrics | object | 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. | | temporal-cloud-openmetrics-metrics | enabled | boolean | Whether Datadog collects this data. Always `true`, because this collection cannot be turned off. Read-only. | | temporal-cloud-openmetrics-metrics | status | object | Read-only collection status of a dataflow. Read-only. | | status | health | enum | Collection health of a single dataflow. Allowed enum values: `DATAFLOW_HEALTH_OK`, `DATAFLOW_HEALTH_BROKEN`, `DATAFLOW_HEALTH_UNKNOWN`. | | status | message | string | Human-readable detail, populated when the dataflow is not healthy. | | status | updated_at | date-time | Time the status was last computed. | | attributes | name [*required*] | string | Human-readable name of the Temporal Cloud OpenMetrics integration account. | | attributes | settings [*required*] | object | Settings configured on the Temporal Cloud OpenMetrics integration account. | | settings | 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. | | settings | 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. | | data | id [*required*] | string | Server-generated unique identifier of the Temporal Cloud OpenMetrics integration account. Read-only. | | data | type [*required*] | enum | The type of the integration account resource. Always `integration-account`. Allowed enum values: `integration-account`. Default: `integration-account`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "authentication": { "auth_type": "bearer_token" }, "dataflows": { "temporal-cloud-openmetrics-metrics": { "enabled": true, "status": { "health": "DATAFLOW_HEALTH_OK", "message": "", "updated_at": "2026-06-25T08:30:50Z" } } }, "name": "temporal-cloud-prod", "settings": { "include_opt_in_labels": false, "namespaces_to_include": "prod-*,billing.a1b2c" } }, "id": "7c2d4e91-5a3b-4f68-b0e2-9d1f6a8c3e57", "type": "integration-account" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% 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 %} {% tab label="403" %} Forbidden {% 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 %} {% tab label="404" %} Not Found {% 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 %} {% tab label="422" %} The server cannot process the request because it contains invalid data. {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /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 # Path parameters export account_id="CHANGE_ME" # 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="" curl -X PATCH "https://api.${DD_SITE}/api/v2/integration-interfaces/temporal-cloud-openmetrics/accounts/${account_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "authentication": { "auth_type": "bearer_token", "token": "your-token" }, "name": "temporal-cloud-prod", "settings": { "include_opt_in_labels": false, "namespaces_to_include": "prod-*,billing.a1b2c" } }, "id": "7c2d4e91-5a3b-4f68-b0e2-9d1f6a8c3e57", "type": "integration-account" } } EOF ``` {% /tab %} {% /tabs %}