Skip to main content
Theme
Home

Create configuration group

POSThttps://api.eu1.coralogix.com/mgmt/openapi/5/fleet-management/configuration-groups/v1
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.

Creates a fleet-manager configuration group.

Authorizations

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

Request​

Body

application/json

Payload used to create a fleet-manager configuration group.

    description#string

    Human-readable description.

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

    Initial configuration family to create with this group.

    name#stringrequired

    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

Created 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