Skip to content
Sluice
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Tutorials
Run your first flow
Build an ELT pipeline
Build a flow with a coding agent
How-to guides
Chain flows
Connect a secret provider
Connect an MCP client
Deploy on Kubernetes with Helm
Deploy with Docker Compose
Pass data between tasks
Retry, time out and limit executions
Run flows from GitHub Actions
Run tasks in Docker
Run tasks on Kubernetes
Schedule a flow
Set up the assistant
Sync a namespace from git
Triage a failed execution
Trigger a flow with a webhook
Use secrets and variables
Use Sluice with coding agents
Concepts
Architecture
Flows, tasks and templates
Executions and states
Namespaces and versions
Executors, pools and the runner
Security model
The assistant and MCP
How Sluice compares
Reference
CLI
Environment variables
Exit codes
Flow file
GitHub Action
HTTP API basics
Keyboard shortcuts
MCP tools
JSON Schemas
States and reasons
Templates
HTTP API
Overview
Operations
runnerPutArtifact
PUT
runnerGetBundle
GET
runnerComplete
POST
runnerPostEvents
POST
runnerHeartbeat
POST
runnerPostLogs
POST
runnerGetSpec
GET
listAIConversations
GET
createAIConversation
POST
getAIConversation
GET
deleteAIConversation
DELETE
confirmAIAction
POST
rejectAIAction
POST
sendAIMessage
POST
getAIProvider
GET
putAIProvider
PUT
deleteAIProvider
DELETE
testAIProvider
POST
getAIStatus
GET
listAuditEvents
GET
login
POST
logout
POST
getMe
GET
updateMe
PATCH
changePassword
POST
revokeOtherSessions
POST
listExecutions
GET
getExecution
GET
listExecutionArtifacts
GET
downloadArtifact
GET
cancelExecution
POST
streamExecutionEvents
GET
listExecutionInsights
GET
requestTriage
POST
getExecutionLogs
GET
downloadExecutionLogs
GET
streamExecutionLogs
GET
listExecutionMetrics
GET
rerunExecution
POST
restartExecution
POST
listFlows
GET
getFlow
GET
updateFlow
PATCH
diffFlowRevisions
GET
triggerFlow
POST
getFlowMetrics
GET
listFlowRevisions
GET
getFlowRevision
GET
getFlowStats
GET
rotateWebhookKey
POST
listGitSources
GET
createGitSource
POST
getGitSource
GET
updateGitSource
PUT
deleteGitSource
DELETE
listGitSyncRuns
GET
syncGitSource
POST
listInstances
GET
listNamespaces
GET
createNamespace
POST
getNamespace
GET
deleteNamespace
DELETE
saveChanges
POST
diffVersions
GET
getFile
GET
uploadFile
PUT
listFiles
GET
getNamespaceGit
GET
pushNamespaceBranch
POST
revertVersion
POST
runFile
POST
listNamespaceSecrets
GET
putNamespaceSecret
PUT
deleteNamespaceSecret
DELETE
checkNamespaceSecret
POST
validateFile
POST
listNamespaceVariables
GET
putNamespaceVariable
PUT
deleteNamespaceVariable
DELETE
listVersions
GET
listUpcomingSchedules
GET
getFlowSchema
GET
listSecretProviders
GET
createSecretProvider
POST
updateSecretProvider
PUT
deleteSecretProvider
DELETE
checkSecretProvider
POST
listGlobalSecrets
GET
putGlobalSecret
PUT
deleteGlobalSecret
DELETE
checkGlobalSecret
POST
getDashboard
GET
getStorageStatus
GET
listTokens
GET
createToken
POST
revokeToken
DELETE
listUsers
GET
createUser
POST
updateUser
PATCH
resetUserPassword
POST
listGlobalVariables
GET
putGlobalVariable
PUT
deleteGlobalVariable
DELETE
Request a sync of a git source from a push webhook
POST
Start the flow of a webhook trigger
POST
Operations
Runbook
Back up and restore
Upgrade
Metrics
Harden a deployment
Rotate the master key
GitHub
Select theme
Dark
Light
Auto
Overview
Sluice API
1
Section titled “Sluice API 1”
Information
OpenAPI version:
3.1.0
Operations
Section titled “ Operations ”
PUT
/api/runner/v1/task-runs/{taskRunId}/artifacts/{name}
GET
/api/runner/v1/task-runs/{taskRunId}/bundle
POST
/api/runner/v1/task-runs/{taskRunId}/complete
POST
/api/runner/v1/task-runs/{taskRunId}/events
POST
/api/runner/v1/task-runs/{taskRunId}/heartbeat
POST
/api/runner/v1/task-runs/{taskRunId}/logs
GET
/api/runner/v1/task-runs/{taskRunId}/spec
GET
/api/v1/ai/conversations
POST
/api/v1/ai/conversations
GET
/api/v1/ai/conversations/{conversationId}
DELETE
/api/v1/ai/conversations/{conversationId}
POST
/api/v1/ai/conversations/{conversationId}/actions/{actionId}/confirm
POST
/api/v1/ai/conversations/{conversationId}/actions/{actionId}/reject
POST
/api/v1/ai/conversations/{conversationId}/messages
GET
/api/v1/ai/provider
PUT
/api/v1/ai/provider
DELETE
/api/v1/ai/provider
POST
/api/v1/ai/provider/test
GET
/api/v1/ai/status
GET
/api/v1/audit
POST
/api/v1/auth/login
POST
/api/v1/auth/logout
GET
/api/v1/auth/me
PATCH
/api/v1/auth/me
POST
/api/v1/auth/password
POST
/api/v1/auth/sessions/revoke-others
GET
/api/v1/executions
GET
/api/v1/executions/{executionId}
GET
/api/v1/executions/{executionId}/artifacts
GET
/api/v1/executions/{executionId}/artifacts/{artifactId}
POST
/api/v1/executions/{executionId}/cancel
GET
/api/v1/executions/{executionId}/events
GET
/api/v1/executions/{executionId}/insights
POST
/api/v1/executions/{executionId}/insights
GET
/api/v1/executions/{executionId}/logs
GET
/api/v1/executions/{executionId}/logs/download
GET
/api/v1/executions/{executionId}/logs/stream
GET
/api/v1/executions/{executionId}/metrics
POST
/api/v1/executions/{executionId}/rerun
POST
/api/v1/executions/{executionId}/restart
GET
/api/v1/flows
GET
/api/v1/flows/{namespace}/{flowId}
PATCH
/api/v1/flows/{namespace}/{flowId}
GET
/api/v1/flows/{namespace}/{flowId}/diff
POST
/api/v1/flows/{namespace}/{flowId}/executions
GET
/api/v1/flows/{namespace}/{flowId}/metrics
GET
/api/v1/flows/{namespace}/{flowId}/revisions
GET
/api/v1/flows/{namespace}/{flowId}/revisions/{revisionId}
GET
/api/v1/flows/{namespace}/{flowId}/stats
POST
/api/v1/flows/{namespace}/{flowId}/triggers/{triggerId}/webhook-key
GET
/api/v1/git-sources
POST
/api/v1/git-sources
GET
/api/v1/git-sources/{sourceId}
PUT
/api/v1/git-sources/{sourceId}
DELETE
/api/v1/git-sources/{sourceId}
GET
/api/v1/git-sources/{sourceId}/runs
POST
/api/v1/git-sources/{sourceId}/sync
GET
/api/v1/instances
GET
/api/v1/namespaces
POST
/api/v1/namespaces
GET
/api/v1/namespaces/{namespace}
DELETE
/api/v1/namespaces/{namespace}
POST
/api/v1/namespaces/{namespace}/changes
GET
/api/v1/namespaces/{namespace}/diff
GET
/api/v1/namespaces/{namespace}/file
PUT
/api/v1/namespaces/{namespace}/file
GET
/api/v1/namespaces/{namespace}/files
GET
/api/v1/namespaces/{namespace}/git
POST
/api/v1/namespaces/{namespace}/git/push
POST
/api/v1/namespaces/{namespace}/revert
POST
/api/v1/namespaces/{namespace}/run
GET
/api/v1/namespaces/{namespace}/secrets
PUT
/api/v1/namespaces/{namespace}/secrets/{key}
DELETE
/api/v1/namespaces/{namespace}/secrets/{key}
POST
/api/v1/namespaces/{namespace}/secrets/{key}/check
POST
/api/v1/namespaces/{namespace}/validate
GET
/api/v1/namespaces/{namespace}/variables
PUT
/api/v1/namespaces/{namespace}/variables/{key}
DELETE
/api/v1/namespaces/{namespace}/variables/{key}
GET
/api/v1/namespaces/{namespace}/versions
GET
/api/v1/schedules/upcoming
GET
/api/v1/schemas/flow.json
GET
/api/v1/secret-providers
POST
/api/v1/secret-providers
PUT
/api/v1/secret-providers/{name}
DELETE
/api/v1/secret-providers/{name}
POST
/api/v1/secret-providers/{name}/check
GET
/api/v1/secrets
PUT
/api/v1/secrets/{key}
DELETE
/api/v1/secrets/{key}
POST
/api/v1/secrets/{key}/check
GET
/api/v1/stats/dashboard
GET
/api/v1/storage
GET
/api/v1/tokens
POST
/api/v1/tokens
DELETE
/api/v1/tokens/{tokenId}
GET
/api/v1/users
POST
/api/v1/users
PATCH
/api/v1/users/{userId}
POST
/api/v1/users/{userId}/reset-password
GET
/api/v1/variables
PUT
/api/v1/variables/{key}
DELETE
/api/v1/variables/{key}
POST
/hooks/git/{sourceId}
POST
/hooks/{key}