Skip to main content
Theme
Home

Create configuration overlay

POSThttps://api.eu1.coralogix.com/mgmt/openapi/5/fleet-management/configuration-overlays/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 custom configuration overlay (OpenTelemetry Collector YAML). It is inactive unless active is true, which needs at least one target.

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 custom configuration overlay.

    active#boolean

    Set true to activate the overlay when it is created.

    Default value: false

    Custom overlay: an OpenTelemetry Collector YAML fragment and its targets.

    description#string

    Human-readable description.

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

    name#stringrequired

    Display name, unique among unarchived overlays.

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

    priorityOrder#int32

    Merge precedence on a shared remote configuration: higher values win, and the newer overlay wins a tie.

    Possible values: >= -2147483648 and <= 2147483647

    Default value: 0

    Activation schedules. Windows must not overlap; a window may start when another ends.

    Possible values: <= 10

    tags#string[]

    Tags attached to the configuration overlay.

    Possible values: <= 64

Response

application/json

Created configuration overlay.

    oneOf
    object
    active#booleanrequired

    Whether the latest version is active. With schedules, it applies only during their windows.

    Default value: false
    archived#booleanrequired

    Whether this configuration overlay is archived.

    createdBy#string

    User that created the configuration overlay.

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

    Custom overlay content of the latest version.

    description#string

    Human-readable description.

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

    id#stringrequired

    Configuration overlay UUID v7.

    Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

    name#string

    Display name.

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

    overlayHash#stringrequired

    Lowercase hexadecimal SHA-256 hash of the normalized payload: the custom overlay YAML, or the preset JSON.

    Possible values: >= 64 characters and <= 64 characters, Value must match regular expression ^[0-9a-f]{64}$

    parentVersionId#string

    UUID v7 of the version the latest version was created from.

    Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

    Preset overlay content of the latest version, for ObservabilityFeatures overlays created outside this API.

    priorityOrder#int32required

    Merge precedence on a shared remote configuration: higher values win, and the newer overlay wins a tie.

    Possible values: >= -2147483648 and <= 2147483647

    Default value: 0

    Activation schedules of the latest version. With schedules, an active overlay applies only during their windows.

    Possible values: <= 10

    tags#string[]required

    Tags attached to the configuration overlay.

    Possible values: <= 64

    version#stringrequired

    Monotonic number of the latest version.

    Possible values: non-empty and <= 10 characters, Value must match regular expression ^[1-9][0-9]*$

    versionId#stringrequired

    UUID v7 of the latest version. Changes when an update creates a version.

    Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$