OverviewLayers

Update layer

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}

Path parameters

projectKeystringRequired
The project key
layerKeystringRequired
The layer key

Headers

AuthorizationstringRequired

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