POST /repositories/{workspace}/{repo_slug}/pipelines_config/schedules

Create a schedule for the given repository.

Servers

Path parameters

Name Type Required Description
repo_slug String Yes

The repository.

workspace String Yes

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
cron_pattern String Yes

The cron expression with second precision (7 fields) that the schedule applies. For example, for expression: 0 0 12 * * ? *, will execute at 12pm UTC every day.

target Object Yes

The target on which the schedule will be executed.

target.ref_type String Yes

The type of reference (branch only).

Possible values:

  • "branch"
target.ref_name String Yes

The name of the reference.

type String Yes
enabled Boolean No

Whether the schedule is enabled.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.