SdkKeysBetaApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
deleteSdkKeyByKey	DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys/{sdkKeyKey}	Delete SDK key
getSdkKeyByKey	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys/{sdkKeyKey}	Get SDK key
getSdkKeys	GET /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys	Get all environment SDK keys
patchSdkKeyByKey	PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys/{sdkKeyKey}	Update SDK key
postSdkKey	POST /api/v2/projects/{projectKey}/environments/{environmentKey}/sdk-keys	Create SDK key

deleteSdkKeyByKey

deleteSdkKeyByKey(ldAPIVersion, projectKey, environmentKey, sdkKeyKey)

Delete SDK key

Delete a specific SDK key by its key.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.SdkKeysBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    SdkKeysBetaApi apiInstance = new SdkKeysBetaApi(defaultClient);
    String ldAPIVersion = "beta"; // String | Version of the endpoint.
    String projectKey = "default"; // String | 
    String environmentKey = "production"; // String | 
    String sdkKeyKey = "my-sdk-key"; // String | 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.
    try {
      apiInstance.deleteSdkKeyByKey(ldAPIVersion, projectKey, environmentKey, sdkKeyKey);
    } catch (ApiException e) {
      System.err.println("Exception when calling SdkKeysBetaApi#deleteSdkKeyByKey");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
ldAPIVersion	String	Version of the endpoint.	[enum: beta]
projectKey	String
environmentKey	String
sdkKeyKey	String	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.

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	SDK key deleted	-
400	Bad request	-
403	Forbidden	-
404	Not found	-
409	Conflict	-
500	Internal server error	-

getSdkKeyByKey

SdkKey getSdkKeyByKey(ldAPIVersion, projectKey, environmentKey, sdkKeyKey)

Get SDK key

Get a specific SDK key by its key.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.SdkKeysBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    SdkKeysBetaApi apiInstance = new SdkKeysBetaApi(defaultClient);
    String ldAPIVersion = "beta"; // String | Version of the endpoint.
    String projectKey = "default"; // String | 
    String environmentKey = "production"; // String | 
    String sdkKeyKey = "my-sdk-key"; // String | 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.
    try {
      SdkKey result = apiInstance.getSdkKeyByKey(ldAPIVersion, projectKey, environmentKey, sdkKeyKey);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SdkKeysBetaApi#getSdkKeyByKey");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
ldAPIVersion	String	Version of the endpoint.	[enum: beta]
projectKey	String
environmentKey	String
sdkKeyKey	String	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.

Return type

SdkKey

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad request	-
403	Forbidden	-
404	Not found	-
500	Internal server error	-

getSdkKeys

SdkKeysForGetSdkKeys getSdkKeys(ldAPIVersion, projectKey, environmentKey, filter, limit, offset, sort)

Get all environment SDK keys

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

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.SdkKeysBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    SdkKeysBetaApi apiInstance = new SdkKeysBetaApi(defaultClient);
    String ldAPIVersion = "beta"; // String | Version of the endpoint.
    String projectKey = "default"; // String | 
    String environmentKey = "production"; // String | 
    String filter = "filter_example"; // 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`.
    Integer limit = 56; // Integer | The number of SDK keys to return. Defaults to 20. Maximum is 100.
    Integer offset = 56; // Integer | The number of SDK keys to skip. Used for pagination.
    String sort = "createdAt"; // 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`).
    try {
      SdkKeysForGetSdkKeys result = apiInstance.getSdkKeys(ldAPIVersion, projectKey, environmentKey, filter, limit, offset, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SdkKeysBetaApi#getSdkKeys");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
ldAPIVersion	String	Version of the endpoint.	[enum: beta]
projectKey	String
environmentKey	String
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`.	[optional]
limit	Integer	The number of SDK keys to return. Defaults to 20. Maximum is 100.	[optional]
offset	Integer	The number of SDK keys to skip. Used for pagination.	[optional]
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`).	[optional] [enum: createdAt, -createdAt]

Return type

SdkKeysForGetSdkKeys

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad request	-
403	Forbidden	-
404	Not found	-
500	Internal server error	-

patchSdkKeyByKey

SdkKey patchSdkKeyByKey(ldAPIVersion, projectKey, environmentKey, sdkKeyKey, sdkKeyPatch, version)

Update SDK key

Update a an existing SDK key by its identifying key.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.SdkKeysBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    SdkKeysBetaApi apiInstance = new SdkKeysBetaApi(defaultClient);
    String ldAPIVersion = "beta"; // String | Version of the endpoint.
    String projectKey = "default"; // String | 
    String environmentKey = "production"; // String | 
    String sdkKeyKey = "my-sdk-key"; // String | 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.
    SdkKeyPatch sdkKeyPatch = new SdkKeyPatch(); // SdkKeyPatch | An array of patches for updating an existing SDK key. The following fields are supported: `name`, `description`, `expiry`.
    Integer version = 56; // Integer | The version of the SDK key for optimistic locking. If provided, the update will only succeed if the current version matches.
    try {
      SdkKey result = apiInstance.patchSdkKeyByKey(ldAPIVersion, projectKey, environmentKey, sdkKeyKey, sdkKeyPatch, version);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SdkKeysBetaApi#patchSdkKeyByKey");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
ldAPIVersion	String	Version of the endpoint.	[enum: beta]
projectKey	String
environmentKey	String
sdkKeyKey	String	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.
sdkKeyPatch	SdkKeyPatch	An array of patches for updating an existing SDK key. The following fields are supported: `name`, `description`, `expiry`.
version	Integer	The version of the SDK key for optimistic locking. If provided, the update will only succeed if the current version matches.	[optional]

Return type

SdkKey

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad request	-
403	Forbidden	-
404	Not found	-
409	Conflict	-
500	Internal server error	-

postSdkKey

SdkKey postSdkKey(ldAPIVersion, projectKey, environmentKey, sdkKeyPost)

Create SDK key

Create a new server-side or mobile SDK key.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.SdkKeysBetaApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    SdkKeysBetaApi apiInstance = new SdkKeysBetaApi(defaultClient);
    String ldAPIVersion = "beta"; // String | Version of the endpoint.
    String projectKey = "default"; // String | 
    String environmentKey = "production"; // String | 
    SdkKeyPost sdkKeyPost = new SdkKeyPost(); // SdkKeyPost | Parameters for creating a new SDK key
    try {
      SdkKey result = apiInstance.postSdkKey(ldAPIVersion, projectKey, environmentKey, sdkKeyPost);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SdkKeysBetaApi#postSdkKey");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
ldAPIVersion	String	Version of the endpoint.	[enum: beta]
projectKey	String
environmentKey	String
sdkKeyPost	SdkKeyPost	Parameters for creating a new SDK key

Return type

SdkKey

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	SDK key created	-
400	Bad request	-
403	Forbidden	-
404	Not found	-
409	Conflict	-
500	Internal server error	-

Navigation Menu

Uh oh!

SdkKeysBetaApi

deleteSdkKeyByKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSdkKeyByKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSdkKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchSdkKeyByKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postSdkKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

SdkKeysBetaApi.md

Latest commit

History

SdkKeysBetaApi.md

File metadata and controls

SdkKeysBetaApi

deleteSdkKeyByKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSdkKeyByKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSdkKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchSdkKeyByKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postSdkKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details