Update layer | LaunchDarkly

Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instructions for updating layers.

Click to expand instructions for updating layers

updateName

Updates the layer name.

Parameters

name: The new layer name.

Here’s an example:

1 {
2   "instructions": [{
3       "kind": "updateName",
4       "name": "New name"
5   }]
6 }

updateDescription

Updates the layer description.

Parameters

description: The new description.

Here’s an example:

1 {
2   "instructions": [{
3       "kind": "updateDescription",
4       "description": "New description"
5   }]
6 }

updateExperimentReservation

Adds or updates a traffic reservation for an experiment in a layer.

Parameters

experimentKey: The key of the experiment whose reservation you are adding to or updating in the layer.
reservationPercent: The amount of traffic in the layer to reserve. Must be an integer. Zero is allowed until iteration start.

Here’s an example:

1 {
2   "environmentKey": "production",
3   "instructions": [{
4       "kind": "updateExperimentReservation",
5       "experimentKey": "exp-key",
6       "reservationPercent": 10
7   }]
8 }

removeExperiment

Removes a traffic reservation for an experiment from a layer.

Parameters

experimentKey: The key of the experiment whose reservation you want to remove from the layer.

Here’s an example:

1 {
2   "environmentKey": "production",
3   "instructions": [{
4       "kind": "removeExperiment",
5       "experimentKey": "exp-key"
6   }]
7 }

Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating layers. <details> <summary>Click to expand instructions for <strong>updating layers</strong></summary> #### updateName Updates the layer name. ##### Parameters - `name`: The new layer name. Here's an example: ```json { "instructions": [{ "kind": "updateName", "name": "New name" }] } ``` #### updateDescription Updates the layer description. ##### Parameters - `description`: The new description. Here's an example: ```json { "instructions": [{ "kind": "updateDescription", "description": "New description" }] } ``` #### updateExperimentReservation Adds or updates a traffic reservation for an experiment in a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you are adding to or updating in the layer. - `reservationPercent`: The amount of traffic in the layer to reserve. Must be an integer. Zero is allowed until iteration start. Here's an example: ```json { "environmentKey": "production", "instructions": [{ "kind": "updateExperimentReservation", "experimentKey": "exp-key", "reservationPercent": 10 }] } ``` #### removeExperiment Removes a traffic reservation for an experiment from a layer. ##### Parameters - `experimentKey`: The key of the experiment whose reservation you want to remove from the layer. Here's an example: ```json { "environmentKey": "production", "instructions": [{ "kind": "removeExperiment", "experimentKey": "exp-key" }] } ``` </details>

Authentication

Authorizationstring

API Key authentication via header

Path Parameters

projectKeystringRequired

The project key

layerKeystringRequired

The layer key

Request

This endpoint expects an object.

instructionslist of maps from strings to anyRequired

The instructions to perform when updating. This should be an array with objects that look like <code>{“kind”: “update_action”}</code>. Some instructions also require a <code>value</code> field in the array element.

commentstringOptional

Optional comment describing the update

environmentKeystringOptional

The environment key used for making environment specific updates. For example, updating the reservation of an experiment

Response

Layer response

keystring

The key of the layer

namestring

The name of the layer

descriptionstring

The description of the layer

createdAtlong

The date and time when the layer was created

randomizationUnitstring or null

The unit of randomization for the layer

environmentsmap from strings to objects or null

The layer configurations for each requested environment

Errors

Update a layer by adding, changing, or removing traffic reservations for experiments, or by changing layer name or description. Updating a layer uses the semantic patch format.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instructions for updating layers.

Click to expand instructions for updating layers

updateName

Updates the layer name.

Parameters

name: The new layer name.

Here’s an example:

1 {
2   "instructions": [{
3       "kind": "updateName",
4       "name": "New name"
5   }]
6 }

updateDescription

Updates the layer description.

Parameters

description: The new description.

Here’s an example:

1 {
2   "instructions": [{
3       "kind": "updateDescription",
4       "description": "New description"
5   }]
6 }

updateExperimentReservation

Adds or updates a traffic reservation for an experiment in a layer.

Parameters

experimentKey: The key of the experiment whose reservation you are adding to or updating in the layer.
reservationPercent: The amount of traffic in the layer to reserve. Must be an integer. Zero is allowed until iteration start.

Here’s an example:

1 {
2   "environmentKey": "production",
3   "instructions": [{
4       "kind": "updateExperimentReservation",
5       "experimentKey": "exp-key",
6       "reservationPercent": 10
7   }]
8 }

removeExperiment

Removes a traffic reservation for an experiment from a layer.

Parameters

experimentKey: The key of the experiment whose reservation you want to remove from the layer.

Here’s an example:

1 {
2   "environmentKey": "production",
3   "instructions": [{
4       "kind": "removeExperiment",
5       "experimentKey": "exp-key"
6   }]
7 }

1	import requests
2
3	url = "https://app.launchdarkly.com/api/v2/projects/projectKey/layers/layerKey"
4
5	payload = {
6	"instructions": [
7	{
8	"experimentKey": "checkout-button-color",
9	"kind": "updateExperimentReservation",
10	"reservationPercent": 25
11	}
12	],
13	"comment": "Example comment describing the update",
14	"environmentKey": "production"
15	}
16	headers = {
17	"Authorization": "<apiKey>",
18	"Content-Type": "application/json"
19	}
20
21	response = requests.patch(url, json=payload, headers=headers)
22
23	print(response.json())

1	{
2	"key": "checkout-flow",
3	"name": "Checkout Flow",
4	"description": "The checkout flow for the application",
5	"createdAt": 1000000,
6	"randomizationUnit": "user",
7	"environments": {
8	"key": {
9	"reservations": [
10	{
11	"experimentKey": "checkout-flow-experiment",
12	"flagKey": "checkout-flow-flag",
13	"reservationPercent": 20
14	}
15	]
16	}
17	}
18	}

1	{
2	"instructions": [{
3	"kind": "updateName",
4	"name": "New name"
5	}]
6	}

1	{
2	"instructions": [{
3	"kind": "updateDescription",
4	"description": "New description"
5	}]
6	}

1	{
2	"environmentKey": "production",
3	"instructions": [{
4	"kind": "updateExperimentReservation",
5	"experimentKey": "exp-key",
6	"reservationPercent": 10
7	}]
8	}

1	{
2	"environmentKey": "production",
3	"instructions": [{
4	"kind": "removeExperiment",
5	"experimentKey": "exp-key"
6	}]
7	}