cURL
curl --request POST \
--url 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks' \
--header 'BLINK-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": true,
"analyst_copilot_workflow": true,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": true,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": true,
"is_otb": true,
"is_request": true,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<string>"
}'
import requests
url = "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks"
payload = {
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": True,
"analyst_copilot_workflow": True,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": True,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": True,
"is_otb": True,
"is_request": True,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<string>"
}
headers = {
"BLINK-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
const url = 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks';
const options = {
method: 'POST',
headers: {'BLINK-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": true,
"analyst_copilot_workflow": true,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": true,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": true,
"is_otb": true,
"is_request": true,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<string>"
})
};
fetch(url, 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://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => '{"actions":[{"action_full_name":"<string>","collection_icon_uri":"<string>","collection_name":"<string>","full_name":"<string>","id":"<string>","name":"<string>"}],"active":true,"analyst_copilot_workflow":true,"automation_origin_id":"<string>","automation_type":"<string>","created_at":123,"created_by":"<string>","custom_timeout":123,"deleted":"<string>","display_settings":{"description":"Automates common tasks","display_as_html":true,"icon":"company-blink","name":"Blink Automation"},"icon":"company-blink","id":"<string>","is_icon_selected_by_user":true,"is_otb":true,"is_request":true,"max_concurrency_level":123,"name":"My Workflow","notification_emails":"<string>","pack_id":"00000000-0000-0000-0000-000000000000","playbook":"<string>","playbook_to_run_on_error":"<string>","preferred_engine_version":"<string>","runner":"<string>","step_transition_limit":123,"tags":["k8s"],"tenant_id":"<string>","updated_at":123,"updated_by":"<string>","used_connections":["<string>"],"used_global_variables":["<string>"],"used_subflows":["<string>"],"used_tables":["<string>"],"version":"1","wizard_id":"<string>","workspace_id":"<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://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks"
payload := strings.NewReader(`{"actions":[{"action_full_name":"<string>","collection_icon_uri":"<string>","collection_name":"<string>","full_name":"<string>","id":"<string>","name":"<string>"}],"active":true,"analyst_copilot_workflow":true,"automation_origin_id":"<string>","automation_type":"<string>","created_at":123,"created_by":"<string>","custom_timeout":123,"deleted":"<string>","display_settings":{"description":"Automates common tasks","display_as_html":true,"icon":"company-blink","name":"Blink Automation"},"icon":"company-blink","id":"<string>","is_icon_selected_by_user":true,"is_otb":true,"is_request":true,"max_concurrency_level":123,"name":"My Workflow","notification_emails":"<string>","pack_id":"00000000-0000-0000-0000-000000000000","playbook":"<string>","playbook_to_run_on_error":"<string>","preferred_engine_version":"<string>","runner":"<string>","step_transition_limit":123,"tags":["k8s"],"tenant_id":"<string>","updated_at":123,"updated_by":"<string>","used_connections":["<string>"],"used_global_variables":["<string>"],"used_subflows":["<string>"],"used_tables":["<string>"],"version":"1","wizard_id":"<string>","workspace_id":"<string>"}`)
req, _ := http.NewRequest("POST", 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(res)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.post("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks")
.header("BLINK-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\"actions\":[{\"action_full_name\":\"<string>\",\"collection_icon_uri\":\"<string>\",\"collection_name\":\"<string>\",\"full_name\":\"<string>\",\"id\":\"<string>\",\"name\":\"<string>\"}],\"active\":true,\"analyst_copilot_workflow\":true,\"automation_origin_id\":\"<string>\",\"automation_type\":\"<string>\",\"created_at\":123,\"created_by\":\"<string>\",\"custom_timeout\":123,\"deleted\":\"<string>\",\"display_settings\":{\"description\":\"Automates common tasks\",\"display_as_html\":true,\"icon\":\"company-blink\",\"name\":\"Blink Automation\"},\"icon\":\"company-blink\",\"id\":\"<string>\",\"is_icon_selected_by_user\":true,\"is_otb\":true,\"is_request\":true,\"max_concurrency_level\":123,\"name\":\"My Workflow\",\"notification_emails\":\"<string>\",\"pack_id\":\"00000000-0000-0000-0000-000000000000\",\"playbook\":\"<string>\",\"playbook_to_run_on_error\":\"<string>\",\"preferred_engine_version\":\"<string>\",\"runner\":\"<string>\",\"step_transition_limit\":123,\"tags\":[\"k8s\"],\"tenant_id\":\"<string>\",\"updated_at\":123,\"updated_by\":\"<string>\",\"used_connections\":[\"<string>\"],\"used_global_variables\":[\"<string>\"],\"used_subflows\":[\"<string>\"],\"used_tables\":[\"<string>\"],\"version\":\"1\",\"wizard_id\":\"<string>\",\"workspace_id\":\"<string>\"}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["BLINK-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\"actions\":[{\"action_full_name\":\"<string>\",\"collection_icon_uri\":\"<string>\",\"collection_name\":\"<string>\",\"full_name\":\"<string>\",\"id\":\"<string>\",\"name\":\"<string>\"}],\"active\":true,\"analyst_copilot_workflow\":true,\"automation_origin_id\":\"<string>\",\"automation_type\":\"<string>\",\"created_at\":123,\"created_by\":\"<string>\",\"custom_timeout\":123,\"deleted\":\"<string>\",\"display_settings\":{\"description\":\"Automates common tasks\",\"display_as_html\":true,\"icon\":\"company-blink\",\"name\":\"Blink Automation\"},\"icon\":\"company-blink\",\"id\":\"<string>\",\"is_icon_selected_by_user\":true,\"is_otb\":true,\"is_request\":true,\"max_concurrency_level\":123,\"name\":\"My Workflow\",\"notification_emails\":\"<string>\",\"pack_id\":\"00000000-0000-0000-0000-000000000000\",\"playbook\":\"<string>\",\"playbook_to_run_on_error\":\"<string>\",\"preferred_engine_version\":\"<string>\",\"runner\":\"<string>\",\"step_transition_limit\":123,\"tags\":[\"k8s\"],\"tenant_id\":\"<string>\",\"updated_at\":123,\"updated_by\":\"<string>\",\"used_connections\":[\"<string>\"],\"used_global_variables\":[\"<string>\"],\"used_subflows\":[\"<string>\"],\"used_tables\":[\"<string>\"],\"version\":\"1\",\"wizard_id\":\"<string>\",\"workspace_id\":\"<string>\"}"
response = http.request(request)
puts response.read_body
{
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": true,
"analyst_copilot_workflow": true,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": true,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": true,
"is_otb": true,
"is_request": true,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<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": {}
}Workflows
Create a new playbook
Creates a new playbook in the specified workspace and immediately publishes it.
POST
/
workspace
/
{ws_id}
/
playbooks
cURL
curl --request POST \
--url 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks' \
--header 'BLINK-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": true,
"analyst_copilot_workflow": true,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": true,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": true,
"is_otb": true,
"is_request": true,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<string>"
}'
import requests
url = "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks"
payload = {
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": True,
"analyst_copilot_workflow": True,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": True,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": True,
"is_otb": True,
"is_request": True,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<string>"
}
headers = {
"BLINK-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
const url = 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks';
const options = {
method: 'POST',
headers: {'BLINK-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": true,
"analyst_copilot_workflow": true,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": true,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": true,
"is_otb": true,
"is_request": true,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<string>"
})
};
fetch(url, 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://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => '{"actions":[{"action_full_name":"<string>","collection_icon_uri":"<string>","collection_name":"<string>","full_name":"<string>","id":"<string>","name":"<string>"}],"active":true,"analyst_copilot_workflow":true,"automation_origin_id":"<string>","automation_type":"<string>","created_at":123,"created_by":"<string>","custom_timeout":123,"deleted":"<string>","display_settings":{"description":"Automates common tasks","display_as_html":true,"icon":"company-blink","name":"Blink Automation"},"icon":"company-blink","id":"<string>","is_icon_selected_by_user":true,"is_otb":true,"is_request":true,"max_concurrency_level":123,"name":"My Workflow","notification_emails":"<string>","pack_id":"00000000-0000-0000-0000-000000000000","playbook":"<string>","playbook_to_run_on_error":"<string>","preferred_engine_version":"<string>","runner":"<string>","step_transition_limit":123,"tags":["k8s"],"tenant_id":"<string>","updated_at":123,"updated_by":"<string>","used_connections":["<string>"],"used_global_variables":["<string>"],"used_subflows":["<string>"],"used_tables":["<string>"],"version":"1","wizard_id":"<string>","workspace_id":"<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://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks"
payload := strings.NewReader(`{"actions":[{"action_full_name":"<string>","collection_icon_uri":"<string>","collection_name":"<string>","full_name":"<string>","id":"<string>","name":"<string>"}],"active":true,"analyst_copilot_workflow":true,"automation_origin_id":"<string>","automation_type":"<string>","created_at":123,"created_by":"<string>","custom_timeout":123,"deleted":"<string>","display_settings":{"description":"Automates common tasks","display_as_html":true,"icon":"company-blink","name":"Blink Automation"},"icon":"company-blink","id":"<string>","is_icon_selected_by_user":true,"is_otb":true,"is_request":true,"max_concurrency_level":123,"name":"My Workflow","notification_emails":"<string>","pack_id":"00000000-0000-0000-0000-000000000000","playbook":"<string>","playbook_to_run_on_error":"<string>","preferred_engine_version":"<string>","runner":"<string>","step_transition_limit":123,"tags":["k8s"],"tenant_id":"<string>","updated_at":123,"updated_by":"<string>","used_connections":["<string>"],"used_global_variables":["<string>"],"used_subflows":["<string>"],"used_tables":["<string>"],"version":"1","wizard_id":"<string>","workspace_id":"<string>"}`)
req, _ := http.NewRequest("POST", 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(res)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.post("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks")
.header("BLINK-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\"actions\":[{\"action_full_name\":\"<string>\",\"collection_icon_uri\":\"<string>\",\"collection_name\":\"<string>\",\"full_name\":\"<string>\",\"id\":\"<string>\",\"name\":\"<string>\"}],\"active\":true,\"analyst_copilot_workflow\":true,\"automation_origin_id\":\"<string>\",\"automation_type\":\"<string>\",\"created_at\":123,\"created_by\":\"<string>\",\"custom_timeout\":123,\"deleted\":\"<string>\",\"display_settings\":{\"description\":\"Automates common tasks\",\"display_as_html\":true,\"icon\":\"company-blink\",\"name\":\"Blink Automation\"},\"icon\":\"company-blink\",\"id\":\"<string>\",\"is_icon_selected_by_user\":true,\"is_otb\":true,\"is_request\":true,\"max_concurrency_level\":123,\"name\":\"My Workflow\",\"notification_emails\":\"<string>\",\"pack_id\":\"00000000-0000-0000-0000-000000000000\",\"playbook\":\"<string>\",\"playbook_to_run_on_error\":\"<string>\",\"preferred_engine_version\":\"<string>\",\"runner\":\"<string>\",\"step_transition_limit\":123,\"tags\":[\"k8s\"],\"tenant_id\":\"<string>\",\"updated_at\":123,\"updated_by\":\"<string>\",\"used_connections\":[\"<string>\"],\"used_global_variables\":[\"<string>\"],\"used_subflows\":[\"<string>\"],\"used_tables\":[\"<string>\"],\"version\":\"1\",\"wizard_id\":\"<string>\",\"workspace_id\":\"<string>\"}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/playbooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["BLINK-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\"actions\":[{\"action_full_name\":\"<string>\",\"collection_icon_uri\":\"<string>\",\"collection_name\":\"<string>\",\"full_name\":\"<string>\",\"id\":\"<string>\",\"name\":\"<string>\"}],\"active\":true,\"analyst_copilot_workflow\":true,\"automation_origin_id\":\"<string>\",\"automation_type\":\"<string>\",\"created_at\":123,\"created_by\":\"<string>\",\"custom_timeout\":123,\"deleted\":\"<string>\",\"display_settings\":{\"description\":\"Automates common tasks\",\"display_as_html\":true,\"icon\":\"company-blink\",\"name\":\"Blink Automation\"},\"icon\":\"company-blink\",\"id\":\"<string>\",\"is_icon_selected_by_user\":true,\"is_otb\":true,\"is_request\":true,\"max_concurrency_level\":123,\"name\":\"My Workflow\",\"notification_emails\":\"<string>\",\"pack_id\":\"00000000-0000-0000-0000-000000000000\",\"playbook\":\"<string>\",\"playbook_to_run_on_error\":\"<string>\",\"preferred_engine_version\":\"<string>\",\"runner\":\"<string>\",\"step_transition_limit\":123,\"tags\":[\"k8s\"],\"tenant_id\":\"<string>\",\"updated_at\":123,\"updated_by\":\"<string>\",\"used_connections\":[\"<string>\"],\"used_global_variables\":[\"<string>\"],\"used_subflows\":[\"<string>\"],\"used_tables\":[\"<string>\"],\"version\":\"1\",\"wizard_id\":\"<string>\",\"workspace_id\":\"<string>\"}"
response = http.request(request)
puts response.read_body
{
"actions": [
{
"action_full_name": "<string>",
"collection_icon_uri": "<string>",
"collection_name": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>"
}
],
"active": true,
"analyst_copilot_workflow": true,
"automation_origin_id": "<string>",
"automation_type": "<string>",
"created_at": 123,
"created_by": "<string>",
"custom_timeout": 123,
"deleted": "<string>",
"display_settings": {
"description": "Automates common tasks",
"display_as_html": true,
"icon": "company-blink",
"name": "Blink Automation"
},
"icon": "company-blink",
"id": "<string>",
"is_icon_selected_by_user": true,
"is_otb": true,
"is_request": true,
"max_concurrency_level": 123,
"name": "My Workflow",
"notification_emails": "<string>",
"pack_id": "00000000-0000-0000-0000-000000000000",
"playbook": "<string>",
"playbook_to_run_on_error": "<string>",
"preferred_engine_version": "<string>",
"runner": "<string>",
"step_transition_limit": 123,
"tags": [
"k8s"
],
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"used_connections": [
"<string>"
],
"used_global_variables": [
"<string>"
],
"used_subflows": [
"<string>"
],
"used_tables": [
"<string>"
],
"version": "1",
"wizard_id": "<string>",
"workspace_id": "<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": {}
}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.
Path Parameters
Workspace ID
Query Parameters
URL to a remote YAML file — currently disabled; providing this returns 400
Body
application/json
Playbook definition to create
Playbook information that includes the playbook definition (YAML), metadata, and associations with packs, connections, and subflows.
List of actions used in the playbook
Show child attributes
Show child attributes
Whether the playbook is currently active
Whether this is an Analyst Copilot workflow
The ID of the original playbook if this is a replica
The type of automation
Custom execution timeout in hours
When the playbook was deleted
Settings for displaying the playbook in the self-service portal.
Show child attributes
Show child attributes
The icon associated with the playbook
Example:
"company-blink"
Whether the icon was manually selected
Whether this is an Out-Of-The-Box playbook
Whether the playbook is exposed as a self-service request
Maximum number of concurrent executions (0 for unlimited)
The name of the playbook
Example:
"My Workflow"
A comma-separated list of emails for notifications
The ID of the automation pack containing this playbook
Example:
"00000000-0000-0000-0000-000000000000"
The YAML definition of the playbook
The ID of the playbook to run if this one fails
The preferred workflow engine version
The name of the runner group assigned to this playbook
Maximum number of step transitions allowed in a single execution
Tags associated with the playbook
Example:
["k8s"]
The ID of the parent tenant
List of connection IDs used by the playbook
List of used global variables
List of subflow IDs used by the playbook
List of used tables
The version of the playbook
Example:
"1"
The ID of the wizard used to create this playbook
The ID of the parent workspace
Response
Created playbook
Playbook information that includes the playbook definition (YAML), metadata, and associations with packs, connections, and subflows.
List of actions used in the playbook
Show child attributes
Show child attributes
Whether the playbook is currently active
Whether this is an Analyst Copilot workflow
The ID of the original playbook if this is a replica
The type of automation
Custom execution timeout in hours
When the playbook was deleted
Settings for displaying the playbook in the self-service portal.
Show child attributes
Show child attributes
The icon associated with the playbook
Example:
"company-blink"
Whether the icon was manually selected
Whether this is an Out-Of-The-Box playbook
Whether the playbook is exposed as a self-service request
Maximum number of concurrent executions (0 for unlimited)
The name of the playbook
Example:
"My Workflow"
A comma-separated list of emails for notifications
The ID of the automation pack containing this playbook
Example:
"00000000-0000-0000-0000-000000000000"
The YAML definition of the playbook
The ID of the playbook to run if this one fails
The preferred workflow engine version
The name of the runner group assigned to this playbook
Maximum number of step transitions allowed in a single execution
Tags associated with the playbook
Example:
["k8s"]
The ID of the parent tenant
List of connection IDs used by the playbook
List of used global variables
List of subflow IDs used by the playbook
List of used tables
The version of the playbook
Example:
"1"
The ID of the wizard used to create this playbook
The ID of the parent workspace
Was this page helpful?