Update layer

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

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:

{
  "instructions": [{
      "kind": "updateName",
      "name": "New name"
  }]
}

updateDescription

Updates the layer description.

Parameters

• description: The new description.

Here’s an example:

{
  "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:

{
  "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:

{
  "environmentKey": "production",
  "instructions": [{
      "kind": "removeExperiment",
      "experimentKey": "exp-key"
  }]
}

PATCH /api/v2/projects/{projectKey}/layers/{layerKey}

Update layer

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/layers/{layerKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "Example comment describing the update",
  "environmentKey": "production",
  "instructions": [
    {
      "experimentKey": "checkout-button-color",
      "kind": "updateExperimentReservation",
      "reservationPercent": 25
    }
  ]
}
'

200

{
  "key": "checkout-flow",
  "name": "Checkout Flow",
  "description": "The checkout flow for the application",
  "createdAt": 123,
  "randomizationUnit": "user",
  "environments": {}
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

layerKey · string<string> · required

The layer key

Body

application/json

instructions · object[] · required

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

Show child attributes

Example:

"[{\"kind\": \"updateName\", \"name\": \"Updated layer name\"}]"

comment · string

Optional comment describing the update

Example:

"Optional comment"

environmentKey · string

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

Example:

"production"

Response

200

application/json

Layer response

key · string · required

The key of the layer

Example:

"checkout-flow"

name · string · required

The name of the layer

Example:

"Checkout Flow"

description · string · required

The description of the layer

Example:

"The checkout flow for the application"

createdAt · integer<int64> · required

The date and time when the layer was created

randomizationUnit · string

The unit of randomization for the layer

Example:

"user"

environments · object

The layer configurations for each requested environment

Show child attributes