Skip to content
StratumStratum Docs

Update mutable log-group fields.

PATCH
/v1/projects/{projectId}/observability/log-groups/{logGroupId}
Code sample: Shell / cURL
curl --request PATCH \
  --url https://stratum.example.com/v1/projects/example/observability/log-groups/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "displayName": "example", "description": "example", "retentionDays": 1, "emfEnabled": true, "tags": { "additionalProperty": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/
logGroupId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
displayName
string
>= 1 characters <= 100 characters
description
string
retentionDays
integer
>= 1 <= 3650
emfEnabled

Toggle EMF metric extraction on this log group.

boolean
tags
object
key
additional properties
string

Example generated

{
  "displayName": "example",
  "description": "example",
  "retentionDays": 1,
  "emfEnabled": true,
  "tags": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated log group.

Media typeapplication/json
object
id
required
string
/^lg-[a-z0-9]{16}$/
projectId
required
string
name
required
string
displayName
required
string
description
string
retentionDays
required
integer
>= 1 <= 3650
emfEnabled

. When true, the PutLogEvents path scans each event message as JSON and extracts AWS Embedded Metric Format (_aws.CloudWatchMetrics) metrics, emitting them through the standard OTel SDK path. The log line still ships to VictoriaLogs unchanged. Defaults to false to avoid cardinality surprises.

boolean
tags
object
key
additional properties
string
origin

Provenance marker. Empty for customer-created groups; one of platform.system / platform.audit-shadow for the two auto-created-per-project groups, platform.pack for substrate groups, platform.image-builder for image build output, and platform.guest-logs for the instances group the instance agent ships guest logs to (one stream per instance, each line stamped instance_id by the control plane; the API cannot write to it).

string
state
required
string
Allowed values: active deleted
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
deletedAt
string format: date-time
nullable
createdBy
required
string

Example 

{
  "emfEnabled": false,
  "state": "active"
}

400

Section titled “400”

Bad request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}

404

Section titled “404”

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}