Module launchdarkly
ballerinax/launchdarkly Ballerina library
1.5.1
Overview
This is a generated connector for LaunchDarkly API v2.0 OpenAPI specification.
LaunchDarkly is a feature management platform enables teams to deploy code at any time, even if a feature isn't ready to be released to all users.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an LaunchDarkly account.
- Obtain tokens - Follow this guide.
Quickstart
To use the LaunchDarkly connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/launchdarkly module into the Ballerina project.
import ballerinax/launchdarkly;
Step 2: Create a new connector instance
You can initialize the client as follows. You can now provide the API key obtained from the LaunchDarkly in the configuration.
launchdarkly:ApiKeysConfig apiKeyConfig = { authorization: "<API_KEY>" } launchdarkly:Client baseClient = check new Client(apiKeyConfig, serviceUrl = ""https://app.launchdarkly.com/api/v2"");
Step 3: Invoke connector operation
- You can find all of the resource categories supported.
launchdarkly:Links links = check baseClient->getRoot(); - Use
bal runcommand to compile and run the Ballerina program.
Clients
launchdarkly: Client
Isolated
This is a generated connector for LaunchDarkly API v2.0 OpenAPI specification. LaunchDarkly is a feature management platform enables teams to deploy code at any time, even if a feature isn't ready to be released to all users.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an LaunchDarkly account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://app.launchdarkly.com/api/v2" - URL of the target service
getRoot
Isolated FunctionRemote Function
You can issue a GET request to the root resource to find all of the resource categories supported by the API.
getRelayProxyConfigs
Isolated FunctionRemote Function
function getRelayProxyConfigs() returns RelayProxyConfigs|errorReturns a list of relay proxy configurations in the account.
Return Type
- RelayProxyConfigs|error - Relay proxy configs response.
postRelayAutoConfig
Isolated FunctionRemote Function
function postRelayAutoConfig(AccountRelayautoconfigsBody payload) returns RelayProxyConfig|errorCreate a new relay proxy config.
Parameters
- payload AccountRelayautoconfigsBody - Create a new relay proxy configuration
Return Type
- RelayProxyConfig|error - Relay proxy config response.
getRelayProxyConfig
Isolated FunctionRemote Function
function getRelayProxyConfig(string id) returns RelayProxyConfig|errorGet a single relay proxy configuration by ID.
Parameters
- id string - The relay proxy configuration ID
Return Type
- RelayProxyConfig|error - Relay proxy config response.
deleteRelayProxyConfig
Isolated FunctionRemote Function
Delete a relay proxy configuration by ID.
Parameters
- id string - The relay proxy configuration ID
patchRelayProxyConfig
Isolated FunctionRemote Function
function patchRelayProxyConfig(string id, PatchOperation[] payload) returns RelayProxyConfig|errorModify a relay proxy configuration by ID.
Parameters
- id string - The relay proxy configuration ID
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
Return Type
- RelayProxyConfig|error - Relay proxy config response.
resetRelayProxyConfig
Isolated FunctionRemote Function
function resetRelayProxyConfig(string id, int? expiry) returns RelayProxyConfig|errorReset a relay proxy configuration's secret key with an optional expiry time for the old key.
Parameters
- id string - The relay proxy configuration ID
- expiry int? (default ()) - An expiration time for the old relay proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the relay proxy configuration will expire immediately
Return Type
- RelayProxyConfig|error - Relay proxy config response.
getAuditLogEntries
Isolated FunctionRemote Function
function getAuditLogEntries(int? before, int? after, string? q, decimal? 'limit, string? spec) returns AuditLogEntries|errorGet a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
Parameters
- before int? (default ()) - A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp.
- after int? (default ()) - A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp.
- q string? (default ()) - Text to search for. You can search for the full or partial name of the resource involved or full or partial email address of the member who made the change.
- 'limit decimal? (default ()) - A limit on the number of audit log entries to be returned, between 1 and 20.
- spec string? (default ()) - A resource specifier, allowing you to filter audit log listings by resource.
Return Type
- AuditLogEntries|error - Audit log entries response.
getAuditLogEntry
Isolated FunctionRemote Function
function getAuditLogEntry(string resourceId) returns AuditLogEntry|errorUse this endpoint to fetch a single audit log entry by its resouce ID.
Parameters
- resourceId string - The resource ID.
Return Type
- AuditLogEntry|error - Audit log entry response.
getDestinations
Isolated FunctionRemote Function
function getDestinations() returns Destinations|errorReturns a list of all data export destinations.
Return Type
- Destinations|error - Destinations response.
postDestination
Isolated FunctionRemote Function
function postDestination(string projectKey, string environmentKey, ProjectkeyEnvironmentkeyBody payload) returns Destination|errorCreate a new data export destination
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- payload ProjectkeyEnvironmentkeyBody - Create a new data export destination.
Return Type
- Destination|error - Destination response.
getDestination
Isolated FunctionRemote Function
function getDestination(string projectKey, string environmentKey, string destinationId) returns Destination|errorGet a single data export destination by ID
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- destinationId string - The data export destination ID.
Return Type
- Destination|error - Destination response.
deleteDestination
Isolated FunctionRemote Function
function deleteDestination(string projectKey, string environmentKey, string destinationId) returns Response|errorGet a single data export destination by ID
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- destinationId string - The data export destination ID.
patchDestination
Isolated FunctionRemote Function
function patchDestination(string projectKey, string environmentKey, string destinationId, PatchOperation[] payload) returns Destination|errorPerform a partial update to a data export destination.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- destinationId string - The data export destination ID.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
Return Type
- Destination|error - Destination response.
getFeatureFlagStatusAcrossEnvironments
Isolated FunctionRemote Function
function getFeatureFlagStatusAcrossEnvironments(string projectKey, string featureFlagKey) returns FeatureFlagStatusAcrossEnvironments|errorGet the status for a particular feature flag across environments
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
Return Type
- FeatureFlagStatusAcrossEnvironments|error - Status of the requested feature flag across environments
getFeatureFlagStatuses
Isolated FunctionRemote Function
function getFeatureFlagStatuses(string projectKey, string environmentKey) returns FeatureFlagStatuses|errorGet a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
Return Type
- FeatureFlagStatuses|error - List of feature flag statuses.
getFeatureFlagStatus
Isolated FunctionRemote Function
function getFeatureFlagStatus(string projectKey, string environmentKey, string featureFlagKey) returns FeatureFlagStatus|errorGet the status for a particular feature flag.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
Return Type
- FeatureFlagStatus|error - Status of the requested feature flag.
getFeatureFlags
Isolated FunctionRemote Function
function getFeatureFlags(string projectKey, string[]? env, boolean? summary, boolean? archived, decimal? 'limit, decimal? offset, string? filter, string? sort, string? tag) returns FeatureFlags|errorGet a list of all features in the given project.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- env string[]? (default ()) - By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=["production"] will restrict the returned configurations to just your production environment.
- summary boolean? (default ()) - By default in api version >= 1, flags will not include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned.
- archived boolean? (default ()) - When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
- 'limit decimal? (default ()) - The number of objects to return. Defaults to -1, which returns everything.
- offset decimal? (default ()) - Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
- filter string? (default ()) - A comma-separated list of filters. Each filter is of the form field:value.
- sort string? (default ()) - A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
- tag string? (default ()) - Filter by tag. A tag can be used to group flags across projects.
Return Type
- FeatureFlags|error - Flags response.
postFeatureFlag
Isolated FunctionRemote Function
function postFeatureFlag(string projectKey, FlagsProjectkeyBody payload, string? clone) returns FeatureFlag|errorCreates a new feature flag.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- payload FlagsProjectkeyBody - Create a new feature flag.
- clone string? (default ()) - The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting clone=flagKey will copy the full targeting configuration for all environments (including on/off state) from the original flag to the new flag.
Return Type
- FeatureFlag|error - Flag response.
getFeatureFlag
Isolated FunctionRemote Function
function getFeatureFlag(string projectKey, string featureFlagKey, string[]? env) returns FeatureFlag|errorGet a single feature flag by key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- env string[]? (default ()) - By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=["production"] will restrict the returned configurations to just your production environment.
Return Type
- FeatureFlag|error - Flag response.
deleteFeatureFlag
Isolated FunctionRemote Function
Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
patchFeatureFlag
Isolated FunctionRemote Function
function patchFeatureFlag(string projectKey, string featureFlagKey, ProjectkeyFeatureflagkeyBody payload) returns FeatureFlag|errorPerform a partial update to a feature.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- payload ProjectkeyFeatureflagkeyBody - Requires a JSON Patch representation of the desired changes to the project, and an optional comment. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
Return Type
- FeatureFlag|error - Feature flag response.
copyFeatureFlag
Isolated FunctionRemote Function
function copyFeatureFlag(string projectKey, string featureFlagKey, FeatureflagkeyCopyBody payload) returns FeatureFlag|errorCopies the feature flag configuration from one environment to the same feature flag in another environment.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- payload FeatureflagkeyCopyBody - Copy feature flag configurations between environments.
Return Type
- FeatureFlag|error - Flag configuration copy response.
getExpiringUserTargets
Isolated FunctionRemote Function
function getExpiringUserTargets(string projectKey, string environmentKey, string featureFlagKey) returns UserTargetingExpirationForFlags|errorGet expiring user targets for feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
Return Type
- UserTargetingExpirationForFlags|error - User targets of the requested feature flag.
patchExpiringUserTargets
Isolated FunctionRemote Function
function patchExpiringUserTargets(string projectKey, string environmentKey, string featureFlagKey, SemanticPatchOperation[] payload) returns UserTargetingExpirationForFlags|errorUpdate, add, or delete expiring user targets on feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- payload SemanticPatchOperation[] - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
Return Type
- UserTargetingExpirationForFlags|error - User targeting expirations on feature flag response.
getIntegrations
Isolated FunctionRemote Function
function getIntegrations() returns Integrations|errorGet a list of all configured audit log event integrations associated with this account.
Return Type
- Integrations|error - Integrations response.
getIntegrationSubscriptions
Isolated FunctionRemote Function
function getIntegrationSubscriptions(string integrationKey) returns Integration|errorGet a list of all configured integrations of a given kind.
Parameters
- integrationKey string - The key used to specify the integration kind.
Return Type
- Integration|error - Integrations response.
postIntegrationSubscription
Isolated FunctionRemote Function
function postIntegrationSubscription(string integrationKey, IntegrationsIntegrationkeyBody payload) returns IntegrationSubscription|errorCreate a new integration subscription of a given kind.
Parameters
- integrationKey string - The key used to specify the integration kind.
- payload IntegrationsIntegrationkeyBody - Create a new integration subscription.
Return Type
- IntegrationSubscription|error - Integrations response.
getIntegrationSubscription
Isolated FunctionRemote Function
function getIntegrationSubscription(string integrationKey, string integrationId) returns IntegrationSubscription|errorGet a single integration subscription by ID.
Parameters
- integrationKey string - The key used to specify the integration kind.
- integrationId string - The integration ID.
Return Type
- IntegrationSubscription|error - Integrations response.
deleteIntegrationSubscription
Isolated FunctionRemote Function
function deleteIntegrationSubscription(string integrationKey, string integrationId) returns Response|errorDelete an integration subscription by ID.
Parameters
- integrationKey string - The key used to specify the integration kind.
- integrationId string - The integration ID.
patchIntegrationSubscription
Isolated FunctionRemote Function
function patchIntegrationSubscription(string integrationKey, string integrationId, PatchOperation[] payload) returns IntegrationSubscription|errorModify an integration subscription by ID.
Parameters
- integrationKey string - The key used to specify the integration kind.
- integrationId string - The integration ID.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
Return Type
- IntegrationSubscription|error - Integrations response.
getMembers
Isolated FunctionRemote Function
function getMembers(decimal? 'limit, decimal? offset, string? filter, string? sort) returns Members|errorReturns a list of all members in the account.
Parameters
- 'limit decimal? (default ()) - The number of objects to return. Defaults to -1, which returns everything.
- offset decimal? (default ()) - Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
- filter string? (default ()) - A comma-separated list of filters. Each filter is of the form field:value.
- sort string? (default ()) - A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
postMembers
Isolated FunctionRemote Function
function postMembers(MembersBody[] payload) returns Members|errorInvite new members.
Parameters
- payload MembersBody[] - New members to invite.
getMe
Isolated FunctionRemote Function
Get the current team member associated with the token
getMember
Isolated FunctionRemote Function
Get a single team member by ID.
Parameters
- memberId string - The member ID.
deleteMember
Isolated FunctionRemote Function
Delete a team member by ID.
Parameters
- memberId string - The member ID.
patchMember
Isolated FunctionRemote Function
function patchMember(string memberId, PatchOperation[] payload) returns Member|errorModify a team member by ID.
Parameters
- memberId string - The member ID.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
getProjects
Isolated FunctionRemote Function
Returns a list of all projects in the account.
postProject
Isolated FunctionRemote Function
function postProject(ProjectsBody payload) returns Project|errorCreate a new project with the given key and name.
Parameters
- payload ProjectsBody - Project keys must be unique within an account.
getProject
Isolated FunctionRemote Function
Fetch a single project by key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
deleteProject
Isolated FunctionRemote Function
Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
patchProject
Isolated FunctionRemote Function
function patchProject(string projectKey, PatchOperation[] payload) returns Project|errorModify a project by ID.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
postEnvironment
Isolated FunctionRemote Function
function postEnvironment(string projectKey, EnvironmentPost payload) returns Environment|errorCreate a new environment in a specified project with a given name, key, and swatch color.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- payload EnvironmentPost - New environment.
Return Type
- Environment|error - Environment response.
getEnvironment
Isolated FunctionRemote Function
function getEnvironment(string projectKey, string environmentKey) returns Environment|errorGet an environment given a project and key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
Return Type
- Environment|error - Environment response.
deleteEnvironment
Isolated FunctionRemote Function
Delete an environment in a specific project.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
patchEnvironment
Isolated FunctionRemote Function
function patchEnvironment(string projectKey, string environmentKey, PatchOperation[] payload) returns Environment|errorModify an environment by ID.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
Return Type
- Environment|error - Environment response.
resetEnvironmentSDKKey
Isolated FunctionRemote Function
function resetEnvironmentSDKKey(string projectKey, string environmentKey, int? expiry) returns Environment|errorReset an environment's SDK key with an optional expiry time for the old key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- expiry int? (default ()) - An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately.
Return Type
- Environment|error - Environment response.
resetEnvironmentMobileKey
Isolated FunctionRemote Function
function resetEnvironmentMobileKey(string projectKey, string environmentKey, int? expiry) returns Environment|errorReset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- expiry int? (default ()) - The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version.
Return Type
- Environment|error - Environment response.
getFeatureFlagApprovalRequests
Isolated FunctionRemote Function
function getFeatureFlagApprovalRequests(string projectKey, string featureFlagKey, string environmentKey) returns FeatureFlagApprovalRequests|errorGet all approval requests for a feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
Return Type
- FeatureFlagApprovalRequests|error - Feature flag approval requests response
getFeatureFlagApprovalRequest
Isolated FunctionRemote Function
function getFeatureFlagApprovalRequest(string projectKey, string featureFlagKey, string environmentKey, string featureFlagApprovalRequestId) returns FeatureFlagApprovalRequests|errorGet a single approval request for a feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagApprovalRequestId string - The feature flag approval request ID
Return Type
- FeatureFlagApprovalRequests|error - Feature flag approval request response
postFeatureFlagApprovalRequest
Isolated FunctionRemote Function
function postFeatureFlagApprovalRequest(string projectKey, string featureFlagKey, string environmentKey, string featureFlagApprovalRequestId, json payload) returns FeatureFlagApprovalRequest|errorCreate an approval request for a feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagApprovalRequestId string - The feature flag approval request ID
- payload json - Create a new feature flag approval request
Return Type
- FeatureFlagApprovalRequest|error - Feature flag approval request response
deleteFeatureFlagApprovalRequest
Isolated FunctionRemote Function
function deleteFeatureFlagApprovalRequest(string projectKey, string environmentKey, string featureFlagKey, string featureFlagApprovalRequestId) returns Response|errorDelete an approval request for a feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- featureFlagApprovalRequestId string - The feature flag approval request ID
postApplyFeatureFlagApprovalRequest
Isolated FunctionRemote Function
function postApplyFeatureFlagApprovalRequest(string projectKey, string featureFlagKey, string environmentKey, string featureFlagApprovalRequestId, FeatureflagapprovalrequestidApplyBody payload) returns FeatureFlagApprovalRequests|errorApply approval request for a feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagApprovalRequestId string - The feature flag approval request ID
- payload FeatureflagapprovalrequestidApplyBody - Apply a new feature flag approval request
Return Type
- FeatureFlagApprovalRequests|error - Feature flag approval request applied response
postReviewFeatureFlagApprovalRequest
Isolated FunctionRemote Function
function postReviewFeatureFlagApprovalRequest(string projectKey, string featureFlagKey, string environmentKey, string featureFlagApprovalRequestId, FeatureflagapprovalrequestidReviewBody payload) returns FeatureFlagApprovalRequests|errorReview approval request for a feature flag
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- featureFlagApprovalRequestId string - The feature flag approval request ID
- payload FeatureflagapprovalrequestidReviewBody - Review a feature flag approval request
Return Type
- FeatureFlagApprovalRequests|error - Feature flag approval request reviewed response
getCustomRoles
Isolated FunctionRemote Function
function getCustomRoles() returns CustomRoles|errorReturn a complete list of custom roles.
Return Type
- CustomRoles|error - Custom roles response.
postCustomRole
Isolated FunctionRemote Function
function postCustomRole(RolesBody payload) returns CustomRole|errorCreate a new custom role.
Parameters
- payload RolesBody - New role or roles to create.
Return Type
- CustomRole|error - Custom role response.
getCustomRole
Isolated FunctionRemote Function
function getCustomRole(string customRoleKey) returns CustomRole|errorGet one custom role by key.
Parameters
- customRoleKey string - The custom role key.
Return Type
- CustomRole|error - Custom role response.
deleteCustomRole
Isolated FunctionRemote Function
Delete a custom role by key.
Parameters
- customRoleKey string - The custom role key.
patchCustomRole
Isolated FunctionRemote Function
function patchCustomRole(string customRoleKey, PatchOperation[] payload) returns CustomRole|errorModify a custom role by key.
Parameters
- customRoleKey string - The custom role key.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
Return Type
- CustomRole|error - Custom role response.
getUserSegments
Isolated FunctionRemote Function
function getUserSegments(string projectKey, string environmentKey, string? tag) returns UserSegments|errorGet a list of all user segments in the given project.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- tag string? (default ()) - Filter by tag. A tag can be used to group flags across projects.
Return Type
- UserSegments|error - Segments response.
postUserSegment
Isolated FunctionRemote Function
function postUserSegment(string projectKey, string environmentKey, ProjectkeyEnvironmentkeyBody1 payload) returns UserSegment|errorCreates a new user segment.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- payload ProjectkeyEnvironmentkeyBody1 - Create a new user segment.
Return Type
- UserSegment|error - User segment response.
getUserSegment
Isolated FunctionRemote Function
function getUserSegment(string projectKey, string environmentKey, string userSegmentKey) returns UserSegment|errorGet a single user segment by key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userSegmentKey string - The user segment's key. The key identifies the user segment in your code.
Return Type
- UserSegment|error - User segment response.
deleteUserSegment
Isolated FunctionRemote Function
function deleteUserSegment(string projectKey, string environmentKey, string userSegmentKey) returns Response|errorDelete a user segment.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userSegmentKey string - The user segment's key. The key identifies the user segment in your code.
patchUserSegment
Isolated FunctionRemote Function
function patchUserSegment(string projectKey, string environmentKey, string userSegmentKey, PatchOperation[] payload) returns UserSegment|errorPerform a partial update to a user segment.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userSegmentKey string - The user segment's key. The key identifies the user segment in your code.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
Return Type
- UserSegment|error - User segment response.
updatedUnboundedSegmentTargets
Isolated FunctionRemote Function
function updatedUnboundedSegmentTargets(string projectKey, string environmentKey, string userSegmentKey, UsersegmentkeyUnboundedusersBody payload) returns Response|errorUpdate targets included or excluded in an unbounded segment
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userSegmentKey string - The user segment's key. The key identifies the user segment in your code.
- payload UsersegmentkeyUnboundedusersBody - Add or remove user targets to the included or excluded lists on an unbounded segment
getExpiringUserTargetsOnSegment
Isolated FunctionRemote Function
function getExpiringUserTargetsOnSegment(string projectKey, string environmentKey, string userSegmentKey) returns UserTargetingExpirationForSegment|errorGet expiring user targets for user segment
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userSegmentKey string - The user segment's key. The key identifies the user segment in your code.
Return Type
- UserTargetingExpirationForSegment|error - User targeting expirations on user segment response.
patchExpiringUserTargetsOnSegment
Isolated FunctionRemote Function
function patchExpiringUserTargetsOnSegment(string projectKey, string environmentKey, string userSegmentKey, SemanticPatchOperation[] payload) returns UserTargetingExpirationForSegment|errorUpdate, add, or delete expiring user targets on user segment
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userSegmentKey string - The user segment's key. The key identifies the user segment in your code.
- payload SemanticPatchOperation[] - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
Return Type
- UserTargetingExpirationForSegment|error - User targeting expirations on user segment response.
getTokens
Isolated FunctionRemote Function
Returns a list of tokens in the account.
Parameters
- showAll boolean? (default ()) - If set to true, and the authentication access token has the "Admin" role, personal access tokens for all members will be retrieved.
postToken
Isolated FunctionRemote Function
function postToken(TokensBody payload) returns Token|errorCreate a new token.
Parameters
- payload TokensBody - Create a new access token.
getToken
Isolated FunctionRemote Function
Get a single access token by ID.
Parameters
- tokenId string - The access token ID.
deleteToken
Isolated FunctionRemote Function
Delete an access token by ID.
Parameters
- tokenId string - The access token ID.
patchToken
Isolated FunctionRemote Function
function patchToken(string tokenId, PatchOperation[] payload) returns Token|errorModify an access token by ID.
Parameters
- tokenId string - The access token ID.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
resetToken
Isolated FunctionRemote Function
Reset an access token's secret key with an optional expiry time for the old key.
Parameters
- tokenId string - The access token ID.
- expiry int? (default ()) - An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
getUsage
Isolated FunctionRemote Function
Returns of the usage endpoints available.
getEvaluations
Isolated FunctionRemote Function
function getEvaluations(string envId, string flagKey) returns StreamSDKVersion|errorGet events usage by event id and the feature flag key.
Parameters
- envId string - The environment id for the flag evaluations in question.
- flagKey string - The key of the flag we want metrics for.
Return Type
- StreamSDKVersion|error - Returns timeseries data and all sdk versions.
getEvents
Isolated FunctionRemote Function
Get events usage endpoints.
getEvent
Isolated FunctionRemote Function
function getEvent(string 'type) returns StreamSDKVersion|errorGet events usage by event type.
Parameters
- 'type string - The type of event we would like to track.
Return Type
- StreamSDKVersion|error - Returns timeseries data and all sdk versions.
getMAU
Isolated FunctionRemote Function
Get monthly active user data.
getMAUByCategory
Isolated FunctionRemote Function
function getMAUByCategory() returns MAUbyCategory|errorGet monthly active user data by category.
Return Type
- MAUbyCategory|error - Returns timeseries data and all sdk versions.
getStreams
Isolated FunctionRemote Function
Returns a list of all streams.
getStream
Isolated FunctionRemote Function
Get a stream endpoint and return timeseries data.
Parameters
- 'source string - The source of where the stream comes from.
getStreamBySDK
Isolated FunctionRemote Function
function getStreamBySDK(string 'source) returns StreamBySDK|errorGet a stream timeseries data by source show sdk version metadata.
Parameters
- 'source string - The source of where the stream comes from.
Return Type
- StreamBySDK|error - Returns timeseries data and metadata on sdk version.
getStreamSDKVersion
Isolated FunctionRemote Function
function getStreamSDKVersion(string 'source) returns StreamSDKVersion|errorGet a stream timeseries data by source and show all sdk version associated.
Parameters
- 'source string - The source of where the stream comes from.
Return Type
- StreamSDKVersion|error - Returns timeseries data and all sdk versions.
getSearchUsers
Isolated FunctionRemote Function
function getSearchUsers(string projectKey, string environmentKey, string? q, int? 'limit, int? offset, int? after) returns Users|errorSearch users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- q string? (default ()) - Search query.
- 'limit int? (default ()) - Pagination limit.
- offset int? (default ()) - Specifies the first item to return in the collection.
- after int? (default ()) - A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp.
getUsers
Isolated FunctionRemote Function
function getUsers(string projectKey, string environmentKey, int? 'limit, string? h, string? scrollId) returns Users|errorList all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a next link containing a URL with the next set of elements in the collection.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- 'limit int? (default ()) - Pagination limit.
- h string? (default ()) - This parameter is required when following "next" links.
- scrollId string? (default ()) - This parameter is required when following "next" links.
getUser
Isolated FunctionRemote Function
Get a user by key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userKey string - The user's key.
deleteUser
Isolated FunctionRemote Function
function deleteUser(string projectKey, string environmentKey, string userKey) returns Response|errorDelete a user by ID.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userKey string - The user's key.
getUserFlagSettings
Isolated FunctionRemote Function
function getUserFlagSettings(string projectKey, string environmentKey, string userKey) returns UserFlagSettings|errorFetch a single flag setting for a user by key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userKey string - The user's key.
Return Type
- UserFlagSettings|error - User flags settings response.
getUserFlagSetting
Isolated FunctionRemote Function
function getUserFlagSetting(string projectKey, string environmentKey, string userKey, string featureFlagKey) returns UserFlagSetting|errorFetch a single flag setting for a user by key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userKey string - The user's key.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
Return Type
- UserFlagSetting|error - User flag setting response.
putFlagSetting
Isolated FunctionRemote Function
function putFlagSetting(string projectKey, string environmentKey, string userKey, string featureFlagKey, FlagsFeatureflagkeyBody payload) returns Response|errorSpecifically enable or disable a feature flag for a user based on their key.
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userKey string - The user's key.
- featureFlagKey string - The feature flag's key. The key identifies the flag in your code.
- payload FlagsFeatureflagkeyBody - A request payload to update feature flag for a user based on their key
getExpiringUserTargetsForUser
Isolated FunctionRemote Function
function getExpiringUserTargetsForUser(string projectKey, string environmentKey, string userKey) returns UserTargetingExpirationOnFlagsForUser|errorGet expiring dates on flags for user
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userKey string - The user's key.
Return Type
- UserTargetingExpirationOnFlagsForUser|error - User targets of the requested feature flag.
patchExpiringUserTargetsForFlags
Isolated FunctionRemote Function
function patchExpiringUserTargetsForFlags(string projectKey, string environmentKey, string userKey, SemanticPatchOperation[] payload) returns UserTargetingExpirationOnFlagsForUser|errorUpdate, add, or delete expiring user targets for a single user on all flags
Parameters
- projectKey string - The project key, used to tie the flags together under one project so they can be managed together.
- environmentKey string - The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- userKey string - The user's key.
- payload SemanticPatchOperation[] - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
Return Type
- UserTargetingExpirationOnFlagsForUser|error - User Targeting expiration for single user on all flags response.
getWebhooks
Isolated FunctionRemote Function
Fetch a list of all webhooks.
postWebhook
Isolated FunctionRemote Function
function postWebhook(WebhooksBody payload) returns Webhook|errorCreate a webhook.
Parameters
- payload WebhooksBody - New webhook.
getWebhook
Isolated FunctionRemote Function
Get a webhook by ID.
Parameters
- resourceId string - The resource ID.
deleteWebhook
Isolated FunctionRemote Function
Delete a webhook by ID.
Parameters
- resourceId string - The resource ID.
patchWebhook
Isolated FunctionRemote Function
function patchWebhook(string resourceId, PatchOperation[] payload) returns Webhook|errorModify a webhook by ID.
Parameters
- resourceId string - The resource ID.
- payload PatchOperation[] - Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
Records
launchdarkly: AccountRelayautoconfigsBody
Fields
- name string? - A human-friendly name for the relay proxy configuration
- policy Policy[]? -
launchdarkly: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
launchdarkly: AuditLogEntries
Fields
- _links Links? -
- items AuditLogEntry[]? -
launchdarkly: AuditLogEntry
Fields
- _id Id? - The unique resource id.
- _links Links? -
- comment string? -
- date int? -
- description string? -
- kind string? -
- member Member? -
- name string? -
- shortDescription string? -
- target AuditlogentryTarget? -
- title string? -
- titleVerb string? -
launchdarkly: AuditlogentryTarget
Fields
- _links Links? -
- name string? -
- resources string[]? -
launchdarkly: Clause
Fields
- _id string? -
- attribute string? -
- negate boolean? -
- op string? -
- values record {}[]? -
launchdarkly: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
launchdarkly: ClientSideAvailability
Fields
- usingEnvironmentId boolean? - When set to true, this flag will be available to SDKs using the client-side id.
- usingMobileKey boolean? - When set to true, this flag will be available to SDKS using a mobile key.
launchdarkly: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
launchdarkly: CustomProperty
A name and value describing a custom property.
Fields
- name string - The name of the property.
- value string[]? - Values for this property.
launchdarkly: CustomRole
Fields
- _id Id? - The unique resource id.
- _links Links? -
- description string? - Description of the custom role.
- 'key string? - The 20-hexdigit id or the key for a custom role.
- name string? - Name of the custom role.
- policy Policy[]? -
launchdarkly: CustomRoles
Fields
- _links Links? -
- items CustomRole[]? -
launchdarkly: Defaults
Default values to be used when a new environment is created.
Fields
- offVariation int - The index of the variation to be served when a flag is off.
- onVariation int - The index of the variation to be served when a flag's targeting is on (default variation).
launchdarkly: Destination
Fields
- _id string? - Unique destination ID.
- _links Links? -
- config record {}? - destination-specific configuration.
- kind string? - Destination type ("google-pubsub", "kinesis", "mparticle", or "segment")
- name string? - The destination name
- 'on boolean? - Whether the data export destination is on or not.
- 'version int? -
launchdarkly: DestinationAmazonKinesis
Fields
- region string? -
- roleArn string? -
- streamName string? -
launchdarkly: DestinationGooglePubSub
Fields
- project string? -
- topic string? -
launchdarkly: DestinationMParticle
Fields
- apiKey string? -
- environment string? -
- secret string? -
- userIdentity string? -
launchdarkly: Destinations
Fields
- _links Links? -
- items Destination[]? -
launchdarkly: DestinationSegment
Fields
- writeKey string? -
launchdarkly: Environment
Fields
- _id Id? - The unique resource id.
- _links Links? -
- apiKey string? - The SDK key for backend LaunchDarkly SDKs.
- approvalSettings EnvironmentApprovalsettings? - Approval settings for an environment. Only appears if the approvals feature is enabled.
- color string? - The swatch color for the environment.
- confirmChanges boolean? - Determines if this environment requires confirmation for flag and segment changes.
- defaultTrackEvents boolean? - Set to true to send detailed event information for new flags.
- defaultTtl decimal? - The default TTL.
- 'key string? - The key for the environment.
- mobileKey string? - The SDK key for mobile LaunchDarkly SDKs.
- name string? - The name of the environment.
- requireComments boolean? - Determines if this environment requires comments for flag and segment changes.
- secureMode boolean? - Determines if this environment is in safe mode.
launchdarkly: EnvironmentApprovalsettings
Approval settings for an environment. Only appears if the approvals feature is enabled.
Fields
- canApplyDeclinedChanges boolean? - Whether changes can be applied as long as minNumApprovals is met, regardless of if any reviewers have declined a request.
- canReviewOwnRequest boolean? - Whether requesters can approve or decline their own request. They may always comment.
- minNumApprovals int? - The number of approvals required before an approval request can be applied.
- required boolean? - Whether any changes to flags in this environment will require approval.
- serviceKind string? - The approvals system used.
launchdarkly: EnvironmentPost
Fields
- color string - A color swatch (as an RGB hex value with no leading '#', e.g. C8C8C8).
- confirmChanges boolean? - Determines if this environment requires confirmation for flag and segment changes.
- defaultTrackEvents boolean? - Set to true to send detailed event information for newly created flags.
- defaultTtl decimal? - The default TTL for the new environment.
- 'key string - A project-unique key for the new environment.
- name string - The name of the new environment.
- requireComments boolean? - Determines if this environment requires comments for flag and segment changes.
- secureMode boolean? - Determines whether the environment is in secure mode.
launchdarkly: EvaluationUsageError
Fields
- code string? -
- message string? -
launchdarkly: Events
Fields
- links UsageLinks? -
launchdarkly: Fallthrough
Fields
- rollout Rollout? -
- variation int? -
launchdarkly: FeatureFlag
Fields
- _links Links? -
- _maintainer Member? -
- _version int? -
- archived boolean? - Whether or not this flag is archived.
- archivedDate int? - A unix epoch time in milliseconds specifying the archived time of this flag.
- clientSideAvailability ClientSideAvailability? -
- creationDate int? - A unix epoch time in milliseconds specifying the creation time of this flag.
- customProperties record {}? - A mapping of keys to CustomProperty entries.
- defaults Defaults? - Default values to be used when a new environment is created.
- description string? - Description of the feature flag.
- environments record {}? -
- goalIds string[]? - An array goals from all environments associated with this feature flag
- includeInSnippet boolean? -
- 'key string? -
- kind string? - Whether the feature flag is a boolean flag or multivariate.
- maintainerId string? - The ID of the member that should maintain this flag.
- name string? - Name of the feature flag.
- temporary boolean? - Whether or not this flag is temporary.
- variations Variation[]? - The variations for this feature flag.
launchdarkly: FeatureFlagApprovalRequest
Fields
- _id Id? - The unique resource id.
- _version int? -
- allReviews FeatureFlagApprovalRequestReview[]? -
- appliedByMemberID string? - The id of the member that applied the approval request
- appliedDate int? - A unix epoch time in milliseconds specifying the date the approval request was applied
- creationDate int? - A unix epoch time in milliseconds specifying the date the approval request was requested
- instructions SemanticPatchInstruction? - A semantic patch instruction
- notifyMemberIds string[]? - Id of members to notify.
- requestorId string? - The id of the member that requested the change
- reviewStatus FeatureFlagApprovalRequestReviewStatus? - | Name | Description | | --------:| ----------- | | pending | the feature flag approval request has not been reviewed yet | | approved | the feature flag approval request has been approved and can now be applied | | declined | the feature flag approval request has been declined and cannot be applied |
- status string? - | Name | Description | | --------:| ----------- | | pending | the feature flag approval request has not been applied yet | | completed| the feature flag approval request has been applied successfully | | failed | the feature flag approval request has been applied but the changes were not applied successfully |
launchdarkly: FeatureflagapprovalrequestidApplyBody
Fields
- comment string? - comment will be included in audit log item for change.
launchdarkly: FeatureflagapprovalrequestidReviewBody
Fields
- comment string? - comment will be included in audit log item for change.
- kind string - One of approve, decline, or comment.
launchdarkly: FeatureFlagApprovalRequestReview
Fields
- _id Id? - The unique resource id.
- creationDate int? - A unix epoch time in milliseconds specifying the date the approval request was reviewed
- kind FeatureFlagApprovalRequestReviewStatus? - | Name | Description | | --------:| ----------- | | pending | the feature flag approval request has not been reviewed yet | | approved | the feature flag approval request has been approved and can now be applied | | declined | the feature flag approval request has been declined and cannot be applied |
- memberId Id? - The unique resource id.
launchdarkly: FeatureFlagApprovalRequests
Fields
- _links Links? -
- items FeatureFlagApprovalRequest[]? -
launchdarkly: FeatureFlagConfig
Fields
- _environmentName string? -
- _site Site? -
- archived boolean? -
- fallthrough Fallthrough? -
- lastModified int? -
- offVariation int? -
- 'on boolean? -
- prerequisites Prerequisite[]? -
- rules Rule[]? -
- salt string? -
- sel string? -
- targets Target[]? -
- trackEvents boolean? - Set to true to send detailed event information for this flag.
- trackEventsFallthrough boolean? - Set to true to send detailed event information when targeting is enabled but no individual targeting rule is matched.
- 'version int? -
launchdarkly: FeatureFlagCopyObject
Fields
- currentVersion int? - If the latest version of the flag matches provided version it will copy, otherwise it will return a conflict.
- 'key string - The environment key to be used.
launchdarkly: FeatureflagkeyCopyBody
Fields
- comment string? - comment will be included in audit log item for change.
- excludedActions CopyActions[]? - Define the parts of the flag configuration that will not be copied.
- includedActions CopyActions[]? - Define the parts of the flag configuration that will be copied.
- 'source FeatureFlagCopyObject? -
- target FeatureFlagCopyObject? -
launchdarkly: FeatureFlags
Fields
- _links Links? -
- items FeatureFlag[]? -
- totalCount decimal? -
launchdarkly: FeatureFlagScheduledChange
Fields
- _id string? -
- _version int? -
- executionDate int? - A unix epoch time in milliseconds specifying the date the scheduled changes will be applied
- instructions SemanticPatchInstruction? - A semantic patch instruction
launchdarkly: FeatureFlagScheduledChanges
Fields
- _links Links? -
- items FeatureFlagScheduledChange[]? -
launchdarkly: FeatureFlagScheduledChangesConflicts
Fields
- instructions FeatureflagscheduledchangesconflictsInstructions[]? -
launchdarkly: FeatureflagscheduledchangesconflictsInstructions
Fields
- conflicts ScheduledChangesFeatureFlagConflict[]? -
- kind string? - The name of the modification you would like to perform on a resource.
launchdarkly: FeatureFlagStatus
Fields
- _links Links? -
- default record {}? -
- lastRequested string? -
- name string? - | Name | Description | | --------:| ----------- | | new | the feature flag was created within the last 7 days, and has not been requested yet | | active | the feature flag was requested by your servers or clients within the last 7 days | | inactive | the feature flag was created more than 7 days ago, and hasn't been requested by your servers or clients within the past 7 days | | launched | one variation of the feature flag has been rolled out to all your users for at least 7 days |
launchdarkly: FeatureFlagStatusAcrossEnvironments
Fields
- _links Links? -
- environments record {}? -
- 'key string? -
launchdarkly: FeatureFlagStatuses
Fields
- _links Links? -
- items FeatureFlagStatus[]? -
launchdarkly: FeatureFlagStatusForQueriedEnvironment
Fields
- default record {}? -
- lastRequested string? -
- name string? - | Name | Description | | --------:| ----------- | | new | the feature flag was created within the last 7 days, and has not been requested yet | | active | the feature flag was requested by your servers or clients within the last 7 days | | inactive | the feature flag was created more than 7 days ago, and hasn't been requested by your servers or clients within the past 7 days | | launched | one variation of the feature flag has been rolled out to all your users for at least 7 days |
launchdarkly: FlagListItem
Fields
- _links Links? -
- _site Site? -
- 'key string? -
- name string? -
launchdarkly: FlagsFeatureflagkeyBody
Fields
- setting boolean? - The variation value to set for the user. Must match the variation type of the flag.
launchdarkly: FlagsProjectkeyBody
Fields
- clientSideAvailability ClientSideAvailability? -
- defaults Defaults? - Default values to be used when a new environment is created.
- description string? - A description of the feature flag.
- includeInSnippet boolean? - Whether or not this flag should be made available to the client-side JavaScript SDK.
- 'key string - A unique key that will be used to reference the flag in your code.
- name string - A human-friendly name for the feature flag. Remember to note if this flag is intended to be temporary or permanent.
- temporary boolean? - Whether or not the flag is a temporary flag.
- variations Variation[] - An array of possible variations for the flag.
launchdarkly: HierarchicalLinks
Fields
- parent Link? -
- self Link? -
launchdarkly: Integration
Fields
- _links IntegrationLinks? -
- items IntegrationSubscription[]? -
launchdarkly: IntegrationLinks
Fields
- self Link? -
launchdarkly: Integrations
Fields
- _links record {}? - A mapping of integration types to their respective API endpoints.
- items IntegrationSubscription[]? -
launchdarkly: IntegrationsIntegrationkeyBody
Fields
- config record {} - Integration-specific configuration fields.
- name string - A human-readable name for your subscription configuration.
- 'on boolean? - Whether the integration subscription is active or not.
- statements Statement[]? -
launchdarkly: IntegrationSubscription
Fields
- _id Id? - The unique resource id.
- _links HierarchicalLinks? -
- _status IntegrationsubscriptionStatus? -
- config record {}? - A key-value mapping of configuration fields.
- kind string? - The type of integration associated with this configuration.
- name string? - The user-defined name associated with this configuration.
- 'on boolean? - Whether or not the integration is currently active.
- statements Statement[]? -
launchdarkly: IntegrationsubscriptionStatus
Fields
- errorCount int? -
- lastSuccess int? - A unix epoch time in milliseconds specifying the last time this integration was successfully used.
- successCount int? -
launchdarkly: Link
Fields
- href string? -
- 'type string? -
launchdarkly: Links
Fields
- next Link? -
- self Link? -
launchdarkly: MAU
Fields
- _links UsageLinks? -
- metadata StreamBySDKLinksMetadata[]? -
- series StreamUsageSeries[]? -
launchdarkly: MAUbyCategory
Fields
- _links StreamBySDKLinks? -
- metadata MAUMetadata[]? -
- series StreamUsageSeries[]? -
launchdarkly: MAUMetadata
launchdarkly: Member
Fields
- _id Id? - The unique resource id.
- _links Links? -
- _pendingInvite boolean? -
- _verified boolean? -
- customRoles Id[]? -
- email string? -
- firstName string? -
- isBeta boolean? -
- lastName string? -
- role Role? -
launchdarkly: Members
Fields
- _links Links? -
- items Member[]? -
- totalCount decimal? -
launchdarkly: MembersBody
Fields
- customRoles string[]? -
- email string -
- firstName string? -
- inlineRole Statement[]? -
- lastName string? -
- role Role? -
launchdarkly: PatchOperation
Fields
- op string -
- path string -
- value record {} -
launchdarkly: Policy
Fields
- actions string[]? -
- effect string? - Effect of the policy - allow or deny.
- notActions string[]? - Targeted actions will be those actions NOT in this list. The "actions" field must be empty to use this field.
- notResources string[]? - Targeted resource will be those resources NOT in this list. The "resources" field must be empty to use this field.
- resources string[]? -
launchdarkly: Prerequisite
Fields
- 'key string? -
- variation int? -
launchdarkly: Project
Fields
- _id Id? - The unique resource id.
- _links Links? -
- defaultClientSideAvailability ClientSideAvailability? -
- environments Environment[]? -
- includeInSnippetByDefault boolean? -
- 'key string? -
- name string? -
launchdarkly: ProjectkeyEnvironmentkeyBody
Fields
- config record {} - destination-specific configuration.
- kind string - The data export destination type. Available choices are kinesis, google-pubsub, mparticle, or segment.
- name string - A human-readable name for your data export destination.
- 'on boolean? - Whether the data export destination is on or not.
launchdarkly: ProjectkeyEnvironmentkeyBody1
Fields
- description string? - A description for the user segment.
- 'key string - A unique key that will be used to reference the user segment in feature flags.
- name string - A human-friendly name for the user segment.
- unbounded boolean? - Controls whether this segment can support unlimited numbers of users. Requires the beta API and additional setup. Include/exclude lists in this payload are not used in unbounded segments.
launchdarkly: ProjectkeyFeatureflagkeyBody
Fields
- comment string? -
- patch PatchOperation[]? -
launchdarkly: Projects
Fields
- _links Links? -
- items Project[]? -
launchdarkly: ProjectsBody
Fields
- defaultClientSideAvailability ClientSideAvailability? -
- environments EnvironmentPost[]? -
- includeInSnippetByDefault boolean? -
- 'key string -
- name string -
launchdarkly: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
launchdarkly: RelayProxyConfig
Fields
- _creator Member -
- _id Id - The unique resource id.
- creationDate int - A unix epoch time in milliseconds specifying the creation time of this relay proxy configuration
- displayKey string - The last 4 digits of the unique secret key for this relay proxy configuration
- fullKey string? - Full secret key. Only included if creating or resetting the relay proxy configuration
- lastModified int - A unix epoch time in milliseconds specifying the last time this relay proxy configuration was modified
- name string - A human-friendly name for the relay proxy configuration
- policy Policy[] -
launchdarkly: RelayProxyConfigs
Fields
- items RelayProxyConfig[]? -
launchdarkly: RolesBody
Fields
- description string? - Description of the custom role.
- 'key string - The 20-hexdigit id or the key for a custom role.
- name string - Name of the custom role.
- policy Policy[] -
launchdarkly: Rollout
Fields
- bucketBy string? -
- variations WeightedVariation[]? -
launchdarkly: Rule
Fields
- _id string? -
- clauses Clause[]? -
- description string? -
- rollout Rollout? -
- trackEvents boolean? -
- variation int? -
launchdarkly: ScheduledChangesFeatureFlagConflict
Fields
- _id string? - Feature flag scheduled change id this change will conflict with
- reason string? - Feature flag scheduled change conflict reason
launchdarkly: SemanticpatchinstructionInner
Fields
- kind string? - The name of the modification you would like to perform on a resource.
launchdarkly: SemanticPatchOperation
Fields
- comment string? -
- instructions SemanticPatchInstruction - A semantic patch instruction
launchdarkly: Site
Fields
- href string? -
- 'type string? -
launchdarkly: Statement
Fields
- actions string[]? -
- effect string? -
- notActions string[]? - Targeted actions will be those actions NOT in this list. The "actions" field must be empty to use this field.
- notResources string[]? - Targeted resource will be those resources NOT in this list. The "resources" field must be empty to use this field.
- resources string[]? -
launchdarkly: Stream
Fields
- _links StreamUsageLinks? -
- metadata StreamUsageMetadata[]? -
- series StreamUsageSeries[]? -
launchdarkly: StreamBySDK
Fields
- _links StreamBySDKLinks? -
- metadata StreamBySDKLinksMetadata[]? -
- series StreamUsageSeries[]? -
launchdarkly: StreamBySDKLinks
Fields
- parent Link? -
- self Link? -
launchdarkly: StreamBySDKLinksMetadata
Fields
- sdk string? -
- 'source string? -
- 'version string? -
launchdarkly: StreamLinks
Fields
- parent Link? -
- self Link? -
- subseries Link[]? - Links to endpoints that are in the request path.
launchdarkly: Streams
Fields
- _links StreamUsageLinks? -
launchdarkly: StreamSDKVersion
Fields
- _links StreamBySDKLinks? -
- sdkVersions StreamSDKVersionData[]? -
launchdarkly: StreamSDKVersionData
Fields
- sdk string? - The language of the sdk
- 'version string? - The version of the sdk
launchdarkly: StreamUsageError
Fields
- code string? -
- message string? -
launchdarkly: StreamUsageLinks
Fields
- parent Link? -
- self Link? -
- subseries Link[]? - The following links that are in the response.
launchdarkly: StreamUsageMetadata
Fields
- sdk string? - The language of the sdk
- 'source string? -
- 'version string? - The version of the SDK
launchdarkly: StreamUsageSeries
Fields
- '0 int? - A key corresponding to a time series data point.
- time int? - A unix epoch time in milliseconds specifying the creation time of this flag.
launchdarkly: Target
Fields
- values string[]? -
- variation int? -
launchdarkly: Token
Fields
- _id Id? - The unique resource id.
- _links Links? -
- _member Member? -
- creationDate int? - A unix epoch time in milliseconds specifying the creation time of this access token.
- customRoleIds string[]? - A list of custom role IDs to use as access limits for the access token
- defaultApiVersion int? - The default API version for this token
- inlineRole Statement[]? -
- lastModified int? - A unix epoch time in milliseconds specifying the last time this access token was modified.
- lastUsed int? - A unix epoch time in milliseconds specifying the last time this access token was used to authorize access to the LaunchDarkly REST API.
- memberId Id? - The unique resource id.
- name string? - A human-friendly name for the access token
- ownerId Id? - The unique resource id.
- role string? - The name of a built-in role for the token
- serviceToken boolean? - Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
- token string? - The last 4 digits of the unique secret key for this access token. If creating or resetting the token, this will be the full token secret.
launchdarkly: Tokens
Fields
- _links Links? -
- items Token[]? -
launchdarkly: TokensBody
Fields
- customRoleIds string[]? - A list of custom role IDs to use as access limits for the access token
- defaultApiVersion int? - The default API version for this token
- inlineRole Statement[]? -
- name string? - A human-friendly name for the access token
- role string? - The name of a built-in role for the token
- serviceToken boolean? - Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
launchdarkly: UnboundedSegmentTargetChanges
Fields
- add string[]? - Users to add to this list of targets
- remove string[]? - Users to remove from this list of targets
launchdarkly: Usage
Fields
- _links UsageLinks? -
- series StreamUsageSeries[]? -
launchdarkly: UsageError
Fields
- message string? -
launchdarkly: UsageLinks
Fields
- parent Link? -
- self Link? -
- subseries Link[]? - The following links that are in the response.
launchdarkly: User
Fields
- anonymous boolean? -
- avatar string? -
- country string? -
- custom record {}? -
- email string? -
- firstName string? -
- ip string? -
- 'key string? -
- lastName string? -
- name string? -
- secondary string? -
launchdarkly: UserFlagSetting
Fields
- _links Links? -
- _value boolean? - The most important attribute in the response. The _value is the current setting for the user. For a boolean feature toggle, this will be true, false, or null if there is no defined fallthrough value.
- setting boolean? - The setting attribute indicates whether you've explicitly targeted this user to receive a particular variation. For example, if you have explicitly turned off a feature toggle for a user, setting will be false. A setting of null means that you haven't assigned that user to a specific variation.
launchdarkly: UserFlagSettings
Fields
- _links Links? -
- items record {}? -
launchdarkly: UserRecord
Fields
- avatar string? -
- environmentId string? -
- lastPing string? -
- ownerId Id? - The unique resource id.
- user User? -
launchdarkly: Users
Fields
- _links Links? -
- items UserRecord[]? -
- totalCount decimal? -
launchdarkly: UserSegment
Fields
- _flags FlagListItem[]? -
- _links Links? -
- creationDate int - A unix epoch time in milliseconds specifying the creation time of this flag.
- description string? - Description of the user segment.
- excluded string[]? - An array of user keys that should not be included in this segment, unless they are also listed in "included".
- included string[]? - An array of user keys that are included in this segment.
- 'key string - Unique identifier for the user segment.
- name string - Name of the user segment.
- rules UserSegmentRule[]? - An array of rules that can cause a user to be included in this segment.
- unbounded boolean? - Controls whether this segment can support unlimited numbers of users. Requires the beta API and additional setup. Include/exclude lists in this payload are not used in unbounded segments.
- 'version int? -
launchdarkly: UsersegmentkeyUnboundedusersBody
Fields
- excluded UnboundedSegmentTargetChanges? -
- included UnboundedSegmentTargetChanges? -
launchdarkly: UserSegmentRule
Fields
- bucketBy string? -
- clauses Clause[]? -
- weight int? -
launchdarkly: UserSegments
Fields
- _links Links? -
- items UserSegment[]? -
launchdarkly: UserTargetingExpirationForFlag
Fields
- _id string? -
- _links Links? -
- _resourceId UserTargetingExpirationResourceIdForFlag? -
- _version int? -
- expirationDate int? - Unix epoch time in milliseconds specifying the expiration date
- userKey string? - Unique identifier for the user
- variationId string? - the ID of the variation that the user is targeted on a flag
launchdarkly: UserTargetingExpirationForFlags
Fields
- _links Links? -
- items UserTargetingExpirationForFlag[]? -
launchdarkly: UserTargetingExpirationForSegment
Fields
- _id string? -
- _links Links? -
- _resourceId UserTargetingExpirationResourceIdForFlag? -
- _version int? -
- expirationDate int? - Unix epoch time in milliseconds specifying the expiration date
- targetType string? - either the included or excluded variation that the user is targeted on a segment
- userKey string? - Unique identifier for the user
launchdarkly: UserTargetingExpirationOnFlagsForUser
Fields
- _links Links? -
- items UserTargetingExpirationForFlag[]? -
launchdarkly: UserTargetingExpirationResourceIdForFlag
Fields
- environmentKey string? -
- flagKey string? -
- 'key string? -
- kind string? -
- projectKey string? -
launchdarkly: Variation
Fields
- _id string? -
- description string? -
- name string? -
- value record {} -
launchdarkly: Webhook
Fields
- _id Id? - The unique resource id.
- _links Links? -
- name string? - The name of the webhook.
- 'on boolean? - Whether this webhook is enabled or not.
- secret string? - If defined, the webhooks post request will include a X-LD-Signature header whose value will contain an HMAC SHA256 hex digest of the webhook payload, using the secret as the key.
- statements Statement[]? -
- url string? - The URL of the remote webhook.
launchdarkly: Webhooks
Fields
- _links Links? -
- items Webhook[]? -
launchdarkly: WebhooksBody
Fields
- name string? - The name of the webhook.
- 'on boolean - Whether this webhook is enabled or not.
- secret string? - If sign is true, and the secret attribute is omitted, LaunchDarkly will automatically generate a secret for you.
- sign boolean - If sign is false, the webhook will not include a signature header, and the secret can be omitted.
- statements Statement[]? -
- url string - The URL of the remote webhook.
launchdarkly: WeightedVariation
Fields
- variation int? -
- weight int? -
String types
launchdarkly: CopyActions
CopyActions
launchdarkly: FeatureFlagApprovalRequestReviewStatus
FeatureFlagApprovalRequestReviewStatus
| Name | Description |
|---|---|
| pending | the feature flag approval request has not been reviewed yet |
| approved | the feature flag approval request has been approved and can now be applied |
| declined | the feature flag approval request has been declined and cannot be applied |
launchdarkly: Id
Id
The unique resource id.
launchdarkly: Role
Role