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 or JSON merge patch representation of the desired changes. To learn more, read Updates.

Path parameters

idstringRequired

The relay auto config id

Request

This endpoint expects an object.

patchlist of objectsRequired

A JSON patch representation of the change to make

commentstringOptional

Optional comment

Response

Relay auto config response

_idstring

The ID of the Relay Proxy configuration

namestring

A human-friendly name for the Relay Proxy configuration

policylist of objects

A description of what environments and projects the Relay Proxy should include or exclude

fullKeystring

The Relay Proxy configuration key

displayKeystring

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

creationDatelong

Timestamp of when the Relay Proxy configuration was created

lastModifiedlong

Timestamp of when the Relay Proxy configuration was most recently modified

_creatorobjectOptional

Details on the member who created this Relay Proxy configuration

_accessobjectOptional

Details on the allowed and denied actions for this Relay Proxy configuration

Errors

PATCH

1 curl -X PATCH https://app.launchdarkly.com/api/v2/account/relay-auto-configs/id \
2      -H "Authorization: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "patch": [
6     {
7       "op": "replace",
8       "path": "/policy/0",
9       "value": {
10         "actions": [
11           "*"
12         ],
13         "effect": "allow",
14         "resources": [
15           "proj/*:env/qa"
16         ]
17       }
18     }
19   ]
20 }'

200Updated

1 {
2   "_id": "_id",
3   "name": "Relay Proxy Demo Config",
4   "policy": [
5     {
6       "effect": "allow",
7       "resources": [
8         "proj/*:env/*;qa_*:/flag/*"
9       ],
10       "notResources": [
11         "notResources"
12       ],
13       "actions": [
14         "*"
15       ],
16       "notActions": [
17         "notActions"
18       ]
19     }
20   ],
21   "fullKey": "fullKey",
22   "displayKey": "7f30",
23   "creationDate": 1000000,
24   "lastModified": 1000000,
25   "_creator": {
26     "_links": {
27       "self": {
28         "href": "/api/v2/members/569f183514f4432160000007",
29         "type": "application/json"
30       }
31     },
32     "_id": "569f183514f4432160000007",
33     "role": "admin",
34     "email": "ariel@acme.com",
35     "firstName": "Ariel",
36     "lastName": "Flores"
37   },
38   "_access": {
39     "denied": [
40       {
41         "action": "action",
42         "reason": {
43           "effect": "allow"
44         }
45       }
46     ],
47     "allowed": [
48       {
49         "action": "action",
50         "reason": {
51           "effect": "allow"
52         }
53       }
54     ]
55   }
56 }

Release pipelines (beta)

Up Next

Built with

1	curl -X PATCH https://app.launchdarkly.com/api/v2/account/relay-auto-configs/id \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"patch": [
6	{
7	"op": "replace",
8	"path": "/policy/0",
9	"value": {
10	"actions": [
11	"*"
12	],
13	"effect": "allow",
14	"resources": [
15	"proj/*:env/qa"
16	]
17	}
18	}
19	]
20	}'

1	{
2	"_id": "_id",
3	"name": "Relay Proxy Demo Config",
4	"policy": [
5	{
6	"effect": "allow",
7	"resources": [
8	"proj/:env/;qa_:/flag/"
9	],
10	"notResources": [
11	"notResources"
12	],
13	"actions": [
14	"*"
15	],
16	"notActions": [
17	"notActions"
18	]
19	}
20	],
21	"fullKey": "fullKey",
22	"displayKey": "7f30",
23	"creationDate": 1000000,
24	"lastModified": 1000000,
25	"_creator": {
26	"_links": {
27	"self": {
28	"href": "/api/v2/members/569f183514f4432160000007",
29	"type": "application/json"
30	}
31	},
32	"_id": "569f183514f4432160000007",
33	"role": "admin",
34	"email": "ariel@acme.com",
35	"firstName": "Ariel",
36	"lastName": "Flores"
37	},
38	"_access": {
39	"denied": [
40	{
41	"action": "action",
42	"reason": {
43	"effect": "allow"
44	}
45	}
46	],
47	"allowed": [
48	{
49	"action": "action",
50	"reason": {
51	"effect": "allow"
52	}
53	}
54	]
55	}
56	}