Create a new Runner
Creates a new Runner with the specified configuration details.
Please note that some combinations are not compatible, for example, an agentType of ‘streaming’ cannot have the enableAutoUpdates set to true.
Authorizations
a valid bearer token
Body
The type of Runner being created
data_productivity_cloud, streaming 1"data_productivity_cloud"
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.
aws, azure, snowflake, google_cloud, gcp, maia 1"aws"
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.
fargate, eks, container app, aks, aci, native app, gke, gce, custom_k8s 1"fargate"
The name to set for the Runner being created
1 - 30"AWS Runner"
The description to set for the Runner being created
500"An AWS Runner"
Whether the Runner being created is set to automatically update.
Note, this is not available for Snowflake Runners or Streaming Runners.
true
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.
true
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.
current, stable "current"
Response
Runner created successfully
The ID of the Runner
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
The reported status of the Runner
"running"
The type of Runner
"data_productivity_cloud"
The cloud provider the Runner is hosted in
"aws"
Whether the Runner is connected
true
The deployment type of the Runner
"fargate"
The description set for the Runner
"An AWS Runner"
Whether the Runner is set to automatically update
true
The name of the Runner
"AWS Runner"
The date and time the Runner will be unpaused automatically. Only returned if the Runner is currently paused
"2025-01-01T00:00:00.000Z"
Whether the Runner is restricted to a specific set of projects
true
The version details of the Runner
