Skip to content

Update drift detection settings

PUT
/drift/settings
curl --request PUT \
--url https://example.com/api/v1/drift/settings \
--header 'Content-Type: application/json' \
--data '{ "enabled": true, "intervalMinutes": 1 }'

Enables/disables drift detection and sets the polling interval, then reschedules or cancels the recurring drift check job accordingly.

Media typeapplication/json
object
enabled
boolean
intervalMinutes
integer
>= 5
Examplegenerated
{
"enabled": true,
"intervalMinutes": 1
}

Updated drift settings

Media typeapplication/json
object
enabled
required
boolean
intervalMinutes
required
integer
>= 5
lastRunAt
required
One of:
string format: date-time
nextRunAt
required
One of:
string format: date-time
backoffUntil
required
One of:
string format: date-time
errorCount
required
integer
Examplegenerated
{
"enabled": true,
"intervalMinutes": 1,
"lastRunAt": "2026-04-15T12:00:00Z",
"nextRunAt": "2026-04-15T12:00:00Z",
"backoffUntil": "2026-04-15T12:00:00Z",
"errorCount": 1
}

Invalid settings payload

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}

Failed to update drift settings

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}