Skip to main content

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

Authorizations

Authorizationstringheaderrequired
API key authentication

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.

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.

Body

application/json

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

    description#string

    Human-readable description.

    Possible values: <= 4096 characters, Value must match regular expression ^[\s\S]*$

    Latest configuration family field values.

    name#string

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

    Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]*$

    priorityOrder#int32

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

    Possible values: >= -2147483648 and <= 2147483647

    Default value: 0
    tags#string[]

    Tags attached to the configuration group.

    Possible values: <= 64

Response

application/json

Updated configuration group.

    archived#booleanrequired

    Whether this configuration group is archived.

    description#string

    Human-readable description.

    Possible values: <= 4096 characters, Value must match regular expression ^[\s\S]*$

    family#object

    Latest configuration family of the group.

    oneOf
    object
    family.active#booleanrequired

    Whether this family is active.

    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}$

    family.description#string

    Human-readable description.

    Possible values: <= 4096 characters, Value must match regular expression ^[\s\S]*$

    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}$

    family.lastActivatedAt#date-time

    Time when this family was last activated.

    Possible values: <= 64 characters

    Configuration template settings; present when the family has a chartName and observability features.

    Inputs of a configuration family defined directly by its remote configurations; present when the family has no chartName.

    Immutable inputs that produced this configuration family version.

    Possible values: <= 128

    family.version#stringrequired

    Monotonic version number of this configuration family within its group.

    Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]*$

    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}$

    name#string

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

    Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]*$

    priorityOrder#int32required

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

    Possible values: >= -2147483648 and <= 2147483647

    Default value: 0
    tags#string[]

    Tags attached to the configuration group.

    Possible values: <= 64