Edit playbook metadata
curl --request PUT \
--url https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit \
--header 'BLINK-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"analyst_copilot_workflow": true,
"custom_timeout": 123,
"desc": "<string>",
"icon": "<string>",
"is_request": true,
"max_concurrency_level": 123,
"name": "<string>",
"notification_emails": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"<string>"
]
}
'import requests
url = "https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit"
payload = {
"active": True,
"analyst_copilot_workflow": True,
"custom_timeout": 123,
"desc": "<string>",
"icon": "<string>",
"is_request": True,
"max_concurrency_level": 123,
"name": "<string>",
"notification_emails": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": ["<string>"]
}
headers = {
"BLINK-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'BLINK-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
analyst_copilot_workflow: true,
custom_timeout: 123,
desc: '<string>',
icon: '<string>',
is_request: true,
max_concurrency_level: 123,
name: '<string>',
notification_emails: '<string>',
playbook_to_run_on_error: '<string>',
preferred_engine_version: '<string>',
runner: '<string>',
step_transition_limit: 123,
tags: ['<string>']
})
};
fetch('https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit', 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://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'active' => true,
'analyst_copilot_workflow' => true,
'custom_timeout' => 123,
'desc' => '<string>',
'icon' => '<string>',
'is_request' => true,
'max_concurrency_level' => 123,
'name' => '<string>',
'notification_emails' => '<string>',
'playbook_to_run_on_error' => '<string>',
'preferred_engine_version' => '<string>',
'runner' => '<string>',
'step_transition_limit' => 123,
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"BLINK-API-KEY: <api-key>",
"Content-Type: application/json"
],
]);
$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://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit"
payload := strings.NewReader("{\n \"active\": true,\n \"analyst_copilot_workflow\": true,\n \"custom_timeout\": 123,\n \"desc\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_request\": true,\n \"max_concurrency_level\": 123,\n \"name\": \"<string>\",\n \"notification_emails\": \"<string>\",\n \"playbook_to_run_on_error\": \"<string>\",\n \"preferred_engine_version\": \"<string>\",\n \"runner\": \"<string>\",\n \"step_transition_limit\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("BLINK-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.put("https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit")
.header("BLINK-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"analyst_copilot_workflow\": true,\n \"custom_timeout\": 123,\n \"desc\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_request\": true,\n \"max_concurrency_level\": 123,\n \"name\": \"<string>\",\n \"notification_emails\": \"<string>\",\n \"playbook_to_run_on_error\": \"<string>\",\n \"preferred_engine_version\": \"<string>\",\n \"runner\": \"<string>\",\n \"step_transition_limit\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["BLINK-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"analyst_copilot_workflow\": true,\n \"custom_timeout\": 123,\n \"desc\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_request\": true,\n \"max_concurrency_level\": 123,\n \"name\": \"<string>\",\n \"notification_emails\": \"<string>\",\n \"playbook_to_run_on_error\": \"<string>\",\n \"preferred_engine_version\": \"<string>\",\n \"runner\": \"<string>\",\n \"step_transition_limit\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"analyst_copilot_workflow": true,
"custom_timeout": 123,
"desc": "<string>",
"icon": "<string>",
"is_request": true,
"max_concurrency_level": 123,
"name": "<string>",
"notification_emails": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"<string>"
]
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}Workflows
Edit playbook metadata
Updates the name, description, tags, and runner of the playbook with the given ID. Updating the runner requires the ViewAction permission on RunnerObject.
PUT
/
workspace
/
{ws_id}
/
playbooks
/
{id}
/
edit
Edit playbook metadata
curl --request PUT \
--url https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit \
--header 'BLINK-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"analyst_copilot_workflow": true,
"custom_timeout": 123,
"desc": "<string>",
"icon": "<string>",
"is_request": true,
"max_concurrency_level": 123,
"name": "<string>",
"notification_emails": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"<string>"
]
}
'import requests
url = "https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit"
payload = {
"active": True,
"analyst_copilot_workflow": True,
"custom_timeout": 123,
"desc": "<string>",
"icon": "<string>",
"is_request": True,
"max_concurrency_level": 123,
"name": "<string>",
"notification_emails": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": ["<string>"]
}
headers = {
"BLINK-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'BLINK-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
analyst_copilot_workflow: true,
custom_timeout: 123,
desc: '<string>',
icon: '<string>',
is_request: true,
max_concurrency_level: 123,
name: '<string>',
notification_emails: '<string>',
playbook_to_run_on_error: '<string>',
preferred_engine_version: '<string>',
runner: '<string>',
step_transition_limit: 123,
tags: ['<string>']
})
};
fetch('https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit', 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://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'active' => true,
'analyst_copilot_workflow' => true,
'custom_timeout' => 123,
'desc' => '<string>',
'icon' => '<string>',
'is_request' => true,
'max_concurrency_level' => 123,
'name' => '<string>',
'notification_emails' => '<string>',
'playbook_to_run_on_error' => '<string>',
'preferred_engine_version' => '<string>',
'runner' => '<string>',
'step_transition_limit' => 123,
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"BLINK-API-KEY: <api-key>",
"Content-Type: application/json"
],
]);
$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://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit"
payload := strings.NewReader("{\n \"active\": true,\n \"analyst_copilot_workflow\": true,\n \"custom_timeout\": 123,\n \"desc\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_request\": true,\n \"max_concurrency_level\": 123,\n \"name\": \"<string>\",\n \"notification_emails\": \"<string>\",\n \"playbook_to_run_on_error\": \"<string>\",\n \"preferred_engine_version\": \"<string>\",\n \"runner\": \"<string>\",\n \"step_transition_limit\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("BLINK-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.put("https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit")
.header("BLINK-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"analyst_copilot_workflow\": true,\n \"custom_timeout\": 123,\n \"desc\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_request\": true,\n \"max_concurrency_level\": 123,\n \"name\": \"<string>\",\n \"notification_emails\": \"<string>\",\n \"playbook_to_run_on_error\": \"<string>\",\n \"preferred_engine_version\": \"<string>\",\n \"runner\": \"<string>\",\n \"step_transition_limit\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["BLINK-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"analyst_copilot_workflow\": true,\n \"custom_timeout\": 123,\n \"desc\": \"<string>\",\n \"icon\": \"<string>\",\n \"is_request\": true,\n \"max_concurrency_level\": 123,\n \"name\": \"<string>\",\n \"notification_emails\": \"<string>\",\n \"playbook_to_run_on_error\": \"<string>\",\n \"preferred_engine_version\": \"<string>\",\n \"runner\": \"<string>\",\n \"step_transition_limit\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"analyst_copilot_workflow": true,
"custom_timeout": 123,
"desc": "<string>",
"icon": "<string>",
"is_request": true,
"max_concurrency_level": 123,
"name": "<string>",
"notification_emails": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"<string>"
]
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}Authorizations
Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.
Body
application/json
Fields to update on the playbook (name, description, tags, runner)
The preferred workflow engine version
Response
Updated playbook metadata
The preferred workflow engine version
Was this page helpful?
⌘I