@datafire/launchdarkly
Client library for LaunchDarkly REST API
Installation and Usage
npm install --save @datafire/launchdarkly
let launchdarkly = require('@datafire/launchdarkly').create({
Token: ""
});
.then(data => {
console.log(data);
});
Description
Build custom integrations with the LaunchDarkly REST API
Actions
getRoot
You can issue a GET request to the root resource to find all of the resource categories supported by the API.
launchdarkly.getRoot(null, context)
Input
This action has no parameters
Output
- output Links
getRelayProxyConfigs
Returns a list of relay proxy configurations in the account.
launchdarkly.getRelayProxyConfigs(null, context)
Input
This action has no parameters
Output
- output RelayProxyConfigs
postRelayAutoConfig
Create a new relay proxy config.
launchdarkly.postRelayAutoConfig({
"relayProxyConfigBody": {}
}, context)
Input
- input
object
- relayProxyConfigBody required
object
- name
string
: A human-friendly name for the relay proxy configuration - policy
array
- items Policy
- name
- relayProxyConfigBody required
Output
- output RelayProxyConfig
deleteRelayProxyConfig
Delete a relay proxy configuration by ID.
launchdarkly.deleteRelayProxyConfig({
"id": ""
}, context)
Input
- input
object
- id required
string
: The relay proxy configuration ID
- id required
Output
Output schema unknown
getRelayProxyConfig
Get a single relay proxy configuration by ID.
launchdarkly.getRelayProxyConfig({
"id": ""
}, context)
Input
- input
object
- id required
string
: The relay proxy configuration ID
- id required
Output
- output RelayProxyConfig
patchRelayProxyConfig
Modify a relay proxy configuration by ID.
launchdarkly.patchRelayProxyConfig({
"id": "",
"patchDelta": []
}, context)
Input
- input
object
- id required
string
: The relay proxy configuration ID - patchDelta required
array
- items PatchOperation
- id required
Output
- output RelayProxyConfig
resetRelayProxyConfig
Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
launchdarkly.resetRelayProxyConfig({
"id": ""
}, context)
Input
- input
object
- id required
string
: The relay proxy configuration ID - expiry
integer
: 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
- id required
Output
- output RelayProxyConfig
getAuditLogEntries
Get 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.
launchdarkly.getAuditLogEntries({}, context)
Input
- input
object
- before
integer
: A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp. - after
integer
: A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. - q
string
: 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
number
: A limit on the number of audit log entries to be returned, between 1 and 20. - spec
string
: A resource specifier, allowing you to filter audit log listings by resource.
- before
Output
- output AuditLogEntries
getAuditLogEntry
Use this endpoint to fetch a single audit log entry by its resouce ID.
launchdarkly.getAuditLogEntry({
"resourceId": ""
}, context)
Input
- input
object
- resourceId required
string
: The resource ID.
- resourceId required
Output
- output AuditLogEntry
getDestinations
Returns a list of all data export destinations.
launchdarkly.getDestinations(null, context)
Input
This action has no parameters
Output
- output Destinations
postDestination
Create a new data export destination
launchdarkly.postDestination({
"projectKey": "",
"environmentKey": "",
"destinationBody": {
"name": "",
"kind": "",
"config": {}
}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - destinationBody required
object
- config required
object
: destination-specific configuration. - kind required
string
(values: google-pubsub, kinesis, mparticle, segment): The data export destination type. Available choices are kinesis, google-pubsub, mparticle, or segment. - name required
string
: A human-readable name for your data export destination. - on
boolean
: Whether the data export destination is on or not.
- config required
- projectKey required
Output
- output Destination
deleteDestination
Get a single data export destination by ID
launchdarkly.deleteDestination({
"projectKey": "",
"environmentKey": "",
"destinationId": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - destinationId required
string
: The data export destination ID.
- projectKey required
Output
Output schema unknown
getDestination
Get a single data export destination by ID
launchdarkly.getDestination({
"projectKey": "",
"environmentKey": "",
"destinationId": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - destinationId required
string
: The data export destination ID.
- projectKey required
Output
- output Destination
patchDestination
Perform a partial update to a data export destination.
launchdarkly.patchDestination({
"projectKey": "",
"environmentKey": "",
"destinationId": "",
"PatchOnly": []
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - destinationId required
string
: The data export destination ID. - PatchOnly required
array
- items PatchOperation
- projectKey required
Output
- output Destination
getFeatureFlagStatusAcrossEnvironments
Get the status for a particular feature flag across environments
launchdarkly.getFeatureFlagStatusAcrossEnvironments({
"projectKey": "",
"featureFlagKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code.
- projectKey required
Output
getFeatureFlagStatuses
Get 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.
launchdarkly.getFeatureFlagStatuses({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- projectKey required
Output
- output FeatureFlagStatuses
getFeatureFlagStatus
Get the status for a particular feature flag.
launchdarkly.getFeatureFlagStatus({
"projectKey": "",
"environmentKey": "",
"featureFlagKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code.
- projectKey required
Output
- output FeatureFlagStatus
getFeatureFlags
Get a list of all features in the given project.
launchdarkly.getFeatureFlags({
"projectKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - env
array
: 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
: 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
: 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
number
: The number of objects to return. Defaults to -1, which returns everything. - offset
number
: 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
: A comma-separated list of filters. Each filter is of the form field:value. - sort
string
: A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. - tag
string
: Filter by tag. A tag can be used to group flags across projects.
- projectKey required
Output
- output FeatureFlags
postFeatureFlag
Creates a new feature flag.
launchdarkly.postFeatureFlag({
"projectKey": "",
"featureFlagBody": {
"name": "",
"key": "",
"variations": []
}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagBody required
object
- clientSideAvailability ClientSideAvailability
- defaults Defaults
- 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 required
string
: A unique key that will be used to reference the flag in your code. - name required
string
: A human-friendly name for the feature flag. Remember to note if this flag is intended to be temporary or permanent. - tags
array
: Tags for the feature flag.- items
string
- items
- temporary
boolean
: Whether or not the flag is a temporary flag. - variations required
array
: An array of possible variations for the flag.- items Variation
- clone
string
: 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.
- projectKey required
Output
- output FeatureFlag
deleteFeatureFlag
Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
launchdarkly.deleteFeatureFlag({
"projectKey": "",
"featureFlagKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code.
- projectKey required
Output
Output schema unknown
getFeatureFlag
Get a single feature flag by key.
launchdarkly.getFeatureFlag({
"projectKey": "",
"featureFlagKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - env
array
: 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.
- projectKey required
Output
- output FeatureFlag
patchFeatureFlag
Perform a partial update to a feature.
launchdarkly.patchFeatureFlag({
"projectKey": "",
"featureFlagKey": "",
"patchComment": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - patchComment required
object
- comment
string
- patch
array
- items PatchOperation
- comment
- projectKey required
Output
- output FeatureFlag
copyFeatureFlag
Copies the feature flag configuration from one environment to the same feature flag in another environment.
launchdarkly.copyFeatureFlag({
"projectKey": "",
"featureFlagKey": "",
"featureFlagCopyBody": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - featureFlagCopyBody required
object
- comment
string
: comment will be included in audit log item for change. - excludedActions
array
: Define the parts of the flag configuration that will not be copied.- items CopyActions
- includedActions
array
: Define the parts of the flag configuration that will be copied.- items CopyActions
- source FeatureFlagCopyObject
- target FeatureFlagCopyObject
- comment
- projectKey required
Output
- output FeatureFlag
getExpiringUserTargets
Get expiring user targets for feature flag
launchdarkly.getExpiringUserTargets({
"projectKey": "",
"environmentKey": "",
"featureFlagKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code.
- projectKey required
Output
patchExpiringUserTargets
Update, add, or delete expiring user targets on feature flag
launchdarkly.patchExpiringUserTargets({
"projectKey": "",
"environmentKey": "",
"featureFlagKey": "",
"SemanticPatchWithComment": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - SemanticPatchWithComment required
object
- items SemanticPatchOperation
- projectKey required
Output
getIntegrations
Get a list of all configured audit log event integrations associated with this account.
launchdarkly.getIntegrations(null, context)
Input
This action has no parameters
Output
- output Integrations
getIntegrationSubscriptions
Get a list of all configured integrations of a given kind.
launchdarkly.getIntegrationSubscriptions({
"integrationKey": ""
}, context)
Input
- input
object
- integrationKey required
string
: The key used to specify the integration kind.
- integrationKey required
Output
- output Integration
postIntegrationSubscription
Create a new integration subscription of a given kind.
launchdarkly.postIntegrationSubscription({
"integrationKey": "",
"subscriptionBody": {
"name": "",
"config": {}
}
}, context)
Input
- input
object
- integrationKey required
string
: The key used to specify the integration kind. - subscriptionBody required
object
- config required
object
: Integration-specific configuration fields. - name required
string
: A human-readable name for your subscription configuration. - on
boolean
: Whether the integration subscription is active or not. - statements
array
- items Statement
- tags
array
: Tags for the integration subscription.- items
string
- items
- config required
- integrationKey required
Output
- output IntegrationSubscription
deleteIntegrationSubscription
Delete an integration subscription by ID.
launchdarkly.deleteIntegrationSubscription({
"integrationKey": "",
"integrationId": ""
}, context)
Input
- input
object
- integrationKey required
string
: The key used to specify the integration kind. - integrationId required
string
: The integration ID.
- integrationKey required
Output
Output schema unknown
getIntegrationSubscription
Get a single integration subscription by ID.
launchdarkly.getIntegrationSubscription({
"integrationKey": "",
"integrationId": ""
}, context)
Input
- input
object
- integrationKey required
string
: The key used to specify the integration kind. - integrationId required
string
: The integration ID.
- integrationKey required
Output
- output IntegrationSubscription
patchIntegrationSubscription
Modify an integration subscription by ID.
launchdarkly.patchIntegrationSubscription({
"integrationKey": "",
"integrationId": "",
"patchDelta": []
}, context)
Input
- input
object
- integrationKey required
string
: The key used to specify the integration kind. - integrationId required
string
: The integration ID. - patchDelta required
array
- items PatchOperation
- integrationKey required
Output
- output IntegrationSubscription
getMembers
Returns a list of all members in the account.
launchdarkly.getMembers({}, context)
Input
- input
object
- limit
number
: The number of objects to return. Defaults to -1, which returns everything. - offset
number
: 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
: A comma-separated list of filters. Each filter is of the form field:value. - sort
string
: A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
- limit
Output
- output Members
postMembers
Invite new members.
launchdarkly.postMembers({
"membersBody": []
}, context)
Input
- input
object
Output
- output Members
getMe
Get the current team member associated with the token
launchdarkly.getMe(null, context)
Input
This action has no parameters
Output
- output Member
deleteMember
Delete a team member by ID.
launchdarkly.deleteMember({
"memberId": ""
}, context)
Input
- input
object
- memberId required
string
: The member ID.
- memberId required
Output
Output schema unknown
getMember
Get a single team member by ID.
launchdarkly.getMember({
"memberId": ""
}, context)
Input
- input
object
- memberId required
string
: The member ID.
- memberId required
Output
- output Member
patchMember
Modify a team member by ID.
launchdarkly.patchMember({
"memberId": "",
"patchDelta": []
}, context)
Input
- input
object
- memberId required
string
: The member ID. - patchDelta required
array
- items PatchOperation
- memberId required
Output
- output Member
getProjects
Returns a list of all projects in the account.
launchdarkly.getProjects(null, context)
Input
This action has no parameters
Output
- output Projects
postProject
Create a new project with the given key and name.
launchdarkly.postProject({
"projectBody": {
"name": "",
"key": ""
}
}, context)
Input
- input
object
- projectBody required
object
- defaultClientSideAvailability ClientSideAvailability
- environments
array
- items EnvironmentPost
- includeInSnippetByDefault
boolean
- key required
string
- name required
string
- tags
array
- items
string
- items
- projectBody required
Output
- output Project
deleteProject
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.
launchdarkly.deleteProject({
"projectKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together.
- projectKey required
Output
Output schema unknown
getProject
Fetch a single project by key.
launchdarkly.getProject({
"projectKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together.
- projectKey required
Output
- output Project
patchProject
Modify a project by ID.
launchdarkly.patchProject({
"projectKey": "",
"patchDelta": []
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - patchDelta required
array
- items PatchOperation
- projectKey required
Output
- output Project
postEnvironment
Create a new environment in a specified project with a given name, key, and swatch color.
launchdarkly.postEnvironment({
"projectKey": "",
"environmentBody": {
"name": "",
"key": "",
"color": ""
}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentBody required EnvironmentPost
- projectKey required
Output
- output Environment
deleteEnvironment
Delete an environment in a specific project.
launchdarkly.deleteEnvironment({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- projectKey required
Output
Output schema unknown
getEnvironment
Get an environment given a project and key.
launchdarkly.getEnvironment({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- projectKey required
Output
- output Environment
patchEnvironment
Modify an environment by ID.
launchdarkly.patchEnvironment({
"projectKey": "",
"environmentKey": "",
"patchDelta": []
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - patchDelta required
array
- items PatchOperation
- projectKey required
Output
- output Environment
resetEnvironmentSDKKey
Reset an environment's SDK key with an optional expiry time for the old key.
launchdarkly.resetEnvironmentSDKKey({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - expiry
integer
: An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately.
- projectKey required
Output
- output Environment
resetEnvironmentMobileKey
Reset 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.
launchdarkly.resetEnvironmentMobileKey({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - expiry
integer
: 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.
- projectKey required
Output
- output Environment
getFeatureFlagChangeRequest
Get a single change request for a feature flag
launchdarkly.getFeatureFlagChangeRequest({
"projectKey": "",
"featureFlagKey": "",
"environmentKey": "",
"featureFlagChangeRequestId": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - featureFlagChangeRequestId required
string
: The feature flag change request ID
- projectKey required
Output
- output FeatureFlagChangeRequests
postApplyFeatureFlagChangeRequest
Apply change request for a feature flag
launchdarkly.postApplyFeatureFlagChangeRequest({
"projectKey": "",
"featureFlagKey": "",
"environmentKey": "",
"featureFlagChangeRequestId": "",
"featureFlagChangeRequestApplyConfigBody": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - featureFlagChangeRequestId required
string
: The feature flag change request ID - featureFlagChangeRequestApplyConfigBody required
object
- comment
string
: comment will be included in audit log item for change.
- comment
- projectKey required
Output
- output FeatureFlagChangeRequests
postReviewFeatureFlagChangeRequest
Review change request for a feature flag
launchdarkly.postReviewFeatureFlagChangeRequest({
"projectKey": "",
"featureFlagKey": "",
"environmentKey": "",
"featureFlagChangeRequestId": "",
"featureFlagChangeRequestReviewConfigBody": {
"kind": ""
}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - featureFlagChangeRequestId required
string
: The feature flag change request ID - featureFlagChangeRequestReviewConfigBody required
object
- comment
string
: comment will be included in audit log item for change. - kind required
string
(values: approve, decline): Either approve or decline change request
- comment
- projectKey required
Output
- output FeatureFlagChangeRequests
getCustomRoles
Return a complete list of custom roles.
launchdarkly.getCustomRoles(null, context)
Input
This action has no parameters
Output
- output CustomRoles
postCustomRole
Create a new custom role.
launchdarkly.postCustomRole({
"customRoleBody": {
"name": "",
"key": "",
"policy": []
}
}, context)
Input
- input
object
- customRoleBody required
object
- description
string
: Description of the custom role. - key required
string
: The 20-hexdigit id or the key for a custom role. - name required
string
: Name of the custom role. - policy required
array
- items Policy
- description
- customRoleBody required
Output
- output CustomRole
deleteCustomRole
Delete a custom role by key.
launchdarkly.deleteCustomRole({
"customRoleKey": ""
}, context)
Input
- input
object
- customRoleKey required
string
: The custom role key.
- customRoleKey required
Output
Output schema unknown
getCustomRole
Get one custom role by key.
launchdarkly.getCustomRole({
"customRoleKey": ""
}, context)
Input
- input
object
- customRoleKey required
string
: The custom role key.
- customRoleKey required
Output
- output CustomRole
patchCustomRole
Modify a custom role by key.
launchdarkly.patchCustomRole({
"customRoleKey": "",
"patchDelta": []
}, context)
Input
- input
object
- customRoleKey required
string
: The custom role key. - patchDelta required
array
- items PatchOperation
- customRoleKey required
Output
- output CustomRole
getUserSegments
Get a list of all user segments in the given project.
launchdarkly.getUserSegments({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - tag
string
: Filter by tag. A tag can be used to group flags across projects.
- projectKey required
Output
- output UserSegments
postUserSegment
Creates a new user segment.
launchdarkly.postUserSegment({
"projectKey": "",
"environmentKey": "",
"userSegmentBody": {
"name": "",
"key": ""
}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userSegmentBody required
object
- description
string
: A description for the user segment. - key required
string
: A unique key that will be used to reference the user segment in feature flags. - name required
string
: A human-friendly name for the user segment. - tags
array
: Tags for the user segment.- items
string
- items
- 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.
- description
- projectKey required
Output
- output UserSegment
deleteUserSegment
Delete a user segment.
launchdarkly.deleteUserSegment({
"projectKey": "",
"environmentKey": "",
"userSegmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userSegmentKey required
string
: The user segment's key. The key identifies the user segment in your code.
- projectKey required
Output
Output schema unknown
getUserSegment
Get a single user segment by key.
launchdarkly.getUserSegment({
"projectKey": "",
"environmentKey": "",
"userSegmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userSegmentKey required
string
: The user segment's key. The key identifies the user segment in your code.
- projectKey required
Output
- output UserSegment
patchUserSegment
Perform a partial update to a user segment.
launchdarkly.patchUserSegment({
"projectKey": "",
"environmentKey": "",
"userSegmentKey": "",
"PatchOnly": []
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userSegmentKey required
string
: The user segment's key. The key identifies the user segment in your code. - PatchOnly required
array
- items PatchOperation
- projectKey required
Output
- output UserSegment
updatedUnboundedSegmentTargets
Update targets included or excluded in an unbounded segment
launchdarkly.updatedUnboundedSegmentTargets({
"projectKey": "",
"environmentKey": "",
"userSegmentKey": "",
"unboundedSegmentTargetsBody": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userSegmentKey required
string
: The user segment's key. The key identifies the user segment in your code. - unboundedSegmentTargetsBody required
object
- excluded UnboundedSegmentTargetChanges
- included UnboundedSegmentTargetChanges
- projectKey required
Output
Output schema unknown
getExpiringUserTargetsOnSegment
Get expiring user targets for user segment
launchdarkly.getExpiringUserTargetsOnSegment({
"projectKey": "",
"environmentKey": "",
"userSegmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userSegmentKey required
string
: The user segment's key. The key identifies the user segment in your code.
- projectKey required
Output
patchExpiringUserTargetsOnSegment
Update, add, or delete expiring user targets on user segment
launchdarkly.patchExpiringUserTargetsOnSegment({
"projectKey": "",
"environmentKey": "",
"userSegmentKey": "",
"SemanticPatchWithComment": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userSegmentKey required
string
: The user segment's key. The key identifies the user segment in your code. - SemanticPatchWithComment required
object
- items SemanticPatchOperation
- projectKey required
Output
getTokens
Returns a list of tokens in the account.
launchdarkly.getTokens({}, context)
Input
- input
object
- showAll
boolean
: If set to true, and the authentication access token has the "Admin" role, personal access tokens for all members will be retrieved.
- showAll
Output
- output Tokens
postToken
Create a new token.
launchdarkly.postToken({
"tokenBody": {}
}, context)
Input
- input
object
- tokenBody required
object
- customRoleIds
array
: A list of custom role IDs to use as access limits for the access token- items
string
- items
- defaultApiVersion
integer
: The default API version for this token - inlineRole
array
- items 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
- customRoleIds
- tokenBody required
Output
- output Token
deleteToken
Delete an access token by ID.
launchdarkly.deleteToken({
"tokenId": ""
}, context)
Input
- input
object
- tokenId required
string
: The access token ID.
- tokenId required
Output
Output schema unknown
getToken
Get a single access token by ID.
launchdarkly.getToken({
"tokenId": ""
}, context)
Input
- input
object
- tokenId required
string
: The access token ID.
- tokenId required
Output
- output Token
patchToken
Modify an access token by ID.
launchdarkly.patchToken({
"tokenId": "",
"patchDelta": []
}, context)
Input
- input
object
- tokenId required
string
: The access token ID. - patchDelta required
array
- items PatchOperation
- tokenId required
Output
- output Token
resetToken
Reset an access token's secret key with an optional expiry time for the old key.
launchdarkly.resetToken({
"tokenId": ""
}, context)
Input
- input
object
- tokenId required
string
: The access token ID. - expiry
integer
: An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
- tokenId required
Output
- output Token
getUsage
Returns of the usage endpoints available.
launchdarkly.getUsage(null, context)
Input
This action has no parameters
Output
- output Usage
getEvaluations
Get events usage by event id and the feature flag key.
launchdarkly.getEvaluations({
"envId": "",
"flagKey": ""
}, context)
Input
- input
object
- envId required
string
: The environment id for the flag evaluations in question. - flagKey required
string
: The key of the flag we want metrics for.
- envId required
Output
- output StreamSDKVersion
getEvents
Get events usage endpoints.
launchdarkly.getEvents(null, context)
Input
This action has no parameters
Output
- output Events
getEvent
Get events usage by event type.
launchdarkly.getEvent({
"type": ""
}, context)
Input
- input
object
- type required
string
: The type of event we would like to track.
- type required
Output
- output StreamSDKVersion
getMAU
Get monthly active user data.
launchdarkly.getMAU(null, context)
Input
This action has no parameters
Output
- output MAU
getMAUByCategory
Get monthly active user data by category.
launchdarkly.getMAUByCategory(null, context)
Input
This action has no parameters
Output
- output MAUbyCategory
getStreams
Returns a list of all streams.
launchdarkly.getStreams(null, context)
Input
This action has no parameters
Output
- output Streams
getStream
Get a stream endpoint and return timeseries data.
launchdarkly.getStream({
"source": ""
}, context)
Input
- input
object
- source required
string
: The source of where the stream comes from.
- source required
Output
- output Stream
getStreamBySDK
Get a stream timeseries data by source show sdk version metadata.
launchdarkly.getStreamBySDK({
"source": ""
}, context)
Input
- input
object
- source required
string
: The source of where the stream comes from.
- source required
Output
- output StreamBySDK
getStreamSDKVersion
Get a stream timeseries data by source and show all sdk version associated.
launchdarkly.getStreamSDKVersion({
"source": ""
}, context)
Input
- input
object
- source required
string
: The source of where the stream comes from.
- source required
Output
- output StreamSDKVersion
getSearchUsers
Search 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.
launchdarkly.getSearchUsers({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - q
string
: Search query. - limit
integer
: Pagination limit. - offset
integer
: Specifies the first item to return in the collection. - after
integer
: A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp.
- projectKey required
Output
- output Users
getUsers
List 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.
launchdarkly.getUsers({
"projectKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - limit
integer
: Pagination limit. - h
string
: This parameter is required when following "next" links. - scrollId
string
: This parameter is required when following "next" links.
- projectKey required
Output
- output Users
deleteUser
Delete a user by ID.
launchdarkly.deleteUser({
"projectKey": "",
"environmentKey": "",
"userKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userKey required
string
: The user's key.
- projectKey required
Output
Output schema unknown
getUser
Get a user by key.
launchdarkly.getUser({
"projectKey": "",
"environmentKey": "",
"userKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userKey required
string
: The user's key.
- projectKey required
Output
- output User
getUserFlagSettings
Fetch a single flag setting for a user by key.
launchdarkly.getUserFlagSettings({
"projectKey": "",
"environmentKey": "",
"userKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userKey required
string
: The user's key.
- projectKey required
Output
- output UserFlagSettings
getUserFlagSetting
Fetch a single flag setting for a user by key.
launchdarkly.getUserFlagSetting({
"projectKey": "",
"environmentKey": "",
"userKey": "",
"featureFlagKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userKey required
string
: The user's key. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code.
- projectKey required
Output
- output UserFlagSetting
putFlagSetting
Specifically enable or disable a feature flag for a user based on their key.
launchdarkly.putFlagSetting({
"projectKey": "",
"environmentKey": "",
"userKey": "",
"featureFlagKey": "",
"userSettingsBody": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userKey required
string
: The user's key. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - userSettingsBody required
object
- setting
boolean
: The variation value to set for the user. Must match the variation type of the flag.
- setting
- projectKey required
Output
Output schema unknown
getExpiringUserTargetsForUser
Get expiring dates on flags for user
launchdarkly.getExpiringUserTargetsForUser({
"projectKey": "",
"environmentKey": "",
"userKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userKey required
string
: The user's key.
- projectKey required
Output
patchExpiringUserTargetsForFlags
Update, add, or delete expiring user targets for a single user on all flags
launchdarkly.patchExpiringUserTargetsForFlags({
"projectKey": "",
"environmentKey": "",
"userKey": "",
"SemanticPatchWithComment": {}
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - userKey required
string
: The user's key. - SemanticPatchWithComment required
object
- items SemanticPatchOperation
- projectKey required
Output
getWebhooks
Fetch a list of all webhooks.
launchdarkly.getWebhooks(null, context)
Input
This action has no parameters
Output
- output Webhooks
postWebhook
Create a webhook.
launchdarkly.postWebhook({
"webhookBody": {
"url": "",
"sign": true,
"on": true
}
}, context)
Input
- input
object
- webhookBody required
object
- name
string
: The name of the webhook. - on required
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 required
boolean
: If sign is false, the webhook will not include a signature header, and the secret can be omitted. - statements
array
- items Statement
- tags
array
: Tags for the webhook.- items
string
- items
- url required
string
: The URL of the remote webhook.
- name
- webhookBody required
Output
- output Webhook
deleteWebhook
Delete a webhook by ID.
launchdarkly.deleteWebhook({
"resourceId": ""
}, context)
Input
- input
object
- resourceId required
string
: The resource ID.
- resourceId required
Output
Output schema unknown
getWebhook
Get a webhook by ID.
launchdarkly.getWebhook({
"resourceId": ""
}, context)
Input
- input
object
- resourceId required
string
: The resource ID.
- resourceId required
Output
- output Webhook
patchWebhook
Modify a webhook by ID.
launchdarkly.patchWebhook({
"resourceId": "",
"patchDelta": []
}, context)
Input
- input
object
- resourceId required
string
: The resource ID. - patchDelta required
array
- items PatchOperation
- resourceId required
Output
- output Webhook
getFeatureFlagChangeRequests
Get all change requests for a feature flag
launchdarkly.getFeatureFlagChangeRequests({
"projectKey": "",
"featureFlagKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
- projectKey required
Output
- output FeatureFlagChangeRequests
postFeatureFlagChangeRequest
launchdarkly.postFeatureFlagChangeRequest({
"projectKey": "",
"featureFlagKey": "",
"environmentKey": ""
}, context)
Input
- input
object
- projectKey required
string
: The project key, used to tie the flags together under one project so they can be managed together. - featureFlagKey required
string
: The feature flag's key. The key identifies the flag in your code. - environmentKey required
string
: The environment key, used to tie together flag configuration and users under one environment so they can be managed together. - featureFlagChangeRequestConfigBody
object
- comment
string
: comment will be included in audit log item for change. - description required
string
: A name that describes the changes you would like to apply to a feature flag configuration - instructions required SemanticPatchInstruction
- notifyMemberIds required
array
- items
string
- items
- comment
- projectKey required
Output
- output FeatureFlagChangeRequest
Definitions
AuditLogEntries
- AuditLogEntries
object
- _links Links
- items
array
- items AuditLogEntry
AuditLogEntry
- AuditLogEntry
object
Clause
- Clause
object
- _id
string
- attribute
string
- negate
boolean
- op
string
- values
array
- items
object
- items
- _id
ClientSideAvailability
- ClientSideAvailability
object
- 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.
- usingEnvironmentId
CopyActions
- CopyActions
string
(values: updateOn, updatePrerequisites, updateTargets, updateRules, updateFallthrough, updateOffVariation)
CustomProperty
- CustomProperty
object
: A name and value describing a custom property.- name required
string
: The name of the property. - value
array
: Values for this property.- items
string
- items
- name required
CustomPropertyValues
- CustomPropertyValues
array
: Values for this property.- items
string
- items
CustomRole
- CustomRole
object
CustomRoles
- CustomRoles
object
- _links Links
- items
array
- items CustomRole
Defaults
- Defaults
object
: Default values to be used when a new environment is created.- offVariation required
integer
: The index of the variation to be served when a flag is off. - onVariation required
integer
: The index of the variation to be served when a flag's targeting is on (default variation).
- offVariation required
Destination
- Destination
object
- _id
string
: Unique destination ID. - _links Links
- config
object
: destination-specific configuration. - kind
string
(values: google-pubsub, kinesis, mparticle, segment): 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
integer
- _id
DestinationAmazonKinesis
- DestinationAmazonKinesis
object
- region
string
- roleArn
string
- streamName
string
- region
DestinationGooglePubSub
- DestinationGooglePubSub
object
- project
string
- topic
string
- project
DestinationMParticle
- DestinationMParticle
object
- apiKey
string
- environment
string
- secret
string
- userIdentity
string
- apiKey
DestinationSegment
- DestinationSegment
object
- writeKey
string
- writeKey
Destinations
- Destinations
object
- _links Links
- items
array
- items Destination
Environment
- Environment
object
- _id Id
- _links Links
- apiKey
string
: The SDK key for backend LaunchDarkly SDKs. - 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
number
: 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. - tags
array
: An array of tags for this environment.- items
string
- items
EnvironmentPost
- EnvironmentPost
object
- color required
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
number
: The default TTL for the new environment. - key required
string
: A project-unique key for the new environment. - name required
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. - tags
array
: An array of tags for this environment.- items
string
- items
- color required
EvaluationUsageError
- EvaluationUsageError
object
- code
string
- message
string
- code
Events
- Events
object
- links UsageLinks
Fallthrough
- Fallthrough
object
- rollout Rollout
- variation
integer
FeatureFlag
- FeatureFlag
object
- _links Links
- _maintainer Member
- _version
integer
- archived
boolean
: Whether or not this flag is archived. - archivedDate
integer
: A unix epoch time in milliseconds specifying the archived time of this flag. - clientSideAvailability ClientSideAvailability
- creationDate
integer
: A unix epoch time in milliseconds specifying the creation time of this flag. - customProperties
object
: A mapping of keys to CustomProperty entries. - defaults Defaults
- description
string
: Description of the feature flag. - environments
object
- goalIds
array
: An array goals from all environments associated with this feature flag- items
string
- items
- 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. - tags
array
: An array of tags for this feature flag.- items
string
- items
- temporary
boolean
: Whether or not this flag is temporary. - variations
array
: The variations for this feature flag.- items Variation
FeatureFlagChangeRequest
- FeatureFlagChangeRequest
object
- _id Id
- _version
integer
- allReviews
array
- appliedByMemberID
string
: The id of the member that applied the change request - appliedDate
integer
: A unix epoch time in milliseconds specifying the date the change request was applied - creationDate
integer
: A unix epoch time in milliseconds specifying the date the change request was requested - currentReviewsByMemberId FeatureFlagChangeRequestReview
- instructions SemanticPatchInstruction
- notifyMemberIds
array
- items
string
- items
- requestorId
string
: The id of the member that requested the change - reviewStatus FeatureFlagChangeRequestReviewStatus
- status
string
(values: pending, completed, failed): | Name | Description |
FeatureFlagChangeRequestReview
- FeatureFlagChangeRequestReview
object
- _id Id
- creationDate
integer
: A unix epoch time in milliseconds specifying the date the change request was reviewed - kind FeatureFlagChangeRequestReviewStatus
- memberId Id
FeatureFlagChangeRequestReviewStatus
- FeatureFlagChangeRequestReviewStatus
string
(values: pending, approved, declined): | Name | Description |
FeatureFlagChangeRequests
- FeatureFlagChangeRequests
object
- _links Links
- items
array
- items FeatureFlagChangeRequest
FeatureFlagConfig
- FeatureFlagConfig
object
- _environmentName
string
- _site Site
- archived
boolean
- fallthrough Fallthrough
- lastModified
integer
- offVariation
integer
- on
boolean
- prerequisites
array
- items Prerequisite
- rules
array
- items Rule
- salt
string
- sel
string
- targets
array
- items 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
integer
- _environmentName
FeatureFlagCopyObject
- FeatureFlagCopyObject
object
- currentVersion
integer
: If the latest version of the flag matches provided version it will copy, otherwise it will return a conflict. - key required
string
: The environment key to be used.
- currentVersion
FeatureFlagScheduledChange
- FeatureFlagScheduledChange
object
- _id
string
- _version
integer
- executionDate
integer
: A unix epoch time in milliseconds specifying the date the scheduled changes will be applied - instructions SemanticPatchInstruction
- _id
FeatureFlagScheduledChanges
- FeatureFlagScheduledChanges
object
- _links Links
- items
array
FeatureFlagScheduledChangesConflicts
- FeatureFlagScheduledChangesConflicts
object
- instructions
array
- items
object
- conflicts
array
- kind
string
: The name of the modification you would like to perform on a resource.
- conflicts
- items
- instructions
FeatureFlagStatus
- FeatureFlagStatus
object
- _links Links
- default
object
- lastRequested
string
- name
string
(values: new, active, inactive, launched): | Name | Description |
FeatureFlagStatusAcrossEnvironments
- FeatureFlagStatusAcrossEnvironments
object
- _links Links
- environments
object
- key
string
FeatureFlagStatusForQueriedEnvironment
- FeatureFlagStatusForQueriedEnvironment
object
- default
object
- lastRequested
string
- name
string
(values: new, active, inactive, launched): | Name | Description |
- default
FeatureFlagStatuses
- FeatureFlagStatuses
object
- _links Links
- items
array
- items FeatureFlagStatus
FeatureFlags
- FeatureFlags
object
- _links Links
- items
array
- items FeatureFlag
- totalCount
number
FlagListItem
HierarchicalLinks
Id
- Id
string
: The unique resource id.
Integration
- Integration
object
- _links
object
- self Link
- items
array
- items IntegrationSubscription
- _links
IntegrationSubscription
- IntegrationSubscription
object
- _id Id
- _links HierarchicalLinks
- _status
object
- errorCount
integer
- lastSuccess
integer
: A unix epoch time in milliseconds specifying the last time this integration was successfully used. - successCount
integer
- errorCount
- config
object
: 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
array
- items Statement
- tags
array
: An array of tags for this integration configuration.- items
string
- items
Integrations
- Integrations
object
- _links
object
: A mapping of integration types to their respective API endpoints. - items
array
- items IntegrationSubscription
- _links
Link
- Link
object
- href
string
- type
string
- href
Links
MAU
- MAU
object
- _links UsageLinks
- metadata
array
- items StreamBySDKLinksMetadata
- series
array
- items StreamUsageSeries
MAUMetadata
- MAUMetadata
object
MAUbyCategory
- MAUbyCategory
object
- _links StreamBySDKLinks
- metadata
array
- items MAUMetadata
- series
array
- items StreamUsageSeries
Member
- Member
object
Members
PatchOperation
- PatchOperation
object
- op required
string
- path required
string
- value required
object
- op required
Policy
- Policy
object
- actions
array
- items
string
: An action to perform on a resource.
- items
- effect
string
: Effect of the policy - allow or deny. - notActions
array
: Targeted actions will be those actions NOT in this list. The "actions" field must be empty to use this field.- items
string
: An action to perform on a resource.
- items
- notResources
array
: Targeted resource will be those resources NOT in this list. The "resources`" field must be empty to use this field.- items
string
: A resource specifier string
- items
- resources
array
- items
string
: A resource specifier string
- items
- actions
Prerequisite
- Prerequisite
object
- key
string
- variation
integer
- key
Project
- Project
object
- _id Id
- _links Links
- defaultClientSideAvailability ClientSideAvailability
- environments
array
- items Environment
- includeInSnippetByDefault
boolean
- key
string
- name
string
- tags
array
: An array of tags for this project.- items
string
- items
Projects
RelayProxyConfig
- RelayProxyConfig
object
- _creator required Member
- _id required Id
- creationDate required
integer
: A unix epoch time in milliseconds specifying the creation time of this relay proxy configuration - displayKey required
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 required
integer
: A unix epoch time in milliseconds specifying the last time this relay proxy configuration was modified - name required
string
: A human-friendly name for the relay proxy configuration - policy required
array
- items Policy
RelayProxyConfigs
- RelayProxyConfigs
object
- items
array
- items RelayProxyConfig
- items
Role
- Role
string
(values: writer, reader, admin, owner)
Rollout
- Rollout
object
- bucketBy
string
- variations
array
- items WeightedVariation
- bucketBy
Rule
- Rule
object
ScheduledChangesFeatureFlagConflict
- ScheduledChangesFeatureFlagConflict
object
- _id
string
: Feature flag scheduled change id this change will conflict with - reason
string
: Feature flag scheduled change conflict reason
- _id
SemanticPatchInstruction
- SemanticPatchInstruction
array
- items
object
- kind
string
: The name of the modification you would like to perform on a resource.
- kind
- items
SemanticPatchOperation
- SemanticPatchOperation
object
- comment
string
- instructions required SemanticPatchInstruction
- comment
Site
- Site
object
- href
string
- type
string
- href
Statement
- Statement
object
- actions
array
- items
string
: An action to perform on a resource.
- items
- effect
string
(values: allow, deny) - notActions
array
: Targeted actions will be those actions NOT in this list. The "actions" field must be empty to use this field.- items
string
: An action to perform on a resource.
- items
- notResources
array
: Targeted resource will be those resources NOT in this list. The "resources`" field must be empty to use this field.- items
string
: A resource specifier string
- items
- resources
array
- items
string
: A resource specifier string
- items
- actions
Stream
- Stream
object
- _links StreamUsageLinks
- metadata
array
- items StreamUsageMetadata
- series
array
- items StreamUsageSeries
StreamBySDK
- StreamBySDK
object
- _links StreamBySDKLinks
- metadata
array
- items StreamBySDKLinksMetadata
- series
array
- items StreamUsageSeries
StreamBySDKLinks
StreamBySDKLinksMetadata
- StreamBySDKLinksMetadata
object
- sdk
string
- source
string
- version
string
- sdk
StreamLinks
- StreamLinks
object
StreamSDKVersion
- StreamSDKVersion
object
- _links StreamBySDKLinks
- sdkVersions
array
- items StreamSDKVersionData
StreamSDKVersionData
- StreamSDKVersionData
object
- sdk
string
: The language of the sdk - version
string
: The version of the sdk
- sdk
StreamUsageError
- StreamUsageError
object
- code
string
- message
string
- code
StreamUsageLinks
- StreamUsageLinks
object
StreamUsageMetadata
- StreamUsageMetadata
object
- sdk
string
: The language of the sdk - source
string
- version
string
: The version of the SDK
- sdk
StreamUsageSeries
- StreamUsageSeries
object
- 0
integer
: A key corresponding to a time series data point. - time
integer
: A unix epoch time in milliseconds specifying the creation time of this flag.
- 0
Streams
- Streams
object
- _links StreamUsageLinks
Target
- Target
object
- values
array
- items
string
- items
- variation
integer
- values
Token
- Token
object
- _id Id
- _links Links
- _member Member
- creationDate
integer
: A unix epoch time in milliseconds specifying the creation time of this access token. - customRoleIds
array
: A list of custom role IDs to use as access limits for the access token- items
string
- items
- defaultApiVersion
integer
: The default API version for this token - inlineRole
array
- items Statement
- lastModified
integer
: A unix epoch time in milliseconds specifying the last time this access token was modified. - lastUsed
integer
: 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
- name
string
: A human-friendly name for the access token - ownerId 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.
Tokens
UnboundedSegmentTargetChanges
- UnboundedSegmentTargetChanges
object
- add
array
: Users to add to this list of targets- items
string
- items
- remove
array
: Users to remove from this list of targets- items
string
- items
- add
Usage
- Usage
object
- _links UsageLinks
- series
array
- items StreamUsageSeries
UsageError
- UsageError
object
- message
string
- message
UsageLinks
- UsageLinks
object
User
- User
object
- anonymous
boolean
- avatar
string
- country
string
- custom
object
- email
string
- firstName
string
- ip
string
- key
string
- lastName
string
- name
string
- secondary
string
- anonymous
UserFlagSetting
- UserFlagSetting
object
- _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.
UserFlagSettings
- UserFlagSettings
object
- _links Links
- items
object
UserRecord
UserSegment
- UserSegment
object
- _flags
array
- items FlagListItem
- _links Links
- creationDate required
integer
: A unix epoch time in milliseconds specifying the creation time of this flag. - description
string
: Description of the user segment. - excluded
array
: An array of user keys that should not be included in this segment, unless they are also listed in "included".- items
string
- items
- included
array
: An array of user keys that are included in this segment.- items
string
- items
- key required
string
: Unique identifier for the user segment. - name required
string
: Name of the user segment. - rules
array
: An array of rules that can cause a user to be included in this segment.- items UserSegmentRule
- tags
array
: An array of tags for this user segment.- items
string
- items
- 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
integer
- _flags
UserSegmentRule
- UserSegmentRule
object
- bucketBy
string
- clauses
array
- items Clause
- weight
integer
- bucketBy
UserSegments
- UserSegments
object
- _links Links
- items
array
- items UserSegment
UserTargetingExpirationForFlag
- UserTargetingExpirationForFlag
object
- _id
string
- _links Links
- _resourceId UserTargetingExpirationResourceIdForFlag
- _version
integer
- expirationDate
integer
: 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
- _id
UserTargetingExpirationForFlags
- UserTargetingExpirationForFlags
object
- _links Links
- items
array
UserTargetingExpirationForSegment
- UserTargetingExpirationForSegment
object
- _id
string
- _links Links
- _resourceId UserTargetingExpirationResourceIdForFlag
- _version
integer
- expirationDate
integer
: 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
- _id
UserTargetingExpirationOnFlagsForUser
- UserTargetingExpirationOnFlagsForUser
object
- _links Links
- items
array
UserTargetingExpirationResourceIdForFlag
- UserTargetingExpirationResourceIdForFlag
object
- environmentKey
string
- flagKey
string
- key
string
- kind
string
- projectKey
string
- environmentKey
Users
- Users
object
- _links Links
- items
array
- items UserRecord
- totalCount
number
Variation
- Variation
object
- _id
string
- description
string
- name
string
- value required
object
- _id
Webhook
- Webhook
object
- _id 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
array
- items Statement
- tags
array
: Tags assigned to this webhook.- items
string
- items
- url
string
: The URL of the remote webhook.
Webhooks
WeightedVariation
- WeightedVariation
object
- variation
integer
- weight
integer
- variation