runs

Start run

Changed on

Start a new run for tracking

post/api/v1/runs/start

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header Authorization

Request body

configRawPluginConfig
pipeline_namestring required
source_namestring required

Response

OK

completed_atstring
configRawPluginConfig
created_bystring
error_messagestring
idstring
pipeline_namestring
run_idstring
source_namestring
started_atstring
status'running' | 'completed' | 'failed' | 'cancelled'

Changes

  • 0bd802afff21Revision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was added to the API