Runs

List Runs

get

Get pipeline runs according to query filters.

Args: runs_filter_model: Filter model used for pagination, sorting, filtering. project_name_or_id: Optional name or ID of the project. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. include_full_metadata: Flag deciding whether to include the full metadata in the response.

Returns: The pipeline runs according to query filters.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofOptional
stringOptional
or
string · uuidOptional
or
nullOptional
hydratebooleanOptionalDefault: false
include_full_metadatabooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
run_metadataany ofOptional
string[]Optional
or
nullOptional
tagany ofOptional
stringOptional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
indexany ofOptional
integerOptional
or
nullOptional
orchestrator_run_idany ofOptional
stringOptional
or
nullOptional
pipeline_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
stack_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
schedule_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
build_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
snapshot_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
code_repository_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
template_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
source_snapshot_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
linked_to_model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
in_progressany ofOptional
booleanOptional
or
nullOptional
start_timeany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
end_timeany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
pipeline_nameany ofOptional
stringOptional
or
nullOptional
pipelineany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
stackany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
code_repositoryany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
modelany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
stack_componentany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
templatableany ofOptional
booleanOptional
or
nullOptional
triggered_by_step_run_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
triggered_by_deployment_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
get
/api/v1/runs

Get Run

get

Get a specific pipeline run using its ID.

Args: run_id: ID of the pipeline run to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. refresh_status: Flag deciding whether we should try to refresh the status of the pipeline run using its orchestrator. include_python_packages: Flag deciding whether to include the Python packages in the response. include_full_metadata: Flag deciding whether to include the full metadata in the response.

Returns: The pipeline run.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
run_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
refresh_statusbooleanOptionalDefault: false
include_python_packagesbooleanOptionalDefault: false
include_full_metadatabooleanOptionalDefault: false
Responses
chevron-right
200

Successful Response

application/json
get
/api/v1/runs/{run_id}

Update Run

put

Updates a run.

Args: run_id: ID of the run. run_model: Run model to use for the update.

Returns: The updated run model.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
run_idstring · uuidRequired
Body

Pipeline run update model.

statusany ofOptional
string · enumOptional

Enum that represents the execution status of a step or pipeline run.

Possible values:
or
nullOptional
status_reasonany ofOptional
string · max: 255Optional
or
nullOptional
end_timeany ofOptional
string · date-timeOptional
or
nullOptional
is_finishedany ofOptional
booleanOptional
or
nullOptional
orchestrator_run_idany ofOptional
stringOptional
or
nullOptional
exception_infoany ofOptional
or
nullOptional
add_tagsany ofOptional
string[]Optional
or
nullOptional
remove_tagsany ofOptional
string[]Optional
or
nullOptional
add_logsany ofOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
put
/api/v1/runs/{run_id}

Delete Run

delete

Deletes a run.

Args: run_id: ID of the run.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
run_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
delete
/api/v1/runs/{run_id}

No content

Last updated

Was this helpful?