❤
npm
Sign UpSign In

@datafire/launchdarkly

6.0.0 • Public • Published

@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

getRelayProxyConfigs

Returns a list of relay proxy configurations in the account.

launchdarkly.getRelayProxyConfigs(null, context)

Input

This action has no parameters

Output

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

Output

deleteRelayProxyConfig

Delete a relay proxy configuration by ID.

launchdarkly.deleteRelayProxyConfig({
  "id": ""
}, context)

Input

  • input object
    • id required string: The relay proxy configuration ID

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

Output

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

Output

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

Output

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.

Output

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.

Output

getDestinations

Returns a list of all data export destinations.

launchdarkly.getDestinations(null, context)

Input

This action has no parameters

Output

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.

Output

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.

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.

Output

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

Output

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.

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.

Output

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.

Output

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.

Output

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
      • temporary boolean: Whether or not the flag is a temporary flag.
      • variations required array: An array of possible variations for the flag.
    • 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.

Output

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.

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.

Output

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

Output

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.
      • includedActions array: Define the parts of the flag configuration that will be copied.
      • source FeatureFlagCopyObject
      • target FeatureFlagCopyObject

Output

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.

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

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

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.

Output

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
      • tags array: Tags for the integration subscription.
        • items string

Output

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.

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.

Output

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

Output

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.

Output

postMembers

Invite new members.

launchdarkly.postMembers({
  "membersBody": []
}, context)

Input

  • input object
    • membersBody required array
      • items object
        • customRoles array
          • items string: The 20-hexdigit id or the key for a custom role.
        • email required string
        • firstName string
        • inlineRole array
        • lastName string
        • role Role

Output

getMe

Get the current team member associated with the token

launchdarkly.getMe(null, context)

Input

This action has no parameters

Output

deleteMember

Delete a team member by ID.

launchdarkly.deleteMember({
  "memberId": ""
}, context)

Input

  • input object
    • memberId required string: The member ID.

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.

Output

patchMember

Modify a team member by ID.

launchdarkly.patchMember({
  "memberId": "",
  "patchDelta": []
}, context)

Input

  • input object
    • memberId required string: The member ID.
    • patchDelta required array

Output

getProjects

Returns a list of all projects in the account.

launchdarkly.getProjects(null, context)

Input

This action has no parameters

Output

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
      • includeInSnippetByDefault boolean
      • key required string
      • name required string
      • tags array
        • items string

Output

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.

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.

Output

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

Output

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

Output

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.

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.

Output

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

Output

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.

Output

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.

Output

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

Output

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.

Output

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

Output

getCustomRoles

Return a complete list of custom roles.

launchdarkly.getCustomRoles(null, context)

Input

This action has no parameters

Output

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

Output

deleteCustomRole

Delete a custom role by key.

launchdarkly.deleteCustomRole({
  "customRoleKey": ""
}, context)

Input

  • input object
    • customRoleKey required string: The custom role key.

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.

Output

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

Output

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.

Output

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
      • 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.

Output

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.

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.

Output

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

Output

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

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.

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

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.

Output

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
      • defaultApiVersion integer: The default API version for this token
      • inlineRole array
      • 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

Output

deleteToken

Delete an access token by ID.

launchdarkly.deleteToken({
  "tokenId": ""
}, context)

Input

  • input object
    • tokenId required string: The access token ID.

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.

Output

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

Output

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.

Output

getUsage

Returns of the usage endpoints available.

launchdarkly.getUsage(null, context)

Input

This action has no parameters

Output

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.

Output

getEvents

Get events usage endpoints.

launchdarkly.getEvents(null, context)

Input

This action has no parameters

Output

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.

Output

getMAU

Get monthly active user data.

launchdarkly.getMAU(null, context)

Input

This action has no parameters

Output

getMAUByCategory

Get monthly active user data by category.

launchdarkly.getMAUByCategory(null, context)

Input

This action has no parameters

Output

getStreams

Returns a list of all streams.

launchdarkly.getStreams(null, context)

Input

This action has no parameters

Output

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.

Output

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.

Output

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.

Output

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.

Output

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.

Output

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.

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.

Output

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.

Output

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.

Output

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.

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.

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

Output

getWebhooks

Fetch a list of all webhooks.

launchdarkly.getWebhooks(null, context)

Input

This action has no parameters

Output

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
      • tags array: Tags for the webhook.
        • items string
      • url required string: The URL of the remote webhook.

Output

deleteWebhook

Delete a webhook by ID.

launchdarkly.deleteWebhook({
  "resourceId": ""
}, context)

Input

  • input object
    • resourceId required string: The resource ID.

Output

Output schema unknown

getWebhook

Get a webhook by ID.

launchdarkly.getWebhook({
  "resourceId": ""
}, context)

Input

  • input object
    • resourceId required string: The resource ID.

Output

patchWebhook

Modify a webhook by ID.

launchdarkly.patchWebhook({
  "resourceId": "",
  "patchDelta": []
}, context)

Input

  • input object
    • resourceId required string: The resource ID.
    • patchDelta required array

Output

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.

Output

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

Output

Definitions

AuditLogEntries

AuditLogEntry

  • AuditLogEntry object
    • _id Id
    • _links Links
    • comment string
    • date integer
    • description string
    • kind string
    • member Member
    • name string
    • shortDescription string
    • target object
      • _links Links
      • name string
      • resources array
        • items string
    • title string
    • titleVerb string

Clause

  • Clause object
    • _id string
    • attribute string
    • negate boolean
    • op string
    • values array
      • items object

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.

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

CustomPropertyValues

  • CustomPropertyValues array: Values for this property.
    • items string

CustomRole

  • CustomRole object
    • _id 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 array

CustomRoles

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).

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

DestinationAmazonKinesis

  • DestinationAmazonKinesis object
    • region string
    • roleArn string
    • streamName string

DestinationGooglePubSub

  • DestinationGooglePubSub object
    • project string
    • topic string

DestinationMParticle

  • DestinationMParticle object
    • apiKey string
    • environment string
    • secret string
    • userIdentity string

DestinationSegment

  • DestinationSegment object
    • writeKey string

Destinations

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

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

EvaluationUsageError

  • EvaluationUsageError object
    • code string
    • message string

Events

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
    • 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
    • temporary boolean: Whether or not this flag is temporary.
    • variations array: The variations for this feature flag.

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
    • requestorId string: The id of the member that requested the change
    • reviewStatus FeatureFlagChangeRequestReviewStatus
    • status string (values: pending, completed, failed): | Name | Description |

FeatureFlagChangeRequestReview

  • FeatureFlagChangeRequestReview object

FeatureFlagChangeRequestReviewStatus

  • FeatureFlagChangeRequestReviewStatus string (values: pending, approved, declined): | Name | Description |

FeatureFlagChangeRequests

FeatureFlagConfig

  • FeatureFlagConfig object
    • _environmentName string
    • _site Site
    • archived boolean
    • fallthrough Fallthrough
    • lastModified integer
    • offVariation integer
    • on boolean
    • prerequisites array
    • rules array
    • salt string
    • sel string
    • targets array
    • 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

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.

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

FeatureFlagScheduledChanges

FeatureFlagScheduledChangesConflicts

  • FeatureFlagScheduledChangesConflicts object

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 |

FeatureFlagStatuses

FeatureFlags

  • FeatureFlags object

FlagListItem

  • FlagListItem object
    • _links Links
    • _site Site
    • key string
    • name string

HierarchicalLinks

  • HierarchicalLinks object

Id

  • Id string: The unique resource id.

Integration

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
    • 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
    • tags array: An array of tags for this integration configuration.
      • items string

Integrations

  • Integrations object
    • _links object: A mapping of integration types to their respective API endpoints.
    • items array

Link

  • Link object
    • href string
    • type string

Links

MAU

MAUMetadata

  • MAUMetadata object

MAUbyCategory

Member

  • Member object
    • _id Id
    • _links Links
    • _pendingInvite boolean
    • _verified boolean
    • customRoles array
      • items Id
    • email string
    • firstName string
    • isBeta boolean
    • lastName string
    • role Role

Members

  • Members object
    • _links Links
    • items array
    • totalCount number

PatchOperation

  • PatchOperation object
    • op required string
    • path required string
    • value required object

Policy

  • Policy object
    • actions array
      • items string: An action to perform on a resource.
    • 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.
    • 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
    • resources array
      • items string: A resource specifier string

Prerequisite

  • Prerequisite object
    • key string
    • variation integer

Project

  • Project object
    • _id Id
    • _links Links
    • defaultClientSideAvailability ClientSideAvailability
    • environments array
    • includeInSnippetByDefault boolean
    • key string
    • name string
    • tags array: An array of tags for this project.
      • items string

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

RelayProxyConfigs

Role

  • Role string (values: writer, reader, admin, owner)

Rollout

Rule

  • Rule object
    • _id string
    • clauses array
    • description string
    • rollout Rollout
    • trackEvents boolean
    • variation integer

ScheduledChangesFeatureFlagConflict

  • ScheduledChangesFeatureFlagConflict object
    • _id string: Feature flag scheduled change id this change will conflict with
    • reason string: Feature flag scheduled change conflict reason

SemanticPatchInstruction

  • SemanticPatchInstruction array
    • items object
      • kind string: The name of the modification you would like to perform on a resource.

SemanticPatchOperation

Site

  • Site object
    • href string
    • type string

Statement

  • Statement object
    • actions array
      • items string: An action to perform on a resource.
    • 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.
    • 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
    • resources array
      • items string: A resource specifier string

Stream

StreamBySDK

StreamBySDKLinks

  • StreamBySDKLinks object

StreamBySDKLinksMetadata

  • StreamBySDKLinksMetadata object
    • sdk string
    • source string
    • version string

StreamLinks

  • StreamLinks object
    • parent Link
    • self Link
    • subseries array: Links to endpoints that are in the request path.

StreamSDKVersion

StreamSDKVersionData

  • StreamSDKVersionData object
    • sdk string: The language of the sdk
    • version string: The version of the sdk

StreamUsageError

  • StreamUsageError object
    • code string
    • message string

StreamUsageLinks

  • StreamUsageLinks object
    • parent Link
    • self Link
    • subseries array: The following links that are in the response.

StreamUsageMetadata

  • StreamUsageMetadata object
    • sdk string: The language of the sdk
    • source string
    • version string: The version of the 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.

Streams

Target

  • Target object
    • values array
      • items string
    • variation integer

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
    • defaultApiVersion integer: The default API version for this token
    • inlineRole array
    • 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

  • Tokens object

UnboundedSegmentTargetChanges

  • UnboundedSegmentTargetChanges object
    • add array: Users to add to this list of targets
      • items string
    • remove array: Users to remove from this list of targets
      • items string

Usage

UsageError

  • UsageError object
    • message string

UsageLinks

  • UsageLinks object
    • parent Link
    • self Link
    • subseries array: The following links that are in the response.

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

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

  • UserRecord object
    • avatar string
    • environmentId string
    • lastPing string
    • ownerId Id
    • user User

UserSegment

  • UserSegment object
    • _flags array
    • _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
    • included array: An array of user keys that are included in this segment.
      • items string
    • 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.
    • tags array: An array of tags for this user segment.
      • items string
    • 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

UserSegmentRule

  • UserSegmentRule object
    • bucketBy string
    • clauses array
    • weight integer

UserSegments

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

UserTargetingExpirationForFlags

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

UserTargetingExpirationOnFlagsForUser

UserTargetingExpirationResourceIdForFlag

  • UserTargetingExpirationResourceIdForFlag object
    • environmentKey string
    • flagKey string
    • key string
    • kind string
    • projectKey string

Users

Variation

  • Variation object
    • _id string
    • description string
    • name string
    • value required object

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
    • tags array: Tags assigned to this webhook.
      • items string
    • url string: The URL of the remote webhook.

Webhooks

WeightedVariation

  • WeightedVariation object
    • variation integer
    • weight integer

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/launchdarkly

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

0

Version

6.0.0

License

MIT

Unpacked Size

254 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware