LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
S D K Keys (beta)

Get all environment SDK keys

GET
/api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys

Get all SDK keys for a given project and environment. Can filter by kind.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string
environmentKey*string

Query Parameters

filter?string

A filter to apply to the list of SDK keys. Supports the following fields and operators: kind (equals "sdk" or "mobile"), active (equals true or false). Format: field:value. Example: kind:sdk.

limit?integer

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

offset?integer

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

sort?string

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).

Value in

  • "createdAt"
  • "-createdAt"

Header Parameters

LD-API-Version*"beta"

Version of the endpoint.

Value in

  • "beta"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/projects/default/environments/production/sdk-keys" \  -H "LD-API-Version: beta"
{  "_links": {    "self": {      "href": "href",      "type": "type"    }  },  "totalCount": 5,  "items": [    {      "isDefault": true,      "_links": {        "parent": {          "href": "href",          "type": "type"        },        "self": {          "href": "href",          "type": "type"        }      },      "kind": "sdk",      "_createdAt": 6,      "name": "name",      "description": "description",      "expiry": 0,      "value": "value",      "_updatedAt": 1,      "_version": 5,      "key": "key",      "_createdByMemberId": "_createdByMemberId"    },    {      "isDefault": true,      "_links": {        "parent": {          "href": "href",          "type": "type"        },        "self": {          "href": "href",          "type": "type"        }      },      "kind": "sdk",      "_createdAt": 6,      "name": "name",      "description": "description",      "expiry": 0,      "value": "value",      "_updatedAt": 1,      "_version": 5,      "key": "key",      "_createdByMemberId": "_createdByMemberId"    }  ]}

Get all project SDK keys GET

Get all SDK keys for a given project across environments.

Create SDK key POST

Create a new server-side or mobile SDK key. Deleted SDK keys are retained for 180 days. During that period you cannot reuse the `key` of a deleted SDK key, even though the deleted key no longer appears in the list of SDK keys for the environment.