All URIs are relative to https://app.launchdarkly.com
| Method | HTTP request | Description |
|---|---|---|
| deleteWorkflow | DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId} | Delete workflow |
| getCustomWorkflow | GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId} | Get custom workflow |
| getWorkflows | GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows | Get workflows |
| postWorkflow | POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows | Create workflow |
deleteWorkflow(projectKey, featureFlagKey, environmentKey, workflowId)
Delete workflow
Delete a workflow from a feature flag.
// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.WorkflowsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://app.launchdarkly.com");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
String projectKey = "projectKey_example"; // String | The project key
String featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
String environmentKey = "environmentKey_example"; // String | The environment key
String workflowId = "workflowId_example"; // String | The workflow id
try {
apiInstance.deleteWorkflow(projectKey, featureFlagKey, environmentKey, workflowId);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowsApi#deleteWorkflow");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| projectKey | String | The project key | |
| featureFlagKey | String | The feature flag key | |
| environmentKey | String | The environment key | |
| workflowId | String | The workflow id |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Action completed successfully | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
CustomWorkflowOutput getCustomWorkflow(projectKey, featureFlagKey, environmentKey, workflowId)
Get custom workflow
Get a specific workflow by ID.
// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.WorkflowsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://app.launchdarkly.com");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
String projectKey = "projectKey_example"; // String | The project key
String featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
String environmentKey = "environmentKey_example"; // String | The environment key
String workflowId = "workflowId_example"; // String | The workflow ID
try {
CustomWorkflowOutput result = apiInstance.getCustomWorkflow(projectKey, featureFlagKey, environmentKey, workflowId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowsApi#getCustomWorkflow");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| projectKey | String | The project key | |
| featureFlagKey | String | The feature flag key | |
| environmentKey | String | The environment key | |
| workflowId | String | The workflow ID |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Workflow response | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
CustomWorkflowsListingOutput getWorkflows(projectKey, featureFlagKey, environmentKey, status, sort, limit, offset)
Get workflows
Display workflows associated with a feature flag.
// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.WorkflowsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://app.launchdarkly.com");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
String projectKey = "projectKey_example"; // String | The project key
String featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
String environmentKey = "environmentKey_example"; // String | The environment key
String status = "status_example"; // String | Filter results by workflow status. Valid status filters are `active`, `completed`, and `failed`.
String sort = "sort_example"; // String | A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `creationDate` or `stopDate`.
Long limit = 56L; // Long | The maximum number of workflows to return. Defaults to 20.
Long offset = 56L; // Long | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
try {
CustomWorkflowsListingOutput result = apiInstance.getWorkflows(projectKey, featureFlagKey, environmentKey, status, sort, limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowsApi#getWorkflows");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| projectKey | String | The project key | |
| featureFlagKey | String | The feature flag key | |
| environmentKey | String | The environment key | |
| status | String | Filter results by workflow status. Valid status filters are `active`, `completed`, and `failed`. | [optional] |
| sort | String | A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `creationDate` or `stopDate`. | [optional] |
| limit | Long | The maximum number of workflows to return. Defaults to 20. | [optional] |
| offset | Long | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Workflows collection response | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |
CustomWorkflowOutput postWorkflow(projectKey, featureFlagKey, environmentKey, customWorkflowInput, templateKey, dryRun)
Create workflow
Create a workflow for a feature flag. You can create a workflow directly, or you can apply a template to create a new workflow. ### Creating a workflow You can use the create workflow endpoint to create a workflow directly by adding a `stages` array to the request body. For each stage, define the `name`, `conditions` when the stage should be executed, and `action` that describes the stage. <details> <summary>Click to expand example</summary> Example request body ```json { "name": "Progressive rollout starting in two days", "description": "Turn flag targeting on and increase feature rollout in 10% increments each day", "stages": [ { "name": "10% rollout on day 1", "conditions": [ { "kind": "schedule", "scheduleKind": "relative", // or "absolute" // If "scheduleKind" is "absolute", set "executionDate"; // "waitDuration" and "waitDurationUnit" will be ignored "waitDuration": 2, "waitDurationUnit": "calendarDay" }, { "kind": "ld-approval", "notifyMemberIds": [ "507f1f77bcf86cd799439011" ], "notifyTeamKeys": [ "team-key-123abc" ] } ], "action": { "instructions": [ { "kind": "turnFlagOn" }, { "kind": "updateFallthroughVariationOrRollout", "rolloutWeights": { "452f5fb5-7320-4ba3-81a1-8f4324f79d49": 90000, "fc15f6a4-05d3-4aa4-a997-446be461345d": 10000 } } ] } } ] } ``` </details> ### Creating a workflow by applying a workflow template You can also create a workflow by applying a workflow template. If you pass a valid workflow template key as the `templateKey` query parameter with the request, the API will attempt to create a new workflow with the stages defined in the workflow template with the corresponding key. #### Applicability of stages Templates are created in the context of a particular flag in a particular environment in a particular project. However, because workflows created from a template can be applied to any project, environment, and flag, some steps of the workflow may need to be updated in order to be applicable for the target resource. You can pass a `dryRun` query parameter to tell the API to return a report of which steps of the workflow template are applicable in the target project/environment/flag, and which will need to be updated. When the `dryRun` query parameter is present the response body includes a `meta` property that holds a list of parameters that could potentially be inapplicable for the target resource. Each of these parameters will include a `valid` field. You will need to update any invalid parameters in order to create the new workflow. You can do this using the `parameters` property, which overrides the workflow template parameters. #### Overriding template parameters You can use the `parameters` property in the request body to tell the API to override the specified workflow template parameters with new values that are specific to your target project/environment/flag. <details> <summary>Click to expand example</summary> Example request body ```json { "name": "workflow created from my-template", "description": "description of my workflow", "parameters": [ { "_id": "62cf2bc4cadbeb7697943f3b", "path": "/clauses/0/values", "default": { "value": ["updated-segment"] } }, { "_id": "62cf2bc4cadbeb7697943f3d", "path": "/variationId", "default": { "value": "abcd1234-abcd-1234-abcd-1234abcd12" } } ] } ``` </details> If there are any steps in the template that are not applicable to the target resource, the workflow will not be created, and the `meta` property will be included in the response body detailing which parameters need to be updated.
// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.WorkflowsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://app.launchdarkly.com");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
WorkflowsApi apiInstance = new WorkflowsApi(defaultClient);
String projectKey = "projectKey_example"; // String | The project key
String featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
String environmentKey = "environmentKey_example"; // String | The environment key
CustomWorkflowInput customWorkflowInput = new CustomWorkflowInput(); // CustomWorkflowInput |
String templateKey = "templateKey_example"; // String | The template key to apply as a starting point for the new workflow
Boolean dryRun = true; // Boolean | Whether to call the endpoint in dry-run mode
try {
CustomWorkflowOutput result = apiInstance.postWorkflow(projectKey, featureFlagKey, environmentKey, customWorkflowInput, templateKey, dryRun);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowsApi#postWorkflow");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| projectKey | String | The project key | |
| featureFlagKey | String | The feature flag key | |
| environmentKey | String | The environment key | |
| customWorkflowInput | CustomWorkflowInput | ||
| templateKey | String | The template key to apply as a starting point for the new workflow | [optional] |
| dryRun | Boolean | Whether to call the endpoint in dry-run mode | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Workflow response | - |
| 400 | Invalid request | - |
| 401 | Invalid access token | - |
| 403 | Forbidden | - |
| 404 | Invalid resource identifier | - |
| 429 | Rate limited | - |