Skip to content
Sluice

updateFlow

PATCH
/api/v1/flows/{namespace}/{flowId}
curl --request PATCH \
  --url https://example.com/api/v1/flows/example/example \
  --header 'Content-Type: application/json' \
  --data '{ "disabled": true }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
namespace
required
string
<= 128 characters /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$/
flowId
required
string
<= 63 characters /^[a-z0-9][a-z0-9-]*$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
disabled
required
boolean
key
additional properties
any
Examplegenerated
{
  "disabled": true
}

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
description
required
string
disabled
required
boolean
error_count
required
integer format: int64
flow_id
required
string
id
required
string
labels
object
key
additional properties
string
last_execution
object
created_at
required
string format: date-time
id
required
string
state
required
string
key
additional properties
any
namespace
required
string
path
required
string
revision
object
created_at
required
string format: date-time
definition
object | null
errors
required
Array<object>
object
code
required
string
column
required
integer format: int64
line
required
integer format: int64
message
required
string
path
required
string
key
additional properties
any
git_sha
string
id
required
string
message
string
path
required
string
snapshot_version
integer | null format: int64
source
required
string
valid
required
boolean
key
additional properties
any
triggers
required
Array<object>
object
active
required
boolean
config
required
object
key
additional properties
has_webhook_key
required
boolean
key
required
string
last_fired_at
string | null format: date-time
next_fire_at
string | null format: date-time
type
required
string
Allowed values: schedule webhook flow
key
additional properties
any
valid
required
boolean
key
additional properties
any
Example
{
  "triggers": [
    {
      "type": "schedule"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}