DAdagucloud
dags

Enqueue a DAG-run from DAG

Changed on

Creates a DAG-run from the DAG definition and adds it to the queue for execution

post/dags/{fileName}/enqueue

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Path parameters

fileNamestring regex required

Name of the DAG file

the name of the DAG file

Query parameters

remoteNodestring

name of the remote node

Request body

paramsstring

Parameters to pass to the DAG-run in JSON format

dagRunIdstring

Optional ID for the DAG-run, if not provided a new one will be generated

dagNamestring

Optional DAG name override to use for the queued dag-run

profilestring

Runtime profile override. Empty string means no profile.

queuestring

Override the DAG-level queue definition

workerSelectorWorkerSelectorOverride

Worker labels this DAG-run requires. Replaces the DAG-level worker_selector for this run, including its "local" value, and is kept with the run so retries, reschedules, and queued dispatch route the same way. Not allowed for DAGs with approval steps.

singletonboolean

If true, prevent enqueuing if DAG is already running or queued (returns 409 conflict)

noReuseboolean

If true, execute eligible build steps without reusing prior materializations

labelsstring[]

Additional labels to apply to the DAG-run (format: key=value or key-only). Merged with labels defined in the DAG spec. Mutually exclusive with deprecated tags; the server returns HTTP 400 if both are set.

tagsstring[]

Deprecated alias for Labels. Additional labels to apply to the DAG-run (format: key=value or key-only). Merged with labels defined in the DAG spec. Mutually exclusive with labels; the server returns HTTP 400 if both are set.

Example request

{
  "dagRunId": "latest"
}

Response

A successful response

dagRunIdstring required

Unique identifier for the DAG-run. The special value 'latest' can be used to reference the most recent DAG-run.

Example response

{
  "dagRunId": "latest"
}

Changes

  • v1ec5ecbb0238aRevision changes
    • info

      added the new optional request property

  • v1e189ef0f1cacRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from array to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from array to no type

    • info

      removed the pattern ^$|^[a-z0-9][a-z0-9._-]*$ from the request property