Lock or unlock a workflow
curl --request PATCH \
--url https://inference.studio.lyzr.ai/api/workflows/{id}/lock \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"is_locked": true
}
'import requests
url = "https://inference.studio.lyzr.ai/api/workflows/{id}/lock"
payload = { "is_locked": True }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_locked: true})
};
fetch('https://inference.studio.lyzr.ai/api/workflows/{id}/lock', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inference.studio.lyzr.ai/api/workflows/{id}/lock",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_locked' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://inference.studio.lyzr.ai/api/workflows/{id}/lock"
payload := strings.NewReader("{\n \"is_locked\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://inference.studio.lyzr.ai/api/workflows/{id}/lock")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"is_locked\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inference.studio.lyzr.ai/api/workflows/{id}/lock")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_locked\": true\n}"
response = http.request(request)
puts response.read_body{
"message": "workflow lock updated",
"is_locked": true
}{
"error": "<string>"
}{
"error": "<string>"
}Workflows
Lock Workflow
Locks a workflow so collaborators cannot edit it, or unlocks it. Only the owner can lock or unlock. While a workflow is locked, a shared editor’s save, publish, or deploy is refused with 423; the owner can still edit, publish, and deploy.
PATCH
/
workflows
/
{id}
/
lock
Lock or unlock a workflow
curl --request PATCH \
--url https://inference.studio.lyzr.ai/api/workflows/{id}/lock \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"is_locked": true
}
'import requests
url = "https://inference.studio.lyzr.ai/api/workflows/{id}/lock"
payload = { "is_locked": True }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({is_locked: true})
};
fetch('https://inference.studio.lyzr.ai/api/workflows/{id}/lock', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inference.studio.lyzr.ai/api/workflows/{id}/lock",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_locked' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://inference.studio.lyzr.ai/api/workflows/{id}/lock"
payload := strings.NewReader("{\n \"is_locked\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://inference.studio.lyzr.ai/api/workflows/{id}/lock")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"is_locked\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inference.studio.lyzr.ai/api/workflows/{id}/lock")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_locked\": true\n}"
response = http.request(request)
puts response.read_body{
"message": "workflow lock updated",
"is_locked": true
}{
"error": "<string>"
}{
"error": "<string>"
}Send
{"is_locked": true} to lock the workflow and {"is_locked": false} to unlock it. Workflow responses carry is_locked, and a normal save never changes it.Authorizations
Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are accepted. Required on every endpoint except GET /node-types and a webhook-triggered execute that carries X-Webhook-Secret.
Path Parameters
Workflow ID
Body
application/json