Skip to content

cron

Accessed as client.admin.cron; the async client mirrors it.

AdminCron

The admin.cron namespace.

list

list(*, page: int | None = None, limit: int | None = None) -> Paginated[Cron]

List cron tasks.

Parameters:

Name Type Description Default
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
Paginated[Cron]

CronList.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: adminCronList

run

run(task: str) -> None

Run cron task.

Parameters:

Name Type Description Default
task str

task to run

required

Returns:

Type Description
None

No content.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: adminCronRun

AsyncAdminCron

The admin.cron namespace.

list

list(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Cron]

List cron tasks.

Parameters:

Name Type Description Default
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
AsyncPaginated[Cron]

CronList.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: adminCronList

run

run(task: str) -> None

Run cron task.

Parameters:

Name Type Description Default
task str

task to run

required

Returns:

Type Description
None

No content.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: adminCronRun