v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Relay Proxy configurations

Update a Relay Proxy config

Update a Relay Proxy configuration. Updating a configuration uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.

patch/api/v2/account/relay-auto-configs/{id}

Path parameters

idstring string required

The relay auto config id

Request body

commentstring

Optional comment

Example request

{
  "patch": [
    {
      "op": "replace",
      "path": "/exampleField",
      "value": "new example value"
    }
  ]
}

Response

Relay auto config response

_idstring required

namestring required

A human-friendly name for the Relay Proxy configuration

fullKeystring

The Relay Proxy configuration key

displayKeystring required

The last few characters of the Relay Proxy configuration key, displayed in the LaunchDarkly UI

creationDateinteger required

lastModifiedinteger required

Example response

{
  "_creator": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "firstName": "Ariel",
    "lastName": "Flores",
    "role": "admin",
    "email": "ariel@acme.com"
  },
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  },
  "name": "Relay Proxy Demo Config",
  "policy": [
    {
      "resources": [
        "proj/*:env/*;qa_*:/flag/*"
      ],
      "actions": [
        "*"
      ],
      "effect": "allow"
    }
  ],
  "displayKey": "7f30"
}