Get all project SDK keys

GET

/api/v2/projects/:projectKey/sdk-keys

GET

/api/v2/projects/:projectKey/sdk-keys

$ curl https://app.launchdarkly.com/api/v2/projects/default/sdk-keys \
>      -H "LD-API-Version: beta" \
>      -H "Authorization: <apiKey>"

1 {
2   "items": [
3     {
4       "kind": "sdk",
5       "key": "key",
6       "name": "name",
7       "value": "value",
8       "isDefault": true,
9       "_createdAt": 6,
10       "_updatedAt": 1,
11       "_version": 5,
12       "_links": {
13         "self": {
14           "href": "href",
15           "type": "type"
16         },
17         "parent": {
18           "href": "href",
19           "type": "type"
20         }
21       },
22       "description": "description",
23       "expiry": 0,
24       "_createdByMemberId": "_createdByMemberId",
25       "environmentSummary": {
26         "_links": {
27           "self": {
28             "href": "/api/v2/projects/my-project/environments/my-environment",
29             "type": "application/json"
30           }
31         },
32         "key": "environment-key-123abc",
33         "name": "My Environment",
34         "color": "F5A623"
35       },
36       "viewSummaries": [
37         {
38           "key": "key",
39           "name": "name",
40           "resourceSummary": {
41             "flagCount": 5,
42             "segmentCount": 2
43           },
44           "_links": {
45             "self": {
46               "href": "href",
47               "type": "type"
48             },
49             "parent": {
50               "href": "href",
51               "type": "type"
52             }
53           }
54         },
55         {
56           "key": "key",
57           "name": "name",
58           "resourceSummary": {
59             "flagCount": 5,
60             "segmentCount": 2
61           },
62           "_links": {
63             "self": {
64               "href": "href",
65               "type": "type"
66             },
67             "parent": {
68               "href": "href",
69               "type": "type"
70             }
71           }
72         }
73       ]
74     },
75     {
76       "kind": "sdk",
77       "key": "key",
78       "name": "name",
79       "value": "value",
80       "isDefault": true,
81       "_createdAt": 6,
82       "_updatedAt": 1,
83       "_version": 5,
84       "_links": {
85         "self": {
86           "href": "href",
87           "type": "type"
88         },
89         "parent": {
90           "href": "href",
91           "type": "type"
92         }
93       },
94       "description": "description",
95       "expiry": 0,
96       "_createdByMemberId": "_createdByMemberId",
97       "environmentSummary": {
98         "_links": {
99           "self": {
100             "href": "/api/v2/projects/my-project/environments/my-environment",
101             "type": "application/json"
102           }
103         },
104         "key": "environment-key-123abc",
105         "name": "My Environment",
106         "color": "F5A623"
107       },
108       "viewSummaries": [
109         {
110           "key": "key",
111           "name": "name",
112           "resourceSummary": {
113             "flagCount": 5,
114             "segmentCount": 2
115           },
116           "_links": {
117             "self": {
118               "href": "href",
119               "type": "type"
120             },
121             "parent": {
122               "href": "href",
123               "type": "type"
124             }
125           }
126         },
127         {
128           "key": "key",
129           "name": "name",
130           "resourceSummary": {
131             "flagCount": 5,
132             "segmentCount": 2
133           },
134           "_links": {
135             "self": {
136               "href": "href",
137               "type": "type"
138             },
139             "parent": {
140               "href": "href",
141               "type": "type"
142             }
143           }
144         }
145       ]
146     }
147   ],
148   "totalCount": 7,
149   "_links": {
150     "self": {
151       "href": "href",
152       "type": "type"
153     }
154   }
155 }

Get all SDK keys for a given project across environments.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

Query parameters

filterstringOptional

A queryfilter expression to apply to the list of SDK keys. Supports the following fields and operators: kind (equals, anyOf; values: “sdk”, “mobile”), active (equals, anyOf; values: true, false), environmentKey (equals, anyOf; values: environment keys), viewKey (equals, anyOf; values: view key strings — returns only SDK keys linked to the specified view(s)), name (equals only; returns SDK keys whose name or key contains the value, matched case-insensitively). Example: kind anyOf ["sdk","mobile"], environmentKey anyOf ["production","test"], viewKey equals my-view, name equals "production".

A queryfilter expression to apply to the list of SDK keys. Supports the following fields and operators: `kind` (`equals`, `anyOf`; values: "sdk", "mobile"), `active` (`equals`, `anyOf`; values: `true`, `false`), `environmentKey` (`equals`, `anyOf`; values: environment keys), `viewKey` (`equals`, `anyOf`; values: view key strings — returns only SDK keys linked to the specified view(s)), `name` (`equals` only; returns SDK keys whose name or key contains the value, matched case-insensitively). Example: `kind anyOf ["sdk","mobile"], environmentKey anyOf ["production","test"], viewKey equals my-view, name equals "production"`.

limitintegerOptional

The number of SDK keys to return. Defaults to 20. Maximum is 100.

offsetintegerOptional

The number of SDK keys to skip. Used for pagination.

expandstringOptional

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

sortenumOptional

A sort to apply to the list of SDK keys. Supported field: createdAt. Prefix the field with - to sort in descending order (for example, -createdAt).

Allowed values:

Response

Successful response

itemslist of objects

totalCountinteger

The total number of SDK keys matching the query, before pagination.

_linksobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors