Get configuration group

GEThttps://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.

Returns a configuration group with its latest family. Family active indicates eligibility for delivery, not whether an agent has successfully applied the configuration. An archived group returns 404 unless include_archived=true; when included, an archived group is returned with its latest configuration family, which may itself be archived.

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

include_archived# boolean

When true, return an archived group with its latest configuration family, including an archived family. Otherwise an archived group returns 404.

Response

200400401404500application/json

Requested 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"]