Update configuration group

PATCHhttps://api.eu1.coralogix.com/mgmt/openapi/5/fleet-management/configuration-groups/v1/{id}

Preview

This operation is experimental. It is published and you can call it, but it may change or break, and is not covered by the stable API compatibility guarantee.

Updates the fields listed in update_mask; other fields are unchanged. Changing family.raw or family.preset creates a new configuration family version only when the content changes. Send group field values directly in the request body. To activate the latest family, send {"family":{"active":true}} with update_mask=family.active. The response contains the latest family. An archived group returns 404.

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Path Parameters

id# stringrequired
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Configuration group UUID v7.
Example: 01975ed4-9c1a-7b3f-8d4e-426614174000

Query Parameters

update_mask# stringrequired
Possible values: non-empty and <= 512 characters, Value must match regular expression ^[A-Za-z_][A-Za-z0-9_.]*(,[A-Za-z_][A-Za-z0-9_.]*)*$
Comma-separated fields to update: name, description, tags, priorityOrder, family.description, family.active, family.raw, family.preset, or one field inside family.raw or family.preset, such as family.raw.metadata or family.preset.chartVersion. family.raw and family.preset replace the whole family content; a field inside them changes only that field and keeps the others. A listed field that is omitted from the body is cleared (description, tags, family.description, and optional fields inside family.raw or family.preset) or reset to its default (priorityOrder 0, family.active false). name cannot be cleared, and family.raw.remoteConfigurations cannot be empty. Changing family.preset.chartVersion without family.preset.integrationVersion uses the default integration version of the new chart version. The body must include the arm being changed, and only the arm matching the current family's content type is accepted (raw and preset families cannot be switched). A bare family, unknown paths, and * return 400.
Example: family.active

Body

application/json

Configuration group field values for an update. Only fields listed in update_mask are applied.

description#string
Description of the group's purpose.
Possible values: <= 4096 characters, Value must match regular expression ^[\s\S]*$
Example: Collector configuration for production Linux virtual machines.
family# object
Latest configuration family field values.
name#string
Display name shown in Fleet Management, unique among the team's configuration groups.
Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]*$
Example: Production Linux VMs
priorityOrder#int32
Selection priority when multiple configurations match an agent. Higher values take precedence.
Possible values: >= -2147483648 and <= 2147483647
Default value: 0
Example: 100
tags#string[]
Tags for organizing the group. Tags do not select agents.
Possible values: <= 64
Example: ["production"]

Response

200400401404409500application/json

Updated configuration group.

archived#booleanrequired
Whether this configuration group is archived.
description#string
Description of the group's purpose.
Possible values: <= 4096 characters, Value must match regular expression ^[\s\S]*$
Example: Collector configuration for production Linux virtual machines.
family#object
Latest configuration family of the group.
oneOf
• Option 1
• Option 2
• Option 3
object
family.active#booleanrequired
Whether this family is eligible for delivery to matching agents. This is not confirmation that an agent has applied it.
Default value: false
family.basedOnConfigurationFamilyId#string
Configuration family UUID v7 this family is based on.
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example: 01975ed4-9c18-7a2d-9b4e-426614173999
family.description#string
Human-readable description.
Possible values: <= 4096 characters, Value must match regular expression ^[\s\S]*$
Example: Adds an OTLP logs pipeline for the production Linux VMs.
family.id#stringrequired
Configuration family UUID v7.
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example: 01975ed4-9c1b-7c2a-9e5f-526614174001
family.lastActivatedAt#date-time
Time when this family was last activated.
Possible values: <= 64 characters
Example: 2026-10-08T09:41:01.000Z
family.preset# object
Configuration template settings; present when the family has a chartName and observability features.
family.raw# object
Inputs of a configuration family defined directly by its remote configurations; present when the family has no chartName.
family.sources# object[]
Immutable inputs that produced this configuration family version.
Possible values: <= 128
family.version#stringrequired
Increasing family version within this group, returned as a string. The initial version is "1"; changed configuration content creates a new version.
Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]*$
Example: 2
id#stringrequired
Configuration group UUID v7.
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example: 01975ed4-9c1a-7b3f-8d4e-426614174000
name#string
Display name shown in Fleet Management, unique among the team's configuration groups.
Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]*$
Example: Production Linux VMs
priorityOrder#int32required
Selection priority when multiple configurations match an agent. Higher values take precedence.
Possible values: >= -2147483648 and <= 2147483647
Default value: 0
Example: 100
tags#string[]
Tags for organizing the group. Tags do not select agents.
Possible values: <= 64
Example: ["production"]