Get custom workflow | LaunchDarkly

curl https://app.launchdarkly.com/api/v2/projects/projectKey/flags/featureFlagKey/environments/environmentKey/workflows/workflowId \
     -H "Authorization: <apiKey>"

{
  "_id": "12ab3c4d5ef1a2345bcde67f",
  "_version": 1,
  "_conflicts": [
    {
      "stageId": "12ab3c4d5ef1a2345bcde67f",
      "message": "string"
    }
  ],
  "_creationDate": 1654104600000,
  "_maintainerId": "12ab3c45de678910abc12345",
  "_links": {},
  "name": "Progressive rollout starting in two days",
  "_execution": {
    "status": "completed"
  },
  "description": "Turn flag on for 10% of customers each day",
  "kind": "custom",
  "stages": [
    {
      "_id": "12ab3c45de678910abc12345",
      "conditions": [
        {
          "_id": "string",
          "_execution": {
            "status": "completed"
          },
          "description": "string",
          "notifyMemberIds": [
            "string"
          ],
          "allReviews": [
            {
              "_id": "string",
              "kind": "string",
              "creationDate": 1,
              "comment": "string",
              "memberId": "string",
              "serviceTokenId": "string"
            }
          ],
          "reviewStatus": "string",
          "kind": "schedule",
          "scheduleKind": "relative",
          "waitDuration": 2,
          "waitDurationUnit": "calendarDay",
          "id": "12ab3c45de678910abc12345"
        }
      ],
      "action": {
        "kind": "patch",
        "instructions": [
          "[{\"kind\": \"turnFlagOn\"}]"
        ]
      },
      "_execution": {
        "status": "completed"
      },
      "name": "10% rollout on day 1"
    }
  ],
  "meta": {
    "parameters": [
      {
        "_id": "string",
        "path": "string",
        "default": {
          "value": null,
          "booleanVariationValue": true,
          "ruleClause": {
            "attribute": "string",
            "op": "in",
            "negate": true
          }
        },
        "valid": true
      }
    ]
  },
  "templateKey": "example-workflow-template"
}

Get a specific workflow by ID.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

featureFlagKeystringRequiredformat: "string"

The feature flag key

environmentKeystringRequiredformat: "string"

The environment key

workflowIdstringRequiredformat: "string"

The workflow ID

Response

Workflow response

_idstring

The ID of the workflow

_versioninteger

The version of the workflow

_conflictslist of objects

Any conflicts that are present in the workflow stages

_creationDatelong

Timestamp of when the workflow was created

_maintainerIdstring

The member ID of the maintainer of the workflow. Defaults to the workflow creator.

_linksmap from strings to objects

The location and content type of related resources

namestring

The name of the workflow

_executionobject

The current execution status of the workflow

descriptionstring

A brief description of the workflow

kindstring

The kind of workflow

stageslist of objects

The stages that make up the workflow. Each stage contains conditions and actions.

metaobject

For workflows being created from a workflow template, this value holds any parameters that could potentially be incompatible with the current project, environment, or flag

templateKeystring

For workflows being created from a workflow template, this value is the template's key

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error