Update SDK key

PATCH

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

PATCH

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

$ curl -X PATCH https://app.launchdarkly.com/api/v2/projects/default/environments/production/sdk-keys/my-sdk-key \
>      -H "LD-API-Version: beta" \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "name",
>   "description": "description",
>   "expiry": 0
> }'

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": 6,
29         "segmentCount": 1
30       }
31     },
32     {
33       "key": "key",
34       "name": "name",
35       "resourceSummary": {
36         "flagCount": 6,
37         "segmentCount": 1
38       }
39     }
40   ]
41 }

Update a an existing SDK key by its identifying key.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

environmentKeystringRequired

sdkKeyKeystringRequired

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.

Query parameters

versionintegerOptional

The version of the SDK key for optimistic locking. If provided, the update will only succeed if the current version matches.

Request

An array of patches for updating an existing SDK key. The following fields are supported: name, description, expiry.

namestringOptional

(Optional)The human-readable name of the SDK key.

descriptionstringOptional

(Optional) The description of the SDK key.

expirylongOptional

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.

_linksobject

The location and content type of related resources

descriptionstring

The optional description of the SDK key.

expirylong

_createdByMemberIdstring

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

viewSummarieslist of objects

Summaries of views associated with the SDK key.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error