Sign in
latestOpenAPI 3.0.02026-08-137192110.1 KB

75294f591cc2

Orchestrations

Create Orchestration

Create a new Orchestration with the given name and cron schedule.

post/orchestrations

Request body

namestring required

The name of the Orchestration.

cron_expressionstring required

Cron expression defining when the Orchestration runs.

descriptionstring

The description of the Orchestration.

Example request

{
  "name": "My Orchestration",
  "cron_expression": "0 0 * * *",
  "description": "Daily sync of all marketing data."
}

Response

The Orchestration has been successfully created.

idstring required

The Id of the Orchestration.

namestring required

The name of the Orchestration.

cron_expressionstring required

The cron expression defining when the Orchestration runs.

descriptionstring nullable required

The description of the Orchestration.

activeboolean required

Whether the Orchestration is active.

Example response

{
  "id": "ewK8sDoLNI4CFR",
  "name": "My Orchestration",
  "cron_expression": "0 0 * * *",
  "description": "Daily sync of all marketing data.",
  "active": true
}