provider Layers PATCH
/api/v2/projects/{projectKey}/layers/{layerKey} @utdk/launchdarkly
/api/v2/projects/{projectKey}/layers/{layerKey} 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](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>
- projectKey path required
- The project key
- string
- layerKey path required
- The layer key
- string
Try it
Authentication
Configure credentials for LaunchDarkly REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import launchdarkly from '@utdk/launchdarkly';
await launchdarkly.updatelayer()