GEgetorchestra
Task Runs

Get a task run

Changed on

Retrieve a single task run by ID, however long ago it ran, without needing its pipeline run ID.

get/task_runs/{task_run_id}

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/task_runs/{task_run_id}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:read

Path parameters

task_run_idstring uuid4 required

Task run ID.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Response

Successful Response

idstring uuid4 required
pipelineRunIdstring uuid4 required
taskNamestring required
taskIdstring required
accountIdstring uuid4 required
pipelineIdstring uuid4 required
integration'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'ANTHROPIC' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BATCH' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AWS_SES' | 'AWS_STEP_FUNCTIONS' | 'AZURE' | 'AZURE_CONTAINER_APPS' | 'AZURE_DATA_FACTORY' | 'AZURE_DATA_LAKE_STORAGE' | 'AZURE_KEY_VAULT' | 'AZURE_KUBERNETES_SERVICE' | 'AZURE_LOGIC_APPS' | 'AZURE_SYNAPSE_ANALYTICS' | 'AZURE_VM' | 'BAUPLAN' | 'BOOMI' | 'CDATA' | 'CENSUS' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DREMIO' | 'DUCKDB' | 'EMAIL' | 'ESTUARY' | 'ETLEAP' | 'FABRIC' | 'FABRIC_SYNAPSE' | 'FIVETRAN' | 'FORTRA' | 'GCP_BIG_QUERY' | 'GCP_CLOUD_RUN' | 'GCP_CLOUD_FUNCTIONS' | 'GCP_CLOUD_STORAGE' | 'GCP_DATAFLOW' | 'GCP_DATAFORM' | 'GCP_DATASTREAM' | 'GCP_LOOKER' | 'GKE' | 'GITHUB_ACTIONS' | 'GOOGLE_CLOUD' | 'HEVO' | 'HEX' | 'HIGHTOUCH' | 'HTTP' | 'HUBSPOT' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MARIADB' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MONGODB' | 'MOTHERDUCK' | 'MYSQL' | 'N8N' | 'NIMBLE' | 'NOTION' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'QUICKBOOKS' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SALESFORCE' | 'SAP' | 'SFTP' | 'SHAREPOINT' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'TYPESAFE' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH' required
integrationJob'ACA_RUN_JOB' | 'ADF_PIPELINE_RUN' | 'ADLS_SENSOR' | 'AIRBYTE_CLOUD_JOB' | 'AIRBYTE_SERVER_JOB' | 'AIRFLOW_RUN_DAG' | 'AKS_RUN_JOB' | 'ALTERYX_SERVER_TRIGGER_WORKFLOW' | 'ANTHROPIC_CLAUDE_CHAT' | 'APPROVAL' | 'ARCH_SYNC_PIPELINE' | 'AWS_EC2_SSM_RUN_SCRIPT' | 'AWS_ECS_RUN_TASK' | 'AWS_EKS_RUN_JOB' | 'AWS_EMR_RUN_JOB' | 'AWS_FIREHOSE_CHECK_STREAM' | 'AWS_GLUE_RUN_JOB' | 'AWS_LAMBDA_EXECUTE_ASYNC_FUNCTION' | 'AWS_REDSHIFT_EXECUTE_STATEMENT' | 'AWS_S3_GET_FILE' | 'AWS_S3_PUT_FILE' | 'AWS_BATCH_SUBMIT_JOB' | 'AWS_BEDROCK_INVOKE_MODEL' | 'AWS_SAGEMAKER_DEPLOY_MODEL' | 'AWS_SAGEMAKER_TRAIN_MODEL' | 'AWS_SES_SEND_EMAIL' | 'AWS_STEP_FUNCTIONS_START_EXECUTION' | 'AZURE_LOGIC_APPS_RUN_WORKFLOW' | 'AZURE_VM_RUN_COMMAND' | 'BAUPLAN_DATA_QUALITY_TEST' | 'BAUPLAN_EXECUTE_PIPELINE' | 'BOOMI_EXECUTE_PROCESS' | 'CDATA_SYNC_JOB' | 'CENSUS_SYNC' | 'CLICKHOUSE_RUN_QUERY' | 'CLICKHOUSE_RUN_TEST' | 'COALESCE_RUNJOB' | 'DATA_RECONCILIATION_MANUAL_QUERY' | 'DATA_RECONCILIATION_CURSOR_FIELD' | 'DATABRICKS_EXECUTE_STATEMENT' | 'DATABRICKS_ONE_TIME_RUN' | 'DATABRICKS_RUN_TEST' | 'DATABRICKS_RUN_WORKFLOW' | 'DATAPROC_RUN_JOB' | 'DATAZEN_CHECK_JOB' | 'DATAZEN_RUN_JOB' | 'DBT_CORE_EXECUTE' | 'DBT_RUNJOB' | 'DLT_EXECUTE_JOB' | 'DREMIO_RUN_QUERY' | 'DUCKDB_EXECUTE_QUERY' | 'ESTUARY_CHECK_FLOW' | 'ETLEAP_REFRESH_PIPELINE' | 'FABRIC_RUN_DATA_PIPELINE' | 'FABRIC_RUN_NOTEBOOK' | 'FABRIC_SYNAPSE_RUN_QUERY' | 'FABRIC_SYNAPSE_RUN_DQ_TEST' | 'FIVETRAN_SYNC_ALL' | 'GCP_BQ_RUN_QUERY_JOB' | 'GCP_BQ_RUN_SCHEDULED_QUERY_JOB' | 'GCP_BQ_RUN_TEST' | 'GCP_CLOUD_RUN_EXECUTE_JOB' | 'GCP_CLOUD_FUNCTIONS_EXECUTE_ASYNC_FUNCTION' | 'GCP_CLOUD_STORAGE_GET_FILE' | 'GCP_CLOUD_STORAGE_PUT_FILE' | 'GCP_DATAFLOW_RUN_PIPELINE' | 'GCP_DATAFORM_INVOKE_WORKFLOW' | 'GCP_DATASTREAM_MONITOR' | 'GCP_LOOKER_RUN_SCHEDULED_PLAN' | 'GITHUB_RUN_WORKFLOW' | 'GKE_RUN_JOB' | 'HEVO_CHECK_DESTINATION_STATUS' | 'HEX_RUN_PROJECT' | 'HIGHTOUCH_SYNC' | 'HTTP_REQUEST' | 'HTTP_REQUEST_ASYNC' | 'HUBSPOT_IMPORT_RECORDS' | 'KAFKA_CHECK_TOPIC' | 'KEBOOLA_RUN_FLOW' | 'LIGHTDASH_CLEAR_RESULTS_CACHE' | 'LIGHTDASH_REFRESH_DASHBOARD' | 'LIGHTDASH_REFRESH_PRE_AGGREGATE' | 'LINUX_SSH_EXECUTE_COMMAND' | 'MARIADB_RUN_QUERY' | 'MATILLION_ETL_RUN_JOB' | 'MATILLION_EXECUTE_PIPELINE' | 'METAPLANE_RUN_MONITOR' | 'MONGODB_RUN_COMMAND' | 'MONGODB_RUN_TEST' | 'MOTHERDUCK_EXECUTE_QUERY' | 'MYSQL_RUN_QUERY' | 'N8N_RUN_WORKFLOW' | 'NIMBLE_SERP_API' | 'NIMBLE_WEB_API' | 'NOTION_APPEND_BLOCKS' | 'NOTION_CREATE_DATABASE_PAGE' | 'NOTION_CREATE_PAGE' | 'NOTION_UPDATE_DATABASE_PAGE' | 'OMNI_TRIGGER_SCHEDULE' | 'OPEN_AI_CHAT' | 'PORTABLE_RUN_FLOW' | 'POSTGRES_RUN_QUERY' | 'POSTGRES_RUN_TEST' | 'POWER_AUTOMATE_RUN_FLOW' | 'POWER_BI_REFRESH_DATAFLOW' | 'POWER_BI_REFRESH_DATASET' | 'PREFECT_CLOUD_RUN_FLOW' | 'PYTHON_EXECUTE_SCRIPT' | 'QLIK_REPLICATE_TASK_FULL_LOAD' | 'QUICKBOOKS_CREATE_ENTITY' | 'RENDER_RUN_JOB' | 'RIVERY_RUN_RIVER' | 'RUDDERSTACK_RETL_SYNC' | 'RUN_AGENT' | 'SALESFORCE_RUN_ANALYTICS_DATAFLOW' | 'SEND_SLACK_MESSAGE' | 'SEND_MICROSOFT_TEAMS_MESSAGE' | 'SFTP_GET_FILE' | 'SFTP_PUT_FILE' | 'SHAREPOINT_GET_FILE' | 'SHAREPOINT_PUT_FILE' | 'SIGMA_DATAMODEL_MATERIALIZATION' | 'SIGMA_DATASET_MATERIALIZATION' | 'SIGMA_WORKBOOK_MATERIALIZATION' | 'SNOWFLAKE_ANOMALY_DETECTION' | 'SNOWFLAKE_RUN_QUERY' | 'SNOWFLAKE_RUN_TEST' | 'SNOWFLAKE_SCHEMA_VALIDATION' | 'SQL_MESH_EXECUTE_JOB' | 'SQL_SERVER_RUN_QUERY' | 'STITCH_SYNC' | 'SYNAPSE_NOTEBOOK_RUN' | 'SYNAPSE_PIPELINE_RUN' | 'TABLEAU_REFRESH_EXTRACT' | 'TABLEAU_REFRESH_WORKBOOK' | 'TABLEAU_UPDATE_SUBSCRIPTION' | 'TALEND_CLOUD_EXECUTE_TASK' | 'THOUGHTSPOT_FETCH_LIVEBOARD_DATA' | 'TOBIKO_CLOUD_EXECUTE' | 'TRIGGER_PIPELINE' | 'TYPESAFE_JEV_EVALUATE' | 'WAIT' | 'WINDOWS_SSH_COMMAND' required
status'CREATED' | 'SKIPPED' | 'PAUSED' | 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'WARNING' | 'FAILED' | 'CANCELLING' | 'CANCELLED' required

NOTE: if changing these values, please also confirm the AWS Step Function state machine is not impacted. This can be done by looking at terraform/modules/step_function/main.tf, and viewing the state machine JSON definition.

messagestring nullable
externalStatusstring nullable
externalMessagestring nullable
taskParametersobject nullable
runParametersobject nullable
connectionIdstring nullable
computeResourceIdstring nullable
platformLinkstring nullable
attemptNumberinteger
supersededboolean
matrixParentboolean
matrixParentIdstring uuid4 nullable
createdAtstring required
updatedAtstring required
completedAtstring nullable
startedAtstring nullable
dependsOnstring[] nullable
hasOperationAnomaliesboolean nullable
anomaliesobject nullable

Changes