Update config-health settings

PUT

/config-health/settings

curl --request PUT \
  --url https://example.com/api/v1/config-health/settings \
  --header 'Content-Type: application/json' \
  --data '{ "expectedEngineVersion": "example", "enabled": true, "intervalMinutes": 1, "retentionDays": 1, "retentionMaxEntries": 1, "criteria": [ { "id": "example", "enabled": true, "weight": 1 } ] }'

• API v1

Update the criteria enable/weights, cadence, and retention. Reschedules the snapshot + cleanup jobs immediately. Returns 409 when expectedEngineVersion does not match the server engine.

Request Body^required

Media typeapplication/json

Partial settings update. expectedEngineVersion guards against a stale client (409 on mismatch).

object

expectedEngineVersion

required

string

enabled

boolean

intervalMinutes

integer

>= 5

retentionDays

integer

>= 1

retentionMaxEntries

integer

>= 1

criteria

Array<object>

object

id

required

string

enabled

required

boolean

weight

required

integer

Example^generated

{
  "expectedEngineVersion": "example",
  "enabled": true,
  "intervalMinutes": 1,
  "retentionDays": 1,
  "retentionMaxEntries": 1,
  "criteria": [
    {
      "id": "example",
      "enabled": true,
      "weight": 1
    }
  ]
}

Responses

200

Updated config-health settings

Media typeapplication/json

object

engineVersion

required

string

enabled

required

boolean

intervalMinutes

required

integer

>= 5

retentionDays

required

integer

>= 1

retentionMaxEntries

required

integer

>= 1

criteria

required

Array<object>

object

id

required

string

enabled

required

boolean

weight

required

integer

catalog

required

Array<object>

object

id

required

string

label

required

string

description

required

string

Example^generated

{
  "engineVersion": "example",
  "enabled": true,
  "intervalMinutes": 1,
  "retentionDays": 1,
  "retentionMaxEntries": 1,
  "criteria": [
    {
      "id": "example",
      "enabled": true,
      "weight": 1
    }
  ],
  "catalog": [
    {
      "id": "example",
      "label": "example",
      "description": "example"
    }
  ]
}

400

Invalid request

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

409

Engine version mismatch

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}