Skip to main content

Run a Job

POST 
/scheduler/startRun

Create a new refresh Job.

Request​

Body

    runDetails

    object

    required

    Object containing the necessary target details required to successfully start a refresh.

    environmentID stringrequired

    The environment being refreshed

    includeNodesSelector string

    Nodes included for an ad-hoc job

    excludeNodesSelector string

    Nodes excluded for an ad-hoc job.

    jobID string

    The ID of a job being run.

    parallelism int32

    Default value: 16

    Maximum number of parallel nodes to run.

    forceIgnoreWorkspaceStatus boolean

    Allows refreshing an environment even if the last deployment on that environment failed. Use with caution as this can put your environment into an even worse state.

    userCredentials

    object

    userCredentials contains connection credentials for connecting to Snowflake. Currently only basic auth (username/password) may be specified. If however, an OAuth connection has been established for the given environment specified in runDetails.environmentID, set "userCredentials": {"snowflakeAuthType": "OAuth"}.

    snowflakeUsername string

    Snowflake Account Username. Required when snowflakeAuthType is Basic and KeyPair Auth

    snowflakePassword string

    Snowflake Account password. Required when snowflakeAuthType is Basic

    snowflakeKeyPairKey string

    The PEM-encoded private key to use when authenticating to Snowflake. Required when using the KeyPair authentication type. Newlines must be encoded as "\n" within the request.

    snowflakeKeyPairPass string

    The password to use to decrypt the private key. This is only applicable when the authentication type is KeyPair and the private key is encrypted.

    snowflakeWarehouse string

    Snowflake compute warehouse

    snowflakeRole string

    Snowflake user role

    snowflakeAuthType string

    Default value: Basic

    Options: Basic | KeyPair | OAuth

    parameters json

    Contains parameters to be used in the Refresh

Responses​

200

Schema

    runCounter integer

    Default value: 0

Loading...