Skip to main content
PATCH
Update a log group
Requires the IAM action telemetry:UpdateLogGroup. See TELEMETRY permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

id
string<uuid>
required
Example:

"4a7b2c8d-9e1f-4a2b-8c3d-5e6f7a8b9c0d"

Body

application/json
description
string | null
Example:

"Production API request logs (v2)"

retention_days
enum<integer> | null

Omit to preserve retention. Null selects no expiry.

Available options:
1,
3,
5,
7,
14,
30,
60,
90,
120,
150,
180,
365,
400,
545,
731,
1096,
1827,
2192,
2557,
2922,
3288,
3653,
null
Example:

90

kms_key
string | null

KMS key UUID, CRN or exact name in this account and region. Omit to preserve the binding; null clears encryption for future records.

Example:

"crn:kms:sa-saopaulo-1:my-account:key/service-key"

tags
object

Response

Updated log group

log_group
object
required