Replace SDK key views

PUT

/api/v2/projects/:projectKey/environments/:environmentKey/sdk-keys/:sdkKeyKey/views

PUT

/api/v2/projects/:projectKey/environments/:environmentKey/sdk-keys/:sdkKeyKey/views

$ curl -X PUT https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/sdk-keys/sdkKeyKey/views \
>      -H "LD-API-Version: beta" \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "viewKeys": [
>     "viewKeys",
>     "viewKeys"
>   ]
> }'

1 {
2   "kind": "sdk",
3   "key": "key",
4   "name": "name",
5   "value": "value",
6   "isDefault": true,
7   "_createdAt": 6,
8   "_updatedAt": 1,
9   "_version": 5,
10   "_links": {
11     "self": {
12       "href": "href",
13       "type": "type"
14     },
15     "parent": {
16       "href": "href",
17       "type": "type"
18     }
19   },
20   "description": "description",
21   "expiry": 0,
22   "_createdByMemberId": "_createdByMemberId",
23   "viewSummaries": [
24     {
25       "key": "key",
26       "name": "name",
27       "resourceSummary": {
28         "flagCount": 5,
29         "segmentCount": 2
30       },
31       "_links": {
32         "self": {
33           "href": "href",
34           "type": "type"
35         },
36         "parent": {
37           "href": "href",
38           "type": "type"
39         }
40       }
41     },
42     {
43       "key": "key",
44       "name": "name",
45       "resourceSummary": {
46         "flagCount": 5,
47         "segmentCount": 2
48       },
49       "_links": {
50         "self": {
51           "href": "href",
52           "type": "type"
53         },
54         "parent": {
55           "href": "href",
56           "type": "type"
57         }
58       }
59     }
60   ]
61 }

Replace the set of views associated with an SDK key. The viewKeys field is required. To remove all views from the SDK key, pass an empty viewKeys array.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

environmentKeystringRequired

sdkKeyKeystringRequired

Query parameters

expandstringOptional

A comma-separated list of fields to expand in the response. Supported fields: viewSummaries.

Request

This endpoint expects an object.

viewKeyslist of stringsRequired

The complete target list of view keys to associate with this SDK key. An empty array removes all views from the SDK key.

Response

Successful response

kindenum

The kind of SDK key. Can be either “sdk” (server-side) or “mobile” (mobile).

keystring

The user-defined identifying key of the SDK key. This is used solely to identify an SDK key and is distinct from the value field, which is the actual SDK key value.

namestring

The human-readable name of the SDK key.

valuestring

The string value of the SDK key. Use this when configuring your SDK.

isDefaultboolean

Indicates if this SDK key is the system-defined default for the environment. There may also be an expiring default SDK key for the environment (not possible with mobile keys).

_createdAtlong

_updatedAtlong

_versioninteger

The auto-incremented version number of the SDK key.

_linksobjectOptional

The location and content type of related resources

descriptionstringOptional

The optional description of the SDK key.

expirylongOptional

_createdByMemberIdstringOptional

The ID of the member who created the SDK key. This field is immutable.

viewSummarieslist of objectsOptional

Summaries of views associated with the SDK key.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error