Skip to content

Update Refresh Policy

PUT
/api/workbooks/{workbook_id}/refresh-policy
curl --request PUT \
--url http://localhost:8000/api/workbooks/example/refresh-policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "enabled": true, "interval": "example", "on_signal": [ "example" ], "staleness_ttl_days": {} }'

Make a workbook ‘living’: schedule recurring refresh and/or signal triggers.

workbook_id
required
Workbook Id
string
x-workspace-id
Any of:
string
Media typeapplication/json
RefreshPolicyRequest
object
enabled
Enabled
boolean
default: true
interval
Any of:
string
on_signal
On Signal
Array
staleness_ttl_days
Staleness Ttl Days
object
key
additional properties
any

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}