Create workflow template
curl --request POST \
--url https://app.launchdarkly.com/api/v2/templates \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"name": "<string>",
"description": "<string>",
"workflowId": "<string>",
"stages": [
{
"name": "10% rollout on day 1",
"executeConditionsInSequence": true,
"conditions": [
{
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"action": "{\"instructions\": [{ \"kind\": \"turnFlagOn\"}]}"
}
],
"projectKey": "<string>",
"environmentKey": "<string>",
"flagKey": "<string>"
}
'import requests
url = "https://app.launchdarkly.com/api/v2/templates"
payload = {
"key": "<string>",
"name": "<string>",
"description": "<string>",
"workflowId": "<string>",
"stages": [
{
"name": "10% rollout on day 1",
"executeConditionsInSequence": True,
"conditions": [
{
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"action": "{\"instructions\": [{ \"kind\": \"turnFlagOn\"}]}"
}
],
"projectKey": "<string>",
"environmentKey": "<string>",
"flagKey": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
name: '<string>',
description: '<string>',
workflowId: '<string>',
stages: [
{
name: '10% rollout on day 1',
executeConditionsInSequence: true,
conditions: [
{
kind: 'schedule',
scheduleKind: 'relative',
waitDuration: 2,
waitDurationUnit: 'calendarDay'
}
],
action: '{"instructions": [{ "kind": "turnFlagOn"}]}'
}
],
projectKey: '<string>',
environmentKey: '<string>',
flagKey: '<string>'
})
};
fetch('https://app.launchdarkly.com/api/v2/templates', 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.launchdarkly.com/api/v2/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'workflowId' => '<string>',
'stages' => [
[
'name' => '10% rollout on day 1',
'executeConditionsInSequence' => true,
'conditions' => [
[
'kind' => 'schedule',
'scheduleKind' => 'relative',
'waitDuration' => 2,
'waitDurationUnit' => 'calendarDay'
]
],
'action' => '{"instructions": [{ "kind": "turnFlagOn"}]}'
]
],
'projectKey' => '<string>',
'environmentKey' => '<string>',
'flagKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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.launchdarkly.com/api/v2/templates"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workflowId\": \"<string>\",\n \"stages\": [\n {\n \"name\": \"10% rollout on day 1\",\n \"executeConditionsInSequence\": true,\n \"conditions\": [\n {\n \"kind\": \"schedule\",\n \"scheduleKind\": \"relative\",\n \"waitDuration\": 2,\n \"waitDurationUnit\": \"calendarDay\"\n }\n ],\n \"action\": \"{\\\"instructions\\\": [{ \\\"kind\\\": \\\"turnFlagOn\\\"}]}\"\n }\n ],\n \"projectKey\": \"<string>\",\n \"environmentKey\": \"<string>\",\n \"flagKey\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.post("https://app.launchdarkly.com/api/v2/templates")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workflowId\": \"<string>\",\n \"stages\": [\n {\n \"name\": \"10% rollout on day 1\",\n \"executeConditionsInSequence\": true,\n \"conditions\": [\n {\n \"kind\": \"schedule\",\n \"scheduleKind\": \"relative\",\n \"waitDuration\": 2,\n \"waitDurationUnit\": \"calendarDay\"\n }\n ],\n \"action\": \"{\\\"instructions\\\": [{ \\\"kind\\\": \\\"turnFlagOn\\\"}]}\"\n }\n ],\n \"projectKey\": \"<string>\",\n \"environmentKey\": \"<string>\",\n \"flagKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.launchdarkly.com/api/v2/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workflowId\": \"<string>\",\n \"stages\": [\n {\n \"name\": \"10% rollout on day 1\",\n \"executeConditionsInSequence\": true,\n \"conditions\": [\n {\n \"kind\": \"schedule\",\n \"scheduleKind\": \"relative\",\n \"waitDuration\": 2,\n \"waitDurationUnit\": \"calendarDay\"\n }\n ],\n \"action\": \"{\\\"instructions\\\": [{ \\\"kind\\\": \\\"turnFlagOn\\\"}]}\"\n }\n ],\n \"projectKey\": \"<string>\",\n \"environmentKey\": \"<string>\",\n \"flagKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"_key": "<string>",
"_creationDate": 123,
"_ownerId": "<string>",
"_maintainerId": "<string>",
"_links": {},
"name": "<string>",
"description": "<string>",
"stages": [
{
"_id": "12ab3c45de678910abc12345",
"conditions": [
{
"_execution": {
"status": "completed"
},
"id": "12ab3c45de678910abc12345",
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"action": "{ \"kind\": \"patch\", \"instructions\": [{ \"kind\": \"turnFlagOn\"}] }",
"_execution": "{ \"status\": \"completed\" }",
"name": "10% rollout on day 1"
}
]
}{
"code": "invalid_request",
"message": "Invalid request body"
}{
"code": "unauthorized",
"message": "Invalid access token"
}{
"code": "forbidden",
"message": "Forbidden. Access to the requested resource was denied."
}{
"code": "rate_limited",
"message": "You've exceeded the API rate limit. Try again later."
}Create workflow template
Workflows are in maintenance mode
The workflows feature is in maintenance mode, and is planned for future deprecation at a date not yet specified. We will work with existing customers using workflows to migrate to a replacement solution when deprecation occurs.
Create a template for a feature flag workflow.
POST
/
api
/
v2
/
templates
Create workflow template
curl --request POST \
--url https://app.launchdarkly.com/api/v2/templates \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"name": "<string>",
"description": "<string>",
"workflowId": "<string>",
"stages": [
{
"name": "10% rollout on day 1",
"executeConditionsInSequence": true,
"conditions": [
{
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"action": "{\"instructions\": [{ \"kind\": \"turnFlagOn\"}]}"
}
],
"projectKey": "<string>",
"environmentKey": "<string>",
"flagKey": "<string>"
}
'import requests
url = "https://app.launchdarkly.com/api/v2/templates"
payload = {
"key": "<string>",
"name": "<string>",
"description": "<string>",
"workflowId": "<string>",
"stages": [
{
"name": "10% rollout on day 1",
"executeConditionsInSequence": True,
"conditions": [
{
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"action": "{\"instructions\": [{ \"kind\": \"turnFlagOn\"}]}"
}
],
"projectKey": "<string>",
"environmentKey": "<string>",
"flagKey": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
name: '<string>',
description: '<string>',
workflowId: '<string>',
stages: [
{
name: '10% rollout on day 1',
executeConditionsInSequence: true,
conditions: [
{
kind: 'schedule',
scheduleKind: 'relative',
waitDuration: 2,
waitDurationUnit: 'calendarDay'
}
],
action: '{"instructions": [{ "kind": "turnFlagOn"}]}'
}
],
projectKey: '<string>',
environmentKey: '<string>',
flagKey: '<string>'
})
};
fetch('https://app.launchdarkly.com/api/v2/templates', 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.launchdarkly.com/api/v2/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'workflowId' => '<string>',
'stages' => [
[
'name' => '10% rollout on day 1',
'executeConditionsInSequence' => true,
'conditions' => [
[
'kind' => 'schedule',
'scheduleKind' => 'relative',
'waitDuration' => 2,
'waitDurationUnit' => 'calendarDay'
]
],
'action' => '{"instructions": [{ "kind": "turnFlagOn"}]}'
]
],
'projectKey' => '<string>',
'environmentKey' => '<string>',
'flagKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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.launchdarkly.com/api/v2/templates"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workflowId\": \"<string>\",\n \"stages\": [\n {\n \"name\": \"10% rollout on day 1\",\n \"executeConditionsInSequence\": true,\n \"conditions\": [\n {\n \"kind\": \"schedule\",\n \"scheduleKind\": \"relative\",\n \"waitDuration\": 2,\n \"waitDurationUnit\": \"calendarDay\"\n }\n ],\n \"action\": \"{\\\"instructions\\\": [{ \\\"kind\\\": \\\"turnFlagOn\\\"}]}\"\n }\n ],\n \"projectKey\": \"<string>\",\n \"environmentKey\": \"<string>\",\n \"flagKey\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.post("https://app.launchdarkly.com/api/v2/templates")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workflowId\": \"<string>\",\n \"stages\": [\n {\n \"name\": \"10% rollout on day 1\",\n \"executeConditionsInSequence\": true,\n \"conditions\": [\n {\n \"kind\": \"schedule\",\n \"scheduleKind\": \"relative\",\n \"waitDuration\": 2,\n \"waitDurationUnit\": \"calendarDay\"\n }\n ],\n \"action\": \"{\\\"instructions\\\": [{ \\\"kind\\\": \\\"turnFlagOn\\\"}]}\"\n }\n ],\n \"projectKey\": \"<string>\",\n \"environmentKey\": \"<string>\",\n \"flagKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.launchdarkly.com/api/v2/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workflowId\": \"<string>\",\n \"stages\": [\n {\n \"name\": \"10% rollout on day 1\",\n \"executeConditionsInSequence\": true,\n \"conditions\": [\n {\n \"kind\": \"schedule\",\n \"scheduleKind\": \"relative\",\n \"waitDuration\": 2,\n \"waitDurationUnit\": \"calendarDay\"\n }\n ],\n \"action\": \"{\\\"instructions\\\": [{ \\\"kind\\\": \\\"turnFlagOn\\\"}]}\"\n }\n ],\n \"projectKey\": \"<string>\",\n \"environmentKey\": \"<string>\",\n \"flagKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"_key": "<string>",
"_creationDate": 123,
"_ownerId": "<string>",
"_maintainerId": "<string>",
"_links": {},
"name": "<string>",
"description": "<string>",
"stages": [
{
"_id": "12ab3c45de678910abc12345",
"conditions": [
{
"_execution": {
"status": "completed"
},
"id": "12ab3c45de678910abc12345",
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"action": "{ \"kind\": \"patch\", \"instructions\": [{ \"kind\": \"turnFlagOn\"}] }",
"_execution": "{ \"status\": \"completed\" }",
"name": "10% rollout on day 1"
}
]
}{
"code": "invalid_request",
"message": "Invalid request body"
}{
"code": "unauthorized",
"message": "Invalid access token"
}{
"code": "forbidden",
"message": "Forbidden. Access to the requested resource was denied."
}{
"code": "rate_limited",
"message": "You've exceeded the API rate limit. Try again later."
}Authorizations
Body
application/json