Kubernetes cluster management, both self-registered and provisioned into cloud accounts.
GET
/me/clustersList my clusters
Returns all Kubernetes clusters that the current user can access based on their team memberships.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100pageinteger
page
The page number to retrieve (1-indexed). Used with limit to support offset-based pagination.
Type
integer
Format
"int32"Minimum
1Default
1sortBystring
sortBy
The field to sort by.
Type
string
Valid values
"name"Default
"name"sortDirectionstring
sortDirection
The direction to sort (ascending or descending).
Type
string
Valid values
"asc""desc"Default
"asc"Responses
Responses
A list of clusters the current user can access is returned.
application/json
JSON "total": 0, "items": [ { "id": "A1B2C3D4E5", "externalClusterId": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] } ], "included": { "clusters": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "externalClusterId": "A1B2C3D4E5", "region": "us-east-1", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "externalStatus": "string", "operationId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "connections": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "string", "providerConfig": { "accountId": "123456789012", "region": "us-east-1", "roleArn": "arn:aws:iam::123456789012:role/LakeSailConnection", "externalIdSecretArn": "arn:aws:secretsmanager:us-east-1:123456789012:secret:lakesail-ext-id", "stackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/lakesail-connection/abc123" }, "status": "active", "statusMessage": "string", "lastUsedAt": "string", "templateSyncedAt": "string", "templateSyncMessage": "string", "templateUpdateAvailable": true, "subscriptionId": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "networks": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "providerNetworkId": "vpc-0a1b2c3d4e5f6g7h8", "config": { "cidr": "10.0.0.0/16" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "status": "string", "statusMessage": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "infraUpdateAvailable": true, "clusterCount": 0, "catalogCount": 0, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "externalClusters": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ] }
{
}
GET
/me/clusters/{cluster}Describe an accessible cluster
Returns a single Kubernetes cluster that the current user can access based on their team memberships.
Returns 404 if the cluster does not exist or the user has no access.
Responses
Responses
The cluster accessible by the current user is returned.
application/json
JSON "item": { "id": "A1B2C3D4E5", "externalClusterId": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] }, "included": { "clusters": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "externalClusterId": "A1B2C3D4E5", "region": "us-east-1", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "externalStatus": "string", "operationId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "connections": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "string", "providerConfig": { "accountId": "123456789012", "region": "us-east-1", "roleArn": "arn:aws:iam::123456789012:role/LakeSailConnection", "externalIdSecretArn": "arn:aws:secretsmanager:us-east-1:123456789012:secret:lakesail-ext-id", "stackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/lakesail-connection/abc123" }, "status": "active", "statusMessage": "string", "lastUsedAt": "string", "templateSyncedAt": "string", "templateSyncMessage": "string", "templateUpdateAvailable": true, "subscriptionId": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "networks": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "providerNetworkId": "vpc-0a1b2c3d4e5f6g7h8", "config": { "cidr": "10.0.0.0/16" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "status": "string", "statusMessage": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "infraUpdateAvailable": true, "clusterCount": 0, "catalogCount": 0, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "externalClusters": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ] }
{
}
GET
/infra/cluster-tier-presetsList cluster tier presets
Returns the enabled cluster tier presets offered when creating a BYOC cluster, in display order. Any authenticated user may read them. When a supported region is supplied, each preset also carries region-scoped pricing for the cost estimate (computePricePerHourUsd) and the response includes serviceRates; without a region (or for an unsupported one), presets return unpriced.
Parameters
regionstring
region
A cloud region code (e.g. us-east-1).
Type
string
Responses
Responses
The list of cluster tier presets.
application/json
JSON "items": [ { "id": "A1B2C3D4E5", "name": "string", "tagline": "string", "description": "string", "guidance": "string", "provider": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "karpenter": { "controllerMilliCpu": 500 } }, "isDefault": true, "computePricePerHourUsd": 0, "containerMetricsCostPerMonthUsd": 0 } ], "serviceRates": { "region": "string", "eksControlPlaneHourUsd": 0, "nlbHourUsd": 0, "natGatewayHourUsd": 0, "gp3GbMonthUsd": 0 }
{
}
GET
/infra/clustersList provisioned clusters
Returns all provisioned clusters accessible to the organization across all connections, supporting marker-based pagination.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100markerstring
marker
The pagination token returned from the previous list operation.
Type
string
Responses
Responses
List of External clusters with connection information.
application/json
JSON "total": 0, "items": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5" } ], "included": { "clusters": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "connections": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "string", "providerConfig": { "accountId": "123456789012", "region": "us-east-1", "roleArn": "arn:aws:iam::123456789012:role/LakeSailConnection", "externalIdSecretArn": "arn:aws:secretsmanager:us-east-1:123456789012:secret:lakesail-ext-id", "stackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/lakesail-connection/abc123" }, "status": "active", "statusMessage": "string", "lastUsedAt": "string", "templateSyncedAt": "string", "templateSyncMessage": "string", "templateUpdateAvailable": true, "subscriptionId": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "operations": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "operation": "string", "status": "string", "result": { "items": [ { "provider": "string", "instanceType": "string", "vCpus": 0, "memoryMiB": 0, "architecture": "string", "gpuCount": 0, "instanceFamily": "string", "maxPods": 0, "group": "string", "allocatableMilliCpu": 0, "pricePerHourUsd": 0 } ], "metadata": { "provider": "string", "systemPodsPerNode": 0, "systemPodsPerSystemNode": 0, "systemPodsFixed": 0, "systemPodsPerNodeMargin": 0, "systemPodsFixedMargin": 0, "systemMilliCPUPerNode": 0, "systemMilliCPUFixed": 0, "karpenterMilliCPUPerReplica": 0, "karpenterReplicas": 0 } }, "error": { "code": "string", "message": "string", "errorType": "string", "details": { "retryable": true, "retryAfter": 0, "fieldErrors": { "additionalProperties": "string" }, "requestId": "string", "causedBy": "string" } }, "progress": { "stage": "string", "message": "string", "resources": [ { "urn": "string", "type": "string", "name": "string", "operation": "string", "status": "string", "duration": 0 } ], "summary": { "total": 0, "pending": 0, "running": 0, "succeeded": 0, "failed": 0, "unchanged": 0 } }, "resourceType": "string", "resourceId": "A1B2C3D4E5", "createdAt": "string", "updatedAt": "string", "startedAt": "string", "completedAt": "string" } ] }, "marker": "string"
{
}
GET
/infra/clusters/{cluster}Describe a provisioned cluster
Returns the details of a specific provisioned cluster including its connection information and related entities.
Responses
Responses
External cluster details with connection information.
application/json
JSON "item": { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5" }, "included": { "clusters": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "connections": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "string", "providerConfig": { "accountId": "123456789012", "region": "us-east-1", "roleArn": "arn:aws:iam::123456789012:role/LakeSailConnection", "externalIdSecretArn": "arn:aws:secretsmanager:us-east-1:123456789012:secret:lakesail-ext-id", "stackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/lakesail-connection/abc123" }, "status": "active", "statusMessage": "string", "lastUsedAt": "string", "templateSyncedAt": "string", "templateSyncMessage": "string", "templateUpdateAvailable": true, "subscriptionId": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "operations": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "operation": "string", "status": "string", "result": { "items": [ { "provider": "string", "instanceType": "string", "vCpus": 0, "memoryMiB": 0, "architecture": "string", "gpuCount": 0, "instanceFamily": "string", "maxPods": 0, "group": "string", "allocatableMilliCpu": 0, "pricePerHourUsd": 0 } ], "metadata": { "provider": "string", "systemPodsPerNode": 0, "systemPodsPerSystemNode": 0, "systemPodsFixed": 0, "systemPodsPerNodeMargin": 0, "systemPodsFixedMargin": 0, "systemMilliCPUPerNode": 0, "systemMilliCPUFixed": 0, "karpenterMilliCPUPerReplica": 0, "karpenterReplicas": 0 } }, "error": { "code": "string", "message": "string", "errorType": "string", "details": { "retryable": true, "retryAfter": 0, "fieldErrors": { "additionalProperties": "string" }, "requestId": "string", "causedBy": "string" } }, "progress": { "stage": "string", "message": "string", "resources": [ { "urn": "string", "type": "string", "name": "string", "operation": "string", "status": "string", "duration": 0 } ], "summary": { "total": 0, "pending": 0, "running": 0, "succeeded": 0, "failed": 0, "unchanged": 0 } }, "resourceType": "string", "resourceId": "A1B2C3D4E5", "createdAt": "string", "updatedAt": "string", "startedAt": "string", "completedAt": "string" } ] }
{
}
DELETE
/infra/clusters/{cluster}Delete a provisioned cluster record
Permanently deletes a provisioned cluster record. The cluster's infrastructure must
first be destroyed before the record can be deleted. A cluster in a failed state
may still have active infrastructure and should be destroyed first.
Responses
Responses
The requested operation was done successfully.
GET
/infra/connections/{connection}/clustersList provisioned clusters by connection
Returns the provisioned clusters within the specified connection.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100markerstring
marker
The pagination token returned from the previous list operation.
Type
string
Responses
Responses
List of External clusters with connection information.
application/json
JSON "total": 0, "items": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5" } ], "included": { "clusters": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "connections": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "string", "providerConfig": { "accountId": "123456789012", "region": "us-east-1", "roleArn": "arn:aws:iam::123456789012:role/LakeSailConnection", "externalIdSecretArn": "arn:aws:secretsmanager:us-east-1:123456789012:secret:lakesail-ext-id", "stackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/lakesail-connection/abc123" }, "status": "active", "statusMessage": "string", "lastUsedAt": "string", "templateSyncedAt": "string", "templateSyncMessage": "string", "templateUpdateAvailable": true, "subscriptionId": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "operations": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "operation": "string", "status": "string", "result": { "items": [ { "provider": "string", "instanceType": "string", "vCpus": 0, "memoryMiB": 0, "architecture": "string", "gpuCount": 0, "instanceFamily": "string", "maxPods": 0, "group": "string", "allocatableMilliCpu": 0, "pricePerHourUsd": 0 } ], "metadata": { "provider": "string", "systemPodsPerNode": 0, "systemPodsPerSystemNode": 0, "systemPodsFixed": 0, "systemPodsPerNodeMargin": 0, "systemPodsFixedMargin": 0, "systemMilliCPUPerNode": 0, "systemMilliCPUFixed": 0, "karpenterMilliCPUPerReplica": 0, "karpenterReplicas": 0 } }, "error": { "code": "string", "message": "string", "errorType": "string", "details": { "retryable": true, "retryAfter": 0, "fieldErrors": { "additionalProperties": "string" }, "requestId": "string", "causedBy": "string" } }, "progress": { "stage": "string", "message": "string", "resources": [ { "urn": "string", "type": "string", "name": "string", "operation": "string", "status": "string", "duration": 0 } ], "summary": { "total": 0, "pending": 0, "running": 0, "succeeded": 0, "failed": 0, "unchanged": 0 } }, "resourceType": "string", "resourceId": "A1B2C3D4E5", "createdAt": "string", "updatedAt": "string", "startedAt": "string", "completedAt": "string" } ] }, "marker": "string"
{
}
POST
/infra/connections/{connection}/clustersCreate a provisioned cluster
Creates a new EKS cluster in your AWS account via the specified connection. Requires an active connection and an active network.
Request Body
application/json
JSON "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5"
{
}
Responses
Responses
External cluster created successfully.
application/json
JSON "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } }
{
}
GET
/infra/connections/{connection}/clusters/{cluster}Describe a provisioned cluster by connection
Returns the details of a provisioned cluster, including its Kubernetes version, node group configuration, and provisioning status.
Responses
Responses
External cluster details with connection information.
application/json
JSON "item": { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5" }, "included": { "clusters": [ { "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } } } ], "connections": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "provider": "string", "providerConfig": { "accountId": "123456789012", "region": "us-east-1", "roleArn": "arn:aws:iam::123456789012:role/LakeSailConnection", "externalIdSecretArn": "arn:aws:secretsmanager:us-east-1:123456789012:secret:lakesail-ext-id", "stackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/lakesail-connection/abc123" }, "status": "active", "statusMessage": "string", "lastUsedAt": "string", "templateSyncedAt": "string", "templateSyncMessage": "string", "templateUpdateAvailable": true, "subscriptionId": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ], "operations": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "operation": "string", "status": "string", "result": { "items": [ { "provider": "string", "instanceType": "string", "vCpus": 0, "memoryMiB": 0, "architecture": "string", "gpuCount": 0, "instanceFamily": "string", "maxPods": 0, "group": "string", "allocatableMilliCpu": 0, "pricePerHourUsd": 0 } ], "metadata": { "provider": "string", "systemPodsPerNode": 0, "systemPodsPerSystemNode": 0, "systemPodsFixed": 0, "systemPodsPerNodeMargin": 0, "systemPodsFixedMargin": 0, "systemMilliCPUPerNode": 0, "systemMilliCPUFixed": 0, "karpenterMilliCPUPerReplica": 0, "karpenterReplicas": 0 } }, "error": { "code": "string", "message": "string", "errorType": "string", "details": { "retryable": true, "retryAfter": 0, "fieldErrors": { "additionalProperties": "string" }, "requestId": "string", "causedBy": "string" } }, "progress": { "stage": "string", "message": "string", "resources": [ { "urn": "string", "type": "string", "name": "string", "operation": "string", "status": "string", "duration": 0 } ], "summary": { "total": 0, "pending": 0, "running": 0, "succeeded": 0, "failed": 0, "unchanged": 0 } }, "resourceType": "string", "resourceId": "A1B2C3D4E5", "createdAt": "string", "updatedAt": "string", "startedAt": "string", "completedAt": "string" } ] }
{
}
POST
/infra/connections/{connection}/clusters/{cluster}Update a provisioned cluster
Update the Kubernetes version or node group configuration of a provisioned cluster. This triggers an asynchronous update process.
Request Body
application/json
JSON "name": "Production Cluster", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }
{
}
Responses
Responses
External cluster upgrade started
application/json
JSON "id": "A1B2C3D4E5", "connectionId": "A1B2C3D4E5", "networkId": "A1B2C3D4E5", "clusterId": "A1B2C3D4E5", "name": "Production Cluster", "region": "us-east-1", "status": "string", "statusMessage": "string", "config": { "kubernetesVersion": "1.35", "systemNodeGroup": { "name": "system", "instanceTypes": [ [ "m7g.large", "m7g.xlarge" ] ], "minSize": 1, "maxSize": 3, "desiredSize": 2, "diskSizeGb": 100 }, "publicAccessCidrs": [ "string" ], "karpenter": { "controllerMilliCpu": 500 }, "observeContainerMetrics": false }, "presetId": "A1B2C3D4E5", "providerMetadata": { "clusterName": "string", "clusterArn": "string" }, "iacState": { "projectName": "lakesail-byoc-cluster", "stackName": "lakesail-prod-cluster-abc123" }, "iacOutputs": { "additionalProperties": "string" }, "jobRunnerRoleArn": "arn:aws:iam::123456789012:role/lakesail-conn1234-clus5678-jr", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "lastHealthStatus": "string", "infraUpdateAvailable": true, "lastHealthCheckAt": "string", "lastHealthDetail": { "message": "string", "pods": { "running": 0, "unschedulable": 0 } }, "capabilities": { "provision": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "destroy": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "delete": { "allowed": true, "blocked": { "label": "string", "message": "string" } } }
{
}
DELETE
/infra/connections/{connection}/clusters/{cluster}Destroy a provisioned cluster
Initiates destruction of an active provisioned cluster's cloud infrastructure. The cluster record is retained for reference. Returns an operation ID for tracking progress.
Responses
Responses
Destruction operation initiated.
application/json
JSON "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "operation": "string", "status": "string", "result": { "items": [ { "provider": "string", "instanceType": "string", "vCpus": 0, "memoryMiB": 0, "architecture": "string", "gpuCount": 0, "instanceFamily": "string", "maxPods": 0, "group": "string", "allocatableMilliCpu": 0, "pricePerHourUsd": 0 } ], "metadata": { "provider": "string", "systemPodsPerNode": 0, "systemPodsPerSystemNode": 0, "systemPodsFixed": 0, "systemPodsPerNodeMargin": 0, "systemPodsFixedMargin": 0, "systemMilliCPUPerNode": 0, "systemMilliCPUFixed": 0, "karpenterMilliCPUPerReplica": 0, "karpenterReplicas": 0 } }, "error": { "code": "string", "message": "string", "errorType": "string", "details": { "retryable": true, "retryAfter": 0, "fieldErrors": { "additionalProperties": "string" }, "requestId": "string", "causedBy": "string" } }, "progress": { "stage": "string", "message": "string", "resources": [ { "urn": "string", "type": "string", "name": "string", "operation": "string", "status": "string", "duration": 0 } ], "summary": { "total": 0, "pending": 0, "running": 0, "succeeded": 0, "failed": 0, "unchanged": 0 } }, "resourceType": "string", "resourceId": "A1B2C3D4E5", "createdAt": "string", "updatedAt": "string", "startedAt": "string", "completedAt": "string"
{
}
GET
/infra/connections/{connection}/clusters/{cluster}/healthGet provisioned cluster health status
Returns the health status of the EKS cluster and its node groups.
Responses
Responses
External cluster health status
application/json
JSON "status": "string", "providerMetadata": { "status": "ACTIVE" }, "nodeGroups": [ { "name": "string", "status": "string", "desiredSize": 0, "readyNodes": 0, "message": "string" } ], "systemPods": [ { "name": "string", "namespace": "string", "ready": true, "phase": "string", "restartCount": 0, "message": "string" } ], "totalNodes": 0, "readyNodes": 0, "lastCheckedAt": "string"
{
}
GET
/infra/connections/{connection}/clusters/{cluster}/kubeconfigGet provisioned cluster kubeconfig
Returns a kubeconfig that can be used to access the EKS cluster.
Responses
Responses
Kubeconfig for the External cluster.
application/json
JSON "kubeconfig": "string", "clusterEndpoint": "string", "clusterCertificateAuthority": "string"
{
}
GET
/infra/connections/{connection}/clusters/{cluster}/metricsGet provisioned cluster metrics
Returns CPU and memory utilization metrics for the cluster over a specified period.
Parameters
periodstring
period
The period for metrics (e.g., "1h", "24h", "7d"). Default is "1h".
Type
string
Default
"1h"Responses
Responses
External cluster metrics.
application/json
JSON "cpuUtilization": [ { "timestamp": "string", "value": 0 } ], "memoryUtilization": [ { "timestamp": "string", "value": 0 } ], "estimatedCost": [ { "timestamp": "string", "value": 0 } ], "activeJobCount": [ { "timestamp": "string", "value": 0 } ]
{
}
POST
/infra/connections/{connection}/clusters/{cluster}/provisionProvision a cluster
Triggers provisioning of a cluster in pending status. Returns an operation ID for progress tracking.
Responses
Responses
Provisioning operation initiated.
application/json
JSON "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "operation": "string", "status": "string", "result": { "items": [ { "provider": "string", "instanceType": "string", "vCpus": 0, "memoryMiB": 0, "architecture": "string", "gpuCount": 0, "instanceFamily": "string", "maxPods": 0, "group": "string", "allocatableMilliCpu": 0, "pricePerHourUsd": 0 } ], "metadata": { "provider": "string", "systemPodsPerNode": 0, "systemPodsPerSystemNode": 0, "systemPodsFixed": 0, "systemPodsPerNodeMargin": 0, "systemPodsFixedMargin": 0, "systemMilliCPUPerNode": 0, "systemMilliCPUFixed": 0, "karpenterMilliCPUPerReplica": 0, "karpenterReplicas": 0 } }, "error": { "code": "string", "message": "string", "errorType": "string", "details": { "retryable": true, "retryAfter": 0, "fieldErrors": { "additionalProperties": "string" }, "requestId": "string", "causedBy": "string" } }, "progress": { "stage": "string", "message": "string", "resources": [ { "urn": "string", "type": "string", "name": "string", "operation": "string", "status": "string", "duration": 0 } ], "summary": { "total": 0, "pending": 0, "running": 0, "succeeded": 0, "failed": 0, "unchanged": 0 } }, "resourceType": "string", "resourceId": "A1B2C3D4E5", "createdAt": "string", "updatedAt": "string", "startedAt": "string", "completedAt": "string"
{
}
GET
/org/clusters/{cluster}/teamsList cluster teams
Returns the teams that have been granted access to the specified Kubernetes cluster.
Parameters
limitinteger
limit
The maximum number of items to list.
Type
integer
Format
"int32"Minimum
0Maximum
100Default
100Responses
Responses
The list of teams associated with the cluster is returned.
application/json
JSON "total": 0, "items": [ { "team": { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" }, "memberCount": 0 } ]
{
}
POST
/org/clusters/{cluster}/teamsAdd teams to a cluster
Grants one or more teams access to a Kubernetes cluster. Team members can then target this cluster when configuring jobs, based on their team role permissions.
Request Body
application/json
JSON "teamIds": [ "A1B2C3D4E5" ]
{
}
Responses
Responses
The teams were added to the cluster successfully.
application/json
JSON "items": [ { "clusterId": "A1B2C3D4E5", "teamId": "A1B2C3D4E5", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ]
{
}
DELETE
/org/clusters/{cluster}/teams/{team}Remove a team from a cluster
Revokes a team's access to a cluster. Unsupported for general use — removing a team may break existing jobs and notebooks still linked to that team. Use at your own risk. Requires cluster Manage and Teams Manage permissions.
Responses
Responses
The requested operation was done successfully.