ApplicationsBetaApi

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

Method	HTTP request	Description
deleteApplication	DELETE /api/v2/applications/{applicationKey}	Delete application
deleteApplicationVersion	DELETE /api/v2/applications/{applicationKey}/versions/{versionKey}	Delete application version
getApplication	GET /api/v2/applications/{applicationKey}	Get application by key
getApplicationVersions	GET /api/v2/applications/{applicationKey}/versions	Get application versions by application key
getApplications	GET /api/v2/applications	Get applications
patchApplication	PATCH /api/v2/applications/{applicationKey}	Update application
patchApplicationVersion	PATCH /api/v2/applications/{applicationKey}/versions/{versionKey}	Update application version

deleteApplication

deleteApplication(applicationKey)

Delete application

Delete an application.

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.ApplicationsBetaApi;

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");

    ApplicationsBetaApi apiInstance = new ApplicationsBetaApi(defaultClient);
    String applicationKey = "applicationKey_example"; // String | The application key
    try {
      apiInstance.deleteApplication(applicationKey);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsBetaApi#deleteApplication");
      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
applicationKey	String	The application key

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	Action succeeded	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

deleteApplicationVersion

deleteApplicationVersion(applicationKey, versionKey)

Delete application version

Delete an application version.

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.ApplicationsBetaApi;

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");

    ApplicationsBetaApi apiInstance = new ApplicationsBetaApi(defaultClient);
    String applicationKey = "applicationKey_example"; // String | The application key
    String versionKey = "versionKey_example"; // String | The application version key
    try {
      apiInstance.deleteApplicationVersion(applicationKey, versionKey);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsBetaApi#deleteApplicationVersion");
      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
applicationKey	String	The application key
versionKey	String	The application version key

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	Action succeeded	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

getApplication

ApplicationRep getApplication(applicationKey, expand)

Get application by key

Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the "Get application" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is not included in the response.

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.ApplicationsBetaApi;

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");

    ApplicationsBetaApi apiInstance = new ApplicationsBetaApi(defaultClient);
    String applicationKey = "applicationKey_example"; // String | The application key
    String expand = "expand_example"; // String | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.
    try {
      ApplicationRep result = apiInstance.getApplication(applicationKey, expand);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsBetaApi#getApplication");
      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
applicationKey	String	The application key
expand	String	A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.	[optional]

Return type

ApplicationRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Application response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

getApplicationVersions

ApplicationVersionsCollectionRep getApplicationVersions(applicationKey, filter, limit, offset, sort)

Get application versions by application key

Get a list of versions for a specific application in an account.

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.ApplicationsBetaApi;

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");

    ApplicationsBetaApi apiInstance = new ApplicationsBetaApi(defaultClient);
    String applicationKey = "applicationKey_example"; // String | The application key
    String filter = "filter_example"; // String | Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions).
    Long limit = 56L; // Long | The number of versions to return. Defaults to 50.
    Long offset = 56L; // Long | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
    String sort = "sort_example"; // String | Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending.
    try {
      ApplicationVersionsCollectionRep result = apiInstance.getApplicationVersions(applicationKey, filter, limit, offset, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsBetaApi#getApplicationVersions");
      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
applicationKey	String	The application key
filter	String	Accepts filter by `key`, `name`, `supported`, and `autoAdded`. To learn more about the filter syntax, read Filtering applications and application versions.	[optional]
limit	Long	The number of versions to return. Defaults to 50.	[optional]
offset	Long	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
sort	String	Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending.	[optional]

Return type

ApplicationVersionsCollectionRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Application versions response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

getApplications

ApplicationCollectionRep getApplications(filter, limit, offset, sort, expand)

Get applications

Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the "Get applications" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is not included in the response.

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.ApplicationsBetaApi;

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");

    ApplicationsBetaApi apiInstance = new ApplicationsBetaApi(defaultClient);
    String filter = "filter_example"; // String | Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read [Filtering applications and application versions](https://launchdarkly.com/docs/api/applications-beta#filtering-applications-and-application-versions).
    Long limit = 56L; // Long | The number of applications to return. Defaults to 10.
    Long offset = 56L; // Long | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
    String sort = "sort_example"; // String | Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending.
    String expand = "expand_example"; // String | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.
    try {
      ApplicationCollectionRep result = apiInstance.getApplications(filter, limit, offset, sort, expand);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsBetaApi#getApplications");
      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
filter	String	Accepts filter by `key`, `name`, `kind`, and `autoAdded`. To learn more about the filter syntax, read Filtering applications and application versions.	[optional]
limit	Long	The number of applications to return. Defaults to 10.	[optional]
offset	Long	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
sort	String	Accepts sorting order and fields. Fields can be comma separated. Possible fields are `creationDate`, `name`. Examples: `sort=name` sort by names ascending, `sort=-name,creationDate` sort by names descending and creationDate ascending.	[optional]
expand	String	A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.	[optional]

Return type

ApplicationCollectionRep

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Applications response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

patchApplication

ApplicationRep patchApplication(applicationKey, patchOperation)

Update application

Update an application. You can update the `description` and `kind` fields. Requires a JSON patch representation of the desired changes to the application. To learn more, read Updates.

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.ApplicationsBetaApi;

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");

    ApplicationsBetaApi apiInstance = new ApplicationsBetaApi(defaultClient);
    String applicationKey = "applicationKey_example"; // String | The application key
    List<PatchOperation> patchOperation = Arrays.asList(); // List<PatchOperation> | 
    try {
      ApplicationRep result = apiInstance.patchApplication(applicationKey, patchOperation);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsBetaApi#patchApplication");
      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
applicationKey	String	The application key
patchOperation	List<PatchOperation>

Return type

ApplicationRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Application response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

patchApplicationVersion

ApplicationVersionRep patchApplicationVersion(applicationKey, versionKey, patchOperation)

Update application version

Update an application version. You can update the `supported` field. Requires a JSON patch representation of the desired changes to the application version. To learn more, read Updates.

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.ApplicationsBetaApi;

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");

    ApplicationsBetaApi apiInstance = new ApplicationsBetaApi(defaultClient);
    String applicationKey = "applicationKey_example"; // String | The application key
    String versionKey = "versionKey_example"; // String | The application version key
    List<PatchOperation> patchOperation = Arrays.asList(); // List<PatchOperation> | 
    try {
      ApplicationVersionRep result = apiInstance.patchApplicationVersion(applicationKey, versionKey, patchOperation);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ApplicationsBetaApi#patchApplicationVersion");
      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
applicationKey	String	The application key
versionKey	String	The application version key
patchOperation	List<PatchOperation>

Return type

ApplicationVersionRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Application version response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

Files

ApplicationsBetaApi.md

Latest commit

History

ApplicationsBetaApi.md

File metadata and controls

ApplicationsBetaApi

deleteApplication

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteApplicationVersion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getApplication

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getApplicationVersions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getApplications

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchApplication

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patchApplicationVersion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details