DAdagucloud
dag-runs

Enqueue a DAG-run from inline spec

Changed on

Creates a DAG-run directly from a provided DAG specification (YAML) and enqueues it for execution.

This endpoint does not require a pre-existing DAG file; the supplied spec is parsed and validated similarly to /dags/validate, and the run is persisted to the queue if valid.

post/dag-runs/enqueue

Request

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

Query parameters

remoteNodestring

name of the remote node

Request body

specstring required

DAG specification in YAML format

namestring

Optional name to use when the spec omits a name

profilestring

Runtime profile override. Empty string means no profile.

paramsstring

Parameters to persist with the queued DAG-run in JSON format

dagRunIdstring

Optional ID for the DAG-run; if omitted a new one will be generated

queuestring

Override the queue to use for this DAG-run

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

DAG-run successfully enqueued

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