LaunchDarklyApi::ApplicationsBetaApi

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

Method	HTTP request	Description
delete_application	DELETE /api/v2/applications/{applicationKey}	Delete application
delete_application_version	DELETE /api/v2/applications/{applicationKey}/versions/{versionKey}	Delete application version
get_application	GET /api/v2/applications/{applicationKey}	Get application by key
get_application_versions	GET /api/v2/applications/{applicationKey}/versions	Get application versions by application key
get_applications	GET /api/v2/applications	Get applications
patch_application	PATCH /api/v2/applications/{applicationKey}	Update application
patch_application_version	PATCH /api/v2/applications/{applicationKey}/versions/{versionKey}	Update application version

delete_application

delete_application(application_key)

Delete application

Delete an application.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApplicationsBetaApi.new
application_key = 'application_key_example' # String | The application key

begin
  # Delete application
  api_instance.delete_application(application_key)
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->delete_application: #{e}"
end

Using the delete_application_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_application_with_http_info(application_key)

begin
  # Delete application
  data, status_code, headers = api_instance.delete_application_with_http_info(application_key)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->delete_application_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
application_key	String	The application key

Return type

nil (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_application_version

delete_application_version(application_key, version_key)

Delete application version

Delete an application version.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApplicationsBetaApi.new
application_key = 'application_key_example' # String | The application key
version_key = 'version_key_example' # String | The application version key

begin
  # Delete application version
  api_instance.delete_application_version(application_key, version_key)
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->delete_application_version: #{e}"
end

Using the delete_application_version_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_application_version_with_http_info(application_key, version_key)

begin
  # Delete application version
  data, status_code, headers = api_instance.delete_application_version_with_http_info(application_key, version_key)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->delete_application_version_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
application_key	String	The application key
version_key	String	The application version key

Return type

nil (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_application

get_application(application_key, opts)

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.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApplicationsBetaApi.new
application_key = 'application_key_example' # String | The application key
opts = {
  expand: 'expand_example' # String | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.
}

begin
  # Get application by key
  result = api_instance.get_application(application_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->get_application: #{e}"
end

Using the get_application_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_application_with_http_info(application_key, opts)

begin
  # Get application by key
  data, status_code, headers = api_instance.get_application_with_http_info(application_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->get_application_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
application_key	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

get_application_versions

get_application_versions(application_key, opts)

Get application versions by application key

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

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApplicationsBetaApi.new
application_key = 'application_key_example' # String | The application key
opts = {
  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](/tag/Applications-(beta)#filtering-contexts-and-context-instances).
  limit: 789, # Integer | The number of versions to return. Defaults to 50.
  offset: 789, # Integer | 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`.
  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.
}

begin
  # Get application versions by application key
  result = api_instance.get_application_versions(application_key, opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->get_application_versions: #{e}"
end

Using the get_application_versions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_application_versions_with_http_info(application_key, opts)

begin
  # Get application versions by application key
  data, status_code, headers = api_instance.get_application_versions_with_http_info(application_key, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationVersionsCollectionRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->get_application_versions_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
application_key	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	Integer	The number of versions to return. Defaults to 50.	[optional]
offset	Integer	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

get_applications

get_applications(opts)

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.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApplicationsBetaApi.new
opts = {
  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](/tag/Applications-(beta)#filtering-contexts-and-context-instances).
  limit: 789, # Integer | The number of applications to return. Defaults to 10.
  offset: 789, # Integer | 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`.
  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.
  expand: 'expand_example' # String | A comma-separated list of properties that can reveal additional information in the response. Options: `flags`.
}

begin
  # Get applications
  result = api_instance.get_applications(opts)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->get_applications: #{e}"
end

Using the get_applications_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_applications_with_http_info(opts)

begin
  # Get applications
  data, status_code, headers = api_instance.get_applications_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationCollectionRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->get_applications_with_http_info: #{e}"
end

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	Integer	The number of applications to return. Defaults to 10.	[optional]
offset	Integer	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

patch_application

patch_application(application_key, patch_operation)

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.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApplicationsBetaApi.new
application_key = 'application_key_example' # String | The application key
patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField'})] # Array<PatchOperation> | 

begin
  # Update application
  result = api_instance.patch_application(application_key, patch_operation)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->patch_application: #{e}"
end

Using the patch_application_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_application_with_http_info(application_key, patch_operation)

begin
  # Update application
  data, status_code, headers = api_instance.patch_application_with_http_info(application_key, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->patch_application_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
application_key	String	The application key
patch_operation	Array<PatchOperation>

Return type

ApplicationRep

Authorization

ApiKey

HTTP request headers

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

patch_application_version

patch_application_version(application_key, version_key, patch_operation)

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.

Examples

require 'time'
require 'launchdarkly_api'
# setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::ApplicationsBetaApi.new
application_key = 'application_key_example' # String | The application key
version_key = 'version_key_example' # String | The application version key
patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField'})] # Array<PatchOperation> | 

begin
  # Update application version
  result = api_instance.patch_application_version(application_key, version_key, patch_operation)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->patch_application_version: #{e}"
end

Using the patch_application_version_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_application_version_with_http_info(application_key, version_key, patch_operation)

begin
  # Update application version
  data, status_code, headers = api_instance.patch_application_version_with_http_info(application_key, version_key, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApplicationVersionRep>
rescue LaunchDarklyApi::ApiError => e
  puts "Error when calling ApplicationsBetaApi->patch_application_version_with_http_info: #{e}"
end

Parameters

Name	Type	Description
application_key	String	The application key
version_key	String	The application version key
patch_operation	Array<PatchOperation>

Return type

ApplicationVersionRep

Authorization

ApiKey

HTTP request headers

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

Files

ApplicationsBetaApi.md

Latest commit

History

ApplicationsBetaApi.md

File metadata and controls

LaunchDarklyApi::ApplicationsBetaApi

delete_application

Examples

Using the delete_application_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_application_version

Examples

Using the delete_application_version_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_application

Examples

Using the get_application_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_application_versions

Examples

Using the get_application_versions_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_applications

Examples

Using the get_applications_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

patch_application

Examples

Using the patch_application_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

patch_application_version

Examples

Using the patch_application_version_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers