Skip to content

Update observability destination

PATCH /observability-destination/{id}

Path Parameters

idstring · uuid
required

Request Body

configRecord<string, any>

Replaces the whole stored config when provided (fields are not merged), so it must be a complete config for the destination type. For example, a Datadog update must include site even when only tags change; a partial config is rejected with a 400.

is_activeboolean
namestring
secretsRecord<string, any>

Secret bag stored as a single encrypted JSON blob. Replaces the stored secrets when provided, and must include the secrets the destination type requires. Never returned by the API.

typestring

Changing the type requires config and secrets for the new type in the same request.

Possible values:
datadogsplunk_hecsentinelotlp

Response Body

configRecord<string, any>

Non-secret destination configuration. Datadog: site, tags. Splunk HEC: hec_url, index, source, sourcetype. Microsoft Sentinel: tenant_id, client_id, dce_endpoint, dcr_immutable_id, stream_name, cloud. OTLP: endpoint, resource_attributes. All types accept a log_types filter.

created_atstring · date-time
environment_idstring · uuid

The environment whose logs are forwarded.

idstring · uuid

The ID of the observability destination.

is_activeboolean

Whether forwarding is enabled.

namestring

Human-readable destination name.

typestring

Destination type.

Possible values:
datadogsplunk_hecsentinelotlp
updated_atstring · date-time
curl -X PATCH 'https://api.truto.one/observability-destination/{id}' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "datadog",
  "name": "your_name",
  "is_active": true,
  "config": {},
  "secrets": {}
}'
const body = {
  "type": "datadog",
  "name": "your_name",
  "is_active": true,
  "config": {},
  "secrets": {}
};

const response = await fetch('https://api.truto.one/observability-destination/{id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/observability-destination/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
}
payload = {
    "type": "datadog",
    "name": "your_name",
    "is_active": True,
    "config": {},
    "secrets": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())