Job definitions, versioning, drafts, and team assignment.
GET
/me/jobsList my jobs
Returns all jobs that the current user can access based on their team memberships.
Includes team associations and latest job run references in the normalized response.
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
"jobKey""createdAt""lastRunAt"Default
"lastRunAt"sortDirectionstring
sortDirection
The direction to sort (ascending or descending).
Type
string
Valid values
"asc""desc"Default
"asc"Responses
Responses
A list of jobs the current user can access is returned.
application/json
JSON "total": 0, "items": [ { "jobId": "A1B2C3D4E5", "latestJobRunId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] } ], "included": { "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5" } ], "jobRuns": [ { "id": "A1B2C3D4E5", "jobId": "A1B2C3D4E5", "jobVersion": 3, "status": "string", "statusMessage": "string", "resourceCleanupMode": "always", "dispatchedAt": "string", "finishedAt": "string", "runnerStartedAt": "string", "runnerCompletedAt": "string", "runnerExecutionTimeUs": 45200000, "trigger": "manual", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "results": { "outputPath": "s3://lakesail-output/jobs/daily-sales-etl/runs/2026-04-06/" }, "updatedBy": "A1B2C3D4E5", "cleanedAt": "string", "workloadConfigId": "A1B2C3D4E5", "retainedUntil": "string", "retainedUntilMax": "string", "logicalTime": "2026-09-19T10:00:00Z", "webUrl": "https://platform.lakesail.com/acme/jobs/JOBABC123/runs/RUNABC123", "restarts": { "count": 2, "involuntaryCount": 1, "lastAt": "string", "lastCause": "runner_failed" }, "terminationReason": "string", "exitCode": 0, "attempt": 1 } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ], "workloadConfigs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "workloadType": "string", "clusterId": "A1B2C3D4E5", "config": { "sail": { "executionMode": "string", "maxRetries": 3, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "extraEnv": { "additionalProperties": { "type": "string", "value": "string" } } } }, "endpointLimits": { "spark_connect": 0 }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "storeFiles": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "warning": { "label": "string", "message": "string" } }, "notebookCount": 0, "jobCount": 0, "activeWorkloadCount": 0 } ] }
{
}
GET
/workloads/jobsList jobs
Returns a paginated list of all jobs in the organization, including their current status, active version, and schedule information.
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
1Responses
Responses
The list of LakeSail jobs is returned.
application/json
JSON "total": 0, "items": [ { "jobId": "A1B2C3D4E5", "latestJobRunId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] } ], "included": { "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5" } ], "jobRuns": [ { "id": "A1B2C3D4E5", "jobId": "A1B2C3D4E5", "jobVersion": 3, "status": "string", "statusMessage": "string", "resourceCleanupMode": "always", "dispatchedAt": "string", "finishedAt": "string", "runnerStartedAt": "string", "runnerCompletedAt": "string", "runnerExecutionTimeUs": 45200000, "trigger": "manual", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "results": { "outputPath": "s3://lakesail-output/jobs/daily-sales-etl/runs/2026-04-06/" }, "updatedBy": "A1B2C3D4E5", "cleanedAt": "string", "workloadConfigId": "A1B2C3D4E5", "retainedUntil": "string", "retainedUntilMax": "string", "logicalTime": "2026-09-19T10:00:00Z", "webUrl": "https://platform.lakesail.com/acme/jobs/JOBABC123/runs/RUNABC123", "restarts": { "count": 2, "involuntaryCount": 1, "lastAt": "string", "lastCause": "runner_failed" }, "terminationReason": "string", "exitCode": 0, "attempt": 1 } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ], "workloadConfigs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "workloadType": "string", "clusterId": "A1B2C3D4E5", "config": { "sail": { "executionMode": "string", "maxRetries": 3, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "extraEnv": { "additionalProperties": { "type": "string", "value": "string" } } } }, "endpointLimits": { "spark_connect": 0 }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "storeFiles": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "warning": { "label": "string", "message": "string" } }, "notebookCount": 0, "jobCount": 0, "activeWorkloadCount": 0 } ] }
{
}
POST
/workloads/jobsCreate a job
Defines a new job within the organization. The job is created with an initial published version containing the provided configuration, including the target cluster, schedule, and query assignments. Requires an active cluster and at least one team.
Request Body
application/json
JSON "jobKey": "daily-sales-etl", "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ ], "defaultCatalogId": "A1B2C3D4E5", "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "missedScheduleOnResume": "skip", "teamIds": [ "A1B2C3D4E5" ]
{
}
Responses
Responses
The LakeSail job was created successfully.
application/json
JSON "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5"
{
}
GET
/workloads/jobs/{job}Describe a job
Returns the full details of a job, including its current active version configuration, schedule, and associated cluster and query information.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Responses
Responses
Job details with normalized entity references
application/json
JSON "item": { "jobId": "A1B2C3D4E5", "latestJobRunId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] }, "included": { "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5" } ], "jobRuns": [ { "id": "A1B2C3D4E5", "jobId": "A1B2C3D4E5", "jobVersion": 3, "status": "string", "statusMessage": "string", "resourceCleanupMode": "always", "dispatchedAt": "string", "finishedAt": "string", "runnerStartedAt": "string", "runnerCompletedAt": "string", "runnerExecutionTimeUs": 45200000, "trigger": "manual", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "results": { "outputPath": "s3://lakesail-output/jobs/daily-sales-etl/runs/2026-04-06/" }, "updatedBy": "A1B2C3D4E5", "cleanedAt": "string", "workloadConfigId": "A1B2C3D4E5", "retainedUntil": "string", "retainedUntilMax": "string", "logicalTime": "2026-09-19T10:00:00Z", "webUrl": "https://platform.lakesail.com/acme/jobs/JOBABC123/runs/RUNABC123", "restarts": { "count": 2, "involuntaryCount": 1, "lastAt": "string", "lastCause": "runner_failed" }, "terminationReason": "string", "exitCode": 0, "attempt": 1 } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ], "workloadConfigs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "workloadType": "string", "clusterId": "A1B2C3D4E5", "config": { "sail": { "executionMode": "string", "maxRetries": 3, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "extraEnv": { "additionalProperties": { "type": "string", "value": "string" } } } }, "endpointLimits": { "spark_connect": 0 }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "storeFiles": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "warning": { "label": "string", "message": "string" } }, "notebookCount": 0, "jobCount": 0, "activeWorkloadCount": 0 } ] }
{
}
DELETE
/workloads/jobs/{job}Delete a job
Permanently removes a job and all its associated versions, runs, and team assignments. Refused while any run is still executing or still being cleaned up: deleting the job removes the run records its teardown reads, which would leave the run's cloud resources behind. Cancel a run in flight to make the job deletable sooner. Runs that keep their resources (see resourceCleanupMode), or whose cleanup gave up, do not block the delete: their cleanup is started here, because once the job is gone nothing can reach them.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Responses
Responses
The requested operation was done successfully.
PATCH
/workloads/jobs/{job}Update a job
Modifies a job's metadata: its key and its status. Description, configuration and schedule belong to the version; change them through the draft operations or by creating a new version.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Request Body
application/json
JSON "jobKey": "daily-sales-etl", "status": "active", "missedScheduleOnResume": "skip"
{
}
Responses
Responses
The LakeSail job was updated successfully.
application/json
JSON "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5"
{
}
POST
/workloads/jobs/{job}/activate-versionActivate a job version
Changes the job's active configuration to a previously published version.
The target version must exist and be published. Any existing draft version
must be discarded or published before activating a different version.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Request Body
application/json
JSON "version": 0
{
}
Responses
Responses
The specified version was activated successfully.
application/json
JSON "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5"
{
}
GET
/workloads/jobs/{job}/draftDescribe the draft version of a job
Returns the current draft version for the specified job.
Returns 404 if no draft version exists.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Responses
Responses
The draft version details.
application/json
JSON "jobId": "A1B2C3D4E5", "version": 0, "basedOnVersion": 0, "status": "string", "jobType": "string", "memberId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5"
{
}
POST
/workloads/jobs/{job}/draftCreate a new draft version for a job
Creates a new draft version by copying the currently published version's
configuration. Fields provided in the request body override the copied values.
A job can have at most one draft version at a time. If a draft already exists,
returns 409 Conflict.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Request Body
application/json
JSON "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "missedSchedulePolicy": "latest"
{
}
Responses
Responses
A new draft version was created successfully.
application/json
JSON "jobId": "A1B2C3D4E5", "version": 0, "basedOnVersion": 0, "status": "string", "jobType": "string", "memberId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5"
{
}
DELETE
/workloads/jobs/{job}/draftDiscard the draft version of a job
Discards (deletes) the current draft version without publishing it.
The job continues running its current published version unchanged.
Returns 404 if no draft version exists.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Responses
Responses
The draft version was discarded successfully.
PATCH
/workloads/jobs/{job}/draftUpdate the draft version of a job
Updates fields on the current draft version. Only provided fields are modified;
omitted fields retain their current values. Returns 404 if no draft version exists.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Request Body
application/json
JSON "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "missedSchedulePolicy": "latest"
{
}
Responses
Responses
The draft version was updated successfully.
application/json
JSON "jobId": "A1B2C3D4E5", "version": 0, "basedOnVersion": 0, "status": "string", "jobType": "string", "memberId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5"
{
}
POST
/workloads/jobs/{job}/draft/publishPublish the draft version of a job
Publishes the current draft version, making it the new active configuration.
The draft version's status changes to 'published' and the job's version pointer
is updated. Returns 400 if no draft version exists, 404 if the job does not exist.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Responses
Responses
The draft version was published successfully.
application/json
JSON "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5"
{
}
GET
/workloads/jobs/{job}/teamsList job teams
Returns the teams that have been granted access to the specified job.
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
1Responses
Responses
The list of teams associated with the job 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
/workloads/jobs/{job}/teamsAdd teams to a job
Grants one or more teams access to a job. Team members inherit the ability to view the job and its runs based on their team role permissions.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Request Body
application/json
JSON "teamIds": [ "A1B2C3D4E5" ]
{
}
Responses
Responses
The teams were added to the job successfully.
application/json
JSON "items": [ { "jobId": "A1B2C3D4E5", "teamId": "A1B2C3D4E5", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ]
{
}
DELETE
/workloads/jobs/{job}/teams/{team}Remove a team from a job
Revokes a team's access to a job. Team members will no longer be able to view or interact with the job unless they have access through another team.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
teamrequired
team*
The team ID.
Required
Responses
Responses
The team was removed from the job successfully.
GET
/workloads/jobs/{job}/versionsList job versions
Returns a paginated list of all published versions for a job, ordered by version number. Each version represents a point-in-time configuration snapshot.
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
1Responses
Responses
The list of LakeSail job versions is returned.
application/json
JSON "total": 0, "items": [ { "jobId": "A1B2C3D4E5", "version": 0, "basedOnVersion": 0, "status": "string", "jobType": "string", "memberId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5" } ]
{
}
POST
/workloads/jobs/{job}/versionsCreate a job version
Creates and publishes a new version for the job in a single request. This is
equivalent to creating a draft, updating fields, and publishing. The job must
not have an existing draft version.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
Request Body
application/json
JSON "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "missedSchedulePolicy": "latest"
{
}
Responses
Responses
The job version was created and published successfully.
application/json
JSON "jobId": "A1B2C3D4E5", "version": 0, "basedOnVersion": 0, "status": "string", "jobType": "string", "memberId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "timeoutSeconds": 0, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "string", "cronTimezone": "string", "concurrencyPolicy": "skip", "maxConcurrentRuns": 0, "workloadConfigId": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5"
{
}
GET
/workloads/jobs/{job}/versions/{jobVersionNumber}Describe a job version
Returns the full configuration snapshot for a specific version of a job, including cluster assignment, schedule, queries, and dependency settings.
Parameters
jobrequired
job*
A LakeSail job ID.
Required
jobVersionNumberintegerrequired
jobVersionNumber*
A LakeSail job version.
Type
Requiredinteger
Format
"int32"Minimum
1Responses
Responses
Job details for the specified version, with normalized entity references
application/json
JSON "item": { "jobId": "A1B2C3D4E5", "latestJobRunId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] }, "included": { "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5" } ], "jobRuns": [ { "id": "A1B2C3D4E5", "jobId": "A1B2C3D4E5", "jobVersion": 3, "status": "string", "statusMessage": "string", "resourceCleanupMode": "always", "dispatchedAt": "string", "finishedAt": "string", "runnerStartedAt": "string", "runnerCompletedAt": "string", "runnerExecutionTimeUs": 45200000, "trigger": "manual", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "results": { "outputPath": "s3://lakesail-output/jobs/daily-sales-etl/runs/2026-04-06/" }, "updatedBy": "A1B2C3D4E5", "cleanedAt": "string", "workloadConfigId": "A1B2C3D4E5", "retainedUntil": "string", "retainedUntilMax": "string", "logicalTime": "2026-09-19T10:00:00Z", "webUrl": "https://platform.lakesail.com/acme/jobs/JOBABC123/runs/RUNABC123", "restarts": { "count": 2, "involuntaryCount": 1, "lastAt": "string", "lastCause": "runner_failed" }, "terminationReason": "string", "exitCode": 0, "attempt": 1 } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ], "workloadConfigs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "workloadType": "string", "clusterId": "A1B2C3D4E5", "config": { "sail": { "executionMode": "string", "maxRetries": 3, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "extraEnv": { "additionalProperties": { "type": "string", "value": "string" } } } }, "endpointLimits": { "spark_connect": 0 }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "storeFiles": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "warning": { "label": "string", "message": "string" } }, "notebookCount": 0, "jobCount": 0, "activeWorkloadCount": 0 } ] }
{
}
GET
/workloads/teams/{team}/jobsList team jobs
Returns a paginated list of jobs that the specified team has been granted access to.
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
1Responses
Responses
The list of LakeSail jobs accessible to the team is returned.
application/json
JSON "total": 0, "items": [ { "jobId": "A1B2C3D4E5", "latestJobRunId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] } ], "included": { "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5" } ], "jobRuns": [ { "id": "A1B2C3D4E5", "jobId": "A1B2C3D4E5", "jobVersion": 3, "status": "string", "statusMessage": "string", "resourceCleanupMode": "always", "dispatchedAt": "string", "finishedAt": "string", "runnerStartedAt": "string", "runnerCompletedAt": "string", "runnerExecutionTimeUs": 45200000, "trigger": "manual", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "results": { "outputPath": "s3://lakesail-output/jobs/daily-sales-etl/runs/2026-04-06/" }, "updatedBy": "A1B2C3D4E5", "cleanedAt": "string", "workloadConfigId": "A1B2C3D4E5", "retainedUntil": "string", "retainedUntilMax": "string", "logicalTime": "2026-09-19T10:00:00Z", "webUrl": "https://platform.lakesail.com/acme/jobs/JOBABC123/runs/RUNABC123", "restarts": { "count": 2, "involuntaryCount": 1, "lastAt": "string", "lastCause": "runner_failed" }, "terminationReason": "string", "exitCode": 0, "attempt": 1 } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ], "workloadConfigs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "workloadType": "string", "clusterId": "A1B2C3D4E5", "config": { "sail": { "executionMode": "string", "maxRetries": 3, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "extraEnv": { "additionalProperties": { "type": "string", "value": "string" } } } }, "endpointLimits": { "spark_connect": 0 }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "storeFiles": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "warning": { "label": "string", "message": "string" } }, "notebookCount": 0, "jobCount": 0, "activeWorkloadCount": 0 } ] }
{
}
GET
/workloads/clusters/{cluster}/jobsList jobs on a cluster
Returns a paginated list of jobs whose active version is configured to execute on the specified cluster.
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
1Responses
Responses
The list of LakeSail jobs configured to run on the cluster is returned.
application/json
JSON "total": 0, "items": [ { "jobId": "A1B2C3D4E5", "latestJobRunId": "A1B2C3D4E5", "teamIds": [ "A1B2C3D4E5" ] } ], "included": { "jobs": [ { "id": "A1B2C3D4E5", "memberId": "A1B2C3D4E5", "jobKey": "daily-sales-etl", "version": 3, "currentVersion": 3, "draftVersion": 4, "basedOnVersion": 0, "status": "active", "workloadConfigId": "A1B2C3D4E5", "description": "Daily ETL pipeline for sales data", "config": { "sql": { "source": "string", "queryId": "Q1R2S3T4U5" }, "python": { "source": "string", "packageName": "string", "entryPoint": "string", "arguments": [ [ "--mode", "incremental", "--full-refresh" ] ] }, "notebook": { "notebookId": "A1B2C3D4E5", "arguments": [ [ "--mode", "incremental" ] ] }, "lakesail": { "executionMode": "string", "maxRetries": 3, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "envVars": { "additionalProperties": { "type": "string", "value": "string" } }, "additionalProperties": "string" }, "parameterDefinitions": [ { "name": "date", "type": "string", "required": true, "default": "2026-01-01" } ] }, "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "catalogsOverridden": true, "effectiveCatalogs": [ { "catalogId": "A1B2C3D4E5", "name": "string", "catalogName": "string", "provider": "glue", "source": "string", "isDefault": true, "overridden": true } ], "timeoutSeconds": 3600, "sourceConfig": { "url": "https://github.com/acme/data-pipelines.git", "provider": "string", "reference": { "type": "string", "value": "main" }, "snapshotCommit": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "dependsOn": [ { "jobKey": "A1B2C3D4E5" } ], "cronExpression": "0 2 * * *", "cronTimezone": "America/New_York", "concurrencyPolicy": "skip", "maxConcurrentRuns": 1, "missedSchedulePolicy": "latest", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "nextRunAt": "string", "lastScheduledAt": "string", "scheduledRunsOverdue": 0, "scheduledRunsOverdueSince": "string", "updatedBy": "A1B2C3D4E5" } ], "jobRuns": [ { "id": "A1B2C3D4E5", "jobId": "A1B2C3D4E5", "jobVersion": 3, "status": "string", "statusMessage": "string", "resourceCleanupMode": "always", "dispatchedAt": "string", "finishedAt": "string", "runnerStartedAt": "string", "runnerCompletedAt": "string", "runnerExecutionTimeUs": 45200000, "trigger": "manual", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "results": { "outputPath": "s3://lakesail-output/jobs/daily-sales-etl/runs/2026-04-06/" }, "updatedBy": "A1B2C3D4E5", "cleanedAt": "string", "workloadConfigId": "A1B2C3D4E5", "retainedUntil": "string", "retainedUntilMax": "string", "logicalTime": "2026-09-19T10:00:00Z", "webUrl": "https://platform.lakesail.com/acme/jobs/JOBABC123/runs/RUNABC123", "restarts": { "count": 2, "involuntaryCount": 1, "lastAt": "string", "lastCause": "runner_failed" }, "terminationReason": "string", "exitCode": 0, "attempt": 1 } ], "teams": [ { "id": "A1B2C3D4E5", "organizationId": "A1B2C3D4E5", "name": "string", "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "defaultRoleId": "A1B2C3D4E5" } ], "workloadConfigs": [ { "id": "A1B2C3D4E5", "name": "Production Cluster", "workloadType": "string", "clusterId": "A1B2C3D4E5", "config": { "sail": { "executionMode": "string", "maxRetries": 3, "compute": { "driver": { "instanceType": "c8g.2xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true } }, "worker": { "instanceType": "c8g.4xlarge", "ebsConfig": { "volumeType": "gp3", "volumeSize": 100, "iops": 3000, "throughput": 125, "deleteOnTermination": true }, "maxNodes": 4, "capacityType": "on-demand" } }, "lakesailImageUri": "string", "libraries": [ { "pypi": { "package": "string", "repo": "string" }, "requirements": { "source": "string", "uri": "string" }, "whl": "string" } ], "extraEnv": { "additionalProperties": { "type": "string", "value": "string" } } } }, "endpointLimits": { "spark_connect": 0 }, "createdAt": "string", "createdBy": "A1B2C3D4E5", "updatedAt": "string", "updatedBy": "A1B2C3D4E5", "catalogs": [ { "catalogId": "A1B2C3D4E5", "name": "Production Cluster" } ], "defaultCatalogId": "A1B2C3D4E5", "capabilities": { "run": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "storeFiles": { "allowed": true, "blocked": { "label": "string", "message": "string" } }, "warning": { "label": "string", "message": "string" } }, "notebookCount": 0, "jobCount": 0, "activeWorkloadCount": 0 } ] }
{
}