REST API overviewSDK Keys Beta

Create SDK key

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.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

projectKeystringRequired
environmentKeystringRequired

Headers

LD-API-VersionenumRequired
Version of the endpoint.
Allowed values:

Request

Parameters for creating a new SDK key
keystringRequired

The user-defined key of the SDK key.

namestringRequired

The human-readable name of the SDK key.

kindenumOptionalDefaults to sdk

The kind of SDK key. Can be either “sdk” (server-side) or “mobile” (mobile). Defaults to “sdk” when not explicitly defined.

descriptionstringOptional
The optional description of the SDK key.
expirylongOptional

Response

SDK key created
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.

descriptionstringOptional
The optional description of the SDK key.
expirylongOptional
_createdByMemberIdstringOptional
The ID of the member who created the SDK key. This field is immutable.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error