Skip to main content

Get Run

GET 
/api/v1/runs/:runID

Gets a single run.

Request​

Path Parameters

    runID integerrequired

    The run ID.

Responses​

A single run.

Schema

    id integerrequired
    reRunID string

    If this is a re-run, the ID of the original operation.

    runDetails

    object

    required

    Detailed information about a run.

    anyOf

    Deployment run details.

    canceled boolean

    If the run was canceled.

    deployCommit stringrequired

    The full commit hash.

    deployCommitMessage string

    The commit message.

    environmentID stringrequired

    The Environment ID for this run.

    parallelism integer

    The parallelism parameter determines how many nodes are processed simultaneously (in parallel) by the Snowflake compute warehouse.

    nodesInRun integer

    The number of Nodes deployed.

    runEndTime date-time

    The datetime when the run ended.

    runHistory integer[]
    runStartTime date-time

    The datetime the run started.

    runStatus RunStatus (string)required

    Possible values: [canceled, completed, failed, initializing, rendering, running, waitingToRun]

    runTimeParameters

    object

    required

    The default Environment parameters. Parameters changed during deploy will not show here.

    property name* any

    The default Environment parameters. Parameters changed during deploy will not show here.

    runType RunType (string)required

    Possible values: [deploy, refresh]

    userCredentials

    object

    Information about the Snowflake account used to perform a run.

    snowflakeAccount stringrequired
    snowflakeAuthType UserConnectionType (string)required

    Possible values: [Basic, Cloud, KeyPair, OAuth]

    snowflakeRole string
    snowflakeUsername stringrequired
    snowflakeWarehouse string
    userID string
    version integer
Loading...