Skip to main content
POST
Create a new Runner

Authorizations

Authorization
string
header
required

a valid bearer token

Body

application/json
agentType
enum<string>
required

The type of Runner being created

Available options:
data_productivity_cloud,
streaming
Minimum string length: 1
Example:

"data_productivity_cloud"

cloudProvider
enum<string>
required

The cloud provider of the Runner to be created. The Cloud Provider must correspond with the chosen Runner Type.

Available cloud providers are:

  • aws - Available for both data_productivity_cloud and streaming Runner Types.
  • azure - Available for both data_productivity_cloud and streaming Runner Types.
  • snowflake - Only available for data_productivity_cloud Runner Types.
  • gcp - Available for both data_productivity_cloud and streaming Runner Types.
  • google_cloud - Alias for gcp, available for both data_productivity_cloud and streaming Runner Types.
  • maia - Only available for data_productivity_cloud Runner Types. Creates a Maia-hosted runner managed by Matillion.
Available options:
aws,
azure,
snowflake,
google_cloud,
gcp,
maia
Minimum string length: 1
Example:

"aws"

deployment
enum<string>
required

The deployment type of the Runner to be created. The Deployment Type must correspond with the chosen Runner Type and Cloud Provider.

Available deployment types are:

  • fargate - Available for AWS Cloud Provider, for both data_productivity_cloud and streaming Runner Types.
  • eks - Available for AWS Cloud provider, for both data_productivity_cloud and streaming Runner Types.
  • container app - Available for Azure Cloud provider, only for data_productivity_cloud Runner Types.
  • aci - Available for Azure Cloud provider, only for streaming Runner Types.
  • aks - Available for Azure Cloud provider, for both data_productivity_cloud and streaming Runner Types.
  • native app - Available for Snowflake Cloud provider, only for data_productivity_cloud Runner Types.
  • gke - Available for Google Cloud provider, for both data_productivity_cloud and streaming Runner Types.
  • gce - Available for Google Cloud provider, only for streaming Runner Types.
  • custom_k8s - Only available for Maia cloud provider, only for data_productivity_cloud Runner Types.
Available options:
fargate,
eks,
container app,
aks,
aci,
native app,
gke,
gce,
custom_k8s
Minimum string length: 1
Example:

"fargate"

name
string
required

The name to set for the Runner being created

Required string length: 1 - 30
Example:

"AWS Runner"

description
string

The description to set for the Runner being created

Maximum string length: 500
Example:

"An AWS Runner"

enableAutoUpdates
boolean

Whether the Runner being created is set to automatically update.

Note, this is not available for Snowflake Runners or Streaming Runners.

Example:

true

restrictedAccess
boolean

Whether the Runner is restricted to a specific set of projects. If set to true, the Runner will only be applicable to projects it is scoped to have access to.

Note, this cannot be set for Streaming Runners.

Example:

true

trackName
enum<string>

The version track applied to the Runner being created. This is not required for Streaming Runners.

Note, Snowflake Runners can only be on the STABLE track.

Available options:
current,
stable
Example:

"current"

Response

Runner created successfully

agentId
string

The ID of the Runner

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

agentStatus
string

The reported status of the Runner

Example:

"running"

agentType
string

The type of Runner

Example:

"data_productivity_cloud"

cloudProvider
string

The cloud provider the Runner is hosted in

Example:

"aws"

connected
boolean

Whether the Runner is connected

Example:

true

deployment
string

The deployment type of the Runner

Example:

"fargate"

description
string

The description set for the Runner

Example:

"An AWS Runner"

enableAutoUpdates
boolean

Whether the Runner is set to automatically update

Example:

true

name
string

The name of the Runner

Example:

"AWS Runner"

pausedUntil
string

The date and time the Runner will be unpaused automatically. Only returned if the Runner is currently paused

Example:

"2025-01-01T00:00:00.000Z"

restrictedAccess
boolean

Whether the Runner is restricted to a specific set of projects

Example:

true

versionDetails
object

The version details of the Runner