Skip to main content
Theme
Home

Update configuration overlay

PATCHhttps://api.eu1.coralogix.com/mgmt/openapi/5/fleet-management/configuration-overlays/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; a listed field that is omitted from the body is cleared or reset to its default. A change to the content of custom.configuration or custom.targets creates a new version that carries over the schedules. An archived overlay can't be updated. Activation needs a target, and every schedule needs a future window. A version-creating change is rejected while a scheduled window is applying.

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}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

    Configuration overlay 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, active, custom, custom.configuration, custom.targets, schedules. A listed field that is omitted from the body is cleared (description, tags, custom.targets, schedules) or reset to its default (priorityOrder 0, active false); name, custom, and custom.configuration cannot be cleared. Unknown fields and * return 400.

Body

application/json

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

    active#boolean

    Set true to activate or false to deactivate the overlay. With schedules, activation enables them, and deactivation pauses them and ends a running window.

    Default value: false

    Custom overlay fields to update. Rejected for preset overlays.

    description#string

    Human-readable description.

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

    name#string

    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

    Replaces the schedules of the latest version without creating a version. When the same request changes custom content, the list moves to the new version with new ids. Windows must not overlap; a window may start when another ends. Schedules are matched by startAt, duration, recurrence, and timeZone: a match keeps its id, and other schedules are removed. An empty list on an active overlay applies it continuously, right away.

    Possible values: <= 10

    tags#string[]

    Tags attached to the configuration overlay. Replaces all tags.

    Possible values: <= 64

Response

application/json

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