Buckets

Schedule bucket refresh

EXPERIMENTAL

Schedule external bucket refresh to a given time or repeating period defined by a cron expression. Available for external buckets in the default branch only.

post/v2/storage/buckets/{bucketId}/scheduled-tasks/refresh

Request

Base URL
https://connection.keboola.com
Auth
- API key in header X-StorageApi-Token
- or API key in header X-KBC-ManageApiToken
- or HTTP bearer
TypeScript
https://skmtc.dev/keboola/apis/keboola-storage-api/docs/v2/storage/buckets/:bucketId/scheduled-tasks/refresh/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

bucketIdstring required

Bucket ID.

Request body

cronExpressionstring required

Cron expression defining when the scheduled refresh runs.

Example request

{
  "cronExpression": "42 13 * * *"
}

Response

Scheduled task data.

uuidstring uuid required

Identifier of the scheduled task.

job'bucketRefresh' required

Job the task runs.

relatedEntity'bucket' required

Type of the entity the task is attached to.

relatedIdstring required

Identifier of the related entity (bucket ID).

cronExpressionstring required

Cron expression of the schedule.

createdAtstring date-time required

Creation timestamp of the task.

Example response

{
  "uuid": "0197e22b-379d-7c62-bc6d-88e50c3d0c75",
  "job": "bucketRefresh",
  "relatedEntity": "bucket",
  "relatedId": "in.c-bucket-name",
  "cronExpression": "42 13 * * *",
  "createdAt": "2025-07-01T00:08:00+02:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.