Patch release for flag

PATCH

/api/v2/flags/:projectKey/:flagKey/release

This endpoint is only available for releases that are part of a legacy release pipeline. Releases for new release pipelines should use the Update phase status for release endpoint. To learn more about migrating from legacy release pipelines to fully automated release pipelines, read the Release pipeline migration guide.

Update currently active release for a flag. Updating releases requires the JSON patch format. To learn more, read Updates.

You can only use this endpoint to mark a release phase complete or incomplete. To indicate which phase to update, use the array index in the path. For example, to mark the first phase of a release as complete, use the following request body:

  [
    {
      "op": "replace",
      "path": "/phase/0/complete",
      "value": true
    }
  ]

Path parameters

projectKeystringRequired

The project key

flagKeystringRequired

The flag key

Request

This endpoint expects a list of objects.

list of objects

Response

Release response

namestring

The release pipeline name

releasePipelineKeystring

The release pipeline key

releasePipelineDescriptionstring

The release pipeline description

phaseslist of objects

An ordered list of the release pipeline phases

_versioninteger

The release version

_linksmap from strings to objectsOptional

The location and content type of related resources

_releaseVariationIdstringOptional

The chosen release variation ID to use across all phases of a release

_canceledAtlongOptional

Timestamp of when the release was canceled

Errors

PATCH

1 curl -X PATCH https://app.launchdarkly.com/api/v2/flags/projectKey/flagKey/release \
2      -H "Authorization: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '[
5   {
6     "op": "replace",
7     "path": "/phases/0/complete",
8     "value": true
9   }
10 ]'

200Updated

1 {
2   "name": "Example release pipeline",
3   "releasePipelineKey": "example-release-pipeline",
4   "releasePipelineDescription": "Our release pipeline for typical testing and deployment",
5   "phases": [
6     {
7       "_id": "1234a56b7c89d012345e678f",
8       "_name": "Phase 1 - Testing",
9       "complete": true,
10       "_creationDate": 1000000,
11       "_audiences": [
12         {
13           "_id": "1234a56b7c89d012345e678g",
14           "name": "Phase 1 - Testing",
15           "environment": {
16             "_links": {
17               "self": {
18                 "href": "/api/v2/projects/my-project/environments/my-environment",
19                 "type": "application/json"
20               }
21             },
22             "key": "environment-key-123abc",
23             "name": "My Environment",
24             "color": "F5A623"
25           },
26           "configuration": {
27             "releaseStrategy": "releaseStrategy",
28             "requireApproval": true,
29             "releaseGuardianConfiguration": {
30               "monitoringWindowMilliseconds": 60000,
31               "rolloutWeight": 50,
32               "rollbackOnRegression": true,
33               "randomizationUnit": "user"
34             }
35           }
36         }
37       ],
38       "_completionDate": 1000000,
39       "_completedBy": {
40         "member": {
41           "_links": {
42             "self": {
43               "href": "/api/v2/members/569f183514f4432160000007",
44               "type": "application/json"
45             }
46           },
47           "_id": "569f183514f4432160000007",
48           "role": "admin",
49           "email": "ariel@acme.com",
50           "firstName": "Ariel",
51           "lastName": "Flores"
52         }
53       },
54       "status": "status",
55       "started": true,
56       "_startedDate": 1000000
57     }
58   ],
59   "_version": 1,
60   "_links": {
61     "key": {
62       "href": "href",
63       "type": "type"
64     }
65   },
66   "_releaseVariationId": "_releaseVariationId",
67   "_canceledAt": 1000000
68 }

Update phase status for release

Up Next

Built with

1	curl -X PATCH https://app.launchdarkly.com/api/v2/flags/projectKey/flagKey/release \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"op": "replace",
7	"path": "/phases/0/complete",
8	"value": true
9	}
10	]'

1	{
2	"name": "Example release pipeline",
3	"releasePipelineKey": "example-release-pipeline",
4	"releasePipelineDescription": "Our release pipeline for typical testing and deployment",
5	"phases": [
6	{
7	"_id": "1234a56b7c89d012345e678f",
8	"_name": "Phase 1 - Testing",
9	"complete": true,
10	"_creationDate": 1000000,
11	"_audiences": [
12	{
13	"_id": "1234a56b7c89d012345e678g",
14	"name": "Phase 1 - Testing",
15	"environment": {
16	"_links": {
17	"self": {
18	"href": "/api/v2/projects/my-project/environments/my-environment",
19	"type": "application/json"
20	}
21	},
22	"key": "environment-key-123abc",
23	"name": "My Environment",
24	"color": "F5A623"
25	},
26	"configuration": {
27	"releaseStrategy": "releaseStrategy",
28	"requireApproval": true,
29	"releaseGuardianConfiguration": {
30	"monitoringWindowMilliseconds": 60000,
31	"rolloutWeight": 50,
32	"rollbackOnRegression": true,
33	"randomizationUnit": "user"
34	}
35	}
36	}
37	],
38	"_completionDate": 1000000,
39	"_completedBy": {
40	"member": {
41	"_links": {
42	"self": {
43	"href": "/api/v2/members/569f183514f4432160000007",
44	"type": "application/json"
45	}
46	},
47	"_id": "569f183514f4432160000007",
48	"role": "admin",
49	"email": "ariel@acme.com",
50	"firstName": "Ariel",
51	"lastName": "Flores"
52	}
53	},
54	"status": "status",
55	"started": true,
56	"_startedDate": 1000000
57	}
58	],
59	"_version": 1,
60	"_links": {
61	"key": {
62	"href": "href",
63	"type": "type"
64	}
65	},
66	"_releaseVariationId": "_releaseVariationId",
67	"_canceledAt": 1000000
68	}