Update application

Beta

PATCH

/api/v2/applications/:applicationKey

PATCH

/api/v2/applications/:applicationKey

$ curl -X PATCH https://app.launchdarkly.com/api/v2/applications/applicationKey \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '[
>   {
>     "op": "replace",
>     "path": "/description",
>     "value": null
>   }
> ]'

1 {
2   "autoAdded": true,
3   "key": "com.launchdarkly.cafe",
4   "kind": "mobile",
5   "name": "LaunchDarklyCafe",
6   "flags": {
7     "items": [
8       {
9         "name": "Example flag",
10         "key": "flag-key-123abc",
11         "_links": {},
12         "_site": {
13           "href": "string",
14           "type": "string"
15         }
16       }
17     ],
18     "totalCount": 1,
19     "_links": {}
20   },
21   "_access": {
22     "denied": [
23       {
24         "action": "string",
25         "reason": {
26           "effect": "allow",
27           "resources": [
28             "proj/*:env/*;qa_*:/flag/*"
29           ],
30           "notResources": [
31             "string"
32           ],
33           "actions": [
34             "*"
35           ],
36           "notActions": [
37             "string"
38           ],
39           "role_name": "string"
40         }
41       }
42     ],
43     "allowed": [
44       {
45         "action": "string",
46         "reason": {
47           "effect": "allow",
48           "resources": [
49             "proj/*:env/*;qa_*:/flag/*"
50           ],
51           "notResources": [
52             "string"
53           ],
54           "actions": [
55             "*"
56           ],
57           "notActions": [
58             "string"
59           ],
60           "role_name": "string"
61         }
62       }
63     ]
64   },
65   "_links": {},
66   "_version": 1,
67   "creationDate": 1654104600000,
68   "description": "The LaunchDarkly Cafe app",
69   "_maintainer": {
70     "member": {
71       "_links": {
72         "self": {
73           "href": "/api/v2/members/569f183514f4432160000007",
74           "type": "application/json"
75         }
76       },
77       "_id": "569f183514f4432160000007",
78       "role": "admin",
79       "email": "ariel@acme.com",
80       "firstName": "Ariel",
81       "lastName": "Flores"
82     },
83     "team": {
84       "customRoleKeys": [
85         "access-to-test-projects"
86       ],
87       "key": "team-key-123abc",
88       "name": "QA Team",
89       "_links": {}
90     }
91   }
92 }

Update an application. You can update the description and kind fields. Requires a JSON patch representation of the desired changes to the application. To learn more, read Updates.

Update an application. You can update the `description` and `kind` fields. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

Authentication

Authorizationstring

API Key authentication via header

Path parameters

applicationKeystringRequiredformat: "string"

The application key

Request

This endpoint expects a list of objects.

Response

Application response

autoAddedboolean

Whether the application was automatically created because it was included in a context when a LaunchDarkly SDK evaluated a feature flag, or was created through the LaunchDarkly UI or REST API.

keystring

The unique identifier of this application

kindenum

To distinguish the kind of application

namestring

The name of the application

flagsobjectOptional

Details about the flags that have been evaluated by the application

_accessobjectOptional

Details on the allowed and denied actions for this application

_linksmap from strings to objectsOptional

The location and content type of related resources

_versionintegerOptional

Version of the application

creationDatelongOptional

Timestamp of when the application version was created

descriptionstringOptional

The application description

_maintainerobjectOptional

Associated maintainer member or team info for the application

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error