List Runs

GET 
/api/v1/runs

Get a collection of information about runs.

Request

Query Parameters

limit integer

Possible values: <= 1000

Default value: 25

The maximum number of runs to return.

startingFrom any

The starting run ID, runStartTime, or runEndTime (exclusive) for paging the query results.

orderBy RunsOrderBy

Possible values: [id, runStartTime, runEndTime]

Default value: id

The field used to order results.

orderByDirection string

Possible values: [asc, desc]

Default value: desc

The sort order for query results.

runType RunType

Possible values: [deploy, refresh]

A run type to filter the query results.

runStatus RunStatus

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

A status value to filter the query results.

environmentID string

An environment ID to filter the query results.

detail boolean

Include the full detail of the run.

Responses

200

A collection of runs.

application/json

Schema

Schema

limit integerrequired

The maximum number of runs returned by this query.

orderByDirection OrderByDirection (string)required

Possible values: [asc, desc]

The sort order for query results.

orderBy RunsOrderBy (string)required

Possible values: [id, runStartTime, runEndTime]

Default value: id

The field used to sort query results.

data

object

required

A collection of runs.

anyOf

MOD1

Array [

id integerrequired

The run ID.

reRunID string

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

runStartTime date-time

The datetime the run started.

runEndTime date-time

The datetime the run ended.

runType RunType (string)required

Possible values: [deploy, refresh]

runStatus RunStatus (string)required

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

environmentID string

The environment in which the run operation was applied.

runFailureReason string

Information about the cause of a run failure.

]

MOD2

Array [

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

DeployRunDetails

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.

RefreshRunDetails

Refresh run details.

canceled boolean

If the run was canceled.

environmentID stringrequired

The Environment ID for this run.

excludeNodesSelector string

A selector string of nodes to exclude.

forceIgnoreEnvironmentStatus boolean

includeNodesSelector string

A selector string of nodes to include.

jobID integer

The Job ID.

parallelism integer

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

refreshDescription string

The Job name.

nodesForRefresh integer

nodesInRun integer

The number of Nodes deployed.

executor string

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

]

Runs Response

{
  "limit": 0,
  "orderByDirection": "asc",
  "orderBy": "id",
  "data": [
    {
      "id": 0,
      "reRunID": "string",
      "runStartTime": "2019-08-24T14:15:22Z",
      "runEndTime": "2019-08-24T14:15:22Z",
      "runType": "deploy",
      "runStatus": "canceled",
      "environmentID": "string",
      "runFailureReason": "string"
    }
  ]
}

400

The request was invalid.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Invalid Request Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

401

User lacks authorization to perform this action.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Unauthorized

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

403

The client is not permitted to perform the requested operation.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Forbidden Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

500

The server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Internal Server Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

502

The server received an error from an upstream system.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Bad Gateway Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

503

The service is currently unavailable.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Service Unavailable Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

504

The server did not receive a response in time from an upstream system.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Gateway Timeout Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Loading...