Skip to main content

ScheduleCollectionClient

Sub-client for manipulating schedules.

Index

Methods

Methods

create

  • create(*, cron_expression, is_enabled, is_exclusive, name, actions, description, timezone, title): dict

  • Create a new schedule.

    https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule

    Parameters

    • keyword-onlycron_expression: str

      The cron expression used by this schedule.

    • keyword-onlyis_enabled: bool

      True if the schedule should be enabled.

    • keyword-onlyis_exclusive: bool

      When set to true, don't start Actor or Actor task if it's still running from the previous schedule.

    • optionalkeyword-onlyname: str | None = None

      The name of the schedule to create.

    • optionalkeyword-onlyactions: list[dict] | None = None

      Actors or tasks that should be run on this schedule. See the API documentation for exact structure.

    • optionalkeyword-onlydescription: str | None = None

      Description of this schedule.

    • optionalkeyword-onlytimezone: str | None = None

      Timezone in which your cron expression runs (TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

    • optionalkeyword-onlytitle: str | None = None

      Title of this schedule.

    Returns dict

list

  • list(*, limit, offset, desc): ListPage[dict]
Page Options