---
title: "Update a Relay Proxy config"
method: PATCH
path: "/api/v2/account/relay-auto-configs/{id}"
tags: ["Relay Proxy configurations"]
---

# Update a Relay Proxy config

`PATCH /api/v2/account/relay-auto-configs/{id}`

Update a Relay Proxy configuration. Updating a configuration uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

## Path parameters

- `id` string, string, required — The relay auto config id

## Request body

- PatchWithComment
  - `patch` PatchOperation[], required
    - `op` string, required — The type of operation to perform
    - `path` string, required — A JSON Pointer string specifying the part of the document to operate on
    - `value` string — A JSON value used in "add", "replace", and "test" operations
  - `comment` string — Optional comment

## Response `200`

Relay auto config response

- RelayAutoConfigRep
  - `_id` string, required
  - `_creator` MemberSummary
    - `_links` object, required — The location and content type of related resources
    - `_id` string, required — The member's ID
    - `firstName` string — The member's first name
    - `lastName` string — The member's last name
    - `role` string, required — The member's base role. If the member has no additional roles, this role will be in effect.
    - `email` string, required — The member's email address
  - `_access` Access
    - `denied` AccessDenied[], required
      - `action` string, required
      - `reason` AccessDeniedReason, required
        - `resources` string[] — Resource specifier strings
        - `notResources` string[] — Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field.
        - `actions` ActionSpecifier[] — Actions to perform on a resource
        - `notActions` ActionSpecifier[] — Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field.
        - `effect` 'allow' | 'deny', required — Whether this statement should allow or deny actions on the resources.
        - `role_name` string
    - `allowed` AccessAllowedRep[], required
      - `action` string, required
      - `reason` AccessAllowedReason, required
        - `resources` string[] — Resource specifier strings
        - `notResources` string[] — Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field.
        - `actions` ActionSpecifier[] — Actions to perform on a resource
        - `notActions` ActionSpecifier[] — Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field.
        - `effect` 'allow' | 'deny', required — Whether this statement should allow or deny actions on the resources.
        - `role_name` string
  - `name` string, required — A human-friendly name for the Relay Proxy configuration
  - `policy` Statement[], required — A description of what environments and projects the Relay Proxy should include or exclude
    - `resources` string[] — Resource specifier strings
    - `notResources` string[] — Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field.
    - `actions` ActionSpecifier[] — Actions to perform on a resource
    - `notActions` ActionSpecifier[] — Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field.
    - `effect` 'allow' | 'deny', required — Whether this statement should allow or deny actions on the resources.
  - `fullKey` string — The Relay Proxy configuration key
  - `displayKey` string, required — The last few characters of the Relay Proxy configuration key, displayed in the LaunchDarkly UI
  - `creationDate` integer, required
  - `lastModified` integer, required

## Other responses

- `400` — Invalid request
- `401` — Invalid access token
- `404` — Invalid resource identifier
- `409` — Status conflict
- `422` — Invalid patch content
- `429` — Rate limited

## Changes

- **2026-02-28** `69c5c9aafe78` — 1 breaking
  - the response property `fullKey` became optional for the status `200`

[Change history](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api/changes/api/v2/account/relay-auto-configs/:id/patch.md)

---

[API](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api.md) · [All operations](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/launchdarkly/launchdarkly-rest-api/revisions/69c5c9aafe78/schema)
