Fleet Manager Configuration Groups

Update configuration group

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. An archived group returns 404.

patch/fleet-management/configuration-groups/v1/{id}

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/fleet-management/configuration-groups/v1/{id}
  • Auth: API key in header Authorization

Query parameters

update_maskstring required

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.

Request body

descriptionstring

Human-readable description.

namestring

Display name, unique among the team's configuration groups.

priorityOrderinteger

Selection precedence. Higher values win on ties and 0 is the default.

tagsstring[]

Tags attached to the configuration group.

Response

archivedboolean required

Whether this configuration group is archived.

descriptionstring

Human-readable description.

idstring required

Configuration group UUID v7.

namestring

Display name, unique among the team's configuration groups.

priorityOrderinteger required

Selection precedence. Higher values win on ties and 0 is the default.

tagsstring[]

Tags attached to the configuration group.

Changes

No recorded changes to this operation across all 1 revision of this API.