launchdarkly_api 5.4.0 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/README.md +841 -263
- data/Rakefile +2 -0
- data/docs/AccessDeniedReasonRep.md +28 -0
- data/docs/AccessDeniedRep.md +20 -0
- data/docs/AccessRep.md +18 -0
- data/docs/AccessTokenPost.md +30 -0
- data/docs/AccessTokensApi.md +239 -126
- data/docs/AccountMembersApi.md +450 -0
- data/docs/AccountUsageBetaApi.md +647 -0
- data/docs/ActionInputRep.md +18 -0
- data/docs/ActionOutputRep.md +20 -0
- data/docs/ApprovalConditionInputRep.md +20 -0
- data/docs/ApprovalConditionOutputRep.md +26 -0
- data/docs/ApprovalSettings.md +32 -0
- data/docs/ApprovalsApi.md +554 -0
- data/docs/AuditLogApi.md +93 -55
- data/docs/AuditLogEntryListingRep.md +52 -0
- data/docs/AuditLogEntryListingRepCollection.md +20 -0
- data/docs/AuditLogEntryRep.md +64 -0
- data/docs/AuthorizedAppDataRep.md +26 -0
- data/docs/BigSegmentTarget.md +22 -0
- data/docs/BranchCollectionRep.md +20 -0
- data/docs/BranchRep.md +28 -0
- data/docs/Clause.md +21 -7
- data/docs/ClientSideAvailability.md +15 -4
- data/docs/ClientSideAvailabilityPost.md +20 -0
- data/docs/CodeReferencesApi.md +980 -0
- data/docs/ConditionBaseOutputRep.md +22 -0
- data/docs/ConditionInputRep.md +26 -0
- data/docs/ConditionOutputRep.md +34 -0
- data/docs/ConfidenceIntervalRep.md +20 -0
- data/docs/Conflict.md +20 -0
- data/docs/ConflictOutputRep.md +20 -0
- data/docs/CopiedFromEnv.md +20 -0
- data/docs/CreateCopyFlagConfigApprovalRequestRequest.md +28 -0
- data/docs/CreateFlagConfigApprovalRequestRequest.md +30 -0
- data/docs/CustomProperty.md +15 -4
- data/docs/CustomRole.md +27 -8
- data/docs/CustomRolePost.md +26 -0
- data/docs/CustomRolePostData.md +26 -0
- data/docs/CustomRoles.md +15 -4
- data/docs/CustomRolesApi.md +196 -100
- data/docs/CustomRolesRep.md +24 -0
- data/docs/CustomWorkflowInputRep.md +24 -0
- data/docs/CustomWorkflowMeta.md +20 -0
- data/docs/CustomWorkflowOutputRep.md +38 -0
- data/docs/CustomWorkflowStageMeta.md +20 -0
- data/docs/CustomWorkflowsListingOutputRep.md +18 -0
- data/docs/DataExportDestinationsApi.md +205 -117
- data/docs/DefaultClientSideAvailabilityPost.md +20 -0
- data/docs/Defaults.md +15 -4
- data/docs/DependentFlag.md +19 -6
- data/docs/DependentFlagEnvironment.md +19 -6
- data/docs/DependentFlagsByEnvironment.md +17 -5
- data/docs/DerivedAttribute.md +20 -0
- data/docs/Destination.md +27 -9
- data/docs/DestinationPost.md +24 -0
- data/docs/Destinations.md +15 -4
- data/docs/Environment.md +39 -16
- data/docs/EnvironmentPost.md +29 -11
- data/docs/EnvironmentsApi.md +246 -144
- data/docs/ExecutionOutputRep.md +18 -0
- data/docs/ExpandedTeamRep.md +44 -0
- data/docs/ExperimentAllocationRep.md +20 -0
- data/docs/ExperimentEnabledPeriodRep.md +20 -0
- data/docs/ExperimentEnvironmentSettingRep.md +22 -0
- data/docs/ExperimentInfoRep.md +20 -0
- data/docs/ExperimentMetadataRep.md +18 -0
- data/docs/ExperimentRep.md +24 -0
- data/docs/ExperimentResultsRep.md +30 -0
- data/docs/ExperimentStatsRep.md +24 -0
- data/docs/ExperimentTimeSeriesSlice.md +20 -0
- data/docs/ExperimentTimeSeriesVariationSlice.md +32 -0
- data/docs/ExperimentTotalsRep.md +32 -0
- data/docs/ExperimentsBetaApi.md +168 -0
- data/docs/ExpiringUserTargetError.md +20 -0
- data/docs/ExpiringUserTargetGetResponse.md +20 -0
- data/docs/ExpiringUserTargetItem.md +30 -0
- data/docs/ExpiringUserTargetPatchResponse.md +28 -0
- data/docs/Extinction.md +26 -0
- data/docs/ExtinctionCollectionRep.md +20 -0
- data/docs/FeatureFlag.md +55 -22
- data/docs/FeatureFlagBody.md +33 -11
- data/docs/FeatureFlagConfig.md +47 -17
- data/docs/FeatureFlagScheduledChange.md +27 -6
- data/docs/FeatureFlagScheduledChanges.md +15 -4
- data/docs/FeatureFlagStatus.md +17 -6
- data/docs/FeatureFlagStatusAcrossEnvironments.md +17 -5
- data/docs/FeatureFlagStatuses.md +15 -4
- data/docs/FeatureFlags.md +17 -5
- data/docs/FeatureFlagsApi.md +449 -1184
- data/docs/FeatureFlagsBetaApi.md +157 -0
- data/docs/FlagConfigApprovalRequestResponse.md +56 -0
- data/docs/FlagConfigApprovalRequestsResponse.md +20 -0
- data/docs/FlagCopyConfigEnvironment.md +20 -0
- data/docs/FlagCopyConfigPost.md +26 -0
- data/docs/FlagGlobalAttributesRep.md +58 -0
- data/docs/FlagListingRep.md +24 -0
- data/docs/FlagScheduledChangesInput.md +20 -0
- data/docs/FlagStatusRep.md +24 -0
- data/docs/FlagSummary.md +18 -0
- data/docs/FlagTriggerInput.md +20 -0
- data/docs/FlagTriggersApi.md +396 -0
- data/docs/ForbiddenErrorRep.md +20 -0
- data/docs/HunkRep.md +26 -0
- data/docs/Integration.md +35 -4
- data/docs/IntegrationAuditLogSubscriptionsApi.md +376 -0
- data/docs/IntegrationMetadata.md +24 -0
- data/docs/IntegrationStatus.md +20 -0
- data/docs/IntegrationStatusRep.md +22 -0
- data/docs/IntegrationSubscriptionStatusRep.md +26 -0
- data/docs/Integrations.md +17 -4
- data/docs/InvalidRequestErrorRep.md +20 -0
- data/docs/IpList.md +20 -0
- data/docs/LastSeenMetadata.md +18 -0
- data/docs/Link.md +15 -4
- data/docs/Member.md +47 -14
- data/docs/MemberDataRep.md +26 -0
- data/docs/MemberImportItemRep.md +22 -0
- data/docs/MemberPermissionGrantSummaryRep.md +22 -0
- data/docs/MemberSummaryRep.md +28 -0
- data/docs/MemberTeamSummaryRep.md +22 -0
- data/docs/MemberTeamsFormPost.md +18 -0
- data/docs/Members.md +17 -5
- data/docs/MethodNotAllowedErrorRep.md +20 -0
- data/docs/MetricCollectionRep.md +20 -0
- data/docs/MetricListingRep.md +52 -0
- data/docs/MetricPost.md +40 -0
- data/docs/MetricRep.md +62 -0
- data/docs/MetricSeen.md +20 -0
- data/docs/MetricsApi.md +376 -0
- data/docs/Modification.md +18 -0
- data/docs/MultiEnvironmentDependentFlag.md +17 -7
- data/docs/MultiEnvironmentDependentFlags.md +17 -5
- data/docs/NewMemberForm.md +28 -0
- data/docs/NotFoundErrorRep.md +20 -0
- data/docs/OtherApi.md +282 -0
- data/docs/ParentResourceRep.md +22 -0
- data/docs/PatchFailedErrorRep.md +20 -0
- data/docs/PatchOperation.md +17 -5
- data/docs/PatchSegmentInstruction.md +26 -0
- data/docs/PatchSegmentRequest.md +20 -0
- data/docs/PatchWithComment.md +20 -0
- data/docs/PermissionGrantInput.md +22 -0
- data/docs/PermissionGrantRep.md +24 -0
- data/docs/PostApprovalRequestApplyRequest.md +18 -0
- data/docs/PostApprovalRequestReviewRequest.md +20 -0
- data/docs/PostFlagScheduledChangesInput.md +22 -0
- data/docs/Prerequisite.md +15 -4
- data/docs/Project.md +27 -10
- data/docs/ProjectListingRep.md +30 -0
- data/docs/ProjectPost.md +28 -0
- data/docs/Projects.md +15 -4
- data/docs/ProjectsApi.md +196 -100
- data/docs/PubNubDetailRep.md +20 -0
- data/docs/PutBranch.md +28 -0
- data/docs/RateLimitedErrorRep.md +20 -0
- data/docs/RecentTriggerBody.md +20 -0
- data/docs/ReferenceRep.md +22 -0
- data/docs/RelayAutoConfigCollectionRep.md +18 -0
- data/docs/RelayAutoConfigPost.md +20 -0
- data/docs/RelayAutoConfigRep.md +34 -0
- data/docs/RelayProxyConfigurationsApi.md +244 -129
- data/docs/RepositoryCollectionRep.md +20 -0
- data/docs/RepositoryPost.md +28 -0
- data/docs/RepositoryRep.md +38 -0
- data/docs/ResourceAccess.md +20 -0
- data/docs/ResourceIDResponse.md +26 -0
- data/docs/ReviewOutputRep.md +26 -0
- data/docs/ReviewResponse.md +26 -0
- data/docs/Rollout.md +19 -4
- data/docs/Rule.md +25 -8
- data/docs/ScheduleConditionInputRep.md +20 -0
- data/docs/ScheduleConditionOutputRep.md +18 -0
- data/docs/ScheduledChangesApi.md +404 -0
- data/docs/SdkListRep.md +20 -0
- data/docs/SdkVersionListRep.md +20 -0
- data/docs/SdkVersionRep.md +20 -0
- data/docs/SegmentBody.md +26 -0
- data/docs/SegmentMetadata.md +28 -0
- data/docs/SegmentUserList.md +20 -0
- data/docs/SegmentUserState.md +20 -0
- data/docs/SegmentsApi.md +695 -0
- data/docs/SeriesListRep.md +22 -0
- data/docs/SourceFlag.md +20 -0
- data/docs/StageInputRep.md +22 -0
- data/docs/StageOutputRep.md +26 -0
- data/docs/Statement.md +21 -7
- data/docs/StatementPost.md +26 -0
- data/docs/StatementPostData.md +26 -0
- data/docs/StatementRep.md +26 -0
- data/docs/StatisticCollectionRep.md +20 -0
- data/docs/StatisticRep.md +30 -0
- data/docs/StatisticsRoot.md +20 -0
- data/docs/StatusConflictErrorRep.md +20 -0
- data/docs/SubjectDataRep.md +22 -0
- data/docs/SubscriptionPost.md +30 -0
- data/docs/Target.md +15 -4
- data/docs/TargetResourceRep.md +22 -0
- data/docs/TeamCollectionRep.md +22 -0
- data/docs/TeamImportsRep.md +18 -0
- data/docs/TeamPatchInput.md +20 -0
- data/docs/TeamPostInput.md +28 -0
- data/docs/TeamRep.md +40 -0
- data/docs/TeamsBetaApi.md +450 -0
- data/docs/TitleRep.md +32 -0
- data/docs/Token.md +43 -17
- data/docs/TokenDataRep.md +26 -0
- data/docs/Tokens.md +15 -4
- data/docs/TriggerPost.md +22 -0
- data/docs/TriggerWorkflowCollectionRep.md +20 -0
- data/docs/TriggerWorkflowRep.md +42 -0
- data/docs/UnauthorizedErrorRep.md +20 -0
- data/docs/UrlPost.md +24 -0
- data/docs/User.md +37 -13
- data/docs/UserAttributeNamesRep.md +22 -0
- data/docs/UserFlagSetting.md +17 -5
- data/docs/UserFlagSettings.md +15 -4
- data/docs/UserRecord.md +25 -7
- data/docs/UserRecordRep.md +26 -0
- data/docs/UserSegment.md +49 -14
- data/docs/UserSegmentRule.md +19 -5
- data/docs/UserSegments.md +15 -4
- data/docs/UserSettingsApi.md +217 -137
- data/docs/Users.md +17 -5
- data/docs/UsersApi.md +187 -114
- data/docs/UsersBetaApi.md +81 -0
- data/docs/ValuePut.md +20 -0
- data/docs/Variation.md +19 -6
- data/docs/VariationOrRolloutRep.md +20 -0
- data/docs/VariationSummary.md +30 -0
- data/docs/VersionsRep.md +24 -0
- data/docs/Webhook.md +29 -10
- data/docs/WebhookPost.md +30 -0
- data/docs/Webhooks.md +15 -4
- data/docs/WebhooksApi.md +199 -103
- data/docs/WeightedVariation.md +17 -4
- data/docs/WorkflowsBetaApi.md +316 -0
- data/git_push.sh +13 -11
- data/launchdarkly_api.gemspec +8 -16
- data/lib/launchdarkly_api/api/access_tokens_api.rb +198 -122
- data/lib/launchdarkly_api/api/account_members_api.rb +433 -0
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
- data/lib/launchdarkly_api/api/approvals_api.rb +615 -0
- data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
- data/lib/launchdarkly_api/api/code_references_api.rb +929 -0
- data/lib/launchdarkly_api/api/custom_roles_api.rb +170 -105
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +210 -145
- data/lib/launchdarkly_api/api/environments_api.rb +205 -132
- data/lib/launchdarkly_api/api/experiments_beta_api.rb +190 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +501 -1393
- data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
- data/lib/launchdarkly_api/api/flag_triggers_api.rb +437 -0
- data/lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb +377 -0
- data/lib/launchdarkly_api/api/metrics_api.rb +377 -0
- data/lib/launchdarkly_api/api/other_api.rb +248 -0
- data/lib/launchdarkly_api/api/projects_api.rb +155 -90
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +203 -127
- data/lib/launchdarkly_api/api/scheduled_changes_api.rb +443 -0
- data/lib/launchdarkly_api/api/segments_api.rb +735 -0
- data/lib/launchdarkly_api/api/teams_beta_api.rb +427 -0
- data/lib/launchdarkly_api/api/user_settings_api.rb +245 -180
- data/lib/launchdarkly_api/api/users_api.rb +185 -135
- data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
- data/lib/launchdarkly_api/api/webhooks_api.rb +178 -113
- data/lib/launchdarkly_api/api/workflows_beta_api.rb +345 -0
- data/lib/launchdarkly_api/api_client.rb +90 -91
- data/lib/launchdarkly_api/api_error.rb +23 -4
- data/lib/launchdarkly_api/configuration.rb +85 -16
- data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +280 -0
- data/lib/launchdarkly_api/models/access_denied_rep.rb +237 -0
- data/lib/launchdarkly_api/models/access_rep.rb +225 -0
- data/lib/launchdarkly_api/models/access_token_post.rb +317 -0
- data/lib/launchdarkly_api/models/action_input_rep.rb +219 -0
- data/lib/launchdarkly_api/models/action_output_rep.rb +239 -0
- data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +229 -0
- data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +278 -0
- data/lib/launchdarkly_api/models/approval_settings.rb +331 -0
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +420 -0
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +241 -0
- data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +481 -0
- data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/big_segment_target.rb +254 -0
- data/lib/launchdarkly_api/models/branch_collection_rep.rb +242 -0
- data/lib/launchdarkly_api/models/branch_rep.rb +291 -0
- data/lib/launchdarkly_api/models/clause.rb +78 -24
- data/lib/launchdarkly_api/models/client_side_availability.rb +65 -33
- data/lib/launchdarkly_api/models/client_side_availability_post.rb +237 -0
- data/lib/launchdarkly_api/models/condition_base_output_rep.rb +246 -0
- data/lib/launchdarkly_api/models/condition_input_rep.rb +256 -0
- data/lib/launchdarkly_api/models/condition_output_rep.rb +324 -0
- data/lib/launchdarkly_api/models/confidence_interval_rep.rb +227 -0
- data/lib/launchdarkly_api/models/conflict.rb +230 -0
- data/lib/launchdarkly_api/models/conflict_output_rep.rb +237 -0
- data/lib/launchdarkly_api/models/copied_from_env.rb +233 -0
- data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +286 -0
- data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +297 -0
- data/lib/launchdarkly_api/models/custom_property.rb +59 -23
- data/lib/launchdarkly_api/models/custom_role.rb +125 -49
- data/lib/launchdarkly_api/models/custom_role_post.rb +274 -0
- data/lib/launchdarkly_api/models/custom_role_post_data.rb +274 -0
- data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
- data/lib/launchdarkly_api/models/custom_roles_rep.rb +247 -0
- data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +252 -0
- data/lib/launchdarkly_api/models/custom_workflow_meta.rb +227 -0
- data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +354 -0
- data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +227 -0
- data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +225 -0
- data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +237 -0
- data/lib/launchdarkly_api/models/defaults.rb +56 -25
- data/lib/launchdarkly_api/models/dependent_flag.rb +76 -25
- data/lib/launchdarkly_api/models/dependent_flag_environment.rb +76 -25
- data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +75 -24
- data/lib/launchdarkly_api/models/derived_attribute.rb +228 -0
- data/lib/launchdarkly_api/models/destination.rb +88 -47
- data/lib/launchdarkly_api/models/destination_post.rb +281 -0
- data/lib/launchdarkly_api/models/destinations.rb +58 -22
- data/lib/launchdarkly_api/models/environment.rb +167 -68
- data/lib/launchdarkly_api/models/environment_post.rb +90 -56
- data/lib/launchdarkly_api/models/execution_output_rep.rb +223 -0
- data/lib/launchdarkly_api/models/expanded_team_rep.rb +349 -0
- data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +237 -0
- data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +227 -0
- data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +238 -0
- data/lib/launchdarkly_api/models/experiment_info_rep.rb +239 -0
- data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +219 -0
- data/lib/launchdarkly_api/models/experiment_rep.rb +249 -0
- data/lib/launchdarkly_api/models/experiment_results_rep.rb +280 -0
- data/lib/launchdarkly_api/models/experiment_stats_rep.rb +245 -0
- data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +229 -0
- data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +281 -0
- data/lib/launchdarkly_api/models/experiment_totals_rep.rb +281 -0
- data/lib/launchdarkly_api/models/expiring_user_target_error.rb +237 -0
- data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +236 -0
- data/lib/launchdarkly_api/models/expiring_user_target_item.rb +300 -0
- data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +274 -0
- data/lib/launchdarkly_api/models/extinction.rb +283 -0
- data/lib/launchdarkly_api/models/extinction_collection_rep.rb +242 -0
- data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
- data/lib/launchdarkly_api/models/feature_flag_body.rb +104 -54
- data/lib/launchdarkly_api/models/feature_flag_config.rb +184 -55
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +142 -38
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +73 -32
- data/lib/launchdarkly_api/models/feature_flag_status.rb +70 -71
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +71 -33
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +64 -23
- data/lib/launchdarkly_api/models/feature_flags.rb +78 -32
- data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +457 -0
- data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +242 -0
- data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +232 -0
- data/lib/launchdarkly_api/models/flag_copy_config_post.rb +290 -0
- data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +514 -0
- data/lib/launchdarkly_api/models/flag_listing_rep.rb +257 -0
- data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +234 -0
- data/lib/launchdarkly_api/models/flag_status_rep.rb +256 -0
- data/lib/launchdarkly_api/models/flag_summary.rb +223 -0
- data/lib/launchdarkly_api/models/flag_trigger_input.rb +230 -0
- data/lib/launchdarkly_api/models/forbidden_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/hunk_rep.rb +266 -0
- data/lib/launchdarkly_api/models/integration.rb +159 -29
- data/lib/launchdarkly_api/models/integration_metadata.rb +265 -0
- data/lib/launchdarkly_api/models/integration_status.rb +237 -0
- data/lib/launchdarkly_api/models/integration_status_rep.rb +236 -0
- data/lib/launchdarkly_api/models/integration_subscription_status_rep.rb +256 -0
- data/lib/launchdarkly_api/models/integrations.rb +71 -27
- data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/ip_list.rb +241 -0
- data/lib/launchdarkly_api/models/last_seen_metadata.rb +219 -0
- data/lib/launchdarkly_api/models/link.rb +54 -20
- data/lib/launchdarkly_api/models/member.rb +227 -67
- data/lib/launchdarkly_api/models/member_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/member_import_item_rep.rb +246 -0
- data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +253 -0
- data/lib/launchdarkly_api/models/member_summary_rep.rb +285 -0
- data/lib/launchdarkly_api/models/member_team_summary_rep.rb +253 -0
- data/lib/launchdarkly_api/models/member_teams_form_post.rb +226 -0
- data/lib/launchdarkly_api/models/members.rb +78 -32
- data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/metric_collection_rep.rb +231 -0
- data/lib/launchdarkly_api/models/metric_listing_rep.rb +456 -0
- data/lib/launchdarkly_api/models/metric_post.rb +380 -0
- data/lib/launchdarkly_api/models/metric_rep.rb +505 -0
- data/lib/launchdarkly_api/models/metric_seen.rb +227 -0
- data/lib/launchdarkly_api/models/modification.rb +218 -0
- data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +69 -43
- data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +75 -24
- data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
- data/lib/launchdarkly_api/models/not_found_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -0
- data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/patch_operation.rb +59 -26
- data/lib/launchdarkly_api/models/patch_segment_instruction.rb +273 -0
- data/lib/launchdarkly_api/models/patch_segment_request.rb +236 -0
- data/lib/launchdarkly_api/models/patch_with_comment.rb +234 -0
- data/lib/launchdarkly_api/models/permission_grant_input.rb +240 -0
- data/lib/launchdarkly_api/models/permission_grant_rep.rb +249 -0
- data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +218 -0
- data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +227 -0
- data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +248 -0
- data/lib/launchdarkly_api/models/prerequisite.rb +64 -20
- data/lib/launchdarkly_api/models/project.rb +120 -50
- data/lib/launchdarkly_api/models/project_listing_rep.rb +306 -0
- data/lib/launchdarkly_api/models/project_post.rb +281 -0
- data/lib/launchdarkly_api/models/projects.rb +70 -22
- data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +227 -0
- data/lib/launchdarkly_api/models/put_branch.rb +284 -0
- data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/recent_trigger_body.rb +229 -0
- data/lib/launchdarkly_api/models/reference_rep.rb +250 -0
- data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +225 -0
- data/lib/launchdarkly_api/models/relay_auto_config_post.rb +240 -0
- data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +327 -0
- data/lib/launchdarkly_api/models/repository_collection_rep.rb +242 -0
- data/lib/launchdarkly_api/models/repository_post.rb +306 -0
- data/lib/launchdarkly_api/models/repository_rep.rb +385 -0
- data/lib/launchdarkly_api/models/resource_access.rb +228 -0
- data/lib/launchdarkly_api/models/resource_id_response.rb +254 -0
- data/lib/launchdarkly_api/models/review_output_rep.rb +264 -0
- data/lib/launchdarkly_api/models/review_response.rb +302 -0
- data/lib/launchdarkly_api/models/rollout.rb +89 -32
- data/lib/launchdarkly_api/models/rule.rb +89 -36
- data/lib/launchdarkly_api/models/schedule_condition_input_rep.rb +227 -0
- data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +218 -0
- data/lib/launchdarkly_api/models/sdk_list_rep.rb +241 -0
- data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +241 -0
- data/lib/launchdarkly_api/models/sdk_version_rep.rb +237 -0
- data/lib/launchdarkly_api/models/segment_body.rb +270 -0
- data/lib/launchdarkly_api/models/segment_metadata.rb +263 -0
- data/lib/launchdarkly_api/models/segment_user_list.rb +231 -0
- data/lib/launchdarkly_api/models/segment_user_state.rb +227 -0
- data/lib/launchdarkly_api/models/series_list_rep.rb +257 -0
- data/lib/launchdarkly_api/models/source_flag.rb +233 -0
- data/lib/launchdarkly_api/models/stage_input_rep.rb +238 -0
- data/lib/launchdarkly_api/models/stage_output_rep.rb +276 -0
- data/lib/launchdarkly_api/models/statement.rb +68 -61
- data/lib/launchdarkly_api/models/statement_post.rb +281 -0
- data/lib/launchdarkly_api/models/statement_post_data.rb +281 -0
- data/lib/launchdarkly_api/models/statement_rep.rb +271 -0
- data/lib/launchdarkly_api/models/statistic_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/statistic_rep.rb +309 -0
- data/lib/launchdarkly_api/models/statistics_root.rb +229 -0
- data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/subject_data_rep.rb +238 -0
- data/lib/launchdarkly_api/models/subscription_post.rb +293 -0
- data/lib/launchdarkly_api/models/target.rb +64 -20
- data/lib/launchdarkly_api/models/target_resource_rep.rb +240 -0
- data/lib/launchdarkly_api/models/team_collection_rep.rb +240 -0
- data/lib/launchdarkly_api/models/team_imports_rep.rb +220 -0
- data/lib/launchdarkly_api/models/team_patch_input.rb +229 -0
- data/lib/launchdarkly_api/models/team_post_input.rb +285 -0
- data/lib/launchdarkly_api/models/team_rep.rb +327 -0
- data/lib/launchdarkly_api/models/title_rep.rb +281 -0
- data/lib/launchdarkly_api/models/token.rb +159 -93
- data/lib/launchdarkly_api/models/token_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/tokens.rb +68 -32
- data/lib/launchdarkly_api/models/trigger_post.rb +245 -0
- data/lib/launchdarkly_api/models/trigger_workflow_collection_rep.rb +231 -0
- data/lib/launchdarkly_api/models/trigger_workflow_rep.rb +332 -0
- data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/url_post.rb +279 -0
- data/lib/launchdarkly_api/models/user.rb +95 -37
- data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +245 -0
- data/lib/launchdarkly_api/models/user_flag_setting.rb +68 -27
- data/lib/launchdarkly_api/models/user_flag_settings.rb +78 -32
- data/lib/launchdarkly_api/models/user_record.rb +89 -34
- data/lib/launchdarkly_api/models/user_record_rep.rb +255 -0
- data/lib/launchdarkly_api/models/user_segment.rb +195 -69
- data/lib/launchdarkly_api/models/user_segment_rule.rb +71 -23
- data/lib/launchdarkly_api/models/user_segments.rb +78 -32
- data/lib/launchdarkly_api/models/users.rb +71 -25
- data/lib/launchdarkly_api/models/value_put.rb +229 -0
- data/lib/launchdarkly_api/models/variation.rb +70 -38
- data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +227 -0
- data/lib/launchdarkly_api/models/variation_summary.rb +287 -0
- data/lib/launchdarkly_api/models/versions_rep.rb +262 -0
- data/lib/launchdarkly_api/models/webhook.rb +120 -55
- data/lib/launchdarkly_api/models/webhook_post.rb +297 -0
- data/lib/launchdarkly_api/models/webhooks.rb +68 -22
- data/lib/launchdarkly_api/models/weighted_variation.rb +77 -24
- data/lib/launchdarkly_api/version.rb +5 -5
- data/lib/launchdarkly_api.rb +178 -95
- data/spec/api/access_tokens_api_spec.rb +23 -17
- data/spec/api/account_members_api_spec.rb +112 -0
- data/spec/api/account_usage_beta_api_spec.rb +156 -0
- data/spec/api/approvals_api_spec.rb +141 -0
- data/spec/api/audit_log_api_spec.rb +19 -17
- data/spec/api/code_references_api_spec.rb +208 -0
- data/spec/api/custom_roles_api_spec.rb +22 -17
- data/spec/api/data_export_destinations_api_spec.rb +30 -25
- data/spec/api/environments_api_spec.rb +31 -26
- data/spec/api/experiments_beta_api_spec.rb +67 -0
- data/spec/api/feature_flags_api_spec.rb +69 -267
- data/spec/api/feature_flags_beta_api_spec.rb +62 -0
- data/spec/api/flag_triggers_api_spec.rb +110 -0
- data/spec/api/integration_audit_log_subscriptions_api_spec.rb +100 -0
- data/spec/api/metrics_api_spec.rb +100 -0
- data/spec/api/other_api_spec.rb +79 -0
- data/spec/api/projects_api_spec.rb +22 -17
- data/spec/api/relay_proxy_configurations_api_spec.rb +37 -31
- data/spec/api/scheduled_changes_api_spec.rb +112 -0
- data/spec/api/segments_api_spec.rb +164 -0
- data/spec/api/teams_beta_api_spec.rb +111 -0
- data/spec/api/user_settings_api_spec.rb +41 -36
- data/spec/api/users_api_spec.rb +34 -28
- data/spec/api/users_beta_api_spec.rb +48 -0
- data/spec/api/webhooks_api_spec.rb +27 -22
- data/spec/api/workflows_beta_api_spec.rb +94 -0
- data/spec/api_client_spec.rb +7 -24
- data/spec/configuration_spec.rb +7 -7
- data/spec/models/access_denied_reason_rep_spec.rb +64 -0
- data/spec/models/access_denied_rep_spec.rb +40 -0
- data/spec/models/access_rep_spec.rb +34 -0
- data/spec/models/access_token_post_spec.rb +74 -0
- data/spec/models/action_input_rep_spec.rb +34 -0
- data/spec/models/action_output_rep_spec.rb +40 -0
- data/spec/models/approval_condition_input_rep_spec.rb +40 -0
- data/spec/models/approval_condition_output_rep_spec.rb +58 -0
- data/spec/models/approval_settings_spec.rb +76 -0
- data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +40 -0
- data/spec/models/audit_log_entry_listing_rep_spec.rb +136 -0
- data/spec/models/audit_log_entry_rep_spec.rb +172 -0
- data/spec/models/authorized_app_data_rep_spec.rb +58 -0
- data/spec/models/big_segment_target_spec.rb +46 -0
- data/spec/models/branch_collection_rep_spec.rb +40 -0
- data/spec/models/branch_rep_spec.rb +64 -0
- data/spec/models/clause_spec.rb +8 -15
- data/spec/models/client_side_availability_post_spec.rb +40 -0
- data/spec/models/client_side_availability_spec.rb +10 -17
- data/spec/models/condition_base_output_rep_spec.rb +46 -0
- data/spec/models/condition_input_rep_spec.rb +58 -0
- data/spec/models/condition_output_rep_spec.rb +82 -0
- data/spec/models/confidence_interval_rep_spec.rb +40 -0
- data/spec/models/conflict_output_rep_spec.rb +40 -0
- data/spec/models/conflict_spec.rb +40 -0
- data/spec/models/copied_from_env_spec.rb +40 -0
- data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +64 -0
- data/spec/models/create_flag_config_approval_request_request_spec.rb +70 -0
- data/spec/models/custom_property_spec.rb +8 -15
- data/spec/models/custom_role_post_data_spec.rb +58 -0
- data/spec/models/custom_role_post_spec.rb +58 -0
- data/spec/models/custom_role_spec.rb +24 -19
- data/spec/models/custom_roles_rep_spec.rb +52 -0
- data/spec/models/custom_roles_spec.rb +8 -15
- data/spec/models/custom_workflow_input_rep_spec.rb +52 -0
- data/spec/models/custom_workflow_meta_spec.rb +40 -0
- data/spec/models/custom_workflow_output_rep_spec.rb +94 -0
- data/spec/models/custom_workflow_stage_meta_spec.rb +40 -0
- data/spec/models/custom_workflows_listing_output_rep_spec.rb +34 -0
- data/spec/models/default_client_side_availability_post_spec.rb +40 -0
- data/spec/models/defaults_spec.rb +8 -15
- data/spec/models/dependent_flag_environment_spec.rb +8 -15
- data/spec/models/dependent_flag_spec.rb +8 -15
- data/spec/models/dependent_flags_by_environment_spec.rb +8 -15
- data/spec/models/derived_attribute_spec.rb +40 -0
- data/spec/models/destination_post_spec.rb +56 -0
- data/spec/models/destination_spec.rb +19 -20
- data/spec/models/destinations_spec.rb +8 -15
- data/spec/models/environment_post_spec.rb +10 -17
- data/spec/models/environment_spec.rb +11 -18
- data/spec/models/execution_output_rep_spec.rb +34 -0
- data/spec/models/expanded_team_rep_spec.rb +112 -0
- data/spec/models/experiment_allocation_rep_spec.rb +40 -0
- data/spec/models/experiment_enabled_period_rep_spec.rb +40 -0
- data/spec/models/experiment_environment_setting_rep_spec.rb +46 -0
- data/spec/models/experiment_info_rep_spec.rb +40 -0
- data/spec/models/experiment_metadata_rep_spec.rb +34 -0
- data/spec/models/experiment_rep_spec.rb +52 -0
- data/spec/models/experiment_results_rep_spec.rb +70 -0
- data/spec/models/experiment_stats_rep_spec.rb +52 -0
- data/spec/models/experiment_time_series_slice_spec.rb +40 -0
- data/spec/models/experiment_time_series_variation_slice_spec.rb +76 -0
- data/spec/models/experiment_totals_rep_spec.rb +76 -0
- data/spec/models/expiring_user_target_error_spec.rb +40 -0
- data/spec/models/expiring_user_target_get_response_spec.rb +40 -0
- data/spec/models/expiring_user_target_item_spec.rb +70 -0
- data/spec/models/expiring_user_target_patch_response_spec.rb +64 -0
- data/spec/models/extinction_collection_rep_spec.rb +40 -0
- data/spec/models/extinction_spec.rb +58 -0
- data/spec/models/feature_flag_body_spec.rb +24 -19
- data/spec/models/feature_flag_config_spec.rb +28 -17
- data/spec/models/feature_flag_scheduled_change_spec.rb +34 -17
- data/spec/models/feature_flag_scheduled_changes_spec.rb +10 -17
- data/spec/models/feature_flag_spec.rb +39 -30
- data/spec/models/feature_flag_status_across_environments_spec.rb +10 -17
- data/spec/models/feature_flag_status_spec.rb +8 -25
- data/spec/models/feature_flag_statuses_spec.rb +8 -15
- data/spec/models/feature_flags_spec.rb +10 -17
- data/spec/models/flag_config_approval_request_response_spec.rb +148 -0
- data/spec/models/flag_config_approval_requests_response_spec.rb +40 -0
- data/spec/models/flag_copy_config_environment_spec.rb +40 -0
- data/spec/models/flag_copy_config_post_spec.rb +66 -0
- data/spec/models/flag_global_attributes_rep_spec.rb +158 -0
- data/spec/models/flag_listing_rep_spec.rb +52 -0
- data/spec/models/flag_scheduled_changes_input_spec.rb +40 -0
- data/spec/models/flag_status_rep_spec.rb +52 -0
- data/spec/models/flag_summary_spec.rb +34 -0
- data/spec/models/flag_trigger_input_spec.rb +40 -0
- data/spec/models/forbidden_error_rep_spec.rb +40 -0
- data/spec/models/hunk_rep_spec.rb +58 -0
- data/spec/models/integration_metadata_spec.rb +52 -0
- data/spec/models/integration_spec.rb +69 -16
- data/spec/models/integration_status_rep_spec.rb +46 -0
- data/spec/models/integration_status_spec.rb +40 -0
- data/spec/models/integration_subscription_status_rep_spec.rb +58 -0
- data/spec/models/integrations_spec.rb +14 -15
- data/spec/models/invalid_request_error_rep_spec.rb +40 -0
- data/spec/models/ip_list_spec.rb +40 -0
- data/spec/models/last_seen_metadata_spec.rb +34 -0
- data/spec/models/link_spec.rb +8 -15
- data/spec/models/member_data_rep_spec.rb +58 -0
- data/spec/models/member_import_item_rep_spec.rb +46 -0
- data/spec/models/member_permission_grant_summary_rep_spec.rb +46 -0
- data/spec/models/member_spec.rb +50 -21
- data/spec/models/member_summary_rep_spec.rb +64 -0
- data/spec/models/member_team_summary_rep_spec.rb +46 -0
- data/spec/models/member_teams_form_post_spec.rb +34 -0
- data/spec/models/members_spec.rb +10 -17
- data/spec/models/method_not_allowed_error_rep_spec.rb +40 -0
- data/spec/models/metric_collection_rep_spec.rb +40 -0
- data/spec/models/metric_listing_rep_spec.rb +144 -0
- data/spec/models/metric_post_spec.rb +108 -0
- data/spec/models/metric_rep_spec.rb +174 -0
- data/spec/models/metric_seen_spec.rb +40 -0
- data/spec/models/modification_spec.rb +34 -0
- data/spec/models/multi_environment_dependent_flag_spec.rb +8 -27
- data/spec/models/multi_environment_dependent_flags_spec.rb +8 -15
- data/spec/models/new_member_form_spec.rb +64 -0
- data/spec/models/not_found_error_rep_spec.rb +40 -0
- data/spec/models/parent_resource_rep_spec.rb +46 -0
- data/spec/models/patch_failed_error_rep_spec.rb +40 -0
- data/spec/models/patch_operation_spec.rb +8 -15
- data/spec/models/patch_segment_instruction_spec.rb +58 -0
- data/spec/models/patch_segment_request_spec.rb +40 -0
- data/spec/models/patch_with_comment_spec.rb +40 -0
- data/spec/models/permission_grant_input_spec.rb +46 -0
- data/spec/models/permission_grant_rep_spec.rb +52 -0
- data/spec/models/post_approval_request_apply_request_spec.rb +34 -0
- data/spec/models/post_approval_request_review_request_spec.rb +40 -0
- data/spec/models/post_flag_scheduled_changes_input_spec.rb +46 -0
- data/spec/models/prerequisite_spec.rb +8 -15
- data/spec/models/project_listing_rep_spec.rb +70 -0
- data/spec/models/project_post_spec.rb +64 -0
- data/spec/models/project_spec.rb +12 -19
- data/spec/models/projects_spec.rb +8 -15
- data/spec/models/pub_nub_detail_rep_spec.rb +40 -0
- data/spec/models/put_branch_spec.rb +64 -0
- data/spec/models/rate_limited_error_rep_spec.rb +40 -0
- data/spec/models/recent_trigger_body_spec.rb +40 -0
- data/spec/models/reference_rep_spec.rb +46 -0
- data/spec/models/relay_auto_config_collection_rep_spec.rb +34 -0
- data/spec/models/relay_auto_config_post_spec.rb +40 -0
- data/spec/models/relay_auto_config_rep_spec.rb +82 -0
- data/spec/models/repository_collection_rep_spec.rb +40 -0
- data/spec/models/repository_post_spec.rb +68 -0
- data/spec/models/repository_rep_spec.rb +98 -0
- data/spec/models/resource_access_spec.rb +40 -0
- data/spec/models/resource_id_response_spec.rb +58 -0
- data/spec/models/review_output_rep_spec.rb +58 -0
- data/spec/models/review_response_spec.rb +62 -0
- data/spec/models/rollout_spec.rb +22 -17
- data/spec/models/rule_spec.rb +17 -18
- data/spec/models/schedule_condition_input_rep_spec.rb +40 -0
- data/spec/models/schedule_condition_output_rep_spec.rb +34 -0
- data/spec/models/sdk_list_rep_spec.rb +40 -0
- data/spec/models/sdk_version_list_rep_spec.rb +40 -0
- data/spec/models/sdk_version_rep_spec.rb +40 -0
- data/spec/models/segment_body_spec.rb +58 -0
- data/spec/models/segment_metadata_spec.rb +64 -0
- data/spec/models/segment_user_list_spec.rb +40 -0
- data/spec/models/segment_user_state_spec.rb +40 -0
- data/spec/models/series_list_rep_spec.rb +46 -0
- data/spec/models/source_flag_spec.rb +40 -0
- data/spec/models/stage_input_rep_spec.rb +46 -0
- data/spec/models/stage_output_rep_spec.rb +58 -0
- data/spec/models/statement_post_data_spec.rb +58 -0
- data/spec/models/statement_post_spec.rb +58 -0
- data/spec/models/statement_rep_spec.rb +58 -0
- data/spec/models/statement_spec.rb +8 -19
- data/spec/models/statistic_collection_rep_spec.rb +40 -0
- data/spec/models/statistic_rep_spec.rb +70 -0
- data/spec/models/statistics_root_spec.rb +40 -0
- data/spec/models/status_conflict_error_rep_spec.rb +40 -0
- data/spec/models/subject_data_rep_spec.rb +46 -0
- data/spec/models/subscription_post_spec.rb +70 -0
- data/spec/models/target_resource_rep_spec.rb +46 -0
- data/spec/models/target_spec.rb +8 -15
- data/spec/models/team_collection_rep_spec.rb +46 -0
- data/spec/models/team_imports_rep_spec.rb +34 -0
- data/spec/models/team_patch_input_spec.rb +40 -0
- data/spec/models/team_post_input_spec.rb +64 -0
- data/spec/models/team_rep_spec.rb +100 -0
- data/spec/models/title_rep_spec.rb +76 -0
- data/spec/models/token_data_rep_spec.rb +58 -0
- data/spec/models/token_spec.rb +27 -28
- data/spec/models/tokens_spec.rb +10 -17
- data/spec/models/trigger_post_spec.rb +46 -0
- data/spec/models/trigger_workflow_collection_rep_spec.rb +40 -0
- data/spec/models/trigger_workflow_rep_spec.rb +106 -0
- data/spec/models/unauthorized_error_rep_spec.rb +40 -0
- data/spec/models/url_post_spec.rb +56 -0
- data/spec/models/user_attribute_names_rep_spec.rb +46 -0
- data/spec/models/user_flag_setting_spec.rb +8 -15
- data/spec/models/user_flag_settings_spec.rb +10 -17
- data/spec/models/user_record_rep_spec.rb +58 -0
- data/spec/models/user_record_spec.rb +21 -16
- data/spec/models/user_segment_rule_spec.rb +14 -15
- data/spec/models/user_segment_spec.rb +58 -23
- data/spec/models/user_segments_spec.rb +10 -17
- data/spec/models/user_spec.rb +20 -15
- data/spec/models/users_spec.rb +8 -15
- data/spec/models/value_put_spec.rb +40 -0
- data/spec/models/variation_or_rollout_rep_spec.rb +40 -0
- data/spec/models/variation_spec.rb +10 -17
- data/spec/models/variation_summary_spec.rb +70 -0
- data/spec/models/versions_rep_spec.rb +52 -0
- data/spec/models/webhook_post_spec.rb +70 -0
- data/spec/models/webhook_spec.rb +18 -19
- data/spec/models/webhooks_spec.rb +8 -15
- data/spec/models/weighted_variation_spec.rb +14 -15
- data/spec/spec_helper.rb +4 -4
- metadata +1015 -578
- data/docs/ApprovalRequest.md +0 -21
- data/docs/ApprovalRequestApplyConfigBody.md +0 -8
- data/docs/ApprovalRequestConfigBody.md +0 -13
- data/docs/ApprovalRequestFlagConfigCopyBody.md +0 -13
- data/docs/ApprovalRequestReview.md +0 -11
- data/docs/ApprovalRequestReviewConfigBody.md +0 -9
- data/docs/ApprovalRequestReviewStatus.md +0 -7
- data/docs/ApprovalRequests.md +0 -9
- data/docs/AuditLogEntries.md +0 -9
- data/docs/AuditLogEntry.md +0 -19
- data/docs/AuditLogEntryTarget.md +0 -10
- data/docs/BigSegmentTargetChanges.md +0 -9
- data/docs/BigSegmentTargetsBody.md +0 -9
- data/docs/CopyActions.md +0 -7
- data/docs/CustomPropertyValues.md +0 -7
- data/docs/CustomRoleBody.md +0 -11
- data/docs/CustomerMetricsApi.md +0 -511
- data/docs/DependentFlagEnvironmentLinks.md +0 -9
- data/docs/DependentFlagLinks.md +0 -8
- data/docs/DependentFlagsLinks.md +0 -9
- data/docs/DestinationAmazonKinesis.md +0 -10
- data/docs/DestinationBody.md +0 -11
- data/docs/DestinationGooglePubSub.md +0 -9
- data/docs/DestinationMParticle.md +0 -11
- data/docs/DestinationSegment.md +0 -8
- data/docs/EnvironmentApprovalSettings.md +0 -13
- data/docs/EvaluationUsageError.md +0 -9
- data/docs/Events.md +0 -8
- data/docs/Fallthrough.md +0 -9
- data/docs/FeatureFlagCopyBody.md +0 -12
- data/docs/FeatureFlagCopyObject.md +0 -9
- data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
- data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
- data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
- data/docs/FeatureFlagStatusLinks.md +0 -9
- data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
- data/docs/FlagListItem.md +0 -11
- data/docs/HierarchicalLinks.md +0 -9
- data/docs/Id.md +0 -7
- data/docs/IntegrationSubscription.md +0 -16
- data/docs/IntegrationSubscriptionStatus.md +0 -10
- data/docs/IntegrationsApi.md +0 -334
- data/docs/Links.md +0 -9
- data/docs/MAU.md +0 -10
- data/docs/MAUMetadata.md +0 -7
- data/docs/MAUbyCategory.md +0 -10
- data/docs/MemberLastSeenMetadata.md +0 -8
- data/docs/MembersBody.md +0 -13
- data/docs/PatchComment.md +0 -9
- data/docs/Policy.md +0 -12
- data/docs/ProjectBody.md +0 -13
- data/docs/RelayProxyConfig.md +0 -15
- data/docs/RelayProxyConfigBody.md +0 -9
- data/docs/RelayProxyConfigs.md +0 -8
- data/docs/Role.md +0 -7
- data/docs/RootApi.md +0 -56
- data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
- data/docs/SemanticPatchInstruction.md +0 -7
- data/docs/SemanticPatchInstructionInner.md +0 -8
- data/docs/SemanticPatchOperation.md +0 -9
- data/docs/Site.md +0 -9
- data/docs/Source.md +0 -9
- data/docs/Stream.md +0 -10
- data/docs/StreamBySDK.md +0 -10
- data/docs/StreamBySDKLinks.md +0 -9
- data/docs/StreamBySDKLinksMetadata.md +0 -10
- data/docs/StreamLinks.md +0 -10
- data/docs/StreamSDKVersion.md +0 -9
- data/docs/StreamSDKVersionData.md +0 -9
- data/docs/StreamUsageError.md +0 -9
- data/docs/StreamUsageLinks.md +0 -10
- data/docs/StreamUsageMetadata.md +0 -10
- data/docs/StreamUsageSeries.md +0 -9
- data/docs/Streams.md +0 -8
- data/docs/SubscriptionBody.md +0 -12
- data/docs/TeamMembersApi.md +0 -329
- data/docs/TokenBody.md +0 -13
- data/docs/Usage.md +0 -9
- data/docs/UsageError.md +0 -8
- data/docs/UsageLinks.md +0 -10
- data/docs/UserSegmentBody.md +0 -12
- data/docs/UserSegmentsApi.md +0 -488
- data/docs/UserSettingsBody.md +0 -8
- data/docs/UserTargetingExpirationForFlag.md +0 -14
- data/docs/UserTargetingExpirationForFlags.md +0 -9
- data/docs/UserTargetingExpirationForSegment.md +0 -14
- data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
- data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
- data/docs/WebhookBody.md +0 -14
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
- data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
- data/lib/launchdarkly_api/api/root_api.rb +0 -69
- data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
- data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
- data/lib/launchdarkly_api/models/approval_request.rb +0 -346
- data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
- data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
- data/lib/launchdarkly_api/models/approval_request_flag_config_copy_body.rb +0 -254
- data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
- data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
- data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
- data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
- data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
- data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
- data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
- data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
- data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
- data/lib/launchdarkly_api/models/dependent_flag__links.rb +0 -184
- data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +0 -193
- data/lib/launchdarkly_api/models/dependent_flags_links.rb +0 -193
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
- data/lib/launchdarkly_api/models/destination_body.rb +0 -264
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
- data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
- data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -272
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/events.rb +0 -184
- data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
- data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
- data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
- data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
- data/lib/launchdarkly_api/models/id.rb +0 -176
- data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
- data/lib/launchdarkly_api/models/links.rb +0 -193
- data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
- data/lib/launchdarkly_api/models/mau.rb +0 -206
- data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
- data/lib/launchdarkly_api/models/members_body.rb +0 -238
- data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
- data/lib/launchdarkly_api/models/policy.rb +0 -231
- data/lib/launchdarkly_api/models/project_body.rb +0 -243
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
- data/lib/launchdarkly_api/models/role.rb +0 -32
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
- data/lib/launchdarkly_api/models/site.rb +0 -193
- data/lib/launchdarkly_api/models/source.rb +0 -195
- data/lib/launchdarkly_api/models/stream.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
- data/lib/launchdarkly_api/models/stream_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
- data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
- data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
- data/lib/launchdarkly_api/models/streams.rb +0 -184
- data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
- data/lib/launchdarkly_api/models/token_body.rb +0 -238
- data/lib/launchdarkly_api/models/usage.rb +0 -195
- data/lib/launchdarkly_api/models/usage_error.rb +0 -184
- data/lib/launchdarkly_api/models/usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
- data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
- data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
- data/openapi.yml +0 -4922
- data/spec/api/customer_metrics_api_spec.rb +0 -141
- data/spec/api/integrations_api_spec.rb +0 -105
- data/spec/api/root_api_spec.rb +0 -45
- data/spec/api/team_members_api_spec.rb +0 -104
- data/spec/api/user_segments_api_spec.rb +0 -142
- data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
- data/spec/models/approval_request_config_body_spec.rb +0 -71
- data/spec/models/approval_request_flag_config_copy_body_spec.rb +0 -71
- data/spec/models/approval_request_review_config_body_spec.rb +0 -51
- data/spec/models/approval_request_review_spec.rb +0 -59
- data/spec/models/approval_request_review_status_spec.rb +0 -35
- data/spec/models/approval_request_spec.rb +0 -123
- data/spec/models/approval_requests_spec.rb +0 -47
- data/spec/models/audit_log_entries_spec.rb +0 -47
- data/spec/models/audit_log_entry_spec.rb +0 -107
- data/spec/models/audit_log_entry_target_spec.rb +0 -53
- data/spec/models/big_segment_target_changes_spec.rb +0 -47
- data/spec/models/big_segment_targets_body_spec.rb +0 -47
- data/spec/models/copy_actions_spec.rb +0 -35
- data/spec/models/custom_property_values_spec.rb +0 -35
- data/spec/models/custom_role_body_spec.rb +0 -59
- data/spec/models/dependent_flag__links_spec.rb +0 -41
- data/spec/models/dependent_flag_environment__links_spec.rb +0 -47
- data/spec/models/dependent_flags_links_spec.rb +0 -47
- data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
- data/spec/models/destination_body_spec.rb +0 -63
- data/spec/models/destination_google_pub_sub_spec.rb +0 -47
- data/spec/models/destination_m_particle_spec.rb +0 -59
- data/spec/models/destination_segment_spec.rb +0 -41
- data/spec/models/environment_approval_settings_spec.rb +0 -75
- data/spec/models/evaluation_usage_error_spec.rb +0 -47
- data/spec/models/events_spec.rb +0 -41
- data/spec/models/fallthrough_spec.rb +0 -47
- data/spec/models/feature_flag_copy_body_spec.rb +0 -65
- data/spec/models/feature_flag_copy_object_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
- data/spec/models/feature_flag_status_links_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
- data/spec/models/flag_list_item_spec.rb +0 -59
- data/spec/models/hierarchical_links_spec.rb +0 -47
- data/spec/models/id_spec.rb +0 -35
- data/spec/models/integration_subscription__status_spec.rb +0 -53
- data/spec/models/integration_subscription_spec.rb +0 -89
- data/spec/models/links_spec.rb +0 -47
- data/spec/models/ma_uby_category_spec.rb +0 -53
- data/spec/models/mau_metadata_spec.rb +0 -35
- data/spec/models/mau_spec.rb +0 -53
- data/spec/models/member__last_seen_metadata_spec.rb +0 -41
- data/spec/models/members_body_spec.rb +0 -71
- data/spec/models/patch_comment_spec.rb +0 -47
- data/spec/models/policy_spec.rb +0 -65
- data/spec/models/project_body_spec.rb +0 -71
- data/spec/models/relay_proxy_config_body_spec.rb +0 -47
- data/spec/models/relay_proxy_config_spec.rb +0 -83
- data/spec/models/relay_proxy_configs_spec.rb +0 -41
- data/spec/models/role_spec.rb +0 -35
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
- data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
- data/spec/models/semantic_patch_instruction_spec.rb +0 -35
- data/spec/models/semantic_patch_operation_spec.rb +0 -47
- data/spec/models/site_spec.rb +0 -47
- data/spec/models/source_spec.rb +0 -47
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
- data/spec/models/stream_by_sdk_links_spec.rb +0 -47
- data/spec/models/stream_by_sdk_spec.rb +0 -53
- data/spec/models/stream_links_spec.rb +0 -53
- data/spec/models/stream_sdk_version_data_spec.rb +0 -47
- data/spec/models/stream_sdk_version_spec.rb +0 -47
- data/spec/models/stream_spec.rb +0 -53
- data/spec/models/stream_usage_error_spec.rb +0 -47
- data/spec/models/stream_usage_links_spec.rb +0 -53
- data/spec/models/stream_usage_metadata_spec.rb +0 -53
- data/spec/models/stream_usage_series_spec.rb +0 -47
- data/spec/models/streams_spec.rb +0 -41
- data/spec/models/subscription_body_spec.rb +0 -65
- data/spec/models/token_body_spec.rb +0 -71
- data/spec/models/usage_error_spec.rb +0 -41
- data/spec/models/usage_links_spec.rb +0 -53
- data/spec/models/usage_spec.rb +0 -47
- data/spec/models/user_segment_body_spec.rb +0 -65
- data/spec/models/user_settings_body_spec.rb +0 -41
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
- data/spec/models/webhook_body_spec.rb +0 -77
data/openapi.yml
DELETED
|
@@ -1,4922 +0,0 @@
|
|
|
1
|
-
swagger: '2.0'
|
|
2
|
-
info:
|
|
3
|
-
title: LaunchDarkly REST API
|
|
4
|
-
description: Build custom integrations with the LaunchDarkly REST API
|
|
5
|
-
termsOfService: 'https://launchdarkly.com/terms'
|
|
6
|
-
contact:
|
|
7
|
-
name: LaunchDarkly Support
|
|
8
|
-
url: 'https://support.launchdarkly.com'
|
|
9
|
-
email: support@launchdarkly.com
|
|
10
|
-
license:
|
|
11
|
-
name: Apache 2.0
|
|
12
|
-
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
|
|
13
|
-
version: 5.4.0
|
|
14
|
-
host: app.launchdarkly.com
|
|
15
|
-
basePath: /api/v2
|
|
16
|
-
schemes:
|
|
17
|
-
- https
|
|
18
|
-
consumes:
|
|
19
|
-
- application/json
|
|
20
|
-
produces:
|
|
21
|
-
- application/json
|
|
22
|
-
securityDefinitions:
|
|
23
|
-
Token:
|
|
24
|
-
type: apiKey
|
|
25
|
-
name: Authorization
|
|
26
|
-
in: header
|
|
27
|
-
description: 'https://app.launchdarkly.com/settings#/tokens'
|
|
28
|
-
security:
|
|
29
|
-
- Token: []
|
|
30
|
-
paths:
|
|
31
|
-
/projects:
|
|
32
|
-
get:
|
|
33
|
-
summary: Returns a list of all projects in the account.
|
|
34
|
-
operationId: getProjects
|
|
35
|
-
responses:
|
|
36
|
-
'200':
|
|
37
|
-
description: Projects response
|
|
38
|
-
schema:
|
|
39
|
-
$ref: '#/definitions/Projects'
|
|
40
|
-
'401':
|
|
41
|
-
$ref: '#/responses/Standard401'
|
|
42
|
-
tags:
|
|
43
|
-
- Projects
|
|
44
|
-
post:
|
|
45
|
-
summary: Create a new project with the given key and name.
|
|
46
|
-
operationId: postProject
|
|
47
|
-
parameters:
|
|
48
|
-
- $ref: '#/parameters/ProjectPostRequest'
|
|
49
|
-
responses:
|
|
50
|
-
'201':
|
|
51
|
-
$ref: '#/responses/Project2xx'
|
|
52
|
-
'400':
|
|
53
|
-
$ref: '#/responses/Standard400'
|
|
54
|
-
'401':
|
|
55
|
-
$ref: '#/responses/Standard401'
|
|
56
|
-
'409':
|
|
57
|
-
$ref: '#/responses/Standard409'
|
|
58
|
-
tags:
|
|
59
|
-
- Projects
|
|
60
|
-
'/projects/{projectKey}':
|
|
61
|
-
get:
|
|
62
|
-
summary: Fetch a single project by key.
|
|
63
|
-
operationId: getProject
|
|
64
|
-
parameters:
|
|
65
|
-
- $ref: '#/parameters/ProjectKey'
|
|
66
|
-
responses:
|
|
67
|
-
'200':
|
|
68
|
-
$ref: '#/responses/Project2xx'
|
|
69
|
-
'401':
|
|
70
|
-
$ref: '#/responses/Standard401'
|
|
71
|
-
'404':
|
|
72
|
-
$ref: '#/responses/Standard404'
|
|
73
|
-
tags:
|
|
74
|
-
- Projects
|
|
75
|
-
patch:
|
|
76
|
-
summary: Modify a project by ID.
|
|
77
|
-
operationId: patchProject
|
|
78
|
-
parameters:
|
|
79
|
-
- $ref: '#/parameters/ProjectKey'
|
|
80
|
-
- $ref: '#/parameters/PatchRequest'
|
|
81
|
-
responses:
|
|
82
|
-
'200':
|
|
83
|
-
$ref: '#/responses/Project2xx'
|
|
84
|
-
'400':
|
|
85
|
-
$ref: '#/responses/Standard400'
|
|
86
|
-
'401':
|
|
87
|
-
$ref: '#/responses/Standard401'
|
|
88
|
-
'404':
|
|
89
|
-
$ref: '#/responses/Standard404'
|
|
90
|
-
'409':
|
|
91
|
-
$ref: '#/responses/Standard409'
|
|
92
|
-
tags:
|
|
93
|
-
- Projects
|
|
94
|
-
delete:
|
|
95
|
-
summary: >-
|
|
96
|
-
Delete a project by key. Caution-- deleting a project will delete all
|
|
97
|
-
associated environments and feature flags. You cannot delete the last
|
|
98
|
-
project in an account.
|
|
99
|
-
operationId: deleteProject
|
|
100
|
-
parameters:
|
|
101
|
-
- $ref: '#/parameters/ProjectKey'
|
|
102
|
-
responses:
|
|
103
|
-
'204':
|
|
104
|
-
$ref: '#/responses/Standard204'
|
|
105
|
-
'401':
|
|
106
|
-
$ref: '#/responses/Standard401'
|
|
107
|
-
'404':
|
|
108
|
-
$ref: '#/responses/Standard404'
|
|
109
|
-
tags:
|
|
110
|
-
- Projects
|
|
111
|
-
'/projects/{projectKey}/environments':
|
|
112
|
-
post:
|
|
113
|
-
summary: >-
|
|
114
|
-
Create a new environment in a specified project with a given name, key,
|
|
115
|
-
and swatch color.
|
|
116
|
-
operationId: postEnvironment
|
|
117
|
-
parameters:
|
|
118
|
-
- $ref: '#/parameters/ProjectKey'
|
|
119
|
-
- $ref: '#/parameters/EnvironmentPostRequest'
|
|
120
|
-
responses:
|
|
121
|
-
'201':
|
|
122
|
-
$ref: '#/responses/Environment2xx'
|
|
123
|
-
'400':
|
|
124
|
-
$ref: '#/responses/Standard400'
|
|
125
|
-
'401':
|
|
126
|
-
$ref: '#/responses/Standard401'
|
|
127
|
-
'409':
|
|
128
|
-
$ref: '#/responses/Standard409'
|
|
129
|
-
tags:
|
|
130
|
-
- Environments
|
|
131
|
-
'/projects/{projectKey}/environments/{environmentKey}':
|
|
132
|
-
get:
|
|
133
|
-
summary: Get an environment given a project and key.
|
|
134
|
-
operationId: getEnvironment
|
|
135
|
-
parameters:
|
|
136
|
-
- $ref: '#/parameters/ProjectKey'
|
|
137
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
138
|
-
responses:
|
|
139
|
-
'200':
|
|
140
|
-
$ref: '#/responses/Environment2xx'
|
|
141
|
-
'401':
|
|
142
|
-
$ref: '#/responses/Standard401'
|
|
143
|
-
'404':
|
|
144
|
-
$ref: '#/responses/Standard404'
|
|
145
|
-
tags:
|
|
146
|
-
- Environments
|
|
147
|
-
patch:
|
|
148
|
-
summary: >-
|
|
149
|
-
Modify an environment by ID. If you try to patch the environment by
|
|
150
|
-
setting both required and requiredApprovalTags, it will result in an
|
|
151
|
-
error. Users can specify either required approvals for all flags in an
|
|
152
|
-
environment or those with specific tags, but not both. Only customers on
|
|
153
|
-
an Enterprise plan can require approval for flag updates with either
|
|
154
|
-
mechanism.
|
|
155
|
-
operationId: patchEnvironment
|
|
156
|
-
parameters:
|
|
157
|
-
- $ref: '#/parameters/ProjectKey'
|
|
158
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
159
|
-
- $ref: '#/parameters/PatchRequest'
|
|
160
|
-
responses:
|
|
161
|
-
'200':
|
|
162
|
-
$ref: '#/responses/Environment2xx'
|
|
163
|
-
'400':
|
|
164
|
-
$ref: '#/responses/Standard400'
|
|
165
|
-
'401':
|
|
166
|
-
$ref: '#/responses/Standard401'
|
|
167
|
-
'404':
|
|
168
|
-
$ref: '#/responses/Standard404'
|
|
169
|
-
'409':
|
|
170
|
-
$ref: '#/responses/Standard409'
|
|
171
|
-
tags:
|
|
172
|
-
- Environments
|
|
173
|
-
delete:
|
|
174
|
-
summary: Delete an environment in a specific project.
|
|
175
|
-
operationId: deleteEnvironment
|
|
176
|
-
parameters:
|
|
177
|
-
- $ref: '#/parameters/ProjectKey'
|
|
178
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
179
|
-
responses:
|
|
180
|
-
'204':
|
|
181
|
-
$ref: '#/responses/Standard204'
|
|
182
|
-
'401':
|
|
183
|
-
$ref: '#/responses/Standard401'
|
|
184
|
-
'404':
|
|
185
|
-
$ref: '#/responses/Standard404'
|
|
186
|
-
tags:
|
|
187
|
-
- Environments
|
|
188
|
-
'/projects/{projectKey}/environments/{environmentKey}/apiKey':
|
|
189
|
-
post:
|
|
190
|
-
summary: >-
|
|
191
|
-
Reset an environment's SDK key with an optional expiry time for the old
|
|
192
|
-
key.
|
|
193
|
-
operationId: resetEnvironmentSDKKey
|
|
194
|
-
parameters:
|
|
195
|
-
- $ref: '#/parameters/ProjectKey'
|
|
196
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
197
|
-
- $ref: '#/parameters/EnvironmentSDKKeyExpiry'
|
|
198
|
-
responses:
|
|
199
|
-
'200':
|
|
200
|
-
$ref: '#/responses/Environment2xx'
|
|
201
|
-
'404':
|
|
202
|
-
$ref: '#/responses/Standard404'
|
|
203
|
-
'409':
|
|
204
|
-
$ref: '#/responses/Standard409'
|
|
205
|
-
tags:
|
|
206
|
-
- Environments
|
|
207
|
-
'/projects/{projectKey}/environments/{environmentKey}/mobileKey':
|
|
208
|
-
post:
|
|
209
|
-
summary: >-
|
|
210
|
-
Reset an environment's mobile key. The optional expiry for the old key
|
|
211
|
-
is deprecated for this endpoint, so the old key will always expire
|
|
212
|
-
immediately.
|
|
213
|
-
operationId: resetEnvironmentMobileKey
|
|
214
|
-
parameters:
|
|
215
|
-
- $ref: '#/parameters/ProjectKey'
|
|
216
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
217
|
-
- $ref: '#/parameters/EnvironmentMobileKeyExpiry'
|
|
218
|
-
responses:
|
|
219
|
-
'200':
|
|
220
|
-
$ref: '#/responses/Environment2xx'
|
|
221
|
-
'404':
|
|
222
|
-
$ref: '#/responses/Standard404'
|
|
223
|
-
'409':
|
|
224
|
-
$ref: '#/responses/Standard409'
|
|
225
|
-
tags:
|
|
226
|
-
- Environments
|
|
227
|
-
'/flags/{projectKey}':
|
|
228
|
-
get:
|
|
229
|
-
summary: Get a list of all features in the given project.
|
|
230
|
-
operationId: getFeatureFlags
|
|
231
|
-
parameters:
|
|
232
|
-
- $ref: '#/parameters/ProjectKey'
|
|
233
|
-
- $ref: '#/parameters/EnvironmentKeyQuery'
|
|
234
|
-
- $ref: '#/parameters/SummaryQuery'
|
|
235
|
-
- $ref: '#/parameters/ArchivedQuery'
|
|
236
|
-
- $ref: '#/parameters/LimitQuery'
|
|
237
|
-
- $ref: '#/parameters/OffsetQuery'
|
|
238
|
-
- $ref: '#/parameters/FilterQuery'
|
|
239
|
-
- $ref: '#/parameters/SortQuery'
|
|
240
|
-
- $ref: '#/parameters/Tag'
|
|
241
|
-
responses:
|
|
242
|
-
'200':
|
|
243
|
-
description: Flags response.
|
|
244
|
-
schema:
|
|
245
|
-
$ref: '#/definitions/FeatureFlags'
|
|
246
|
-
'401':
|
|
247
|
-
$ref: '#/responses/Standard401'
|
|
248
|
-
tags:
|
|
249
|
-
- Feature flags
|
|
250
|
-
post:
|
|
251
|
-
summary: Creates a new feature flag.
|
|
252
|
-
operationId: postFeatureFlag
|
|
253
|
-
parameters:
|
|
254
|
-
- $ref: '#/parameters/ProjectKey'
|
|
255
|
-
- $ref: '#/parameters/FeatureFlagPostRequest'
|
|
256
|
-
- $ref: '#/parameters/CloneFlagKeyQuery'
|
|
257
|
-
responses:
|
|
258
|
-
'201':
|
|
259
|
-
description: Flag response.
|
|
260
|
-
schema:
|
|
261
|
-
$ref: '#/definitions/FeatureFlag'
|
|
262
|
-
'400':
|
|
263
|
-
$ref: '#/responses/Standard400'
|
|
264
|
-
'401':
|
|
265
|
-
$ref: '#/responses/Standard401'
|
|
266
|
-
'409':
|
|
267
|
-
$ref: '#/responses/Standard409'
|
|
268
|
-
tags:
|
|
269
|
-
- Feature flags
|
|
270
|
-
'/flags/{projectKey}/{featureFlagKey}':
|
|
271
|
-
get:
|
|
272
|
-
summary: Get a single feature flag by key.
|
|
273
|
-
operationId: getFeatureFlag
|
|
274
|
-
parameters:
|
|
275
|
-
- $ref: '#/parameters/ProjectKey'
|
|
276
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
277
|
-
- $ref: '#/parameters/EnvironmentKeyQuery'
|
|
278
|
-
responses:
|
|
279
|
-
'200':
|
|
280
|
-
description: Flag response.
|
|
281
|
-
schema:
|
|
282
|
-
$ref: '#/definitions/FeatureFlag'
|
|
283
|
-
'401':
|
|
284
|
-
$ref: '#/responses/Standard401'
|
|
285
|
-
'404':
|
|
286
|
-
$ref: '#/responses/Standard404'
|
|
287
|
-
tags:
|
|
288
|
-
- Feature flags
|
|
289
|
-
patch:
|
|
290
|
-
summary: Perform a partial update to a feature.
|
|
291
|
-
operationId: patchFeatureFlag
|
|
292
|
-
parameters:
|
|
293
|
-
- $ref: '#/parameters/ProjectKey'
|
|
294
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
295
|
-
- $ref: '#/parameters/PatchWithComment'
|
|
296
|
-
responses:
|
|
297
|
-
'200':
|
|
298
|
-
description: Feature flag response.
|
|
299
|
-
schema:
|
|
300
|
-
$ref: '#/definitions/FeatureFlag'
|
|
301
|
-
'400':
|
|
302
|
-
$ref: '#/responses/Standard400'
|
|
303
|
-
'401':
|
|
304
|
-
$ref: '#/responses/Standard401'
|
|
305
|
-
'404':
|
|
306
|
-
$ref: '#/responses/Standard404'
|
|
307
|
-
'409':
|
|
308
|
-
$ref: '#/responses/Standard409'
|
|
309
|
-
tags:
|
|
310
|
-
- Feature flags
|
|
311
|
-
delete:
|
|
312
|
-
summary: >-
|
|
313
|
-
Delete a feature flag in all environments. Be careful-- only delete
|
|
314
|
-
feature flags that are no longer being used by your application.
|
|
315
|
-
operationId: deleteFeatureFlag
|
|
316
|
-
parameters:
|
|
317
|
-
- $ref: '#/parameters/ProjectKey'
|
|
318
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
319
|
-
responses:
|
|
320
|
-
'204':
|
|
321
|
-
$ref: '#/responses/Standard204'
|
|
322
|
-
'401':
|
|
323
|
-
$ref: '#/responses/Standard401'
|
|
324
|
-
'404':
|
|
325
|
-
$ref: '#/responses/Standard404'
|
|
326
|
-
tags:
|
|
327
|
-
- Feature flags
|
|
328
|
-
'/flags/{projectKey}/{featureFlagKey}/copy':
|
|
329
|
-
post:
|
|
330
|
-
summary: >-
|
|
331
|
-
Copies the feature flag configuration from one environment to the same
|
|
332
|
-
feature flag in another environment.
|
|
333
|
-
operationId: copyFeatureFlag
|
|
334
|
-
parameters:
|
|
335
|
-
- $ref: '#/parameters/ProjectKey'
|
|
336
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
337
|
-
- $ref: '#/parameters/FeatureFlagCopyBody'
|
|
338
|
-
responses:
|
|
339
|
-
'201':
|
|
340
|
-
description: Flag configuration copy response.
|
|
341
|
-
schema:
|
|
342
|
-
$ref: '#/definitions/FeatureFlag'
|
|
343
|
-
'400':
|
|
344
|
-
$ref: '#/responses/Standard400'
|
|
345
|
-
'401':
|
|
346
|
-
$ref: '#/responses/Standard401'
|
|
347
|
-
'409':
|
|
348
|
-
$ref: '#/responses/Standard409'
|
|
349
|
-
tags:
|
|
350
|
-
- Feature flags
|
|
351
|
-
'/flag-statuses/{projectKey}/{environmentKey}':
|
|
352
|
-
get:
|
|
353
|
-
summary: >-
|
|
354
|
-
Get a list of statuses for all feature flags. The status includes the
|
|
355
|
-
last time the feature flag was requested, as well as the state of the
|
|
356
|
-
flag.
|
|
357
|
-
operationId: getFeatureFlagStatuses
|
|
358
|
-
parameters:
|
|
359
|
-
- $ref: '#/parameters/ProjectKey'
|
|
360
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
361
|
-
responses:
|
|
362
|
-
'200':
|
|
363
|
-
description: List of feature flag statuses.
|
|
364
|
-
schema:
|
|
365
|
-
$ref: '#/definitions/FeatureFlagStatuses'
|
|
366
|
-
'401':
|
|
367
|
-
$ref: '#/responses/Standard401'
|
|
368
|
-
tags:
|
|
369
|
-
- Feature flags
|
|
370
|
-
'/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}':
|
|
371
|
-
get:
|
|
372
|
-
summary: Get the status for a particular feature flag.
|
|
373
|
-
operationId: getFeatureFlagStatus
|
|
374
|
-
parameters:
|
|
375
|
-
- $ref: '#/parameters/ProjectKey'
|
|
376
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
377
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
378
|
-
responses:
|
|
379
|
-
'200':
|
|
380
|
-
description: Status of the requested feature flag.
|
|
381
|
-
schema:
|
|
382
|
-
$ref: '#/definitions/FeatureFlagStatus'
|
|
383
|
-
'401':
|
|
384
|
-
$ref: '#/responses/Standard401'
|
|
385
|
-
tags:
|
|
386
|
-
- Feature flags
|
|
387
|
-
'/flag-status/{projectKey}/{featureFlagKey}':
|
|
388
|
-
get:
|
|
389
|
-
summary: Get the status for a particular feature flag across environments
|
|
390
|
-
operationId: getFeatureFlagStatusAcrossEnvironments
|
|
391
|
-
parameters:
|
|
392
|
-
- $ref: '#/parameters/ProjectKey'
|
|
393
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
394
|
-
responses:
|
|
395
|
-
'200':
|
|
396
|
-
description: Status of the requested feature flag across environments
|
|
397
|
-
schema:
|
|
398
|
-
$ref: '#/definitions/FeatureFlagStatusAcrossEnvironments'
|
|
399
|
-
'401':
|
|
400
|
-
$ref: '#/responses/Standard401'
|
|
401
|
-
'403':
|
|
402
|
-
$ref: '#/responses/BetaApi403'
|
|
403
|
-
tags:
|
|
404
|
-
- Feature flags
|
|
405
|
-
'/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}':
|
|
406
|
-
get:
|
|
407
|
-
summary: Get expiring user targets for feature flag
|
|
408
|
-
operationId: getExpiringUserTargets
|
|
409
|
-
parameters:
|
|
410
|
-
- $ref: '#/parameters/ProjectKey'
|
|
411
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
412
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
413
|
-
responses:
|
|
414
|
-
'200':
|
|
415
|
-
description: User targets of the requested feature flag.
|
|
416
|
-
schema:
|
|
417
|
-
$ref: '#/definitions/UserTargetingExpirationForFlags'
|
|
418
|
-
'401':
|
|
419
|
-
$ref: '#/responses/Standard401'
|
|
420
|
-
tags:
|
|
421
|
-
- Feature flags
|
|
422
|
-
patch:
|
|
423
|
-
summary: 'Update, add, or delete expiring user targets on feature flag'
|
|
424
|
-
operationId: patchExpiringUserTargets
|
|
425
|
-
parameters:
|
|
426
|
-
- $ref: '#/parameters/ProjectKey'
|
|
427
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
428
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
429
|
-
- $ref: '#/parameters/SemanticPatchWithComment'
|
|
430
|
-
responses:
|
|
431
|
-
'200':
|
|
432
|
-
description: User targeting expirations on feature flag response.
|
|
433
|
-
schema:
|
|
434
|
-
$ref: '#/definitions/UserTargetingExpirationForFlags'
|
|
435
|
-
'400':
|
|
436
|
-
$ref: '#/responses/Standard400'
|
|
437
|
-
'401':
|
|
438
|
-
$ref: '#/responses/Standard401'
|
|
439
|
-
'404':
|
|
440
|
-
$ref: '#/responses/Standard404'
|
|
441
|
-
'409':
|
|
442
|
-
$ref: '#/responses/Standard409'
|
|
443
|
-
tags:
|
|
444
|
-
- Feature flags
|
|
445
|
-
'/flags/{projectKey}/{featureFlagKey}/dependent-flags':
|
|
446
|
-
get:
|
|
447
|
-
summary: >-
|
|
448
|
-
Get dependent flags across all environments for the flag specified in
|
|
449
|
-
the path parameters
|
|
450
|
-
parameters:
|
|
451
|
-
- $ref: '#/parameters/ProjectKey'
|
|
452
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
453
|
-
responses:
|
|
454
|
-
'200':
|
|
455
|
-
description: Dependent flags accross all environemnts in the project response
|
|
456
|
-
schema:
|
|
457
|
-
$ref: '#/definitions/MultiEnvironmentDependentFlags'
|
|
458
|
-
'401':
|
|
459
|
-
$ref: '#/responses/Standard401'
|
|
460
|
-
'403':
|
|
461
|
-
$ref: '#/responses/BetaApi403'
|
|
462
|
-
'404':
|
|
463
|
-
$ref: '#/responses/Standard404'
|
|
464
|
-
tags:
|
|
465
|
-
- Feature flags
|
|
466
|
-
'/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags':
|
|
467
|
-
get:
|
|
468
|
-
summary: >-
|
|
469
|
-
Get dependent flags for the flag in the environment specified in path
|
|
470
|
-
parameters
|
|
471
|
-
parameters:
|
|
472
|
-
- $ref: '#/parameters/ProjectKey'
|
|
473
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
474
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
475
|
-
responses:
|
|
476
|
-
'200':
|
|
477
|
-
description: Dependent flags in a single envrionemnt response
|
|
478
|
-
schema:
|
|
479
|
-
$ref: '#/definitions/DependentFlagsByEnvironment'
|
|
480
|
-
'401':
|
|
481
|
-
$ref: '#/responses/Standard401'
|
|
482
|
-
'403':
|
|
483
|
-
$ref: '#/responses/BetaApi403'
|
|
484
|
-
'404':
|
|
485
|
-
$ref: '#/responses/Standard404'
|
|
486
|
-
tags:
|
|
487
|
-
- Feature flags
|
|
488
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes':
|
|
489
|
-
get:
|
|
490
|
-
summary: Get all scheduled workflows for a feature flag by key.
|
|
491
|
-
operationId: getFlagConfigScheduledChanges
|
|
492
|
-
parameters:
|
|
493
|
-
- $ref: '#/parameters/ProjectKey'
|
|
494
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
495
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
496
|
-
responses:
|
|
497
|
-
'200':
|
|
498
|
-
schema:
|
|
499
|
-
$ref: '#/definitions/FeatureFlagScheduledChanges'
|
|
500
|
-
description: A list of scheduled changes for feature flag response.
|
|
501
|
-
'401':
|
|
502
|
-
$ref: '#/responses/Standard401'
|
|
503
|
-
'404':
|
|
504
|
-
$ref: '#/responses/Standard404'
|
|
505
|
-
tags:
|
|
506
|
-
- Feature flags
|
|
507
|
-
post:
|
|
508
|
-
summary: Creates a new scheduled change for a feature flag.
|
|
509
|
-
operationId: postFlagConfigScheduledChanges
|
|
510
|
-
parameters:
|
|
511
|
-
- $ref: '#/parameters/ProjectKey'
|
|
512
|
-
- $ref: '#/parameters/FlagConfigScheduledChangesPostBody'
|
|
513
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
514
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
515
|
-
responses:
|
|
516
|
-
'201':
|
|
517
|
-
description: A scheduled change for feature flag response.
|
|
518
|
-
schema:
|
|
519
|
-
$ref: '#/definitions/FeatureFlagScheduledChange'
|
|
520
|
-
'400':
|
|
521
|
-
$ref: '#/responses/Standard400'
|
|
522
|
-
'401':
|
|
523
|
-
$ref: '#/responses/Standard401'
|
|
524
|
-
'409':
|
|
525
|
-
$ref: '#/responses/Standard409'
|
|
526
|
-
tags:
|
|
527
|
-
- Feature flags
|
|
528
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes-conflicts':
|
|
529
|
-
post:
|
|
530
|
-
summary: >-
|
|
531
|
-
Lists conflicts between the given instructions and any existing
|
|
532
|
-
scheduled changes for the feature flag. The actual HTTP verb should be
|
|
533
|
-
REPORT, not POST.
|
|
534
|
-
operationId: getFlagConfigScheduledChangesConflicts
|
|
535
|
-
parameters:
|
|
536
|
-
- $ref: '#/parameters/ProjectKey'
|
|
537
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
538
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
539
|
-
- $ref: '#/parameters/FlagConfigScheduledChangesConflictsBody'
|
|
540
|
-
responses:
|
|
541
|
-
'200':
|
|
542
|
-
schema:
|
|
543
|
-
$ref: '#/definitions/FeatureFlagScheduledChangesConflicts'
|
|
544
|
-
description: Scheduled changes conflict response
|
|
545
|
-
'401':
|
|
546
|
-
$ref: '#/responses/Standard401'
|
|
547
|
-
'404':
|
|
548
|
-
$ref: '#/responses/Standard404'
|
|
549
|
-
tags:
|
|
550
|
-
- Feature flags
|
|
551
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId}':
|
|
552
|
-
get:
|
|
553
|
-
summary: Get a scheduled change on a feature flag by id.
|
|
554
|
-
operationId: getFlagConfigScheduledChange
|
|
555
|
-
parameters:
|
|
556
|
-
- $ref: '#/parameters/ProjectKey'
|
|
557
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
558
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
559
|
-
- $ref: '#/parameters/ScheduledChangeId'
|
|
560
|
-
responses:
|
|
561
|
-
'200':
|
|
562
|
-
schema:
|
|
563
|
-
$ref: '#/definitions/FeatureFlagScheduledChange'
|
|
564
|
-
description: A scheduled change for feature flag response.
|
|
565
|
-
'401':
|
|
566
|
-
$ref: '#/responses/Standard401'
|
|
567
|
-
'404':
|
|
568
|
-
$ref: '#/responses/Standard404'
|
|
569
|
-
tags:
|
|
570
|
-
- Feature flags
|
|
571
|
-
patch:
|
|
572
|
-
summary: >-
|
|
573
|
-
Updates an existing scheduled-change on a feature flag in an
|
|
574
|
-
environment.
|
|
575
|
-
operationId: patchFlagConfigScheduledChange
|
|
576
|
-
parameters:
|
|
577
|
-
- $ref: '#/parameters/ProjectKey'
|
|
578
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
579
|
-
- $ref: '#/parameters/FlagConfigScheduledChangesPatchBody'
|
|
580
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
581
|
-
- $ref: '#/parameters/ScheduledChangeId'
|
|
582
|
-
responses:
|
|
583
|
-
'201':
|
|
584
|
-
description: A Scheduled change for feature flag response.
|
|
585
|
-
schema:
|
|
586
|
-
$ref: '#/definitions/FeatureFlagScheduledChange'
|
|
587
|
-
'400':
|
|
588
|
-
$ref: '#/responses/Standard400'
|
|
589
|
-
'401':
|
|
590
|
-
$ref: '#/responses/Standard401'
|
|
591
|
-
'409':
|
|
592
|
-
$ref: '#/responses/Standard409'
|
|
593
|
-
tags:
|
|
594
|
-
- Feature flags
|
|
595
|
-
delete:
|
|
596
|
-
summary: Delete a scheduled change on a feature flag in an environment.
|
|
597
|
-
operationId: deleteFlagConfigScheduledChanges
|
|
598
|
-
parameters:
|
|
599
|
-
- $ref: '#/parameters/ProjectKey'
|
|
600
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
601
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
602
|
-
- $ref: '#/parameters/ScheduledChangeId'
|
|
603
|
-
responses:
|
|
604
|
-
'204':
|
|
605
|
-
$ref: '#/responses/Standard204'
|
|
606
|
-
'401':
|
|
607
|
-
$ref: '#/responses/Standard401'
|
|
608
|
-
'404':
|
|
609
|
-
$ref: '#/responses/Standard404'
|
|
610
|
-
tags:
|
|
611
|
-
- Feature flags
|
|
612
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests':
|
|
613
|
-
get:
|
|
614
|
-
operationId: getApprovalRequests
|
|
615
|
-
summary: Get all approval requests for a feature flag config
|
|
616
|
-
parameters:
|
|
617
|
-
- $ref: '#/parameters/ProjectKey'
|
|
618
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
619
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
620
|
-
responses:
|
|
621
|
-
'200':
|
|
622
|
-
schema:
|
|
623
|
-
$ref: '#/definitions/ApprovalRequests'
|
|
624
|
-
description: Approval requests response
|
|
625
|
-
'401':
|
|
626
|
-
$ref: '#/responses/Standard401'
|
|
627
|
-
'404':
|
|
628
|
-
$ref: '#/responses/Standard404'
|
|
629
|
-
tags:
|
|
630
|
-
- Feature flags
|
|
631
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy':
|
|
632
|
-
post:
|
|
633
|
-
operationId: postApprovalRequestFlagCopy
|
|
634
|
-
summary: Create an approval request to copy feature flag config
|
|
635
|
-
parameters:
|
|
636
|
-
- $ref: '#/parameters/ProjectKey'
|
|
637
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
638
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
639
|
-
- $ref: '#/parameters/ApprovalRequestFlagCopyPostRequest'
|
|
640
|
-
responses:
|
|
641
|
-
'201':
|
|
642
|
-
schema:
|
|
643
|
-
$ref: '#/definitions/ApprovalRequest'
|
|
644
|
-
description: Approval request applied response
|
|
645
|
-
'401':
|
|
646
|
-
$ref: '#/responses/Standard401'
|
|
647
|
-
'404':
|
|
648
|
-
$ref: '#/responses/Standard404'
|
|
649
|
-
'409':
|
|
650
|
-
$ref: '#/responses/Standard409'
|
|
651
|
-
tags:
|
|
652
|
-
- Feature flags
|
|
653
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}':
|
|
654
|
-
get:
|
|
655
|
-
operationId: getApprovalRequest
|
|
656
|
-
summary: Get a single approval request for a feature flag config
|
|
657
|
-
parameters:
|
|
658
|
-
- $ref: '#/parameters/ProjectKey'
|
|
659
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
660
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
661
|
-
- $ref: '#/parameters/ApprovalRequestId'
|
|
662
|
-
responses:
|
|
663
|
-
'200':
|
|
664
|
-
schema:
|
|
665
|
-
$ref: '#/definitions/ApprovalRequest'
|
|
666
|
-
description: Approval request response
|
|
667
|
-
'401':
|
|
668
|
-
$ref: '#/responses/Standard401'
|
|
669
|
-
'404':
|
|
670
|
-
$ref: '#/responses/Standard404'
|
|
671
|
-
tags:
|
|
672
|
-
- Feature flags
|
|
673
|
-
post:
|
|
674
|
-
operationId: postApprovalRequest
|
|
675
|
-
summary: Create an approval request for a feature flag config
|
|
676
|
-
parameters:
|
|
677
|
-
- $ref: '#/parameters/ProjectKey'
|
|
678
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
679
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
680
|
-
- $ref: '#/parameters/ApprovalRequestId'
|
|
681
|
-
- $ref: '#/parameters/ApprovalRequestPostRequest'
|
|
682
|
-
responses:
|
|
683
|
-
'201':
|
|
684
|
-
schema:
|
|
685
|
-
$ref: '#/definitions/ApprovalRequest'
|
|
686
|
-
description: Approval request response
|
|
687
|
-
'401':
|
|
688
|
-
$ref: '#/responses/Standard401'
|
|
689
|
-
'404':
|
|
690
|
-
$ref: '#/responses/Standard404'
|
|
691
|
-
tags:
|
|
692
|
-
- Feature flags
|
|
693
|
-
delete:
|
|
694
|
-
operationId: deleteApprovalRequest
|
|
695
|
-
summary: Delete an approval request for a feature flag config
|
|
696
|
-
parameters:
|
|
697
|
-
- $ref: '#/parameters/ProjectKey'
|
|
698
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
699
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
700
|
-
- $ref: '#/parameters/ApprovalRequestId'
|
|
701
|
-
- $ref: '#/parameters/ApprovalRequestPostRequest'
|
|
702
|
-
responses:
|
|
703
|
-
'204':
|
|
704
|
-
$ref: '#/responses/Standard204'
|
|
705
|
-
'401':
|
|
706
|
-
$ref: '#/responses/Standard401'
|
|
707
|
-
'404':
|
|
708
|
-
$ref: '#/responses/Standard404'
|
|
709
|
-
tags:
|
|
710
|
-
- Feature flags
|
|
711
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/apply':
|
|
712
|
-
post:
|
|
713
|
-
operationId: postApplyApprovalRequest
|
|
714
|
-
summary: Apply approval request for a feature flag config
|
|
715
|
-
parameters:
|
|
716
|
-
- $ref: '#/parameters/ProjectKey'
|
|
717
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
718
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
719
|
-
- $ref: '#/parameters/ApprovalRequestId'
|
|
720
|
-
- $ref: '#/parameters/ApprovalRequestApplyPostRequest'
|
|
721
|
-
responses:
|
|
722
|
-
'200':
|
|
723
|
-
schema:
|
|
724
|
-
$ref: '#/definitions/ApprovalRequest'
|
|
725
|
-
description: Approval request applied response
|
|
726
|
-
'401':
|
|
727
|
-
$ref: '#/responses/Standard401'
|
|
728
|
-
'404':
|
|
729
|
-
$ref: '#/responses/Standard404'
|
|
730
|
-
tags:
|
|
731
|
-
- Feature flags
|
|
732
|
-
'/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review':
|
|
733
|
-
post:
|
|
734
|
-
operationId: postReviewApprovalRequest
|
|
735
|
-
summary: Review approval request for a feature flag config
|
|
736
|
-
parameters:
|
|
737
|
-
- $ref: '#/parameters/ProjectKey'
|
|
738
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
739
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
740
|
-
- $ref: '#/parameters/ApprovalRequestId'
|
|
741
|
-
- $ref: '#/parameters/ApprovalRequestReviewPostRequest'
|
|
742
|
-
responses:
|
|
743
|
-
'200':
|
|
744
|
-
schema:
|
|
745
|
-
$ref: '#/definitions/ApprovalRequest'
|
|
746
|
-
description: Approval request reviewed response
|
|
747
|
-
'401':
|
|
748
|
-
$ref: '#/responses/Standard401'
|
|
749
|
-
'404':
|
|
750
|
-
$ref: '#/responses/Standard404'
|
|
751
|
-
tags:
|
|
752
|
-
- Feature flags
|
|
753
|
-
'/segments/{projectKey}/{environmentKey}':
|
|
754
|
-
get:
|
|
755
|
-
summary: Get a list of all user segments in the given project.
|
|
756
|
-
operationId: getUserSegments
|
|
757
|
-
parameters:
|
|
758
|
-
- $ref: '#/parameters/ProjectKey'
|
|
759
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
760
|
-
- $ref: '#/parameters/Tag'
|
|
761
|
-
responses:
|
|
762
|
-
'200':
|
|
763
|
-
description: Segments response.
|
|
764
|
-
schema:
|
|
765
|
-
$ref: '#/definitions/UserSegments'
|
|
766
|
-
'401':
|
|
767
|
-
$ref: '#/responses/Standard401'
|
|
768
|
-
tags:
|
|
769
|
-
- User segments
|
|
770
|
-
post:
|
|
771
|
-
summary: Creates a new user segment.
|
|
772
|
-
operationId: postUserSegment
|
|
773
|
-
parameters:
|
|
774
|
-
- $ref: '#/parameters/ProjectKey'
|
|
775
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
776
|
-
- $ref: '#/parameters/UserSegmentPostRequest'
|
|
777
|
-
responses:
|
|
778
|
-
'201':
|
|
779
|
-
$ref: '#/responses/UserSegment2xx'
|
|
780
|
-
'400':
|
|
781
|
-
$ref: '#/responses/Standard400'
|
|
782
|
-
'401':
|
|
783
|
-
$ref: '#/responses/Standard401'
|
|
784
|
-
'409':
|
|
785
|
-
$ref: '#/responses/Standard409'
|
|
786
|
-
tags:
|
|
787
|
-
- User segments
|
|
788
|
-
'/segments/{projectKey}/{environmentKey}/{userSegmentKey}':
|
|
789
|
-
get:
|
|
790
|
-
summary: Get a single user segment by key.
|
|
791
|
-
operationId: getUserSegment
|
|
792
|
-
parameters:
|
|
793
|
-
- $ref: '#/parameters/ProjectKey'
|
|
794
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
795
|
-
- $ref: '#/parameters/UserSegmentKey'
|
|
796
|
-
responses:
|
|
797
|
-
'200':
|
|
798
|
-
$ref: '#/responses/UserSegment2xx'
|
|
799
|
-
'401':
|
|
800
|
-
$ref: '#/responses/Standard401'
|
|
801
|
-
'404':
|
|
802
|
-
$ref: '#/responses/Standard404'
|
|
803
|
-
tags:
|
|
804
|
-
- User segments
|
|
805
|
-
patch:
|
|
806
|
-
summary: Perform a partial update to a user segment.
|
|
807
|
-
operationId: patchUserSegment
|
|
808
|
-
parameters:
|
|
809
|
-
- $ref: '#/parameters/ProjectKey'
|
|
810
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
811
|
-
- $ref: '#/parameters/UserSegmentKey'
|
|
812
|
-
- $ref: '#/parameters/PatchOnly'
|
|
813
|
-
responses:
|
|
814
|
-
'200':
|
|
815
|
-
$ref: '#/responses/UserSegment2xx'
|
|
816
|
-
'400':
|
|
817
|
-
$ref: '#/responses/Standard400'
|
|
818
|
-
'401':
|
|
819
|
-
$ref: '#/responses/Standard401'
|
|
820
|
-
'404':
|
|
821
|
-
$ref: '#/responses/Standard404'
|
|
822
|
-
'409':
|
|
823
|
-
$ref: '#/responses/Standard409'
|
|
824
|
-
tags:
|
|
825
|
-
- User segments
|
|
826
|
-
delete:
|
|
827
|
-
summary: Delete a user segment.
|
|
828
|
-
operationId: deleteUserSegment
|
|
829
|
-
parameters:
|
|
830
|
-
- $ref: '#/parameters/ProjectKey'
|
|
831
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
832
|
-
- $ref: '#/parameters/UserSegmentKey'
|
|
833
|
-
responses:
|
|
834
|
-
'204':
|
|
835
|
-
$ref: '#/responses/Standard204'
|
|
836
|
-
'401':
|
|
837
|
-
$ref: '#/responses/Standard401'
|
|
838
|
-
'404':
|
|
839
|
-
$ref: '#/responses/Standard404'
|
|
840
|
-
tags:
|
|
841
|
-
- User segments
|
|
842
|
-
'/segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey}':
|
|
843
|
-
get:
|
|
844
|
-
summary: Get expiring user targets for user segment
|
|
845
|
-
operationId: getExpiringUserTargetsOnSegment
|
|
846
|
-
parameters:
|
|
847
|
-
- $ref: '#/parameters/ProjectKey'
|
|
848
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
849
|
-
- $ref: '#/parameters/UserSegmentKey'
|
|
850
|
-
responses:
|
|
851
|
-
'200':
|
|
852
|
-
description: User targeting expirations on user segment response.
|
|
853
|
-
schema:
|
|
854
|
-
$ref: '#/definitions/UserTargetingExpirationForSegment'
|
|
855
|
-
'401':
|
|
856
|
-
$ref: '#/responses/Standard401'
|
|
857
|
-
'404':
|
|
858
|
-
$ref: '#/responses/Standard404'
|
|
859
|
-
tags:
|
|
860
|
-
- User segments
|
|
861
|
-
patch:
|
|
862
|
-
summary: 'Update, add, or delete expiring user targets on user segment'
|
|
863
|
-
operationId: patchExpiringUserTargetsOnSegment
|
|
864
|
-
parameters:
|
|
865
|
-
- $ref: '#/parameters/ProjectKey'
|
|
866
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
867
|
-
- $ref: '#/parameters/UserSegmentKey'
|
|
868
|
-
- $ref: '#/parameters/SemanticPatchWithComment'
|
|
869
|
-
responses:
|
|
870
|
-
'200':
|
|
871
|
-
description: User targeting expirations on user segment response.
|
|
872
|
-
schema:
|
|
873
|
-
$ref: '#/definitions/UserTargetingExpirationForSegment'
|
|
874
|
-
'400':
|
|
875
|
-
$ref: '#/responses/Standard400'
|
|
876
|
-
'401':
|
|
877
|
-
$ref: '#/responses/Standard401'
|
|
878
|
-
'404':
|
|
879
|
-
$ref: '#/responses/Standard404'
|
|
880
|
-
'409':
|
|
881
|
-
$ref: '#/responses/Standard409'
|
|
882
|
-
tags:
|
|
883
|
-
- User segments
|
|
884
|
-
'/segments/{projectKey}/{environmentKey}/{userSegmentKey}/users':
|
|
885
|
-
post:
|
|
886
|
-
summary: Update targets included or excluded in a big segment
|
|
887
|
-
operationId: updateBigSegmentTargets
|
|
888
|
-
parameters:
|
|
889
|
-
- $ref: '#/parameters/ProjectKey'
|
|
890
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
891
|
-
- $ref: '#/parameters/UserSegmentKey'
|
|
892
|
-
- $ref: '#/parameters/BigSegmentTargetsPostRequest'
|
|
893
|
-
responses:
|
|
894
|
-
'204':
|
|
895
|
-
$ref: '#/responses/Standard204'
|
|
896
|
-
'400':
|
|
897
|
-
$ref: '#/responses/Standard400'
|
|
898
|
-
'401':
|
|
899
|
-
$ref: '#/responses/Standard401'
|
|
900
|
-
tags:
|
|
901
|
-
- User segments
|
|
902
|
-
'/users/{projectKey}/{environmentKey}':
|
|
903
|
-
get:
|
|
904
|
-
summary: >-
|
|
905
|
-
List all users in the environment. Includes the total count of users. In
|
|
906
|
-
each page, there will be up to 'limit' users returned (default 20). This
|
|
907
|
-
is useful for exporting all users in the system for further analysis.
|
|
908
|
-
Paginated collections will include a next link containing a URL with the
|
|
909
|
-
next set of elements in the collection.
|
|
910
|
-
operationId: getUsers
|
|
911
|
-
parameters:
|
|
912
|
-
- $ref: '#/parameters/ProjectKey'
|
|
913
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
914
|
-
- $ref: '#/parameters/Limit'
|
|
915
|
-
- $ref: '#/parameters/HMAC'
|
|
916
|
-
- $ref: '#/parameters/ScrollId'
|
|
917
|
-
responses:
|
|
918
|
-
'200':
|
|
919
|
-
description: Users response.
|
|
920
|
-
schema:
|
|
921
|
-
$ref: '#/definitions/Users'
|
|
922
|
-
'401':
|
|
923
|
-
$ref: '#/responses/Standard401'
|
|
924
|
-
tags:
|
|
925
|
-
- Users
|
|
926
|
-
'/user-search/{projectKey}/{environmentKey}':
|
|
927
|
-
get:
|
|
928
|
-
summary: >-
|
|
929
|
-
Search users in LaunchDarkly based on their last active date, or a
|
|
930
|
-
search query. It should not be used to enumerate all users in
|
|
931
|
-
LaunchDarkly-- use the List users API resource.
|
|
932
|
-
operationId: getSearchUsers
|
|
933
|
-
parameters:
|
|
934
|
-
- $ref: '#/parameters/ProjectKey'
|
|
935
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
936
|
-
- $ref: '#/parameters/Query'
|
|
937
|
-
- $ref: '#/parameters/Limit'
|
|
938
|
-
- $ref: '#/parameters/Offset'
|
|
939
|
-
- $ref: '#/parameters/After'
|
|
940
|
-
responses:
|
|
941
|
-
'200':
|
|
942
|
-
description: Users response.
|
|
943
|
-
schema:
|
|
944
|
-
$ref: '#/definitions/Users'
|
|
945
|
-
'401':
|
|
946
|
-
$ref: '#/responses/Standard401'
|
|
947
|
-
tags:
|
|
948
|
-
- Users
|
|
949
|
-
'/users/{projectKey}/{environmentKey}/{userKey}':
|
|
950
|
-
get:
|
|
951
|
-
summary: Get a user by key.
|
|
952
|
-
operationId: getUser
|
|
953
|
-
parameters:
|
|
954
|
-
- $ref: '#/parameters/ProjectKey'
|
|
955
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
956
|
-
- $ref: '#/parameters/UserKey'
|
|
957
|
-
responses:
|
|
958
|
-
'200':
|
|
959
|
-
description: User response.
|
|
960
|
-
schema:
|
|
961
|
-
$ref: '#/definitions/UserRecord'
|
|
962
|
-
'401':
|
|
963
|
-
$ref: '#/responses/Standard401'
|
|
964
|
-
'404':
|
|
965
|
-
$ref: '#/responses/Standard404'
|
|
966
|
-
tags:
|
|
967
|
-
- Users
|
|
968
|
-
delete:
|
|
969
|
-
summary: Delete a user by ID.
|
|
970
|
-
operationId: deleteUser
|
|
971
|
-
parameters:
|
|
972
|
-
- $ref: '#/parameters/ProjectKey'
|
|
973
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
974
|
-
- $ref: '#/parameters/UserKey'
|
|
975
|
-
responses:
|
|
976
|
-
'204':
|
|
977
|
-
$ref: '#/responses/Standard204'
|
|
978
|
-
'401':
|
|
979
|
-
$ref: '#/responses/Standard401'
|
|
980
|
-
'404':
|
|
981
|
-
$ref: '#/responses/Standard404'
|
|
982
|
-
tags:
|
|
983
|
-
- Users
|
|
984
|
-
'/users/{projectKey}/{environmentKey}/{userKey}/flags':
|
|
985
|
-
get:
|
|
986
|
-
summary: Fetch a single flag setting for a user by key.
|
|
987
|
-
operationId: getUserFlagSettings
|
|
988
|
-
parameters:
|
|
989
|
-
- $ref: '#/parameters/ProjectKey'
|
|
990
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
991
|
-
- $ref: '#/parameters/UserKey'
|
|
992
|
-
responses:
|
|
993
|
-
'200':
|
|
994
|
-
description: User flags settings response.
|
|
995
|
-
schema:
|
|
996
|
-
$ref: '#/definitions/UserFlagSettings'
|
|
997
|
-
'401':
|
|
998
|
-
$ref: '#/responses/Standard401'
|
|
999
|
-
'404':
|
|
1000
|
-
$ref: '#/responses/Standard404'
|
|
1001
|
-
tags:
|
|
1002
|
-
- User settings
|
|
1003
|
-
'/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}':
|
|
1004
|
-
get:
|
|
1005
|
-
summary: Fetch a single flag setting for a user by key.
|
|
1006
|
-
operationId: getUserFlagSetting
|
|
1007
|
-
parameters:
|
|
1008
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1009
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1010
|
-
- $ref: '#/parameters/UserKey'
|
|
1011
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
1012
|
-
responses:
|
|
1013
|
-
'200':
|
|
1014
|
-
description: User flag setting response.
|
|
1015
|
-
schema:
|
|
1016
|
-
$ref: '#/definitions/UserFlagSetting'
|
|
1017
|
-
'401':
|
|
1018
|
-
$ref: '#/responses/Standard401'
|
|
1019
|
-
'404':
|
|
1020
|
-
$ref: '#/responses/Standard404'
|
|
1021
|
-
tags:
|
|
1022
|
-
- User settings
|
|
1023
|
-
put:
|
|
1024
|
-
summary: >-
|
|
1025
|
-
Specifically enable or disable a feature flag for a user based on their
|
|
1026
|
-
key.
|
|
1027
|
-
operationId: putFlagSetting
|
|
1028
|
-
parameters:
|
|
1029
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1030
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1031
|
-
- $ref: '#/parameters/UserKey'
|
|
1032
|
-
- $ref: '#/parameters/FeatureFlagKey'
|
|
1033
|
-
- $ref: '#/parameters/UserSettingsPutRequest'
|
|
1034
|
-
responses:
|
|
1035
|
-
'204':
|
|
1036
|
-
$ref: '#/responses/Standard204'
|
|
1037
|
-
'400':
|
|
1038
|
-
$ref: '#/responses/Standard400'
|
|
1039
|
-
'401':
|
|
1040
|
-
$ref: '#/responses/Standard401'
|
|
1041
|
-
'404':
|
|
1042
|
-
$ref: '#/responses/Standard404'
|
|
1043
|
-
tags:
|
|
1044
|
-
- User settings
|
|
1045
|
-
'/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}':
|
|
1046
|
-
get:
|
|
1047
|
-
summary: Get expiring dates on flags for user
|
|
1048
|
-
operationId: getExpiringUserTargetsForUser
|
|
1049
|
-
parameters:
|
|
1050
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1051
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1052
|
-
- $ref: '#/parameters/UserKey'
|
|
1053
|
-
responses:
|
|
1054
|
-
'200':
|
|
1055
|
-
description: User targets of the requested feature flag.
|
|
1056
|
-
schema:
|
|
1057
|
-
$ref: '#/definitions/UserTargetingExpirationOnFlagsForUser'
|
|
1058
|
-
'401':
|
|
1059
|
-
$ref: '#/responses/Standard401'
|
|
1060
|
-
tags:
|
|
1061
|
-
- User settings
|
|
1062
|
-
patch:
|
|
1063
|
-
summary: >-
|
|
1064
|
-
Update, add, or delete expiring user targets for a single user on all
|
|
1065
|
-
flags
|
|
1066
|
-
operationId: patchExpiringUserTargetsForFlags
|
|
1067
|
-
parameters:
|
|
1068
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1069
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1070
|
-
- $ref: '#/parameters/UserKey'
|
|
1071
|
-
- $ref: '#/parameters/SemanticPatchWithComment'
|
|
1072
|
-
responses:
|
|
1073
|
-
'200':
|
|
1074
|
-
description: User Targeting expiration for single user on all flags response.
|
|
1075
|
-
schema:
|
|
1076
|
-
$ref: '#/definitions/UserTargetingExpirationOnFlagsForUser'
|
|
1077
|
-
'400':
|
|
1078
|
-
$ref: '#/responses/Standard400'
|
|
1079
|
-
'401':
|
|
1080
|
-
$ref: '#/responses/Standard401'
|
|
1081
|
-
'404':
|
|
1082
|
-
$ref: '#/responses/Standard404'
|
|
1083
|
-
'409':
|
|
1084
|
-
$ref: '#/responses/Standard409'
|
|
1085
|
-
tags:
|
|
1086
|
-
- User settings
|
|
1087
|
-
/auditlog:
|
|
1088
|
-
get:
|
|
1089
|
-
summary: >-
|
|
1090
|
-
Get a list of all audit log entries. The query parameters allow you to
|
|
1091
|
-
restrict the returned results by date ranges, resource specifiers, or a
|
|
1092
|
-
full-text search query.
|
|
1093
|
-
operationId: getAuditLogEntries
|
|
1094
|
-
parameters:
|
|
1095
|
-
- $ref: '#/parameters/Before'
|
|
1096
|
-
- $ref: '#/parameters/After'
|
|
1097
|
-
- $ref: '#/parameters/Q'
|
|
1098
|
-
- $ref: '#/parameters/AuditLimit'
|
|
1099
|
-
- $ref: '#/parameters/Spec'
|
|
1100
|
-
responses:
|
|
1101
|
-
'200':
|
|
1102
|
-
description: Audit log entries response.
|
|
1103
|
-
schema:
|
|
1104
|
-
$ref: '#/definitions/AuditLogEntries'
|
|
1105
|
-
'400':
|
|
1106
|
-
$ref: '#/responses/Standard400'
|
|
1107
|
-
'401':
|
|
1108
|
-
$ref: '#/responses/Standard401'
|
|
1109
|
-
tags:
|
|
1110
|
-
- Audit log
|
|
1111
|
-
'/auditlog/{resourceId}':
|
|
1112
|
-
get:
|
|
1113
|
-
summary: Use this endpoint to fetch a single audit log entry by its resouce ID.
|
|
1114
|
-
operationId: getAuditLogEntry
|
|
1115
|
-
parameters:
|
|
1116
|
-
- $ref: '#/parameters/ResourceId'
|
|
1117
|
-
responses:
|
|
1118
|
-
'200':
|
|
1119
|
-
description: Audit log entry response.
|
|
1120
|
-
schema:
|
|
1121
|
-
$ref: '#/definitions/AuditLogEntry'
|
|
1122
|
-
'401':
|
|
1123
|
-
$ref: '#/responses/Standard401'
|
|
1124
|
-
'404':
|
|
1125
|
-
$ref: '#/responses/Standard404'
|
|
1126
|
-
tags:
|
|
1127
|
-
- Audit log
|
|
1128
|
-
/webhooks:
|
|
1129
|
-
get:
|
|
1130
|
-
summary: Fetch a list of all webhooks.
|
|
1131
|
-
operationId: getWebhooks
|
|
1132
|
-
responses:
|
|
1133
|
-
'200':
|
|
1134
|
-
description: Webhooks response.
|
|
1135
|
-
schema:
|
|
1136
|
-
$ref: '#/definitions/Webhooks'
|
|
1137
|
-
'401':
|
|
1138
|
-
$ref: '#/responses/Standard401'
|
|
1139
|
-
tags:
|
|
1140
|
-
- Webhooks
|
|
1141
|
-
post:
|
|
1142
|
-
summary: Create a webhook.
|
|
1143
|
-
operationId: postWebhook
|
|
1144
|
-
parameters:
|
|
1145
|
-
- $ref: '#/parameters/WebhookPostRequest'
|
|
1146
|
-
responses:
|
|
1147
|
-
'201':
|
|
1148
|
-
$ref: '#/responses/Webhook2xx'
|
|
1149
|
-
'400':
|
|
1150
|
-
$ref: '#/responses/Standard400'
|
|
1151
|
-
'401':
|
|
1152
|
-
$ref: '#/responses/Standard401'
|
|
1153
|
-
tags:
|
|
1154
|
-
- Webhooks
|
|
1155
|
-
'/webhooks/{resourceId}':
|
|
1156
|
-
get:
|
|
1157
|
-
summary: Get a webhook by ID.
|
|
1158
|
-
operationId: getWebhook
|
|
1159
|
-
parameters:
|
|
1160
|
-
- $ref: '#/parameters/ResourceId'
|
|
1161
|
-
responses:
|
|
1162
|
-
'200':
|
|
1163
|
-
$ref: '#/responses/Webhook2xx'
|
|
1164
|
-
'401':
|
|
1165
|
-
$ref: '#/responses/Standard401'
|
|
1166
|
-
'404':
|
|
1167
|
-
$ref: '#/responses/Standard404'
|
|
1168
|
-
tags:
|
|
1169
|
-
- Webhooks
|
|
1170
|
-
patch:
|
|
1171
|
-
summary: Modify a webhook by ID.
|
|
1172
|
-
operationId: patchWebhook
|
|
1173
|
-
parameters:
|
|
1174
|
-
- $ref: '#/parameters/ResourceId'
|
|
1175
|
-
- $ref: '#/parameters/PatchRequest'
|
|
1176
|
-
responses:
|
|
1177
|
-
'200':
|
|
1178
|
-
$ref: '#/responses/Webhook2xx'
|
|
1179
|
-
'400':
|
|
1180
|
-
$ref: '#/responses/Standard400'
|
|
1181
|
-
'401':
|
|
1182
|
-
$ref: '#/responses/Standard401'
|
|
1183
|
-
'404':
|
|
1184
|
-
$ref: '#/responses/Standard404'
|
|
1185
|
-
'409':
|
|
1186
|
-
$ref: '#/responses/Standard409'
|
|
1187
|
-
tags:
|
|
1188
|
-
- Webhooks
|
|
1189
|
-
delete:
|
|
1190
|
-
summary: Delete a webhook by ID.
|
|
1191
|
-
operationId: deleteWebhook
|
|
1192
|
-
parameters:
|
|
1193
|
-
- $ref: '#/parameters/ResourceId'
|
|
1194
|
-
responses:
|
|
1195
|
-
'204':
|
|
1196
|
-
$ref: '#/responses/Standard204'
|
|
1197
|
-
'401':
|
|
1198
|
-
$ref: '#/responses/Standard401'
|
|
1199
|
-
'404':
|
|
1200
|
-
$ref: '#/responses/Standard404'
|
|
1201
|
-
tags:
|
|
1202
|
-
- Webhooks
|
|
1203
|
-
/roles:
|
|
1204
|
-
get:
|
|
1205
|
-
summary: Return a complete list of custom roles.
|
|
1206
|
-
operationId: getCustomRoles
|
|
1207
|
-
responses:
|
|
1208
|
-
'200':
|
|
1209
|
-
description: Custom roles response.
|
|
1210
|
-
schema:
|
|
1211
|
-
$ref: '#/definitions/CustomRoles'
|
|
1212
|
-
'401':
|
|
1213
|
-
$ref: '#/responses/Standard401'
|
|
1214
|
-
tags:
|
|
1215
|
-
- Custom roles
|
|
1216
|
-
post:
|
|
1217
|
-
summary: Create a new custom role.
|
|
1218
|
-
operationId: postCustomRole
|
|
1219
|
-
parameters:
|
|
1220
|
-
- $ref: '#/parameters/CustomRolePostRequest'
|
|
1221
|
-
responses:
|
|
1222
|
-
'201':
|
|
1223
|
-
$ref: '#/responses/CustomRole2xx'
|
|
1224
|
-
'400':
|
|
1225
|
-
$ref: '#/responses/Standard400'
|
|
1226
|
-
'401':
|
|
1227
|
-
$ref: '#/responses/Standard401'
|
|
1228
|
-
'409':
|
|
1229
|
-
$ref: '#/responses/Standard409'
|
|
1230
|
-
tags:
|
|
1231
|
-
- Custom roles
|
|
1232
|
-
'/roles/{customRoleKey}':
|
|
1233
|
-
get:
|
|
1234
|
-
summary: Get one custom role by key.
|
|
1235
|
-
operationId: getCustomRole
|
|
1236
|
-
parameters:
|
|
1237
|
-
- $ref: '#/parameters/CustomRoleKey'
|
|
1238
|
-
responses:
|
|
1239
|
-
'200':
|
|
1240
|
-
$ref: '#/responses/CustomRole2xx'
|
|
1241
|
-
'400':
|
|
1242
|
-
$ref: '#/responses/Standard400'
|
|
1243
|
-
'401':
|
|
1244
|
-
$ref: '#/responses/Standard401'
|
|
1245
|
-
tags:
|
|
1246
|
-
- Custom roles
|
|
1247
|
-
patch:
|
|
1248
|
-
summary: Modify a custom role by key.
|
|
1249
|
-
operationId: patchCustomRole
|
|
1250
|
-
parameters:
|
|
1251
|
-
- $ref: '#/parameters/CustomRoleKey'
|
|
1252
|
-
- $ref: '#/parameters/PatchRequest'
|
|
1253
|
-
responses:
|
|
1254
|
-
'200':
|
|
1255
|
-
$ref: '#/responses/CustomRole2xx'
|
|
1256
|
-
'400':
|
|
1257
|
-
$ref: '#/responses/Standard400'
|
|
1258
|
-
'401':
|
|
1259
|
-
$ref: '#/responses/Standard401'
|
|
1260
|
-
'404':
|
|
1261
|
-
$ref: '#/responses/Standard404'
|
|
1262
|
-
'409':
|
|
1263
|
-
$ref: '#/responses/Standard409'
|
|
1264
|
-
tags:
|
|
1265
|
-
- Custom roles
|
|
1266
|
-
delete:
|
|
1267
|
-
summary: Delete a custom role by key.
|
|
1268
|
-
operationId: deleteCustomRole
|
|
1269
|
-
parameters:
|
|
1270
|
-
- $ref: '#/parameters/CustomRoleKey'
|
|
1271
|
-
responses:
|
|
1272
|
-
'204':
|
|
1273
|
-
$ref: '#/responses/Standard204'
|
|
1274
|
-
'401':
|
|
1275
|
-
$ref: '#/responses/Standard401'
|
|
1276
|
-
'404':
|
|
1277
|
-
$ref: '#/responses/Standard404'
|
|
1278
|
-
tags:
|
|
1279
|
-
- Custom roles
|
|
1280
|
-
/members:
|
|
1281
|
-
get:
|
|
1282
|
-
summary: Returns a list of all members in the account.
|
|
1283
|
-
operationId: getMembers
|
|
1284
|
-
parameters:
|
|
1285
|
-
- $ref: '#/parameters/LimitQuery'
|
|
1286
|
-
- $ref: '#/parameters/OffsetQuery'
|
|
1287
|
-
- $ref: '#/parameters/FilterQuery'
|
|
1288
|
-
- $ref: '#/parameters/SortQuery'
|
|
1289
|
-
responses:
|
|
1290
|
-
'200':
|
|
1291
|
-
description: Members response.
|
|
1292
|
-
schema:
|
|
1293
|
-
$ref: '#/definitions/Members'
|
|
1294
|
-
'401':
|
|
1295
|
-
$ref: '#/responses/Standard401'
|
|
1296
|
-
tags:
|
|
1297
|
-
- Team members
|
|
1298
|
-
post:
|
|
1299
|
-
summary: Invite new members.
|
|
1300
|
-
operationId: postMembers
|
|
1301
|
-
parameters:
|
|
1302
|
-
- $ref: '#/parameters/MembersPostRequest'
|
|
1303
|
-
responses:
|
|
1304
|
-
'201':
|
|
1305
|
-
description: Members response.
|
|
1306
|
-
schema:
|
|
1307
|
-
$ref: '#/definitions/Members'
|
|
1308
|
-
'400':
|
|
1309
|
-
$ref: '#/responses/Standard400'
|
|
1310
|
-
'401':
|
|
1311
|
-
$ref: '#/responses/Standard401'
|
|
1312
|
-
'409':
|
|
1313
|
-
$ref: '#/responses/Standard409'
|
|
1314
|
-
tags:
|
|
1315
|
-
- Team members
|
|
1316
|
-
/members/me:
|
|
1317
|
-
get:
|
|
1318
|
-
summary: Get the current team member associated with the token
|
|
1319
|
-
operationId: getMe
|
|
1320
|
-
responses:
|
|
1321
|
-
'200':
|
|
1322
|
-
$ref: '#/responses/Member2xx'
|
|
1323
|
-
'400':
|
|
1324
|
-
$ref: '#/responses/Standard400'
|
|
1325
|
-
'401':
|
|
1326
|
-
$ref: '#/responses/Standard401'
|
|
1327
|
-
tags:
|
|
1328
|
-
- Team members
|
|
1329
|
-
'/members/{memberId}':
|
|
1330
|
-
get:
|
|
1331
|
-
summary: Get a single team member by ID.
|
|
1332
|
-
operationId: getMember
|
|
1333
|
-
parameters:
|
|
1334
|
-
- $ref: '#/parameters/MemberId'
|
|
1335
|
-
responses:
|
|
1336
|
-
'200':
|
|
1337
|
-
$ref: '#/responses/Member2xx'
|
|
1338
|
-
'400':
|
|
1339
|
-
$ref: '#/responses/Standard400'
|
|
1340
|
-
'401':
|
|
1341
|
-
$ref: '#/responses/Standard401'
|
|
1342
|
-
tags:
|
|
1343
|
-
- Team members
|
|
1344
|
-
patch:
|
|
1345
|
-
summary: Modify a team member by ID.
|
|
1346
|
-
operationId: patchMember
|
|
1347
|
-
parameters:
|
|
1348
|
-
- $ref: '#/parameters/MemberId'
|
|
1349
|
-
- $ref: '#/parameters/PatchRequest'
|
|
1350
|
-
responses:
|
|
1351
|
-
'200':
|
|
1352
|
-
$ref: '#/responses/Member2xx'
|
|
1353
|
-
'400':
|
|
1354
|
-
$ref: '#/responses/Standard400'
|
|
1355
|
-
'401':
|
|
1356
|
-
$ref: '#/responses/Standard401'
|
|
1357
|
-
'404':
|
|
1358
|
-
$ref: '#/responses/Standard404'
|
|
1359
|
-
'409':
|
|
1360
|
-
$ref: '#/responses/Standard409'
|
|
1361
|
-
tags:
|
|
1362
|
-
- Team members
|
|
1363
|
-
delete:
|
|
1364
|
-
summary: Delete a team member by ID.
|
|
1365
|
-
operationId: deleteMember
|
|
1366
|
-
parameters:
|
|
1367
|
-
- $ref: '#/parameters/MemberId'
|
|
1368
|
-
responses:
|
|
1369
|
-
'204':
|
|
1370
|
-
$ref: '#/responses/Standard204'
|
|
1371
|
-
'401':
|
|
1372
|
-
$ref: '#/responses/Standard401'
|
|
1373
|
-
'404':
|
|
1374
|
-
$ref: '#/responses/Standard404'
|
|
1375
|
-
tags:
|
|
1376
|
-
- Team members
|
|
1377
|
-
/destinations:
|
|
1378
|
-
get:
|
|
1379
|
-
summary: Returns a list of all data export destinations.
|
|
1380
|
-
operationId: getDestinations
|
|
1381
|
-
responses:
|
|
1382
|
-
'200':
|
|
1383
|
-
description: Destinations response.
|
|
1384
|
-
schema:
|
|
1385
|
-
$ref: '#/definitions/Destinations'
|
|
1386
|
-
'401':
|
|
1387
|
-
$ref: '#/responses/Standard401'
|
|
1388
|
-
tags:
|
|
1389
|
-
- Data export destinations
|
|
1390
|
-
'/destinations/{projectKey}/{environmentKey}':
|
|
1391
|
-
post:
|
|
1392
|
-
summary: Create a new data export destination
|
|
1393
|
-
operationId: postDestination
|
|
1394
|
-
parameters:
|
|
1395
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1396
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1397
|
-
- $ref: '#/parameters/DestinationPostRequest'
|
|
1398
|
-
responses:
|
|
1399
|
-
'201':
|
|
1400
|
-
$ref: '#/responses/Destination2xx'
|
|
1401
|
-
'400':
|
|
1402
|
-
$ref: '#/responses/Standard400'
|
|
1403
|
-
'401':
|
|
1404
|
-
$ref: '#/responses/Standard401'
|
|
1405
|
-
'409':
|
|
1406
|
-
$ref: '#/responses/Standard409'
|
|
1407
|
-
tags:
|
|
1408
|
-
- Data export destinations
|
|
1409
|
-
'/destinations/{projectKey}/{environmentKey}/{destinationId}':
|
|
1410
|
-
get:
|
|
1411
|
-
summary: Get a single data export destination by ID
|
|
1412
|
-
operationId: getDestination
|
|
1413
|
-
parameters:
|
|
1414
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1415
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1416
|
-
- $ref: '#/parameters/DestinationId'
|
|
1417
|
-
responses:
|
|
1418
|
-
'200':
|
|
1419
|
-
$ref: '#/responses/Destination2xx'
|
|
1420
|
-
'401':
|
|
1421
|
-
$ref: '#/responses/Standard401'
|
|
1422
|
-
'404':
|
|
1423
|
-
$ref: '#/responses/Standard404'
|
|
1424
|
-
tags:
|
|
1425
|
-
- Data export destinations
|
|
1426
|
-
patch:
|
|
1427
|
-
summary: Perform a partial update to a data export destination.
|
|
1428
|
-
operationId: patchDestination
|
|
1429
|
-
parameters:
|
|
1430
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1431
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1432
|
-
- $ref: '#/parameters/DestinationId'
|
|
1433
|
-
- $ref: '#/parameters/PatchOnly'
|
|
1434
|
-
responses:
|
|
1435
|
-
'200':
|
|
1436
|
-
$ref: '#/responses/Destination2xx'
|
|
1437
|
-
'400':
|
|
1438
|
-
$ref: '#/responses/Standard400'
|
|
1439
|
-
'401':
|
|
1440
|
-
$ref: '#/responses/Standard401'
|
|
1441
|
-
'404':
|
|
1442
|
-
$ref: '#/responses/Standard404'
|
|
1443
|
-
'409':
|
|
1444
|
-
$ref: '#/responses/Standard409'
|
|
1445
|
-
tags:
|
|
1446
|
-
- Data export destinations
|
|
1447
|
-
delete:
|
|
1448
|
-
summary: Get a single data export destination by ID
|
|
1449
|
-
operationId: deleteDestination
|
|
1450
|
-
parameters:
|
|
1451
|
-
- $ref: '#/parameters/ProjectKey'
|
|
1452
|
-
- $ref: '#/parameters/EnvironmentKey'
|
|
1453
|
-
- $ref: '#/parameters/DestinationId'
|
|
1454
|
-
responses:
|
|
1455
|
-
'204':
|
|
1456
|
-
$ref: '#/responses/Standard204'
|
|
1457
|
-
'401':
|
|
1458
|
-
$ref: '#/responses/Standard401'
|
|
1459
|
-
'404':
|
|
1460
|
-
$ref: '#/responses/Standard404'
|
|
1461
|
-
tags:
|
|
1462
|
-
- Data export destinations
|
|
1463
|
-
/usage:
|
|
1464
|
-
get:
|
|
1465
|
-
summary: Returns of the usage endpoints available.
|
|
1466
|
-
operationId: getUsage
|
|
1467
|
-
responses:
|
|
1468
|
-
'200':
|
|
1469
|
-
description: Usage endpoints
|
|
1470
|
-
schema:
|
|
1471
|
-
$ref: '#/definitions/Usage'
|
|
1472
|
-
'403':
|
|
1473
|
-
$ref: '#/responses/BetaApi403'
|
|
1474
|
-
tags:
|
|
1475
|
-
- Customer Metrics
|
|
1476
|
-
/usage/streams:
|
|
1477
|
-
get:
|
|
1478
|
-
summary: Returns a list of all streams.
|
|
1479
|
-
operationId: getStreams
|
|
1480
|
-
responses:
|
|
1481
|
-
'200':
|
|
1482
|
-
description: Stream usage endpoints
|
|
1483
|
-
schema:
|
|
1484
|
-
$ref: '#/definitions/Streams'
|
|
1485
|
-
'403':
|
|
1486
|
-
$ref: '#/responses/BetaApi403'
|
|
1487
|
-
tags:
|
|
1488
|
-
- Customer Metrics
|
|
1489
|
-
'/usage/streams/{source}':
|
|
1490
|
-
get:
|
|
1491
|
-
summary: Get a stream endpoint and return timeseries data.
|
|
1492
|
-
operationId: getStream
|
|
1493
|
-
parameters:
|
|
1494
|
-
- $ref: '#/parameters/StreamSource'
|
|
1495
|
-
responses:
|
|
1496
|
-
'200':
|
|
1497
|
-
description: Responds with time series data on stream usage.
|
|
1498
|
-
schema:
|
|
1499
|
-
$ref: '#/definitions/Stream'
|
|
1500
|
-
'403':
|
|
1501
|
-
$ref: '#/responses/BetaApi403'
|
|
1502
|
-
'404':
|
|
1503
|
-
$ref: '#/responses/StreamUsage404'
|
|
1504
|
-
tags:
|
|
1505
|
-
- Customer Metrics
|
|
1506
|
-
'/usage/streams/{source}/bysdkversion':
|
|
1507
|
-
get:
|
|
1508
|
-
summary: Get a stream timeseries data by source show sdk version metadata.
|
|
1509
|
-
operationId: getStreamBySDK
|
|
1510
|
-
parameters:
|
|
1511
|
-
- $ref: '#/parameters/StreamSource'
|
|
1512
|
-
responses:
|
|
1513
|
-
'200':
|
|
1514
|
-
description: Returns timeseries data and metadata on sdk version.
|
|
1515
|
-
schema:
|
|
1516
|
-
$ref: '#/definitions/StreamBySDK'
|
|
1517
|
-
'403':
|
|
1518
|
-
$ref: '#/responses/BetaApi403'
|
|
1519
|
-
'404':
|
|
1520
|
-
$ref: '#/responses/StreamUsage404'
|
|
1521
|
-
tags:
|
|
1522
|
-
- Customer Metrics
|
|
1523
|
-
'/usage/streams/{source}/sdkversions':
|
|
1524
|
-
get:
|
|
1525
|
-
summary: >-
|
|
1526
|
-
Get a stream timeseries data by source and show all sdk version
|
|
1527
|
-
associated.
|
|
1528
|
-
operationId: getStreamSDKVersion
|
|
1529
|
-
parameters:
|
|
1530
|
-
- $ref: '#/parameters/StreamSource'
|
|
1531
|
-
responses:
|
|
1532
|
-
'200':
|
|
1533
|
-
description: Returns timeseries data and all sdk versions.
|
|
1534
|
-
schema:
|
|
1535
|
-
$ref: '#/definitions/StreamSDKVersion'
|
|
1536
|
-
'403':
|
|
1537
|
-
$ref: '#/responses/BetaApi403'
|
|
1538
|
-
'404':
|
|
1539
|
-
$ref: '#/responses/StreamUsage404'
|
|
1540
|
-
tags:
|
|
1541
|
-
- Customer Metrics
|
|
1542
|
-
/usage/mau:
|
|
1543
|
-
get:
|
|
1544
|
-
summary: Get monthly active user data.
|
|
1545
|
-
operationId: getMAU
|
|
1546
|
-
responses:
|
|
1547
|
-
'200':
|
|
1548
|
-
description: Returns timeseries data and all sdk versions.
|
|
1549
|
-
schema:
|
|
1550
|
-
$ref: '#/definitions/MAU'
|
|
1551
|
-
'403':
|
|
1552
|
-
$ref: '#/responses/BetaApi403'
|
|
1553
|
-
tags:
|
|
1554
|
-
- Customer Metrics
|
|
1555
|
-
/usage/mau/bycategory:
|
|
1556
|
-
get:
|
|
1557
|
-
summary: Get monthly active user data by category.
|
|
1558
|
-
operationId: getMAUByCategory
|
|
1559
|
-
responses:
|
|
1560
|
-
'200':
|
|
1561
|
-
description: Returns timeseries data and all sdk versions.
|
|
1562
|
-
schema:
|
|
1563
|
-
$ref: '#/definitions/MAUbyCategory'
|
|
1564
|
-
'403':
|
|
1565
|
-
$ref: '#/responses/BetaApi403'
|
|
1566
|
-
tags:
|
|
1567
|
-
- Customer Metrics
|
|
1568
|
-
/usage/events:
|
|
1569
|
-
get:
|
|
1570
|
-
summary: Get events usage endpoints.
|
|
1571
|
-
operationId: getEvents
|
|
1572
|
-
responses:
|
|
1573
|
-
'200':
|
|
1574
|
-
description: Returns timeseries data and all sdk versions.
|
|
1575
|
-
schema:
|
|
1576
|
-
$ref: '#/definitions/Events'
|
|
1577
|
-
'403':
|
|
1578
|
-
$ref: '#/responses/BetaApi403'
|
|
1579
|
-
tags:
|
|
1580
|
-
- Customer Metrics
|
|
1581
|
-
'/usage/events/{type}':
|
|
1582
|
-
get:
|
|
1583
|
-
summary: Get events usage by event type.
|
|
1584
|
-
operationId: getEvent
|
|
1585
|
-
parameters:
|
|
1586
|
-
- $ref: '#/parameters/EventType'
|
|
1587
|
-
responses:
|
|
1588
|
-
'200':
|
|
1589
|
-
description: Returns timeseries data and all sdk versions.
|
|
1590
|
-
schema:
|
|
1591
|
-
$ref: '#/definitions/StreamSDKVersion'
|
|
1592
|
-
'403':
|
|
1593
|
-
$ref: '#/responses/BetaApi403'
|
|
1594
|
-
'404':
|
|
1595
|
-
$ref: '#/responses/StreamUsage404'
|
|
1596
|
-
tags:
|
|
1597
|
-
- Customer Metrics
|
|
1598
|
-
'/usage/evaluations/{envId}/{flagKey}':
|
|
1599
|
-
get:
|
|
1600
|
-
summary: Get events usage by event id and the feature flag key.
|
|
1601
|
-
operationId: getEvaluations
|
|
1602
|
-
parameters:
|
|
1603
|
-
- $ref: '#/parameters/EvaluationEnvId'
|
|
1604
|
-
- $ref: '#/parameters/EvaluationFlagKey'
|
|
1605
|
-
responses:
|
|
1606
|
-
'200':
|
|
1607
|
-
description: Returns timeseries data and all sdk versions.
|
|
1608
|
-
schema:
|
|
1609
|
-
$ref: '#/definitions/StreamSDKVersion'
|
|
1610
|
-
'403':
|
|
1611
|
-
$ref: '#/responses/BetaApi403'
|
|
1612
|
-
'404':
|
|
1613
|
-
$ref: '#/responses/EvaluationUsage404'
|
|
1614
|
-
tags:
|
|
1615
|
-
- Customer Metrics
|
|
1616
|
-
/tokens:
|
|
1617
|
-
get:
|
|
1618
|
-
summary: Returns a list of tokens in the account.
|
|
1619
|
-
operationId: getTokens
|
|
1620
|
-
parameters:
|
|
1621
|
-
- $ref: '#/parameters/TokenShowAllQuery'
|
|
1622
|
-
responses:
|
|
1623
|
-
'200':
|
|
1624
|
-
description: Tokens response.
|
|
1625
|
-
schema:
|
|
1626
|
-
$ref: '#/definitions/Tokens'
|
|
1627
|
-
'401':
|
|
1628
|
-
$ref: '#/responses/Standard401'
|
|
1629
|
-
tags:
|
|
1630
|
-
- Access tokens
|
|
1631
|
-
post:
|
|
1632
|
-
summary: Create a new token.
|
|
1633
|
-
operationId: postToken
|
|
1634
|
-
parameters:
|
|
1635
|
-
- $ref: '#/parameters/TokensPostRequest'
|
|
1636
|
-
responses:
|
|
1637
|
-
'201':
|
|
1638
|
-
description: Token response.
|
|
1639
|
-
schema:
|
|
1640
|
-
$ref: '#/definitions/Token'
|
|
1641
|
-
'400':
|
|
1642
|
-
$ref: '#/responses/Standard400'
|
|
1643
|
-
'401':
|
|
1644
|
-
$ref: '#/responses/Standard401'
|
|
1645
|
-
'409':
|
|
1646
|
-
$ref: '#/responses/Standard409'
|
|
1647
|
-
tags:
|
|
1648
|
-
- Access tokens
|
|
1649
|
-
'/tokens/{tokenId}':
|
|
1650
|
-
get:
|
|
1651
|
-
summary: Get a single access token by ID.
|
|
1652
|
-
operationId: getToken
|
|
1653
|
-
parameters:
|
|
1654
|
-
- $ref: '#/parameters/TokenId'
|
|
1655
|
-
responses:
|
|
1656
|
-
'200':
|
|
1657
|
-
$ref: '#/responses/Token2xx'
|
|
1658
|
-
'400':
|
|
1659
|
-
$ref: '#/responses/Standard400'
|
|
1660
|
-
'401':
|
|
1661
|
-
$ref: '#/responses/Standard401'
|
|
1662
|
-
tags:
|
|
1663
|
-
- Access tokens
|
|
1664
|
-
patch:
|
|
1665
|
-
summary: Modify an access token by ID.
|
|
1666
|
-
operationId: patchToken
|
|
1667
|
-
parameters:
|
|
1668
|
-
- $ref: '#/parameters/TokenId'
|
|
1669
|
-
- $ref: '#/parameters/PatchRequest'
|
|
1670
|
-
responses:
|
|
1671
|
-
'200':
|
|
1672
|
-
$ref: '#/responses/Token2xx'
|
|
1673
|
-
'400':
|
|
1674
|
-
$ref: '#/responses/Standard400'
|
|
1675
|
-
'401':
|
|
1676
|
-
$ref: '#/responses/Standard401'
|
|
1677
|
-
'404':
|
|
1678
|
-
$ref: '#/responses/Standard404'
|
|
1679
|
-
'409':
|
|
1680
|
-
$ref: '#/responses/Standard409'
|
|
1681
|
-
tags:
|
|
1682
|
-
- Access tokens
|
|
1683
|
-
delete:
|
|
1684
|
-
summary: Delete an access token by ID.
|
|
1685
|
-
operationId: deleteToken
|
|
1686
|
-
parameters:
|
|
1687
|
-
- $ref: '#/parameters/TokenId'
|
|
1688
|
-
responses:
|
|
1689
|
-
'204':
|
|
1690
|
-
$ref: '#/responses/Standard204'
|
|
1691
|
-
'401':
|
|
1692
|
-
$ref: '#/responses/Standard401'
|
|
1693
|
-
'404':
|
|
1694
|
-
$ref: '#/responses/Standard404'
|
|
1695
|
-
tags:
|
|
1696
|
-
- Access tokens
|
|
1697
|
-
'/tokens/{tokenId}/reset':
|
|
1698
|
-
post:
|
|
1699
|
-
summary: >-
|
|
1700
|
-
Reset an access token's secret key with an optional expiry time for the
|
|
1701
|
-
old key.
|
|
1702
|
-
operationId: resetToken
|
|
1703
|
-
parameters:
|
|
1704
|
-
- $ref: '#/parameters/TokenId'
|
|
1705
|
-
- $ref: '#/parameters/TokenExpiry'
|
|
1706
|
-
responses:
|
|
1707
|
-
'200':
|
|
1708
|
-
$ref: '#/responses/Token2xx'
|
|
1709
|
-
'400':
|
|
1710
|
-
$ref: '#/responses/Standard400'
|
|
1711
|
-
'401':
|
|
1712
|
-
$ref: '#/responses/Standard401'
|
|
1713
|
-
tags:
|
|
1714
|
-
- Access tokens
|
|
1715
|
-
/account/relay-auto-configs:
|
|
1716
|
-
get:
|
|
1717
|
-
summary: Returns a list of relay proxy configurations in the account.
|
|
1718
|
-
operationId: getRelayProxyConfigs
|
|
1719
|
-
responses:
|
|
1720
|
-
'200':
|
|
1721
|
-
description: Relay proxy configs response.
|
|
1722
|
-
schema:
|
|
1723
|
-
$ref: '#/definitions/RelayProxyConfigs'
|
|
1724
|
-
tags:
|
|
1725
|
-
- Relay proxy configurations
|
|
1726
|
-
post:
|
|
1727
|
-
summary: Create a new relay proxy config.
|
|
1728
|
-
operationId: postRelayAutoConfig
|
|
1729
|
-
parameters:
|
|
1730
|
-
- $ref: '#/parameters/RelayProxyConfigPostRequest'
|
|
1731
|
-
responses:
|
|
1732
|
-
'201':
|
|
1733
|
-
description: Relay proxy config response.
|
|
1734
|
-
schema:
|
|
1735
|
-
$ref: '#/definitions/RelayProxyConfig'
|
|
1736
|
-
'400':
|
|
1737
|
-
$ref: '#/responses/Standard400'
|
|
1738
|
-
'403':
|
|
1739
|
-
$ref: '#/responses/Standard403'
|
|
1740
|
-
tags:
|
|
1741
|
-
- Relay proxy configurations
|
|
1742
|
-
'/account/relay-auto-configs/{id}':
|
|
1743
|
-
get:
|
|
1744
|
-
summary: Get a single relay proxy configuration by ID.
|
|
1745
|
-
operationId: getRelayProxyConfig
|
|
1746
|
-
parameters:
|
|
1747
|
-
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1748
|
-
responses:
|
|
1749
|
-
'200':
|
|
1750
|
-
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1751
|
-
'404':
|
|
1752
|
-
$ref: '#/responses/Standard404'
|
|
1753
|
-
tags:
|
|
1754
|
-
- Relay proxy configurations
|
|
1755
|
-
patch:
|
|
1756
|
-
summary: Modify a relay proxy configuration by ID.
|
|
1757
|
-
operationId: patchRelayProxyConfig
|
|
1758
|
-
parameters:
|
|
1759
|
-
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1760
|
-
- $ref: '#/parameters/PatchRequest'
|
|
1761
|
-
responses:
|
|
1762
|
-
'200':
|
|
1763
|
-
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1764
|
-
'400':
|
|
1765
|
-
$ref: '#/responses/Standard400'
|
|
1766
|
-
'404':
|
|
1767
|
-
$ref: '#/responses/Standard404'
|
|
1768
|
-
'409':
|
|
1769
|
-
$ref: '#/responses/Standard409'
|
|
1770
|
-
tags:
|
|
1771
|
-
- Relay proxy configurations
|
|
1772
|
-
delete:
|
|
1773
|
-
summary: Delete a relay proxy configuration by ID.
|
|
1774
|
-
operationId: deleteRelayProxyConfig
|
|
1775
|
-
parameters:
|
|
1776
|
-
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1777
|
-
responses:
|
|
1778
|
-
'204':
|
|
1779
|
-
$ref: '#/responses/Standard204'
|
|
1780
|
-
'400':
|
|
1781
|
-
$ref: '#/responses/Standard400'
|
|
1782
|
-
'404':
|
|
1783
|
-
$ref: '#/responses/Standard404'
|
|
1784
|
-
tags:
|
|
1785
|
-
- Relay proxy configurations
|
|
1786
|
-
'/account/relay-auto-configs/{id}/reset':
|
|
1787
|
-
post:
|
|
1788
|
-
summary: >-
|
|
1789
|
-
Reset a relay proxy configuration's secret key with an optional expiry
|
|
1790
|
-
time for the old key.
|
|
1791
|
-
operationId: resetRelayProxyConfig
|
|
1792
|
-
parameters:
|
|
1793
|
-
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1794
|
-
- $ref: '#/parameters/RelayProxyConfigsExpiry'
|
|
1795
|
-
responses:
|
|
1796
|
-
'200':
|
|
1797
|
-
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1798
|
-
'400':
|
|
1799
|
-
$ref: '#/responses/Standard400'
|
|
1800
|
-
'404':
|
|
1801
|
-
$ref: '#/responses/Standard404'
|
|
1802
|
-
tags:
|
|
1803
|
-
- Relay proxy configurations
|
|
1804
|
-
/:
|
|
1805
|
-
get:
|
|
1806
|
-
description: >-
|
|
1807
|
-
You can issue a GET request to the root resource to find all of the
|
|
1808
|
-
resource categories supported by the API.
|
|
1809
|
-
operationId: getRoot
|
|
1810
|
-
responses:
|
|
1811
|
-
'200':
|
|
1812
|
-
$ref: '#/responses/Root200'
|
|
1813
|
-
'401':
|
|
1814
|
-
$ref: '#/responses/Standard401'
|
|
1815
|
-
tags:
|
|
1816
|
-
- Root
|
|
1817
|
-
/integrations:
|
|
1818
|
-
get:
|
|
1819
|
-
summary: >-
|
|
1820
|
-
Get a list of all configured audit log event integrations associated
|
|
1821
|
-
with this account.
|
|
1822
|
-
operationId: getIntegrations
|
|
1823
|
-
responses:
|
|
1824
|
-
'200':
|
|
1825
|
-
description: Integrations response.
|
|
1826
|
-
schema:
|
|
1827
|
-
$ref: '#/definitions/Integrations'
|
|
1828
|
-
'403':
|
|
1829
|
-
$ref: '#/responses/BetaApi403'
|
|
1830
|
-
tags:
|
|
1831
|
-
- Integrations
|
|
1832
|
-
'/integrations/{integrationKey}':
|
|
1833
|
-
get:
|
|
1834
|
-
summary: Get a list of all configured integrations of a given kind.
|
|
1835
|
-
operationId: getIntegrationSubscriptions
|
|
1836
|
-
parameters:
|
|
1837
|
-
- $ref: '#/parameters/IntegrationKey'
|
|
1838
|
-
responses:
|
|
1839
|
-
'200':
|
|
1840
|
-
description: Integrations response.
|
|
1841
|
-
schema:
|
|
1842
|
-
$ref: '#/definitions/Integration'
|
|
1843
|
-
'403':
|
|
1844
|
-
$ref: '#/responses/BetaApi403'
|
|
1845
|
-
'404':
|
|
1846
|
-
$ref: '#/responses/Standard404'
|
|
1847
|
-
tags:
|
|
1848
|
-
- Integrations
|
|
1849
|
-
post:
|
|
1850
|
-
summary: Create a new integration subscription of a given kind.
|
|
1851
|
-
operationId: postIntegrationSubscription
|
|
1852
|
-
parameters:
|
|
1853
|
-
- $ref: '#/parameters/IntegrationKey'
|
|
1854
|
-
- $ref: '#/parameters/IntegrationPostRequest'
|
|
1855
|
-
responses:
|
|
1856
|
-
'201':
|
|
1857
|
-
description: Integrations response.
|
|
1858
|
-
schema:
|
|
1859
|
-
$ref: '#/definitions/IntegrationSubscription'
|
|
1860
|
-
'400':
|
|
1861
|
-
$ref: '#/responses/Standard400'
|
|
1862
|
-
'401':
|
|
1863
|
-
$ref: '#/responses/Standard401'
|
|
1864
|
-
'409':
|
|
1865
|
-
$ref: '#/responses/Standard409'
|
|
1866
|
-
tags:
|
|
1867
|
-
- Integrations
|
|
1868
|
-
'/integrations/{integrationKey}/{integrationId}':
|
|
1869
|
-
get:
|
|
1870
|
-
summary: Get a single integration subscription by ID.
|
|
1871
|
-
operationId: getIntegrationSubscription
|
|
1872
|
-
parameters:
|
|
1873
|
-
- $ref: '#/parameters/IntegrationKey'
|
|
1874
|
-
- $ref: '#/parameters/IntegrationId'
|
|
1875
|
-
responses:
|
|
1876
|
-
'200':
|
|
1877
|
-
description: Integrations response.
|
|
1878
|
-
schema:
|
|
1879
|
-
$ref: '#/definitions/IntegrationSubscription'
|
|
1880
|
-
'403':
|
|
1881
|
-
$ref: '#/responses/BetaApi403'
|
|
1882
|
-
'404':
|
|
1883
|
-
$ref: '#/responses/Standard404'
|
|
1884
|
-
tags:
|
|
1885
|
-
- Integrations
|
|
1886
|
-
patch:
|
|
1887
|
-
summary: Modify an integration subscription by ID.
|
|
1888
|
-
operationId: patchIntegrationSubscription
|
|
1889
|
-
parameters:
|
|
1890
|
-
- $ref: '#/parameters/IntegrationKey'
|
|
1891
|
-
- $ref: '#/parameters/IntegrationId'
|
|
1892
|
-
- $ref: '#/parameters/PatchRequest'
|
|
1893
|
-
responses:
|
|
1894
|
-
'200':
|
|
1895
|
-
description: Integrations response.
|
|
1896
|
-
schema:
|
|
1897
|
-
$ref: '#/definitions/IntegrationSubscription'
|
|
1898
|
-
'400':
|
|
1899
|
-
$ref: '#/responses/Standard400'
|
|
1900
|
-
'401':
|
|
1901
|
-
$ref: '#/responses/Standard401'
|
|
1902
|
-
'404':
|
|
1903
|
-
$ref: '#/responses/Standard404'
|
|
1904
|
-
tags:
|
|
1905
|
-
- Integrations
|
|
1906
|
-
delete:
|
|
1907
|
-
summary: Delete an integration subscription by ID.
|
|
1908
|
-
operationId: deleteIntegrationSubscription
|
|
1909
|
-
parameters:
|
|
1910
|
-
- $ref: '#/parameters/IntegrationKey'
|
|
1911
|
-
- $ref: '#/parameters/IntegrationId'
|
|
1912
|
-
responses:
|
|
1913
|
-
'204':
|
|
1914
|
-
$ref: '#/responses/Standard204'
|
|
1915
|
-
'401':
|
|
1916
|
-
$ref: '#/responses/Standard401'
|
|
1917
|
-
'404':
|
|
1918
|
-
$ref: '#/responses/Standard404'
|
|
1919
|
-
tags:
|
|
1920
|
-
- Integrations
|
|
1921
|
-
definitions:
|
|
1922
|
-
Link:
|
|
1923
|
-
type: object
|
|
1924
|
-
properties:
|
|
1925
|
-
href:
|
|
1926
|
-
type: string
|
|
1927
|
-
example: /api/v2/endpoint
|
|
1928
|
-
type:
|
|
1929
|
-
type: string
|
|
1930
|
-
example: application/json
|
|
1931
|
-
Links:
|
|
1932
|
-
type: object
|
|
1933
|
-
properties:
|
|
1934
|
-
self:
|
|
1935
|
-
$ref: '#/definitions/Link'
|
|
1936
|
-
next:
|
|
1937
|
-
$ref: '#/definitions/Link'
|
|
1938
|
-
Site:
|
|
1939
|
-
type: object
|
|
1940
|
-
properties:
|
|
1941
|
-
href:
|
|
1942
|
-
type: string
|
|
1943
|
-
example: /features/sort.order
|
|
1944
|
-
type:
|
|
1945
|
-
type: string
|
|
1946
|
-
example: text/html
|
|
1947
|
-
Webhook:
|
|
1948
|
-
type: object
|
|
1949
|
-
properties:
|
|
1950
|
-
_links:
|
|
1951
|
-
$ref: '#/definitions/Links'
|
|
1952
|
-
_id:
|
|
1953
|
-
$ref: '#/definitions/Id'
|
|
1954
|
-
url:
|
|
1955
|
-
type: string
|
|
1956
|
-
description: The URL of the remote webhook.
|
|
1957
|
-
example: 'https://example.com/example'
|
|
1958
|
-
secret:
|
|
1959
|
-
type: string
|
|
1960
|
-
description: >-
|
|
1961
|
-
If defined, the webhooks post request will include a X-LD-Signature
|
|
1962
|
-
header whose value will contain an HMAC SHA256 hex digest of the
|
|
1963
|
-
webhook payload, using the secret as the key.
|
|
1964
|
-
example: frobozz
|
|
1965
|
-
'on':
|
|
1966
|
-
type: boolean
|
|
1967
|
-
description: Whether this webhook is enabled or not.
|
|
1968
|
-
example: true
|
|
1969
|
-
name:
|
|
1970
|
-
type: string
|
|
1971
|
-
description: The name of the webhook.
|
|
1972
|
-
example: Example hook
|
|
1973
|
-
statements:
|
|
1974
|
-
type: array
|
|
1975
|
-
items:
|
|
1976
|
-
$ref: '#/definitions/Statement'
|
|
1977
|
-
tags:
|
|
1978
|
-
type: array
|
|
1979
|
-
description: Tags assigned to this webhook.
|
|
1980
|
-
items:
|
|
1981
|
-
type: string
|
|
1982
|
-
example: []
|
|
1983
|
-
Webhooks:
|
|
1984
|
-
type: object
|
|
1985
|
-
properties:
|
|
1986
|
-
_links:
|
|
1987
|
-
$ref: '#/definitions/Links'
|
|
1988
|
-
items:
|
|
1989
|
-
type: array
|
|
1990
|
-
items:
|
|
1991
|
-
$ref: '#/definitions/Webhook'
|
|
1992
|
-
FeatureFlag:
|
|
1993
|
-
type: object
|
|
1994
|
-
properties:
|
|
1995
|
-
key:
|
|
1996
|
-
type: string
|
|
1997
|
-
example: test-feature
|
|
1998
|
-
name:
|
|
1999
|
-
type: string
|
|
2000
|
-
description: Name of the feature flag.
|
|
2001
|
-
example: Test Feature
|
|
2002
|
-
description:
|
|
2003
|
-
type: string
|
|
2004
|
-
description: Description of the feature flag.
|
|
2005
|
-
example: This flag controls whether test feature is turned on or not.
|
|
2006
|
-
kind:
|
|
2007
|
-
type: string
|
|
2008
|
-
description: Whether the feature flag is a boolean flag or multivariate.
|
|
2009
|
-
example: boolean
|
|
2010
|
-
creationDate:
|
|
2011
|
-
type: integer
|
|
2012
|
-
format: int64
|
|
2013
|
-
description: >-
|
|
2014
|
-
A unix epoch time in milliseconds specifying the creation time of this
|
|
2015
|
-
flag.
|
|
2016
|
-
example: 1443652232590
|
|
2017
|
-
includeInSnippet:
|
|
2018
|
-
type: boolean
|
|
2019
|
-
example: false
|
|
2020
|
-
temporary:
|
|
2021
|
-
type: boolean
|
|
2022
|
-
description: Whether or not this flag is temporary.
|
|
2023
|
-
example: false
|
|
2024
|
-
maintainerId:
|
|
2025
|
-
type: string
|
|
2026
|
-
description: The ID of the member that should maintain this flag.
|
|
2027
|
-
example: 561c579cd8fd5c2704000001
|
|
2028
|
-
tags:
|
|
2029
|
-
type: array
|
|
2030
|
-
description: An array of tags for this feature flag.
|
|
2031
|
-
items:
|
|
2032
|
-
type: string
|
|
2033
|
-
example: []
|
|
2034
|
-
variations:
|
|
2035
|
-
type: array
|
|
2036
|
-
description: The variations for this feature flag.
|
|
2037
|
-
items:
|
|
2038
|
-
$ref: '#/definitions/Variation'
|
|
2039
|
-
example:
|
|
2040
|
-
- value: a
|
|
2041
|
-
- value: b
|
|
2042
|
-
goalIds:
|
|
2043
|
-
type: array
|
|
2044
|
-
description: An array goals from all environments associated with this feature flag
|
|
2045
|
-
items:
|
|
2046
|
-
type: string
|
|
2047
|
-
example:
|
|
2048
|
-
- d7239405bd89c930e885aa76
|
|
2049
|
-
- 405bc930e88d7239d895aa76
|
|
2050
|
-
_version:
|
|
2051
|
-
type: integer
|
|
2052
|
-
example: 23
|
|
2053
|
-
customProperties:
|
|
2054
|
-
type: object
|
|
2055
|
-
description: A mapping of keys to CustomProperty entries.
|
|
2056
|
-
additionalProperties:
|
|
2057
|
-
$ref: '#/definitions/CustomProperty'
|
|
2058
|
-
example:
|
|
2059
|
-
bugs:
|
|
2060
|
-
name: Issue tracker ids
|
|
2061
|
-
value:
|
|
2062
|
-
- '123'
|
|
2063
|
-
- '456'
|
|
2064
|
-
deprecated:
|
|
2065
|
-
name: Deprecated Date
|
|
2066
|
-
value: []
|
|
2067
|
-
_links:
|
|
2068
|
-
$ref: '#/definitions/Links'
|
|
2069
|
-
_maintainer:
|
|
2070
|
-
$ref: '#/definitions/Member'
|
|
2071
|
-
environments:
|
|
2072
|
-
type: object
|
|
2073
|
-
additionalProperties:
|
|
2074
|
-
$ref: '#/definitions/FeatureFlagConfig'
|
|
2075
|
-
archivedDate:
|
|
2076
|
-
type: integer
|
|
2077
|
-
format: int64
|
|
2078
|
-
description: >-
|
|
2079
|
-
A unix epoch time in milliseconds specifying the archived time of this
|
|
2080
|
-
flag.
|
|
2081
|
-
example: 1443652232590
|
|
2082
|
-
archived:
|
|
2083
|
-
type: boolean
|
|
2084
|
-
description: Whether or not this flag is archived.
|
|
2085
|
-
example: false
|
|
2086
|
-
clientSideAvailability:
|
|
2087
|
-
$ref: '#/definitions/ClientSideAvailability'
|
|
2088
|
-
defaults:
|
|
2089
|
-
$ref: '#/definitions/Defaults'
|
|
2090
|
-
FeatureFlags:
|
|
2091
|
-
type: object
|
|
2092
|
-
properties:
|
|
2093
|
-
_links:
|
|
2094
|
-
$ref: '#/definitions/Links'
|
|
2095
|
-
items:
|
|
2096
|
-
type: array
|
|
2097
|
-
items:
|
|
2098
|
-
$ref: '#/definitions/FeatureFlag'
|
|
2099
|
-
totalCount:
|
|
2100
|
-
type: number
|
|
2101
|
-
Member:
|
|
2102
|
-
type: object
|
|
2103
|
-
properties:
|
|
2104
|
-
_links:
|
|
2105
|
-
$ref: '#/definitions/Links'
|
|
2106
|
-
_id:
|
|
2107
|
-
$ref: '#/definitions/Id'
|
|
2108
|
-
role:
|
|
2109
|
-
$ref: '#/definitions/Role'
|
|
2110
|
-
email:
|
|
2111
|
-
type: string
|
|
2112
|
-
example: user@launchdarkly.com
|
|
2113
|
-
firstName:
|
|
2114
|
-
type: string
|
|
2115
|
-
example: Alan
|
|
2116
|
-
lastName:
|
|
2117
|
-
type: string
|
|
2118
|
-
example: Turing
|
|
2119
|
-
_verified:
|
|
2120
|
-
type: boolean
|
|
2121
|
-
_pendingInvite:
|
|
2122
|
-
type: boolean
|
|
2123
|
-
isBeta:
|
|
2124
|
-
type: boolean
|
|
2125
|
-
customRoles:
|
|
2126
|
-
type: array
|
|
2127
|
-
items:
|
|
2128
|
-
$ref: '#/definitions/Id'
|
|
2129
|
-
_lastSeen:
|
|
2130
|
-
type: integer
|
|
2131
|
-
format: int64
|
|
2132
|
-
example: 1469326565348
|
|
2133
|
-
description: >-
|
|
2134
|
-
A unix epoch time in milliseconds specifying the last time this member
|
|
2135
|
-
was active in LaunchDarkly.
|
|
2136
|
-
_lastSeenMetadata:
|
|
2137
|
-
type: object
|
|
2138
|
-
properties:
|
|
2139
|
-
tokenId:
|
|
2140
|
-
type: string
|
|
2141
|
-
example: 5fd2a1ee05600316d5cb3e96
|
|
2142
|
-
description: >-
|
|
2143
|
-
If the last time this member accessed LaunchDarkly was using the
|
|
2144
|
-
REST API, this value will be set to the ID of the personal access
|
|
2145
|
-
token used.
|
|
2146
|
-
Members:
|
|
2147
|
-
type: object
|
|
2148
|
-
properties:
|
|
2149
|
-
_links:
|
|
2150
|
-
$ref: '#/definitions/Links'
|
|
2151
|
-
items:
|
|
2152
|
-
type: array
|
|
2153
|
-
items:
|
|
2154
|
-
$ref: '#/definitions/Member'
|
|
2155
|
-
totalCount:
|
|
2156
|
-
type: number
|
|
2157
|
-
FeatureFlagConfig:
|
|
2158
|
-
type: object
|
|
2159
|
-
properties:
|
|
2160
|
-
'on':
|
|
2161
|
-
type: boolean
|
|
2162
|
-
archived:
|
|
2163
|
-
type: boolean
|
|
2164
|
-
salt:
|
|
2165
|
-
type: string
|
|
2166
|
-
example: YWx0ZXJuYXRlLnBhZ2U=
|
|
2167
|
-
sel:
|
|
2168
|
-
type: string
|
|
2169
|
-
example: 45501b9314dc4641841af774cb038b96
|
|
2170
|
-
lastModified:
|
|
2171
|
-
type: integer
|
|
2172
|
-
format: int64
|
|
2173
|
-
example: 1469326565348
|
|
2174
|
-
version:
|
|
2175
|
-
type: integer
|
|
2176
|
-
example: 65
|
|
2177
|
-
targets:
|
|
2178
|
-
type: array
|
|
2179
|
-
items:
|
|
2180
|
-
$ref: '#/definitions/Target'
|
|
2181
|
-
rules:
|
|
2182
|
-
type: array
|
|
2183
|
-
items:
|
|
2184
|
-
$ref: '#/definitions/Rule'
|
|
2185
|
-
fallthrough:
|
|
2186
|
-
$ref: '#/definitions/Fallthrough'
|
|
2187
|
-
offVariation:
|
|
2188
|
-
type: integer
|
|
2189
|
-
prerequisites:
|
|
2190
|
-
type: array
|
|
2191
|
-
items:
|
|
2192
|
-
$ref: '#/definitions/Prerequisite'
|
|
2193
|
-
trackEvents:
|
|
2194
|
-
type: boolean
|
|
2195
|
-
example: false
|
|
2196
|
-
description: Set to true to send detailed event information for this flag.
|
|
2197
|
-
trackEventsFallthrough:
|
|
2198
|
-
type: boolean
|
|
2199
|
-
example: true
|
|
2200
|
-
description: >-
|
|
2201
|
-
Set to true to send detailed event information when targeting is
|
|
2202
|
-
enabled but no individual targeting rule is matched.
|
|
2203
|
-
_site:
|
|
2204
|
-
$ref: '#/definitions/Site'
|
|
2205
|
-
_environmentName:
|
|
2206
|
-
type: string
|
|
2207
|
-
Target:
|
|
2208
|
-
type: object
|
|
2209
|
-
properties:
|
|
2210
|
-
values:
|
|
2211
|
-
type: array
|
|
2212
|
-
items:
|
|
2213
|
-
type: string
|
|
2214
|
-
example: '"1461797806427-7-115540266", "00142875-a39d-4028-a3b7-987ccd151649"'
|
|
2215
|
-
variation:
|
|
2216
|
-
type: integer
|
|
2217
|
-
Rule:
|
|
2218
|
-
type: object
|
|
2219
|
-
properties:
|
|
2220
|
-
_id:
|
|
2221
|
-
type: string
|
|
2222
|
-
variation:
|
|
2223
|
-
type: integer
|
|
2224
|
-
trackEvents:
|
|
2225
|
-
type: boolean
|
|
2226
|
-
rollout:
|
|
2227
|
-
$ref: '#/definitions/Rollout'
|
|
2228
|
-
clauses:
|
|
2229
|
-
type: array
|
|
2230
|
-
items:
|
|
2231
|
-
$ref: '#/definitions/Clause'
|
|
2232
|
-
description:
|
|
2233
|
-
type: string
|
|
2234
|
-
Fallthrough:
|
|
2235
|
-
type: object
|
|
2236
|
-
properties:
|
|
2237
|
-
variation:
|
|
2238
|
-
type: integer
|
|
2239
|
-
rollout:
|
|
2240
|
-
$ref: '#/definitions/Rollout'
|
|
2241
|
-
Rollout:
|
|
2242
|
-
type: object
|
|
2243
|
-
properties:
|
|
2244
|
-
bucketBy:
|
|
2245
|
-
type: string
|
|
2246
|
-
variations:
|
|
2247
|
-
type: array
|
|
2248
|
-
items:
|
|
2249
|
-
$ref: '#/definitions/WeightedVariation'
|
|
2250
|
-
WeightedVariation:
|
|
2251
|
-
type: object
|
|
2252
|
-
properties:
|
|
2253
|
-
variation:
|
|
2254
|
-
type: integer
|
|
2255
|
-
weight:
|
|
2256
|
-
type: integer
|
|
2257
|
-
Clause:
|
|
2258
|
-
type: object
|
|
2259
|
-
properties:
|
|
2260
|
-
_id:
|
|
2261
|
-
type: string
|
|
2262
|
-
attribute:
|
|
2263
|
-
type: string
|
|
2264
|
-
example: groups
|
|
2265
|
-
op:
|
|
2266
|
-
type: string
|
|
2267
|
-
example: in
|
|
2268
|
-
values:
|
|
2269
|
-
type: array
|
|
2270
|
-
items:
|
|
2271
|
-
type: object
|
|
2272
|
-
example: Top Customers
|
|
2273
|
-
negate:
|
|
2274
|
-
type: boolean
|
|
2275
|
-
Variation:
|
|
2276
|
-
type: object
|
|
2277
|
-
required:
|
|
2278
|
-
- value
|
|
2279
|
-
properties:
|
|
2280
|
-
_id:
|
|
2281
|
-
type: string
|
|
2282
|
-
example: 24b32dd3-0ba6-46ee-86af-230eebf3c7cb
|
|
2283
|
-
name:
|
|
2284
|
-
type: string
|
|
2285
|
-
example: 'True'
|
|
2286
|
-
description:
|
|
2287
|
-
type: string
|
|
2288
|
-
example: The true variation
|
|
2289
|
-
value:
|
|
2290
|
-
type: object
|
|
2291
|
-
Defaults:
|
|
2292
|
-
type: object
|
|
2293
|
-
description: Default values to be used when a new environment is created.
|
|
2294
|
-
required:
|
|
2295
|
-
- onVariation
|
|
2296
|
-
- offVariation
|
|
2297
|
-
properties:
|
|
2298
|
-
onVariation:
|
|
2299
|
-
type: integer
|
|
2300
|
-
description: >-
|
|
2301
|
-
The index of the variation to be served when a flag's targeting is on
|
|
2302
|
-
(default variation).
|
|
2303
|
-
offVariation:
|
|
2304
|
-
type: integer
|
|
2305
|
-
description: The index of the variation to be served when a flag is off.
|
|
2306
|
-
Prerequisite:
|
|
2307
|
-
type: object
|
|
2308
|
-
properties:
|
|
2309
|
-
key:
|
|
2310
|
-
type: string
|
|
2311
|
-
variation:
|
|
2312
|
-
type: integer
|
|
2313
|
-
FeatureFlagScheduledChanges:
|
|
2314
|
-
type: object
|
|
2315
|
-
properties:
|
|
2316
|
-
_links:
|
|
2317
|
-
$ref: '#/definitions/Links'
|
|
2318
|
-
items:
|
|
2319
|
-
type: array
|
|
2320
|
-
items:
|
|
2321
|
-
$ref: '#/definitions/FeatureFlagScheduledChange'
|
|
2322
|
-
FeatureFlagScheduledChange:
|
|
2323
|
-
type: object
|
|
2324
|
-
properties:
|
|
2325
|
-
executionDate:
|
|
2326
|
-
type: integer
|
|
2327
|
-
description: >-
|
|
2328
|
-
A unix epoch time in milliseconds specifying the date the scheduled
|
|
2329
|
-
changes will be applied
|
|
2330
|
-
_version:
|
|
2331
|
-
type: integer
|
|
2332
|
-
_id:
|
|
2333
|
-
type: string
|
|
2334
|
-
instructions:
|
|
2335
|
-
$ref: '#/definitions/SemanticPatchInstruction'
|
|
2336
|
-
FeatureFlagScheduledChangesConflicts:
|
|
2337
|
-
type: object
|
|
2338
|
-
properties:
|
|
2339
|
-
instructions:
|
|
2340
|
-
type: array
|
|
2341
|
-
items:
|
|
2342
|
-
properties:
|
|
2343
|
-
kind:
|
|
2344
|
-
type: string
|
|
2345
|
-
example: removeUserTargets
|
|
2346
|
-
description: >-
|
|
2347
|
-
The name of the modification you would like to perform on a
|
|
2348
|
-
resource.
|
|
2349
|
-
conflicts:
|
|
2350
|
-
type: array
|
|
2351
|
-
items:
|
|
2352
|
-
$ref: '#/definitions/ScheduledChangesFeatureFlagConflict'
|
|
2353
|
-
ScheduledChangesFeatureFlagConflict:
|
|
2354
|
-
type: object
|
|
2355
|
-
properties:
|
|
2356
|
-
_id:
|
|
2357
|
-
type: string
|
|
2358
|
-
description: Feature flag scheduled change id this change will conflict with
|
|
2359
|
-
reason:
|
|
2360
|
-
type: string
|
|
2361
|
-
description: Feature flag scheduled change conflict reason
|
|
2362
|
-
ApprovalRequests:
|
|
2363
|
-
type: object
|
|
2364
|
-
properties:
|
|
2365
|
-
_links:
|
|
2366
|
-
$ref: '#/definitions/Links'
|
|
2367
|
-
items:
|
|
2368
|
-
type: array
|
|
2369
|
-
items:
|
|
2370
|
-
$ref: '#/definitions/ApprovalRequest'
|
|
2371
|
-
ApprovalRequest:
|
|
2372
|
-
type: object
|
|
2373
|
-
properties:
|
|
2374
|
-
_id:
|
|
2375
|
-
$ref: '#/definitions/Id'
|
|
2376
|
-
_version:
|
|
2377
|
-
type: integer
|
|
2378
|
-
creationDate:
|
|
2379
|
-
type: integer
|
|
2380
|
-
description: >-
|
|
2381
|
-
A unix epoch time in milliseconds specifying the date the approval
|
|
2382
|
-
request was requested
|
|
2383
|
-
requestorId:
|
|
2384
|
-
type: string
|
|
2385
|
-
description: The id of the member that requested the change
|
|
2386
|
-
reviewStatus:
|
|
2387
|
-
$ref: '#/definitions/ApprovalRequestReviewStatus'
|
|
2388
|
-
status:
|
|
2389
|
-
type: string
|
|
2390
|
-
description: >
|
|
2391
|
-
| Name | Description |
|
|
2392
|
-
|
|
2393
|
-
| ---------:| ----------- |
|
|
2394
|
-
|
|
2395
|
-
| pending | the approval request has not been applied yet |
|
|
2396
|
-
|
|
2397
|
-
| completed | the approval request has been applied successfully |
|
|
2398
|
-
|
|
2399
|
-
| scheduled | the approval request for a scheduled change has been
|
|
2400
|
-
applied successfully |
|
|
2401
|
-
|
|
2402
|
-
| failed | the approval request has been applied but the changes
|
|
2403
|
-
were not applied successfully |
|
|
2404
|
-
enum:
|
|
2405
|
-
- pending
|
|
2406
|
-
- completed
|
|
2407
|
-
- scheduled
|
|
2408
|
-
- failed
|
|
2409
|
-
appliedByMemberID:
|
|
2410
|
-
type: string
|
|
2411
|
-
description: The id of the member that applied the approval request
|
|
2412
|
-
appliedDate:
|
|
2413
|
-
type: integer
|
|
2414
|
-
description: >-
|
|
2415
|
-
A unix epoch time in milliseconds specifying the date the approval
|
|
2416
|
-
request was applied
|
|
2417
|
-
allReviews:
|
|
2418
|
-
type: array
|
|
2419
|
-
items:
|
|
2420
|
-
$ref: '#/definitions/ApprovalRequestReview'
|
|
2421
|
-
notifyMemberIds:
|
|
2422
|
-
type: array
|
|
2423
|
-
items:
|
|
2424
|
-
type: string
|
|
2425
|
-
example:
|
|
2426
|
-
- memberId
|
|
2427
|
-
- memberId2
|
|
2428
|
-
instructions:
|
|
2429
|
-
$ref: '#/definitions/SemanticPatchInstruction'
|
|
2430
|
-
executionDate:
|
|
2431
|
-
type: integer
|
|
2432
|
-
format: int64
|
|
2433
|
-
description: Timestamp for when instructions will be executed
|
|
2434
|
-
operatingOnId:
|
|
2435
|
-
type: string
|
|
2436
|
-
description: ID of scheduled change to edit or delete
|
|
2437
|
-
source:
|
|
2438
|
-
$ref: '#/definitions/Source'
|
|
2439
|
-
Source:
|
|
2440
|
-
type: object
|
|
2441
|
-
properties:
|
|
2442
|
-
key:
|
|
2443
|
-
type: string
|
|
2444
|
-
description: Environment key to be copied from
|
|
2445
|
-
version:
|
|
2446
|
-
type: integer
|
|
2447
|
-
description: Version of environment at time of request
|
|
2448
|
-
ApprovalRequestReview:
|
|
2449
|
-
type: object
|
|
2450
|
-
properties:
|
|
2451
|
-
creationDate:
|
|
2452
|
-
type: integer
|
|
2453
|
-
description: >-
|
|
2454
|
-
A unix epoch time in milliseconds specifying the date the approval
|
|
2455
|
-
request was reviewed
|
|
2456
|
-
kind:
|
|
2457
|
-
$ref: '#/definitions/ApprovalRequestReviewStatus'
|
|
2458
|
-
memberId:
|
|
2459
|
-
$ref: '#/definitions/Id'
|
|
2460
|
-
_id:
|
|
2461
|
-
$ref: '#/definitions/Id'
|
|
2462
|
-
ApprovalRequestReviewStatus:
|
|
2463
|
-
type: string
|
|
2464
|
-
description: >
|
|
2465
|
-
| Name | Description |
|
|
2466
|
-
|
|
2467
|
-
| --------:| ----------- |
|
|
2468
|
-
|
|
2469
|
-
| pending | the approval request has not been reviewed yet |
|
|
2470
|
-
|
|
2471
|
-
| approved | the approval request has been approved and can now be applied
|
|
2472
|
-
|
|
|
2473
|
-
|
|
2474
|
-
| declined | the approval request has been declined and cannot be applied
|
|
2475
|
-
|
|
|
2476
|
-
enum:
|
|
2477
|
-
- pending
|
|
2478
|
-
- approved
|
|
2479
|
-
- declined
|
|
2480
|
-
ClientSideAvailability:
|
|
2481
|
-
type: object
|
|
2482
|
-
properties:
|
|
2483
|
-
usingEnvironmentId:
|
|
2484
|
-
type: boolean
|
|
2485
|
-
description: >-
|
|
2486
|
-
When set to true, this flag will be available to SDKs using the
|
|
2487
|
-
client-side id.
|
|
2488
|
-
usingMobileKey:
|
|
2489
|
-
type: boolean
|
|
2490
|
-
description: >-
|
|
2491
|
-
When set to true, this flag will be available to SDKS using a mobile
|
|
2492
|
-
key.
|
|
2493
|
-
FeatureFlagStatus:
|
|
2494
|
-
type: object
|
|
2495
|
-
properties:
|
|
2496
|
-
name:
|
|
2497
|
-
type: string
|
|
2498
|
-
description: >
|
|
2499
|
-
| Name | Description |
|
|
2500
|
-
|
|
2501
|
-
| --------:| ----------- |
|
|
2502
|
-
|
|
2503
|
-
| new | the feature flag was created within the last 7 days, and
|
|
2504
|
-
has not been requested yet |
|
|
2505
|
-
|
|
2506
|
-
| active | the feature flag was requested by your servers or clients
|
|
2507
|
-
within the last 7 days |
|
|
2508
|
-
|
|
2509
|
-
| inactive | the feature flag was created more than 7 days ago, and
|
|
2510
|
-
hasn't been requested by your servers or clients within the past 7
|
|
2511
|
-
days |
|
|
2512
|
-
|
|
2513
|
-
| launched | one variation of the feature flag has been rolled out to
|
|
2514
|
-
all your users for at least 7 days |
|
|
2515
|
-
enum:
|
|
2516
|
-
- new
|
|
2517
|
-
- active
|
|
2518
|
-
- inactive
|
|
2519
|
-
- launched
|
|
2520
|
-
lastRequested:
|
|
2521
|
-
type: string
|
|
2522
|
-
example: '2016-08-16T21:10:11.886Z'
|
|
2523
|
-
default:
|
|
2524
|
-
type: object
|
|
2525
|
-
_links:
|
|
2526
|
-
$ref: '#/definitions/FeatureFlagStatusLinks'
|
|
2527
|
-
FeatureFlagStatuses:
|
|
2528
|
-
type: object
|
|
2529
|
-
properties:
|
|
2530
|
-
_links:
|
|
2531
|
-
$ref: '#/definitions/FeatureFlagStatusLinks'
|
|
2532
|
-
items:
|
|
2533
|
-
type: array
|
|
2534
|
-
items:
|
|
2535
|
-
$ref: '#/definitions/FeatureFlagStatus'
|
|
2536
|
-
FeatureFlagStatusForQueriedEnvironment:
|
|
2537
|
-
type: object
|
|
2538
|
-
properties:
|
|
2539
|
-
name:
|
|
2540
|
-
type: string
|
|
2541
|
-
description: >
|
|
2542
|
-
| Name | Description |
|
|
2543
|
-
|
|
2544
|
-
| --------:| ----------- |
|
|
2545
|
-
|
|
2546
|
-
| new | the feature flag was created within the last 7 days, and
|
|
2547
|
-
has not been requested yet |
|
|
2548
|
-
|
|
2549
|
-
| active | the feature flag was requested by your servers or clients
|
|
2550
|
-
within the last 7 days |
|
|
2551
|
-
|
|
2552
|
-
| inactive | the feature flag was created more than 7 days ago, and
|
|
2553
|
-
hasn't been requested by your servers or clients within the past 7
|
|
2554
|
-
days |
|
|
2555
|
-
|
|
2556
|
-
| launched | one variation of the feature flag has been rolled out to
|
|
2557
|
-
all your users for at least 7 days |
|
|
2558
|
-
enum:
|
|
2559
|
-
- new
|
|
2560
|
-
- active
|
|
2561
|
-
- inactive
|
|
2562
|
-
- launched
|
|
2563
|
-
lastRequested:
|
|
2564
|
-
type: string
|
|
2565
|
-
example: '2016-08-16T21:10:11.886Z'
|
|
2566
|
-
default:
|
|
2567
|
-
type: object
|
|
2568
|
-
FeatureFlagStatusAcrossEnvironments:
|
|
2569
|
-
type: object
|
|
2570
|
-
properties:
|
|
2571
|
-
_links:
|
|
2572
|
-
$ref: '#/definitions/FeatureFlagStatusLinks'
|
|
2573
|
-
key:
|
|
2574
|
-
type: string
|
|
2575
|
-
environments:
|
|
2576
|
-
type: object
|
|
2577
|
-
additionalProperties:
|
|
2578
|
-
$ref: '#/definitions/FeatureFlagStatusForQueriedEnvironment'
|
|
2579
|
-
FeatureFlagStatusLinks:
|
|
2580
|
-
type: object
|
|
2581
|
-
properties:
|
|
2582
|
-
parent:
|
|
2583
|
-
$ref: '#/definitions/Link'
|
|
2584
|
-
self:
|
|
2585
|
-
$ref: '#/definitions/Link'
|
|
2586
|
-
DependentFlagsByEnvironment:
|
|
2587
|
-
type: object
|
|
2588
|
-
properties:
|
|
2589
|
-
items:
|
|
2590
|
-
type: array
|
|
2591
|
-
items:
|
|
2592
|
-
$ref: '#/definitions/DependentFlag'
|
|
2593
|
-
_links:
|
|
2594
|
-
$ref: '#/definitions/DependentFlagsLinks'
|
|
2595
|
-
_site:
|
|
2596
|
-
$ref: '#/definitions/Site'
|
|
2597
|
-
DependentFlag:
|
|
2598
|
-
type: object
|
|
2599
|
-
properties:
|
|
2600
|
-
name:
|
|
2601
|
-
type: string
|
|
2602
|
-
key:
|
|
2603
|
-
type: string
|
|
2604
|
-
_links:
|
|
2605
|
-
type: object
|
|
2606
|
-
properties:
|
|
2607
|
-
self:
|
|
2608
|
-
$ref: '#/definitions/Link'
|
|
2609
|
-
_site:
|
|
2610
|
-
$ref: '#/definitions/Site'
|
|
2611
|
-
DependentFlagsLinks:
|
|
2612
|
-
type: object
|
|
2613
|
-
properties:
|
|
2614
|
-
parent:
|
|
2615
|
-
$ref: '#/definitions/Link'
|
|
2616
|
-
self:
|
|
2617
|
-
$ref: '#/definitions/Link'
|
|
2618
|
-
MultiEnvironmentDependentFlags:
|
|
2619
|
-
type: object
|
|
2620
|
-
properties:
|
|
2621
|
-
items:
|
|
2622
|
-
type: array
|
|
2623
|
-
items:
|
|
2624
|
-
$ref: '#/definitions/MultiEnvironmentDependentFlag'
|
|
2625
|
-
_links:
|
|
2626
|
-
$ref: '#/definitions/DependentFlagsLinks'
|
|
2627
|
-
_site:
|
|
2628
|
-
$ref: '#/definitions/Site'
|
|
2629
|
-
MultiEnvironmentDependentFlag:
|
|
2630
|
-
type: object
|
|
2631
|
-
properties:
|
|
2632
|
-
name:
|
|
2633
|
-
type: string
|
|
2634
|
-
key:
|
|
2635
|
-
type: string
|
|
2636
|
-
environments:
|
|
2637
|
-
type: array
|
|
2638
|
-
items:
|
|
2639
|
-
$ref: '#/definitions/DependentFlagEnvironment'
|
|
2640
|
-
_links:
|
|
2641
|
-
$ref: '#/definitions/DependentFlagsLinks'
|
|
2642
|
-
_site:
|
|
2643
|
-
$ref: '#/definitions/Site'
|
|
2644
|
-
DependentFlagEnvironment:
|
|
2645
|
-
type: object
|
|
2646
|
-
properties:
|
|
2647
|
-
name:
|
|
2648
|
-
type: string
|
|
2649
|
-
key:
|
|
2650
|
-
type: string
|
|
2651
|
-
_links:
|
|
2652
|
-
type: object
|
|
2653
|
-
properties:
|
|
2654
|
-
self:
|
|
2655
|
-
$ref: '#/definitions/Link'
|
|
2656
|
-
flagLink:
|
|
2657
|
-
$ref: '#/definitions/Link'
|
|
2658
|
-
_site:
|
|
2659
|
-
$ref: '#/definitions/Site'
|
|
2660
|
-
UserTargetingExpirationForFlags:
|
|
2661
|
-
type: object
|
|
2662
|
-
properties:
|
|
2663
|
-
_links:
|
|
2664
|
-
$ref: '#/definitions/Links'
|
|
2665
|
-
items:
|
|
2666
|
-
type: array
|
|
2667
|
-
items:
|
|
2668
|
-
$ref: '#/definitions/UserTargetingExpirationForFlag'
|
|
2669
|
-
UserTargetingExpirationOnFlagsForUser:
|
|
2670
|
-
type: object
|
|
2671
|
-
properties:
|
|
2672
|
-
_links:
|
|
2673
|
-
$ref: '#/definitions/Links'
|
|
2674
|
-
items:
|
|
2675
|
-
type: array
|
|
2676
|
-
items:
|
|
2677
|
-
$ref: '#/definitions/UserTargetingExpirationForFlag'
|
|
2678
|
-
UserTargetingExpirationForFlag:
|
|
2679
|
-
type: object
|
|
2680
|
-
properties:
|
|
2681
|
-
expirationDate:
|
|
2682
|
-
type: integer
|
|
2683
|
-
format: int64
|
|
2684
|
-
description: Unix epoch time in milliseconds specifying the expiration date
|
|
2685
|
-
example: 1735689600000
|
|
2686
|
-
variationId:
|
|
2687
|
-
type: string
|
|
2688
|
-
description: the ID of the variation that the user is targeted on a flag
|
|
2689
|
-
userKey:
|
|
2690
|
-
type: string
|
|
2691
|
-
description: Unique identifier for the user
|
|
2692
|
-
_id:
|
|
2693
|
-
type: string
|
|
2694
|
-
_resourceId:
|
|
2695
|
-
$ref: '#/definitions/UserTargetingExpirationResourceIdForFlag'
|
|
2696
|
-
_links:
|
|
2697
|
-
$ref: '#/definitions/Links'
|
|
2698
|
-
_version:
|
|
2699
|
-
type: integer
|
|
2700
|
-
UserTargetingExpirationForSegment:
|
|
2701
|
-
type: object
|
|
2702
|
-
properties:
|
|
2703
|
-
expirationDate:
|
|
2704
|
-
type: integer
|
|
2705
|
-
format: int64
|
|
2706
|
-
description: Unix epoch time in milliseconds specifying the expiration date
|
|
2707
|
-
example: 1735689600000
|
|
2708
|
-
targetType:
|
|
2709
|
-
type: string
|
|
2710
|
-
description: >-
|
|
2711
|
-
either the included or excluded variation that the user is targeted on
|
|
2712
|
-
a segment
|
|
2713
|
-
userKey:
|
|
2714
|
-
type: string
|
|
2715
|
-
description: Unique identifier for the user
|
|
2716
|
-
_id:
|
|
2717
|
-
type: string
|
|
2718
|
-
_resourceId:
|
|
2719
|
-
$ref: '#/definitions/UserTargetingExpirationResourceIdForFlag'
|
|
2720
|
-
_links:
|
|
2721
|
-
$ref: '#/definitions/Links'
|
|
2722
|
-
_version:
|
|
2723
|
-
type: integer
|
|
2724
|
-
UserTargetingExpirationResourceIdForFlag:
|
|
2725
|
-
type: object
|
|
2726
|
-
properties:
|
|
2727
|
-
kind:
|
|
2728
|
-
type: string
|
|
2729
|
-
projectKey:
|
|
2730
|
-
type: string
|
|
2731
|
-
environmentKey:
|
|
2732
|
-
type: string
|
|
2733
|
-
flagKey:
|
|
2734
|
-
type: string
|
|
2735
|
-
key:
|
|
2736
|
-
type: string
|
|
2737
|
-
UserSegment:
|
|
2738
|
-
type: object
|
|
2739
|
-
required:
|
|
2740
|
-
- key
|
|
2741
|
-
- name
|
|
2742
|
-
- creationDate
|
|
2743
|
-
properties:
|
|
2744
|
-
key:
|
|
2745
|
-
type: string
|
|
2746
|
-
description: Unique identifier for the user segment.
|
|
2747
|
-
example: beta-testers
|
|
2748
|
-
name:
|
|
2749
|
-
type: string
|
|
2750
|
-
description: Name of the user segment.
|
|
2751
|
-
example: Beta Testers
|
|
2752
|
-
description:
|
|
2753
|
-
type: string
|
|
2754
|
-
description: Description of the user segment.
|
|
2755
|
-
example: Users in this segment can access beta features.
|
|
2756
|
-
tags:
|
|
2757
|
-
type: array
|
|
2758
|
-
items:
|
|
2759
|
-
type: string
|
|
2760
|
-
example:
|
|
2761
|
-
- dev
|
|
2762
|
-
- ops
|
|
2763
|
-
description: An array of tags for this user segment.
|
|
2764
|
-
creationDate:
|
|
2765
|
-
type: integer
|
|
2766
|
-
format: int64
|
|
2767
|
-
description: >-
|
|
2768
|
-
A unix epoch time in milliseconds specifying the creation time of this
|
|
2769
|
-
flag.
|
|
2770
|
-
example: 1443652232590
|
|
2771
|
-
included:
|
|
2772
|
-
type: array
|
|
2773
|
-
items:
|
|
2774
|
-
type: string
|
|
2775
|
-
description: An array of user keys that are included in this segment.
|
|
2776
|
-
excluded:
|
|
2777
|
-
type: array
|
|
2778
|
-
items:
|
|
2779
|
-
type: string
|
|
2780
|
-
description: >-
|
|
2781
|
-
An array of user keys that should not be included in this segment,
|
|
2782
|
-
unless they are also listed in "included".
|
|
2783
|
-
rules:
|
|
2784
|
-
type: array
|
|
2785
|
-
items:
|
|
2786
|
-
$ref: '#/definitions/UserSegmentRule'
|
|
2787
|
-
description: >-
|
|
2788
|
-
An array of rules that can cause a user to be included in this
|
|
2789
|
-
segment.
|
|
2790
|
-
unbounded:
|
|
2791
|
-
type: boolean
|
|
2792
|
-
example: false
|
|
2793
|
-
description: >-
|
|
2794
|
-
Controls whether this is considered a "big segment" which can support
|
|
2795
|
-
an unlimited numbers of users. Include/exclude lists sent with this
|
|
2796
|
-
payload are not used in big segments. Contact your account manager for
|
|
2797
|
-
early access to this feature.
|
|
2798
|
-
version:
|
|
2799
|
-
type: integer
|
|
2800
|
-
_links:
|
|
2801
|
-
$ref: '#/definitions/Links'
|
|
2802
|
-
_flags:
|
|
2803
|
-
type: array
|
|
2804
|
-
readOnly: true
|
|
2805
|
-
items:
|
|
2806
|
-
$ref: '#/definitions/FlagListItem'
|
|
2807
|
-
UserSegmentRule:
|
|
2808
|
-
type: object
|
|
2809
|
-
properties:
|
|
2810
|
-
clauses:
|
|
2811
|
-
type: array
|
|
2812
|
-
items:
|
|
2813
|
-
$ref: '#/definitions/Clause'
|
|
2814
|
-
weight:
|
|
2815
|
-
type: integer
|
|
2816
|
-
bucketBy:
|
|
2817
|
-
type: string
|
|
2818
|
-
UserSegments:
|
|
2819
|
-
type: object
|
|
2820
|
-
properties:
|
|
2821
|
-
_links:
|
|
2822
|
-
$ref: '#/definitions/Links'
|
|
2823
|
-
items:
|
|
2824
|
-
type: array
|
|
2825
|
-
items:
|
|
2826
|
-
$ref: '#/definitions/UserSegment'
|
|
2827
|
-
BigSegmentTargetChanges:
|
|
2828
|
-
type: object
|
|
2829
|
-
properties:
|
|
2830
|
-
add:
|
|
2831
|
-
type: array
|
|
2832
|
-
example:
|
|
2833
|
-
- user@launchdarkly.com
|
|
2834
|
-
items:
|
|
2835
|
-
type: string
|
|
2836
|
-
description: Users to add to this list of targets
|
|
2837
|
-
remove:
|
|
2838
|
-
type: array
|
|
2839
|
-
example: []
|
|
2840
|
-
items:
|
|
2841
|
-
type: string
|
|
2842
|
-
description: Users to remove from this list of targets
|
|
2843
|
-
Project:
|
|
2844
|
-
type: object
|
|
2845
|
-
properties:
|
|
2846
|
-
_links:
|
|
2847
|
-
$ref: '#/definitions/Links'
|
|
2848
|
-
_id:
|
|
2849
|
-
$ref: '#/definitions/Id'
|
|
2850
|
-
key:
|
|
2851
|
-
type: string
|
|
2852
|
-
example: zentasks
|
|
2853
|
-
name:
|
|
2854
|
-
type: string
|
|
2855
|
-
example: Zentasks
|
|
2856
|
-
includeInSnippetByDefault:
|
|
2857
|
-
type: boolean
|
|
2858
|
-
example: true
|
|
2859
|
-
environments:
|
|
2860
|
-
type: array
|
|
2861
|
-
items:
|
|
2862
|
-
$ref: '#/definitions/Environment'
|
|
2863
|
-
tags:
|
|
2864
|
-
type: array
|
|
2865
|
-
items:
|
|
2866
|
-
type: string
|
|
2867
|
-
description: An array of tags for this project.
|
|
2868
|
-
defaultClientSideAvailability:
|
|
2869
|
-
$ref: '#/definitions/ClientSideAvailability'
|
|
2870
|
-
Projects:
|
|
2871
|
-
type: object
|
|
2872
|
-
properties:
|
|
2873
|
-
_links:
|
|
2874
|
-
$ref: '#/definitions/Links'
|
|
2875
|
-
items:
|
|
2876
|
-
type: array
|
|
2877
|
-
items:
|
|
2878
|
-
$ref: '#/definitions/Project'
|
|
2879
|
-
Destination:
|
|
2880
|
-
type: object
|
|
2881
|
-
properties:
|
|
2882
|
-
_links:
|
|
2883
|
-
$ref: '#/definitions/Links'
|
|
2884
|
-
_id:
|
|
2885
|
-
type: string
|
|
2886
|
-
example: 37ed9aad-de0a-4665-932e-41c35587aeea
|
|
2887
|
-
description: Unique destination ID.
|
|
2888
|
-
name:
|
|
2889
|
-
type: string
|
|
2890
|
-
example: Example Google Pub/Sub Destination
|
|
2891
|
-
description: The destination name
|
|
2892
|
-
kind:
|
|
2893
|
-
type: string
|
|
2894
|
-
example: google-pubsub
|
|
2895
|
-
description: >-
|
|
2896
|
-
Destination type ("google-pubsub", "kinesis", "mparticle", or
|
|
2897
|
-
"segment")
|
|
2898
|
-
enum:
|
|
2899
|
-
- google-pubsub
|
|
2900
|
-
- kinesis
|
|
2901
|
-
- mparticle
|
|
2902
|
-
- segment
|
|
2903
|
-
config:
|
|
2904
|
-
type: object
|
|
2905
|
-
description: destination-specific configuration.
|
|
2906
|
-
example:
|
|
2907
|
-
project: cool-project
|
|
2908
|
-
topic: test
|
|
2909
|
-
'on':
|
|
2910
|
-
type: boolean
|
|
2911
|
-
example: true
|
|
2912
|
-
description: Whether the data export destination is on or not.
|
|
2913
|
-
version:
|
|
2914
|
-
type: integer
|
|
2915
|
-
example: 2
|
|
2916
|
-
Destinations:
|
|
2917
|
-
type: object
|
|
2918
|
-
properties:
|
|
2919
|
-
_links:
|
|
2920
|
-
$ref: '#/definitions/Links'
|
|
2921
|
-
items:
|
|
2922
|
-
type: array
|
|
2923
|
-
items:
|
|
2924
|
-
$ref: '#/definitions/Destination'
|
|
2925
|
-
DestinationGooglePubSub:
|
|
2926
|
-
type: object
|
|
2927
|
-
properties:
|
|
2928
|
-
project:
|
|
2929
|
-
type: string
|
|
2930
|
-
example: cool-project
|
|
2931
|
-
topic:
|
|
2932
|
-
type: string
|
|
2933
|
-
example: test
|
|
2934
|
-
DestinationAmazonKinesis:
|
|
2935
|
-
type: object
|
|
2936
|
-
properties:
|
|
2937
|
-
region:
|
|
2938
|
-
type: string
|
|
2939
|
-
example: us-east-1
|
|
2940
|
-
roleArn:
|
|
2941
|
-
type: string
|
|
2942
|
-
example: 'arn:aws:iam::123456789012:role/marketingadmin'
|
|
2943
|
-
streamName:
|
|
2944
|
-
type: string
|
|
2945
|
-
example: cat-stream
|
|
2946
|
-
DestinationMParticle:
|
|
2947
|
-
type: object
|
|
2948
|
-
properties:
|
|
2949
|
-
apiKey:
|
|
2950
|
-
type: string
|
|
2951
|
-
example: apiKeyfromMParticle
|
|
2952
|
-
secret:
|
|
2953
|
-
type: string
|
|
2954
|
-
example: mParticleSecret
|
|
2955
|
-
userIdentity:
|
|
2956
|
-
type: string
|
|
2957
|
-
example: customer_id
|
|
2958
|
-
environment:
|
|
2959
|
-
type: string
|
|
2960
|
-
example: production
|
|
2961
|
-
DestinationSegment:
|
|
2962
|
-
type: object
|
|
2963
|
-
properties:
|
|
2964
|
-
writeKey:
|
|
2965
|
-
type: string
|
|
2966
|
-
example: segmentWriteKey
|
|
2967
|
-
Environment:
|
|
2968
|
-
type: object
|
|
2969
|
-
properties:
|
|
2970
|
-
_links:
|
|
2971
|
-
$ref: '#/definitions/Links'
|
|
2972
|
-
_id:
|
|
2973
|
-
$ref: '#/definitions/Id'
|
|
2974
|
-
key:
|
|
2975
|
-
type: string
|
|
2976
|
-
example: production
|
|
2977
|
-
description: The key for the environment.
|
|
2978
|
-
name:
|
|
2979
|
-
type: string
|
|
2980
|
-
example: Production
|
|
2981
|
-
description: The name of the environment.
|
|
2982
|
-
apiKey:
|
|
2983
|
-
type: string
|
|
2984
|
-
example: XXX
|
|
2985
|
-
description: The SDK key for backend LaunchDarkly SDKs.
|
|
2986
|
-
mobileKey:
|
|
2987
|
-
type: string
|
|
2988
|
-
example: XXX
|
|
2989
|
-
description: The SDK key for mobile LaunchDarkly SDKs.
|
|
2990
|
-
color:
|
|
2991
|
-
type: string
|
|
2992
|
-
example: '417505'
|
|
2993
|
-
description: The swatch color for the environment.
|
|
2994
|
-
defaultTtl:
|
|
2995
|
-
type: number
|
|
2996
|
-
example: 0
|
|
2997
|
-
description: The default TTL.
|
|
2998
|
-
secureMode:
|
|
2999
|
-
type: boolean
|
|
3000
|
-
example: false
|
|
3001
|
-
description: Determines if this environment is in safe mode.
|
|
3002
|
-
defaultTrackEvents:
|
|
3003
|
-
type: boolean
|
|
3004
|
-
example: false
|
|
3005
|
-
description: Set to true to send detailed event information for new flags.
|
|
3006
|
-
tags:
|
|
3007
|
-
type: array
|
|
3008
|
-
items:
|
|
3009
|
-
type: string
|
|
3010
|
-
description: An array of tags for this environment.
|
|
3011
|
-
requireComments:
|
|
3012
|
-
type: boolean
|
|
3013
|
-
example: false
|
|
3014
|
-
description: >-
|
|
3015
|
-
Determines if this environment requires comments for flag and segment
|
|
3016
|
-
changes.
|
|
3017
|
-
confirmChanges:
|
|
3018
|
-
type: boolean
|
|
3019
|
-
example: false
|
|
3020
|
-
description: >-
|
|
3021
|
-
Determines if this environment requires confirmation for flag and
|
|
3022
|
-
segment changes.
|
|
3023
|
-
approvalSettings:
|
|
3024
|
-
type: object
|
|
3025
|
-
description: >-
|
|
3026
|
-
Approval settings for an environment. Only appears if the approvals
|
|
3027
|
-
feature is enabled.
|
|
3028
|
-
properties:
|
|
3029
|
-
serviceKind:
|
|
3030
|
-
type: string
|
|
3031
|
-
description: The approvals system used.
|
|
3032
|
-
enum:
|
|
3033
|
-
- launchdarkly
|
|
3034
|
-
- service-now
|
|
3035
|
-
required:
|
|
3036
|
-
type: boolean
|
|
3037
|
-
description: >-
|
|
3038
|
-
Whether any changes to flags in this environment will require
|
|
3039
|
-
approval. You may only set required or requiredApprovalTags, not
|
|
3040
|
-
both.
|
|
3041
|
-
canReviewOwnRequest:
|
|
3042
|
-
type: boolean
|
|
3043
|
-
description: >-
|
|
3044
|
-
Whether requesters can approve or decline their own request. They
|
|
3045
|
-
may always comment.
|
|
3046
|
-
minNumApprovals:
|
|
3047
|
-
type: integer
|
|
3048
|
-
format: int64
|
|
3049
|
-
description: >-
|
|
3050
|
-
The number of approvals required before an approval request can be
|
|
3051
|
-
applied.
|
|
3052
|
-
example: 2
|
|
3053
|
-
canApplyDeclinedChanges:
|
|
3054
|
-
type: boolean
|
|
3055
|
-
description: >-
|
|
3056
|
-
Whether changes can be applied as long as minNumApprovals is met,
|
|
3057
|
-
regardless of if any reviewers have declined a request.
|
|
3058
|
-
requiredApprovalTags:
|
|
3059
|
-
type: array
|
|
3060
|
-
items:
|
|
3061
|
-
type: string
|
|
3062
|
-
description: >-
|
|
3063
|
-
An array of tags used to specify which flags with those tags
|
|
3064
|
-
require approval. You may only set requiredApprovalTags or
|
|
3065
|
-
required, not both.
|
|
3066
|
-
EnvironmentPost:
|
|
3067
|
-
type: object
|
|
3068
|
-
properties:
|
|
3069
|
-
name:
|
|
3070
|
-
type: string
|
|
3071
|
-
description: The name of the new environment.
|
|
3072
|
-
example: Development
|
|
3073
|
-
key:
|
|
3074
|
-
type: string
|
|
3075
|
-
description: A project-unique key for the new environment.
|
|
3076
|
-
example: dev
|
|
3077
|
-
color:
|
|
3078
|
-
type: string
|
|
3079
|
-
description: 'A color swatch (as an RGB hex value with no leading ''#'', e.g. C8C8C8).'
|
|
3080
|
-
example: '417505'
|
|
3081
|
-
defaultTtl:
|
|
3082
|
-
type: number
|
|
3083
|
-
description: The default TTL for the new environment.
|
|
3084
|
-
example: 0
|
|
3085
|
-
secureMode:
|
|
3086
|
-
type: boolean
|
|
3087
|
-
description: Determines whether the environment is in secure mode.
|
|
3088
|
-
example: false
|
|
3089
|
-
defaultTrackEvents:
|
|
3090
|
-
type: boolean
|
|
3091
|
-
description: >-
|
|
3092
|
-
Set to true to send detailed event information for newly created
|
|
3093
|
-
flags.
|
|
3094
|
-
example: false
|
|
3095
|
-
tags:
|
|
3096
|
-
type: array
|
|
3097
|
-
description: An array of tags for this environment.
|
|
3098
|
-
items:
|
|
3099
|
-
type: string
|
|
3100
|
-
example:
|
|
3101
|
-
- tag1
|
|
3102
|
-
- tag2
|
|
3103
|
-
requireComments:
|
|
3104
|
-
type: boolean
|
|
3105
|
-
description: >-
|
|
3106
|
-
Determines if this environment requires comments for flag and segment
|
|
3107
|
-
changes.
|
|
3108
|
-
example: false
|
|
3109
|
-
confirmChanges:
|
|
3110
|
-
type: boolean
|
|
3111
|
-
description: >-
|
|
3112
|
-
Determines if this environment requires confirmation for flag and
|
|
3113
|
-
segment changes.
|
|
3114
|
-
example: false
|
|
3115
|
-
required:
|
|
3116
|
-
- name
|
|
3117
|
-
- key
|
|
3118
|
-
- color
|
|
3119
|
-
User:
|
|
3120
|
-
type: object
|
|
3121
|
-
properties:
|
|
3122
|
-
key:
|
|
3123
|
-
type: string
|
|
3124
|
-
example: a00bea
|
|
3125
|
-
secondary:
|
|
3126
|
-
type: string
|
|
3127
|
-
ip:
|
|
3128
|
-
type: string
|
|
3129
|
-
country:
|
|
3130
|
-
type: string
|
|
3131
|
-
email:
|
|
3132
|
-
type: string
|
|
3133
|
-
firstName:
|
|
3134
|
-
type: string
|
|
3135
|
-
lastName:
|
|
3136
|
-
type: string
|
|
3137
|
-
avatar:
|
|
3138
|
-
type: string
|
|
3139
|
-
name:
|
|
3140
|
-
type: string
|
|
3141
|
-
example: Bob Loblaw
|
|
3142
|
-
anonymous:
|
|
3143
|
-
type: boolean
|
|
3144
|
-
custom:
|
|
3145
|
-
type: object
|
|
3146
|
-
example:
|
|
3147
|
-
company: example.com
|
|
3148
|
-
UserRecord:
|
|
3149
|
-
type: object
|
|
3150
|
-
properties:
|
|
3151
|
-
lastPing:
|
|
3152
|
-
type: string
|
|
3153
|
-
example: '2015-03-03T02:37:22.492Z'
|
|
3154
|
-
environmentId:
|
|
3155
|
-
type: string
|
|
3156
|
-
example: 54ac2d97de674204ddd61096
|
|
3157
|
-
ownerId:
|
|
3158
|
-
$ref: '#/definitions/Id'
|
|
3159
|
-
user:
|
|
3160
|
-
$ref: '#/definitions/User'
|
|
3161
|
-
avatar:
|
|
3162
|
-
type: string
|
|
3163
|
-
example: 'https://s3.amazonaws.com/uifaces/faces/twitter/shylockjoy/73.jpg'
|
|
3164
|
-
Users:
|
|
3165
|
-
type: object
|
|
3166
|
-
properties:
|
|
3167
|
-
_links:
|
|
3168
|
-
$ref: '#/definitions/Links'
|
|
3169
|
-
totalCount:
|
|
3170
|
-
type: number
|
|
3171
|
-
example: 3
|
|
3172
|
-
items:
|
|
3173
|
-
type: array
|
|
3174
|
-
items:
|
|
3175
|
-
$ref: '#/definitions/UserRecord'
|
|
3176
|
-
AuditLogEntry:
|
|
3177
|
-
type: object
|
|
3178
|
-
properties:
|
|
3179
|
-
_links:
|
|
3180
|
-
$ref: '#/definitions/Links'
|
|
3181
|
-
_id:
|
|
3182
|
-
$ref: '#/definitions/Id'
|
|
3183
|
-
date:
|
|
3184
|
-
type: integer
|
|
3185
|
-
format: int64
|
|
3186
|
-
example: 1472243938774
|
|
3187
|
-
kind:
|
|
3188
|
-
type: string
|
|
3189
|
-
example: environment
|
|
3190
|
-
name:
|
|
3191
|
-
type: string
|
|
3192
|
-
example: Testing
|
|
3193
|
-
description:
|
|
3194
|
-
type: string
|
|
3195
|
-
example: Changed the name from Test to Testing
|
|
3196
|
-
shortDescription:
|
|
3197
|
-
type: string
|
|
3198
|
-
example: '""'
|
|
3199
|
-
comment:
|
|
3200
|
-
type: string
|
|
3201
|
-
example: This is a comment string
|
|
3202
|
-
member:
|
|
3203
|
-
$ref: '#/definitions/Member'
|
|
3204
|
-
titleVerb:
|
|
3205
|
-
type: string
|
|
3206
|
-
example: changed the name of
|
|
3207
|
-
title:
|
|
3208
|
-
type: string
|
|
3209
|
-
example: >-
|
|
3210
|
-
[Reese Applebaum](mailto:refapp@launchdarkly.com) changed the name of
|
|
3211
|
-
[Testing](https://app.launchdarkly.com/settings#/projects)
|
|
3212
|
-
target:
|
|
3213
|
-
type: object
|
|
3214
|
-
properties:
|
|
3215
|
-
_links:
|
|
3216
|
-
$ref: '#/definitions/Links'
|
|
3217
|
-
name:
|
|
3218
|
-
type: string
|
|
3219
|
-
example: Testing
|
|
3220
|
-
resources:
|
|
3221
|
-
type: array
|
|
3222
|
-
items:
|
|
3223
|
-
type: string
|
|
3224
|
-
example: 'proj/alexis:env/test'
|
|
3225
|
-
AuditLogEntries:
|
|
3226
|
-
type: object
|
|
3227
|
-
properties:
|
|
3228
|
-
_links:
|
|
3229
|
-
$ref: '#/definitions/Links'
|
|
3230
|
-
items:
|
|
3231
|
-
type: array
|
|
3232
|
-
items:
|
|
3233
|
-
$ref: '#/definitions/AuditLogEntry'
|
|
3234
|
-
UserFlagSetting:
|
|
3235
|
-
type: object
|
|
3236
|
-
properties:
|
|
3237
|
-
_links:
|
|
3238
|
-
$ref: '#/definitions/Links'
|
|
3239
|
-
_value:
|
|
3240
|
-
type: boolean
|
|
3241
|
-
description: >-
|
|
3242
|
-
The most important attribute in the response. The _value is the
|
|
3243
|
-
current setting for the user. For a boolean feature toggle, this will
|
|
3244
|
-
be true, false, or null if there is no defined fallthrough value.
|
|
3245
|
-
example: true
|
|
3246
|
-
setting:
|
|
3247
|
-
type: boolean
|
|
3248
|
-
description: >-
|
|
3249
|
-
The setting attribute indicates whether you've explicitly targeted
|
|
3250
|
-
this user to receive a particular variation. For example, if you have
|
|
3251
|
-
explicitly turned off a feature toggle for a user, setting will be
|
|
3252
|
-
false. A setting of null means that you haven't assigned that user to
|
|
3253
|
-
a specific variation.
|
|
3254
|
-
example: null
|
|
3255
|
-
UserFlagSettings:
|
|
3256
|
-
type: object
|
|
3257
|
-
properties:
|
|
3258
|
-
_links:
|
|
3259
|
-
$ref: '#/definitions/Links'
|
|
3260
|
-
items:
|
|
3261
|
-
type: object
|
|
3262
|
-
additionalProperties:
|
|
3263
|
-
$ref: '#/definitions/UserFlagSetting'
|
|
3264
|
-
example:
|
|
3265
|
-
sort.order:
|
|
3266
|
-
_links:
|
|
3267
|
-
self:
|
|
3268
|
-
href: /api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order
|
|
3269
|
-
type: application/json
|
|
3270
|
-
_value: true
|
|
3271
|
-
setting: null
|
|
3272
|
-
alternate.page:
|
|
3273
|
-
_links:
|
|
3274
|
-
self:
|
|
3275
|
-
href: >-
|
|
3276
|
-
/api/v2/users/lacuna/production/Abbie_Braun/flags/alternate.page
|
|
3277
|
-
type: application/json
|
|
3278
|
-
_value: 'false,'
|
|
3279
|
-
setting: null
|
|
3280
|
-
Statement:
|
|
3281
|
-
type: object
|
|
3282
|
-
properties:
|
|
3283
|
-
resources:
|
|
3284
|
-
type: array
|
|
3285
|
-
items:
|
|
3286
|
-
type: string
|
|
3287
|
-
description: A resource specifier string
|
|
3288
|
-
example: 'proj/*:env/*:flag/my-flag'
|
|
3289
|
-
notResources:
|
|
3290
|
-
type: array
|
|
3291
|
-
items:
|
|
3292
|
-
type: string
|
|
3293
|
-
description: A resource specifier string
|
|
3294
|
-
example: 'proj/*:env/*:flag/my-flag'
|
|
3295
|
-
description: >-
|
|
3296
|
-
Targeted resource will be those resources NOT in this list. The
|
|
3297
|
-
"resources`" field must be empty to use this field.
|
|
3298
|
-
actions:
|
|
3299
|
-
type: array
|
|
3300
|
-
items:
|
|
3301
|
-
type: string
|
|
3302
|
-
description: An action to perform on a resource.
|
|
3303
|
-
example: updateOn
|
|
3304
|
-
notActions:
|
|
3305
|
-
type: array
|
|
3306
|
-
items:
|
|
3307
|
-
type: string
|
|
3308
|
-
description: An action to perform on a resource.
|
|
3309
|
-
example: updateOn
|
|
3310
|
-
description: >-
|
|
3311
|
-
Targeted actions will be those actions NOT in this list. The "actions"
|
|
3312
|
-
field must be empty to use this field.
|
|
3313
|
-
effect:
|
|
3314
|
-
type: string
|
|
3315
|
-
enum:
|
|
3316
|
-
- allow
|
|
3317
|
-
- deny
|
|
3318
|
-
Role:
|
|
3319
|
-
type: string
|
|
3320
|
-
enum:
|
|
3321
|
-
- writer
|
|
3322
|
-
- reader
|
|
3323
|
-
- admin
|
|
3324
|
-
- owner
|
|
3325
|
-
CustomRole:
|
|
3326
|
-
type: object
|
|
3327
|
-
properties:
|
|
3328
|
-
_links:
|
|
3329
|
-
$ref: '#/definitions/Links'
|
|
3330
|
-
name:
|
|
3331
|
-
type: string
|
|
3332
|
-
description: Name of the custom role.
|
|
3333
|
-
example: revenue team
|
|
3334
|
-
key:
|
|
3335
|
-
type: string
|
|
3336
|
-
description: The 20-hexdigit id or the key for a custom role.
|
|
3337
|
-
example: revenue-team
|
|
3338
|
-
description:
|
|
3339
|
-
type: string
|
|
3340
|
-
description: Description of the custom role.
|
|
3341
|
-
example: Description of revenue team role here
|
|
3342
|
-
_id:
|
|
3343
|
-
$ref: '#/definitions/Id'
|
|
3344
|
-
policy:
|
|
3345
|
-
type: array
|
|
3346
|
-
items:
|
|
3347
|
-
$ref: '#/definitions/Policy'
|
|
3348
|
-
CustomRoles:
|
|
3349
|
-
type: object
|
|
3350
|
-
properties:
|
|
3351
|
-
_links:
|
|
3352
|
-
$ref: '#/definitions/Links'
|
|
3353
|
-
items:
|
|
3354
|
-
type: array
|
|
3355
|
-
items:
|
|
3356
|
-
$ref: '#/definitions/CustomRole'
|
|
3357
|
-
Policy:
|
|
3358
|
-
type: object
|
|
3359
|
-
properties:
|
|
3360
|
-
resources:
|
|
3361
|
-
type: array
|
|
3362
|
-
items:
|
|
3363
|
-
type: string
|
|
3364
|
-
description: A resource specifier string
|
|
3365
|
-
example: 'proj/*:env/*:flag/my-flag'
|
|
3366
|
-
notResources:
|
|
3367
|
-
type: array
|
|
3368
|
-
items:
|
|
3369
|
-
type: string
|
|
3370
|
-
description: A resource specifier string
|
|
3371
|
-
example: 'proj/*:env/*:flag/my-flag'
|
|
3372
|
-
description: >-
|
|
3373
|
-
Targeted resource will be those resources NOT in this list. The
|
|
3374
|
-
"resources`" field must be empty to use this field.
|
|
3375
|
-
actions:
|
|
3376
|
-
type: array
|
|
3377
|
-
items:
|
|
3378
|
-
type: string
|
|
3379
|
-
description: An action to perform on a resource.
|
|
3380
|
-
example: updateOn
|
|
3381
|
-
notActions:
|
|
3382
|
-
type: array
|
|
3383
|
-
items:
|
|
3384
|
-
type: string
|
|
3385
|
-
description: An action to perform on a resource.
|
|
3386
|
-
example: updateOn
|
|
3387
|
-
description: >-
|
|
3388
|
-
Targeted actions will be those actions NOT in this list. The "actions"
|
|
3389
|
-
field must be empty to use this field.
|
|
3390
|
-
effect:
|
|
3391
|
-
type: string
|
|
3392
|
-
description: Effect of the policy - allow or deny.
|
|
3393
|
-
example: deny
|
|
3394
|
-
Id:
|
|
3395
|
-
type: string
|
|
3396
|
-
description: The unique resource id.
|
|
3397
|
-
example: 5a580a01b4ff89217bdf9dc1
|
|
3398
|
-
PatchOperation:
|
|
3399
|
-
type: object
|
|
3400
|
-
properties:
|
|
3401
|
-
op:
|
|
3402
|
-
type: string
|
|
3403
|
-
example: replace
|
|
3404
|
-
path:
|
|
3405
|
-
type: string
|
|
3406
|
-
example: /name
|
|
3407
|
-
value:
|
|
3408
|
-
type: object
|
|
3409
|
-
example: My resource name
|
|
3410
|
-
required:
|
|
3411
|
-
- op
|
|
3412
|
-
- path
|
|
3413
|
-
- value
|
|
3414
|
-
SemanticPatchOperation:
|
|
3415
|
-
type: object
|
|
3416
|
-
properties:
|
|
3417
|
-
comment:
|
|
3418
|
-
type: string
|
|
3419
|
-
example: This is a comment string
|
|
3420
|
-
instructions:
|
|
3421
|
-
$ref: '#/definitions/SemanticPatchInstruction'
|
|
3422
|
-
required:
|
|
3423
|
-
- instructions
|
|
3424
|
-
SemanticPatchInstruction:
|
|
3425
|
-
type: array
|
|
3426
|
-
items:
|
|
3427
|
-
properties:
|
|
3428
|
-
kind:
|
|
3429
|
-
type: string
|
|
3430
|
-
example: removeUserTargets
|
|
3431
|
-
description: >-
|
|
3432
|
-
The name of the modification you would like to perform on a
|
|
3433
|
-
resource.
|
|
3434
|
-
CustomProperty:
|
|
3435
|
-
type: object
|
|
3436
|
-
description: A name and value describing a custom property.
|
|
3437
|
-
properties:
|
|
3438
|
-
name:
|
|
3439
|
-
type: string
|
|
3440
|
-
description: The name of the property.
|
|
3441
|
-
example: My property
|
|
3442
|
-
value:
|
|
3443
|
-
type: array
|
|
3444
|
-
description: Values for this property.
|
|
3445
|
-
items:
|
|
3446
|
-
type: string
|
|
3447
|
-
example:
|
|
3448
|
-
- Value 1
|
|
3449
|
-
- Value 2
|
|
3450
|
-
required:
|
|
3451
|
-
- name
|
|
3452
|
-
CustomPropertyValues:
|
|
3453
|
-
type: array
|
|
3454
|
-
description: Values for this property.
|
|
3455
|
-
items:
|
|
3456
|
-
type: string
|
|
3457
|
-
example:
|
|
3458
|
-
- Value 1
|
|
3459
|
-
- Value 2
|
|
3460
|
-
UsageLinks:
|
|
3461
|
-
type: object
|
|
3462
|
-
properties:
|
|
3463
|
-
parent:
|
|
3464
|
-
$ref: '#/definitions/Link'
|
|
3465
|
-
self:
|
|
3466
|
-
$ref: '#/definitions/Link'
|
|
3467
|
-
subseries:
|
|
3468
|
-
type: array
|
|
3469
|
-
description: The following links that are in the response.
|
|
3470
|
-
items:
|
|
3471
|
-
$ref: '#/definitions/Link'
|
|
3472
|
-
StreamLinks:
|
|
3473
|
-
type: object
|
|
3474
|
-
properties:
|
|
3475
|
-
parent:
|
|
3476
|
-
$ref: '#/definitions/Link'
|
|
3477
|
-
self:
|
|
3478
|
-
$ref: '#/definitions/Link'
|
|
3479
|
-
subseries:
|
|
3480
|
-
type: array
|
|
3481
|
-
description: Links to endpoints that are in the request path.
|
|
3482
|
-
items:
|
|
3483
|
-
$ref: '#/definitions/Link'
|
|
3484
|
-
Usage:
|
|
3485
|
-
type: object
|
|
3486
|
-
properties:
|
|
3487
|
-
_links:
|
|
3488
|
-
$ref: '#/definitions/UsageLinks'
|
|
3489
|
-
series:
|
|
3490
|
-
type: array
|
|
3491
|
-
items:
|
|
3492
|
-
$ref: '#/definitions/StreamUsageSeries'
|
|
3493
|
-
UsageError:
|
|
3494
|
-
type: object
|
|
3495
|
-
properties:
|
|
3496
|
-
message:
|
|
3497
|
-
type: string
|
|
3498
|
-
example: >-
|
|
3499
|
-
This is a beta API, you must pass beta in the LD-API-Version header to
|
|
3500
|
-
use it.
|
|
3501
|
-
Streams:
|
|
3502
|
-
type: object
|
|
3503
|
-
properties:
|
|
3504
|
-
_links:
|
|
3505
|
-
$ref: '#/definitions/StreamUsageLinks'
|
|
3506
|
-
Stream:
|
|
3507
|
-
type: object
|
|
3508
|
-
properties:
|
|
3509
|
-
_links:
|
|
3510
|
-
$ref: '#/definitions/StreamUsageLinks'
|
|
3511
|
-
metadata:
|
|
3512
|
-
type: array
|
|
3513
|
-
items:
|
|
3514
|
-
$ref: '#/definitions/StreamUsageMetadata'
|
|
3515
|
-
series:
|
|
3516
|
-
type: array
|
|
3517
|
-
items:
|
|
3518
|
-
$ref: '#/definitions/StreamUsageSeries'
|
|
3519
|
-
StreamUsageLinks:
|
|
3520
|
-
type: object
|
|
3521
|
-
properties:
|
|
3522
|
-
parent:
|
|
3523
|
-
$ref: '#/definitions/Link'
|
|
3524
|
-
self:
|
|
3525
|
-
$ref: '#/definitions/Link'
|
|
3526
|
-
subseries:
|
|
3527
|
-
type: array
|
|
3528
|
-
description: The following links that are in the response.
|
|
3529
|
-
items:
|
|
3530
|
-
$ref: '#/definitions/Link'
|
|
3531
|
-
StreamUsageSeries:
|
|
3532
|
-
type: object
|
|
3533
|
-
properties:
|
|
3534
|
-
'0':
|
|
3535
|
-
type: integer
|
|
3536
|
-
format: int64
|
|
3537
|
-
description: A key corresponding to a time series data point.
|
|
3538
|
-
example: 0
|
|
3539
|
-
time:
|
|
3540
|
-
type: integer
|
|
3541
|
-
format: int64
|
|
3542
|
-
description: >-
|
|
3543
|
-
A unix epoch time in milliseconds specifying the creation time of this
|
|
3544
|
-
flag.
|
|
3545
|
-
example: 1551740400000
|
|
3546
|
-
StreamUsageMetadata:
|
|
3547
|
-
type: object
|
|
3548
|
-
properties:
|
|
3549
|
-
sdk:
|
|
3550
|
-
type: string
|
|
3551
|
-
description: The language of the sdk
|
|
3552
|
-
example: ruby
|
|
3553
|
-
version:
|
|
3554
|
-
type: string
|
|
3555
|
-
description: The version of the SDK
|
|
3556
|
-
example: 5.4.3
|
|
3557
|
-
source:
|
|
3558
|
-
type: string
|
|
3559
|
-
example: server
|
|
3560
|
-
StreamUsageError:
|
|
3561
|
-
type: object
|
|
3562
|
-
properties:
|
|
3563
|
-
code:
|
|
3564
|
-
type: string
|
|
3565
|
-
example: not_found
|
|
3566
|
-
message:
|
|
3567
|
-
type: string
|
|
3568
|
-
example: Stream source not found
|
|
3569
|
-
StreamBySDK:
|
|
3570
|
-
type: object
|
|
3571
|
-
properties:
|
|
3572
|
-
_links:
|
|
3573
|
-
$ref: '#/definitions/StreamBySDKLinks'
|
|
3574
|
-
metadata:
|
|
3575
|
-
type: array
|
|
3576
|
-
items:
|
|
3577
|
-
$ref: '#/definitions/StreamBySDKLinksMetadata'
|
|
3578
|
-
series:
|
|
3579
|
-
type: array
|
|
3580
|
-
items:
|
|
3581
|
-
$ref: '#/definitions/StreamUsageSeries'
|
|
3582
|
-
StreamBySDKLinks:
|
|
3583
|
-
type: object
|
|
3584
|
-
properties:
|
|
3585
|
-
parent:
|
|
3586
|
-
$ref: '#/definitions/Link'
|
|
3587
|
-
self:
|
|
3588
|
-
$ref: '#/definitions/Link'
|
|
3589
|
-
StreamBySDKLinksMetadata:
|
|
3590
|
-
type: object
|
|
3591
|
-
properties:
|
|
3592
|
-
sdk:
|
|
3593
|
-
type: string
|
|
3594
|
-
example: ruby
|
|
3595
|
-
version:
|
|
3596
|
-
type: string
|
|
3597
|
-
example: 5.4.3
|
|
3598
|
-
source:
|
|
3599
|
-
type: string
|
|
3600
|
-
example: server
|
|
3601
|
-
StreamSDKVersion:
|
|
3602
|
-
type: object
|
|
3603
|
-
properties:
|
|
3604
|
-
_links:
|
|
3605
|
-
$ref: '#/definitions/StreamBySDKLinks'
|
|
3606
|
-
sdkVersions:
|
|
3607
|
-
type: array
|
|
3608
|
-
items:
|
|
3609
|
-
$ref: '#/definitions/StreamSDKVersionData'
|
|
3610
|
-
StreamSDKVersionData:
|
|
3611
|
-
type: object
|
|
3612
|
-
properties:
|
|
3613
|
-
sdk:
|
|
3614
|
-
type: string
|
|
3615
|
-
description: The language of the sdk
|
|
3616
|
-
example: ruby
|
|
3617
|
-
version:
|
|
3618
|
-
type: string
|
|
3619
|
-
description: The version of the sdk
|
|
3620
|
-
example: 5.4.3
|
|
3621
|
-
MAU:
|
|
3622
|
-
type: object
|
|
3623
|
-
properties:
|
|
3624
|
-
_links:
|
|
3625
|
-
$ref: '#/definitions/UsageLinks'
|
|
3626
|
-
metadata:
|
|
3627
|
-
type: array
|
|
3628
|
-
items:
|
|
3629
|
-
$ref: '#/definitions/StreamBySDKLinksMetadata'
|
|
3630
|
-
series:
|
|
3631
|
-
type: array
|
|
3632
|
-
items:
|
|
3633
|
-
$ref: '#/definitions/StreamUsageSeries'
|
|
3634
|
-
MAUbyCategory:
|
|
3635
|
-
type: object
|
|
3636
|
-
properties:
|
|
3637
|
-
_links:
|
|
3638
|
-
$ref: '#/definitions/StreamBySDKLinks'
|
|
3639
|
-
metadata:
|
|
3640
|
-
type: array
|
|
3641
|
-
items:
|
|
3642
|
-
$ref: '#/definitions/MAUMetadata'
|
|
3643
|
-
series:
|
|
3644
|
-
type: array
|
|
3645
|
-
items:
|
|
3646
|
-
$ref: '#/definitions/StreamUsageSeries'
|
|
3647
|
-
MAUMetadata:
|
|
3648
|
-
type: object
|
|
3649
|
-
Events:
|
|
3650
|
-
type: object
|
|
3651
|
-
properties:
|
|
3652
|
-
links:
|
|
3653
|
-
$ref: '#/definitions/UsageLinks'
|
|
3654
|
-
EvaluationUsageError:
|
|
3655
|
-
type: object
|
|
3656
|
-
properties:
|
|
3657
|
-
code:
|
|
3658
|
-
type: string
|
|
3659
|
-
example: not_found
|
|
3660
|
-
message:
|
|
3661
|
-
type: string
|
|
3662
|
-
example: unknown environment
|
|
3663
|
-
FeatureFlagCopyObject:
|
|
3664
|
-
type: object
|
|
3665
|
-
properties:
|
|
3666
|
-
key:
|
|
3667
|
-
type: string
|
|
3668
|
-
description: The environment key to be used.
|
|
3669
|
-
example: staging
|
|
3670
|
-
currentVersion:
|
|
3671
|
-
type: integer
|
|
3672
|
-
description: >-
|
|
3673
|
-
If the latest version of the flag matches provided version it will
|
|
3674
|
-
copy, otherwise it will return a conflict.
|
|
3675
|
-
example: 65
|
|
3676
|
-
required:
|
|
3677
|
-
- key
|
|
3678
|
-
CopyActions:
|
|
3679
|
-
type: string
|
|
3680
|
-
example: []
|
|
3681
|
-
enum:
|
|
3682
|
-
- updateOn
|
|
3683
|
-
- updatePrerequisites
|
|
3684
|
-
- updateTargets
|
|
3685
|
-
- updateRules
|
|
3686
|
-
- updateFallthrough
|
|
3687
|
-
- updateOffVariation
|
|
3688
|
-
FlagListItem:
|
|
3689
|
-
type: object
|
|
3690
|
-
properties:
|
|
3691
|
-
name:
|
|
3692
|
-
type: string
|
|
3693
|
-
key:
|
|
3694
|
-
type: string
|
|
3695
|
-
_links:
|
|
3696
|
-
$ref: '#/definitions/Links'
|
|
3697
|
-
_site:
|
|
3698
|
-
$ref: '#/definitions/Site'
|
|
3699
|
-
Tokens:
|
|
3700
|
-
type: object
|
|
3701
|
-
properties:
|
|
3702
|
-
_links:
|
|
3703
|
-
$ref: '#/definitions/Links'
|
|
3704
|
-
items:
|
|
3705
|
-
type: array
|
|
3706
|
-
items:
|
|
3707
|
-
$ref: '#/definitions/Token'
|
|
3708
|
-
Token:
|
|
3709
|
-
type: object
|
|
3710
|
-
properties:
|
|
3711
|
-
_links:
|
|
3712
|
-
$ref: '#/definitions/Links'
|
|
3713
|
-
_id:
|
|
3714
|
-
$ref: '#/definitions/Id'
|
|
3715
|
-
ownerId:
|
|
3716
|
-
$ref: '#/definitions/Id'
|
|
3717
|
-
memberId:
|
|
3718
|
-
$ref: '#/definitions/Id'
|
|
3719
|
-
_member:
|
|
3720
|
-
$ref: '#/definitions/Member'
|
|
3721
|
-
creationDate:
|
|
3722
|
-
type: integer
|
|
3723
|
-
format: int64
|
|
3724
|
-
description: >-
|
|
3725
|
-
A unix epoch time in milliseconds specifying the creation time of this
|
|
3726
|
-
access token.
|
|
3727
|
-
example: 1443652232590
|
|
3728
|
-
lastModified:
|
|
3729
|
-
type: integer
|
|
3730
|
-
format: int64
|
|
3731
|
-
example: 1469326565348
|
|
3732
|
-
description: >-
|
|
3733
|
-
A unix epoch time in milliseconds specifying the last time this access
|
|
3734
|
-
token was modified.
|
|
3735
|
-
lastUsed:
|
|
3736
|
-
type: integer
|
|
3737
|
-
format: int64
|
|
3738
|
-
example: 1469326565348
|
|
3739
|
-
description: >-
|
|
3740
|
-
A unix epoch time in milliseconds specifying the last time this access
|
|
3741
|
-
token was used to authorize access to the LaunchDarkly REST API.
|
|
3742
|
-
token:
|
|
3743
|
-
type: string
|
|
3744
|
-
example: '3243'
|
|
3745
|
-
description: >-
|
|
3746
|
-
The last 4 digits of the unique secret key for this access token. If
|
|
3747
|
-
creating or resetting the token, this will be the full token secret.
|
|
3748
|
-
name:
|
|
3749
|
-
type: string
|
|
3750
|
-
description: A human-friendly name for the access token
|
|
3751
|
-
example: My access token
|
|
3752
|
-
role:
|
|
3753
|
-
type: string
|
|
3754
|
-
description: The name of a built-in role for the token
|
|
3755
|
-
example: writer
|
|
3756
|
-
customRoleIds:
|
|
3757
|
-
type: array
|
|
3758
|
-
items:
|
|
3759
|
-
type: string
|
|
3760
|
-
description: A list of custom role IDs to use as access limits for the access token
|
|
3761
|
-
inlineRole:
|
|
3762
|
-
type: array
|
|
3763
|
-
items:
|
|
3764
|
-
$ref: '#/definitions/Statement'
|
|
3765
|
-
serviceToken:
|
|
3766
|
-
type: boolean
|
|
3767
|
-
description: >-
|
|
3768
|
-
Whether the token will be a service token
|
|
3769
|
-
https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
|
|
3770
|
-
defaultApiVersion:
|
|
3771
|
-
type: integer
|
|
3772
|
-
description: The default API version for this token
|
|
3773
|
-
RelayProxyConfigs:
|
|
3774
|
-
type: object
|
|
3775
|
-
properties:
|
|
3776
|
-
items:
|
|
3777
|
-
type: array
|
|
3778
|
-
items:
|
|
3779
|
-
$ref: '#/definitions/RelayProxyConfig'
|
|
3780
|
-
RelayProxyConfig:
|
|
3781
|
-
type: object
|
|
3782
|
-
properties:
|
|
3783
|
-
_id:
|
|
3784
|
-
$ref: '#/definitions/Id'
|
|
3785
|
-
_creator:
|
|
3786
|
-
$ref: '#/definitions/Member'
|
|
3787
|
-
name:
|
|
3788
|
-
type: string
|
|
3789
|
-
description: A human-friendly name for the relay proxy configuration
|
|
3790
|
-
example: My relay proxy config
|
|
3791
|
-
policy:
|
|
3792
|
-
type: array
|
|
3793
|
-
items:
|
|
3794
|
-
$ref: '#/definitions/Policy'
|
|
3795
|
-
fullKey:
|
|
3796
|
-
type: string
|
|
3797
|
-
example: rel-8a3a773d-b75e-48eb-a850-492cda9266eo
|
|
3798
|
-
description: >-
|
|
3799
|
-
Full secret key. Only included if creating or resetting the relay
|
|
3800
|
-
proxy configuration
|
|
3801
|
-
displayKey:
|
|
3802
|
-
type: string
|
|
3803
|
-
example: 66eo
|
|
3804
|
-
description: >-
|
|
3805
|
-
The last 4 digits of the unique secret key for this relay proxy
|
|
3806
|
-
configuration
|
|
3807
|
-
creationDate:
|
|
3808
|
-
type: integer
|
|
3809
|
-
format: int64
|
|
3810
|
-
description: >-
|
|
3811
|
-
A unix epoch time in milliseconds specifying the creation time of this
|
|
3812
|
-
relay proxy configuration
|
|
3813
|
-
example: 1443652232590
|
|
3814
|
-
lastModified:
|
|
3815
|
-
type: integer
|
|
3816
|
-
format: int64
|
|
3817
|
-
example: 1469326565348
|
|
3818
|
-
description: >-
|
|
3819
|
-
A unix epoch time in milliseconds specifying the last time this relay
|
|
3820
|
-
proxy configuration was modified
|
|
3821
|
-
required:
|
|
3822
|
-
- _id
|
|
3823
|
-
- _creator
|
|
3824
|
-
- name
|
|
3825
|
-
- policy
|
|
3826
|
-
- displayKey
|
|
3827
|
-
- creationDate
|
|
3828
|
-
- lastModified
|
|
3829
|
-
HierarchicalLinks:
|
|
3830
|
-
type: object
|
|
3831
|
-
properties:
|
|
3832
|
-
parent:
|
|
3833
|
-
$ref: '#/definitions/Link'
|
|
3834
|
-
self:
|
|
3835
|
-
$ref: '#/definitions/Link'
|
|
3836
|
-
IntegrationSubscription:
|
|
3837
|
-
type: object
|
|
3838
|
-
properties:
|
|
3839
|
-
_links:
|
|
3840
|
-
$ref: '#/definitions/HierarchicalLinks'
|
|
3841
|
-
_id:
|
|
3842
|
-
$ref: '#/definitions/Id'
|
|
3843
|
-
kind:
|
|
3844
|
-
type: string
|
|
3845
|
-
description: The type of integration associated with this configuration.
|
|
3846
|
-
example: datadog
|
|
3847
|
-
name:
|
|
3848
|
-
type: string
|
|
3849
|
-
description: The user-defined name associated with this configuration.
|
|
3850
|
-
example: V2
|
|
3851
|
-
config:
|
|
3852
|
-
type: object
|
|
3853
|
-
description: A key-value mapping of configuration fields.
|
|
3854
|
-
example:
|
|
3855
|
-
apiKey: 582**************************116
|
|
3856
|
-
hostURL: 'https://api.datadoghq.com'
|
|
3857
|
-
statements:
|
|
3858
|
-
type: array
|
|
3859
|
-
items:
|
|
3860
|
-
$ref: '#/definitions/Statement'
|
|
3861
|
-
'on':
|
|
3862
|
-
type: boolean
|
|
3863
|
-
description: Whether or not the integration is currently active.
|
|
3864
|
-
example: true
|
|
3865
|
-
tags:
|
|
3866
|
-
type: array
|
|
3867
|
-
items:
|
|
3868
|
-
type: string
|
|
3869
|
-
description: An array of tags for this integration configuration.
|
|
3870
|
-
_status:
|
|
3871
|
-
type: object
|
|
3872
|
-
properties:
|
|
3873
|
-
successCount:
|
|
3874
|
-
type: integer
|
|
3875
|
-
example: 6
|
|
3876
|
-
lastSuccess:
|
|
3877
|
-
type: integer
|
|
3878
|
-
format: int64
|
|
3879
|
-
description: >-
|
|
3880
|
-
A unix epoch time in milliseconds specifying the last time this
|
|
3881
|
-
integration was successfully used.
|
|
3882
|
-
example: 1443652232590
|
|
3883
|
-
errorCount:
|
|
3884
|
-
type: integer
|
|
3885
|
-
example: 2
|
|
3886
|
-
Integration:
|
|
3887
|
-
type: object
|
|
3888
|
-
properties:
|
|
3889
|
-
_links:
|
|
3890
|
-
type: object
|
|
3891
|
-
properties:
|
|
3892
|
-
self:
|
|
3893
|
-
$ref: '#/definitions/Link'
|
|
3894
|
-
items:
|
|
3895
|
-
type: array
|
|
3896
|
-
items:
|
|
3897
|
-
$ref: '#/definitions/IntegrationSubscription'
|
|
3898
|
-
Integrations:
|
|
3899
|
-
type: object
|
|
3900
|
-
properties:
|
|
3901
|
-
_links:
|
|
3902
|
-
type: object
|
|
3903
|
-
description: A mapping of integration types to their respective API endpoints.
|
|
3904
|
-
example:
|
|
3905
|
-
appdynamics:
|
|
3906
|
-
href: /api/v2/integrations/appdynamics
|
|
3907
|
-
type: application/json
|
|
3908
|
-
splunk:
|
|
3909
|
-
href: /api/v2/integrations/splunk
|
|
3910
|
-
type: application/json
|
|
3911
|
-
items:
|
|
3912
|
-
type: array
|
|
3913
|
-
items:
|
|
3914
|
-
type: object
|
|
3915
|
-
$ref: '#/definitions/IntegrationSubscription'
|
|
3916
|
-
responses:
|
|
3917
|
-
Standard201:
|
|
3918
|
-
description: Resource created.
|
|
3919
|
-
Standard204:
|
|
3920
|
-
description: Action completed successfully.
|
|
3921
|
-
Standard400:
|
|
3922
|
-
description: Invalid request body.
|
|
3923
|
-
Standard401:
|
|
3924
|
-
description: Invalid access token.
|
|
3925
|
-
Standard403:
|
|
3926
|
-
description: Access to the requested resource was denied.
|
|
3927
|
-
Standard404:
|
|
3928
|
-
description: Invalid resource specifier.
|
|
3929
|
-
Standard409:
|
|
3930
|
-
description: Status conflict.
|
|
3931
|
-
Root200:
|
|
3932
|
-
description: A list of links to available resources in the API.
|
|
3933
|
-
schema:
|
|
3934
|
-
$ref: '#/definitions/Links'
|
|
3935
|
-
Webhook2xx:
|
|
3936
|
-
description: Webhook response.
|
|
3937
|
-
schema:
|
|
3938
|
-
$ref: '#/definitions/Webhook'
|
|
3939
|
-
UserSegment2xx:
|
|
3940
|
-
description: User segment response.
|
|
3941
|
-
schema:
|
|
3942
|
-
$ref: '#/definitions/UserSegment'
|
|
3943
|
-
Project2xx:
|
|
3944
|
-
description: Successful Project response.
|
|
3945
|
-
schema:
|
|
3946
|
-
$ref: '#/definitions/Project'
|
|
3947
|
-
Member2xx:
|
|
3948
|
-
description: Member response.
|
|
3949
|
-
schema:
|
|
3950
|
-
$ref: '#/definitions/Member'
|
|
3951
|
-
CustomRole2xx:
|
|
3952
|
-
description: Custom role response.
|
|
3953
|
-
schema:
|
|
3954
|
-
$ref: '#/definitions/CustomRole'
|
|
3955
|
-
BetaApi403:
|
|
3956
|
-
description: >-
|
|
3957
|
-
This is a beta API, you must pass beta in the LD-API-Version header to use
|
|
3958
|
-
it.
|
|
3959
|
-
schema:
|
|
3960
|
-
$ref: '#/definitions/UsageError'
|
|
3961
|
-
StreamUsage404:
|
|
3962
|
-
description: The stream source you requested could not be found
|
|
3963
|
-
schema:
|
|
3964
|
-
$ref: '#/definitions/StreamUsageError'
|
|
3965
|
-
EvaluationUsage404:
|
|
3966
|
-
description: The environment or flag you requested could not be found
|
|
3967
|
-
schema:
|
|
3968
|
-
$ref: '#/definitions/EvaluationUsageError'
|
|
3969
|
-
Environment2xx:
|
|
3970
|
-
description: Environment response.
|
|
3971
|
-
schema:
|
|
3972
|
-
$ref: '#/definitions/Environment'
|
|
3973
|
-
Destination2xx:
|
|
3974
|
-
description: Destination response.
|
|
3975
|
-
schema:
|
|
3976
|
-
$ref: '#/definitions/Destination'
|
|
3977
|
-
Token2xx:
|
|
3978
|
-
description: Token response.
|
|
3979
|
-
schema:
|
|
3980
|
-
$ref: '#/definitions/Token'
|
|
3981
|
-
RelayProxyConfig2xx:
|
|
3982
|
-
description: Relay proxy config response.
|
|
3983
|
-
schema:
|
|
3984
|
-
$ref: '#/definitions/RelayProxyConfig'
|
|
3985
|
-
parameters:
|
|
3986
|
-
ResourceId:
|
|
3987
|
-
name: resourceId
|
|
3988
|
-
in: path
|
|
3989
|
-
required: true
|
|
3990
|
-
description: The resource ID.
|
|
3991
|
-
type: string
|
|
3992
|
-
WebhookPostRequest:
|
|
3993
|
-
name: webhookBody
|
|
3994
|
-
in: body
|
|
3995
|
-
required: true
|
|
3996
|
-
description: New webhook.
|
|
3997
|
-
schema:
|
|
3998
|
-
type: object
|
|
3999
|
-
properties:
|
|
4000
|
-
url:
|
|
4001
|
-
example: 'https://example.com/example'
|
|
4002
|
-
type: string
|
|
4003
|
-
description: The URL of the remote webhook.
|
|
4004
|
-
secret:
|
|
4005
|
-
example: <password>
|
|
4006
|
-
type: string
|
|
4007
|
-
description: >-
|
|
4008
|
-
If sign is true, and the secret attribute is omitted, LaunchDarkly
|
|
4009
|
-
will automatically generate a secret for you.
|
|
4010
|
-
sign:
|
|
4011
|
-
type: boolean
|
|
4012
|
-
description: >-
|
|
4013
|
-
If sign is false, the webhook will not include a signature header,
|
|
4014
|
-
and the secret can be omitted.
|
|
4015
|
-
'on':
|
|
4016
|
-
type: boolean
|
|
4017
|
-
example: true
|
|
4018
|
-
description: Whether this webhook is enabled or not.
|
|
4019
|
-
name:
|
|
4020
|
-
type: string
|
|
4021
|
-
example: Example hook
|
|
4022
|
-
description: The name of the webhook.
|
|
4023
|
-
statements:
|
|
4024
|
-
type: array
|
|
4025
|
-
items:
|
|
4026
|
-
$ref: '#/definitions/Statement'
|
|
4027
|
-
tags:
|
|
4028
|
-
type: array
|
|
4029
|
-
items:
|
|
4030
|
-
type: string
|
|
4031
|
-
example: []
|
|
4032
|
-
description: Tags for the webhook.
|
|
4033
|
-
required:
|
|
4034
|
-
- url
|
|
4035
|
-
- sign
|
|
4036
|
-
- 'on'
|
|
4037
|
-
FeatureFlagCopyBody:
|
|
4038
|
-
name: featureFlagCopyBody
|
|
4039
|
-
in: body
|
|
4040
|
-
required: true
|
|
4041
|
-
description: Copy feature flag configurations between environments.
|
|
4042
|
-
schema:
|
|
4043
|
-
type: object
|
|
4044
|
-
properties:
|
|
4045
|
-
source:
|
|
4046
|
-
$ref: '#/definitions/FeatureFlagCopyObject'
|
|
4047
|
-
target:
|
|
4048
|
-
$ref: '#/definitions/FeatureFlagCopyObject'
|
|
4049
|
-
comment:
|
|
4050
|
-
type: string
|
|
4051
|
-
description: comment will be included in audit log item for change.
|
|
4052
|
-
example: This is a comment string
|
|
4053
|
-
includedActions:
|
|
4054
|
-
type: array
|
|
4055
|
-
items:
|
|
4056
|
-
$ref: '#/definitions/CopyActions'
|
|
4057
|
-
description: Define the parts of the flag configuration that will be copied.
|
|
4058
|
-
excludedActions:
|
|
4059
|
-
type: array
|
|
4060
|
-
items:
|
|
4061
|
-
$ref: '#/definitions/CopyActions'
|
|
4062
|
-
description: Define the parts of the flag configuration that will not be copied.
|
|
4063
|
-
FeatureFlagPostRequest:
|
|
4064
|
-
name: featureFlagBody
|
|
4065
|
-
in: body
|
|
4066
|
-
required: true
|
|
4067
|
-
description: Create a new feature flag.
|
|
4068
|
-
schema:
|
|
4069
|
-
type: object
|
|
4070
|
-
properties:
|
|
4071
|
-
name:
|
|
4072
|
-
type: string
|
|
4073
|
-
description: >-
|
|
4074
|
-
A human-friendly name for the feature flag. Remember to note if this
|
|
4075
|
-
flag is intended to be temporary or permanent.
|
|
4076
|
-
example: new test flag
|
|
4077
|
-
key:
|
|
4078
|
-
type: string
|
|
4079
|
-
description: A unique key that will be used to reference the flag in your code.
|
|
4080
|
-
example: new-test-flag
|
|
4081
|
-
description:
|
|
4082
|
-
type: string
|
|
4083
|
-
description: A description of the feature flag.
|
|
4084
|
-
example: This flag controls whether test feature is turned on or not.
|
|
4085
|
-
variations:
|
|
4086
|
-
type: array
|
|
4087
|
-
items:
|
|
4088
|
-
$ref: '#/definitions/Variation'
|
|
4089
|
-
description: An array of possible variations for the flag.
|
|
4090
|
-
temporary:
|
|
4091
|
-
type: boolean
|
|
4092
|
-
description: Whether or not the flag is a temporary flag.
|
|
4093
|
-
tags:
|
|
4094
|
-
type: array
|
|
4095
|
-
items:
|
|
4096
|
-
type: string
|
|
4097
|
-
example: []
|
|
4098
|
-
description: Tags for the feature flag.
|
|
4099
|
-
includeInSnippet:
|
|
4100
|
-
type: boolean
|
|
4101
|
-
description: >-
|
|
4102
|
-
Whether or not this flag should be made available to the client-side
|
|
4103
|
-
JavaScript SDK.
|
|
4104
|
-
clientSideAvailability:
|
|
4105
|
-
$ref: '#/definitions/ClientSideAvailability'
|
|
4106
|
-
defaults:
|
|
4107
|
-
$ref: '#/definitions/Defaults'
|
|
4108
|
-
required:
|
|
4109
|
-
- name
|
|
4110
|
-
- key
|
|
4111
|
-
- variations
|
|
4112
|
-
ScheduledChangeId:
|
|
4113
|
-
name: scheduledChangeId
|
|
4114
|
-
in: path
|
|
4115
|
-
required: true
|
|
4116
|
-
description: The id of the scheduled change
|
|
4117
|
-
type: string
|
|
4118
|
-
FlagConfigScheduledChangesConflictsBody:
|
|
4119
|
-
name: flagConfigScheduledChangesConflictsBody
|
|
4120
|
-
in: body
|
|
4121
|
-
required: true
|
|
4122
|
-
description: >-
|
|
4123
|
-
Used to determine if a semantic patch will result in conflicts with
|
|
4124
|
-
scheduled changes on a feature flag.
|
|
4125
|
-
schema:
|
|
4126
|
-
type: object
|
|
4127
|
-
properties:
|
|
4128
|
-
executionDate:
|
|
4129
|
-
type: integer
|
|
4130
|
-
description: >-
|
|
4131
|
-
A unix epoch time in milliseconds specifying the date the scheduled
|
|
4132
|
-
changes will be applied
|
|
4133
|
-
instructions:
|
|
4134
|
-
$ref: '#/definitions/SemanticPatchInstruction'
|
|
4135
|
-
FlagConfigScheduledChangesPostBody:
|
|
4136
|
-
name: flagConfigScheduledChangesPostBody
|
|
4137
|
-
in: body
|
|
4138
|
-
required: true
|
|
4139
|
-
description: Create scheduled changes on a feature flag.
|
|
4140
|
-
schema:
|
|
4141
|
-
type: object
|
|
4142
|
-
properties:
|
|
4143
|
-
comment:
|
|
4144
|
-
type: string
|
|
4145
|
-
description: Used to describe the scheduled changes.
|
|
4146
|
-
executionDate:
|
|
4147
|
-
type: integer
|
|
4148
|
-
description: >-
|
|
4149
|
-
A unix epoch time in milliseconds specifying the date the scheduled
|
|
4150
|
-
changes will be applied
|
|
4151
|
-
instructions:
|
|
4152
|
-
$ref: '#/definitions/SemanticPatchInstruction'
|
|
4153
|
-
FlagConfigScheduledChangesPatchBody:
|
|
4154
|
-
name: flagConfigScheduledChangesPatchBody
|
|
4155
|
-
in: body
|
|
4156
|
-
required: true
|
|
4157
|
-
description: Update scheduled changes on a feature flag.
|
|
4158
|
-
schema:
|
|
4159
|
-
type: object
|
|
4160
|
-
properties:
|
|
4161
|
-
comment:
|
|
4162
|
-
type: string
|
|
4163
|
-
description: Used to describe the scheduled changes.
|
|
4164
|
-
instructions:
|
|
4165
|
-
$ref: '#/definitions/SemanticPatchInstruction'
|
|
4166
|
-
DestinationPostRequest:
|
|
4167
|
-
name: destinationBody
|
|
4168
|
-
in: body
|
|
4169
|
-
required: true
|
|
4170
|
-
description: Create a new data export destination.
|
|
4171
|
-
schema:
|
|
4172
|
-
type: object
|
|
4173
|
-
properties:
|
|
4174
|
-
name:
|
|
4175
|
-
type: string
|
|
4176
|
-
description: A human-readable name for your data export destination.
|
|
4177
|
-
example: Example Google Pub/Sub Destination
|
|
4178
|
-
kind:
|
|
4179
|
-
type: string
|
|
4180
|
-
description: >-
|
|
4181
|
-
The data export destination type. Available choices are kinesis,
|
|
4182
|
-
google-pubsub, mparticle, or segment.
|
|
4183
|
-
example: google-pubsub
|
|
4184
|
-
enum:
|
|
4185
|
-
- google-pubsub
|
|
4186
|
-
- kinesis
|
|
4187
|
-
- mparticle
|
|
4188
|
-
- segment
|
|
4189
|
-
config:
|
|
4190
|
-
type: object
|
|
4191
|
-
description: destination-specific configuration.
|
|
4192
|
-
example:
|
|
4193
|
-
project: cool-project
|
|
4194
|
-
topic: test
|
|
4195
|
-
'on':
|
|
4196
|
-
type: boolean
|
|
4197
|
-
example: true
|
|
4198
|
-
description: Whether the data export destination is on or not.
|
|
4199
|
-
required:
|
|
4200
|
-
- name
|
|
4201
|
-
- kind
|
|
4202
|
-
- config
|
|
4203
|
-
UserSegmentPostRequest:
|
|
4204
|
-
name: userSegmentBody
|
|
4205
|
-
in: body
|
|
4206
|
-
required: true
|
|
4207
|
-
description: Create a new user segment.
|
|
4208
|
-
schema:
|
|
4209
|
-
type: object
|
|
4210
|
-
properties:
|
|
4211
|
-
name:
|
|
4212
|
-
type: string
|
|
4213
|
-
description: A human-friendly name for the user segment.
|
|
4214
|
-
example: new segment
|
|
4215
|
-
key:
|
|
4216
|
-
type: string
|
|
4217
|
-
description: >-
|
|
4218
|
-
A unique key that will be used to reference the user segment in
|
|
4219
|
-
feature flags.
|
|
4220
|
-
example: new-segment
|
|
4221
|
-
description:
|
|
4222
|
-
type: string
|
|
4223
|
-
description: A description for the user segment.
|
|
4224
|
-
example: Users in this segment will have access to beta features.
|
|
4225
|
-
unbounded:
|
|
4226
|
-
type: boolean
|
|
4227
|
-
example: false
|
|
4228
|
-
description: >-
|
|
4229
|
-
Controls whether this is considered a "big segment" which can
|
|
4230
|
-
support an unlimited numbers of users. Include/exclude lists sent
|
|
4231
|
-
with this payload are not used in big segments. Contact your account
|
|
4232
|
-
manager for early access to this feature.
|
|
4233
|
-
tags:
|
|
4234
|
-
type: array
|
|
4235
|
-
items:
|
|
4236
|
-
type: string
|
|
4237
|
-
example: []
|
|
4238
|
-
description: Tags for the user segment.
|
|
4239
|
-
required:
|
|
4240
|
-
- name
|
|
4241
|
-
- key
|
|
4242
|
-
BigSegmentTargetsPostRequest:
|
|
4243
|
-
name: bigSegmentTargetsBody
|
|
4244
|
-
in: body
|
|
4245
|
-
required: true
|
|
4246
|
-
description: >-
|
|
4247
|
-
Add or remove user targets to the included or excluded lists on a big
|
|
4248
|
-
segment. Contact your account manager for early access to this feature.
|
|
4249
|
-
schema:
|
|
4250
|
-
type: object
|
|
4251
|
-
properties:
|
|
4252
|
-
included:
|
|
4253
|
-
$ref: '#/definitions/BigSegmentTargetChanges'
|
|
4254
|
-
excluded:
|
|
4255
|
-
$ref: '#/definitions/BigSegmentTargetChanges'
|
|
4256
|
-
ProjectPostRequest:
|
|
4257
|
-
name: projectBody
|
|
4258
|
-
in: body
|
|
4259
|
-
required: true
|
|
4260
|
-
description: Project keys must be unique within an account.
|
|
4261
|
-
schema:
|
|
4262
|
-
type: object
|
|
4263
|
-
properties:
|
|
4264
|
-
name:
|
|
4265
|
-
type: string
|
|
4266
|
-
example: New Project
|
|
4267
|
-
key:
|
|
4268
|
-
type: string
|
|
4269
|
-
example: new-project
|
|
4270
|
-
includeInSnippetByDefault:
|
|
4271
|
-
type: boolean
|
|
4272
|
-
example: false
|
|
4273
|
-
tags:
|
|
4274
|
-
type: array
|
|
4275
|
-
items:
|
|
4276
|
-
type: string
|
|
4277
|
-
example:
|
|
4278
|
-
- ops
|
|
4279
|
-
- dev
|
|
4280
|
-
environments:
|
|
4281
|
-
type: array
|
|
4282
|
-
items:
|
|
4283
|
-
$ref: '#/definitions/EnvironmentPost'
|
|
4284
|
-
minLength: 1
|
|
4285
|
-
defaultClientSideAvailability:
|
|
4286
|
-
$ref: '#/definitions/ClientSideAvailability'
|
|
4287
|
-
required:
|
|
4288
|
-
- name
|
|
4289
|
-
- key
|
|
4290
|
-
EnvironmentPostRequest:
|
|
4291
|
-
name: environmentBody
|
|
4292
|
-
in: body
|
|
4293
|
-
required: true
|
|
4294
|
-
description: New environment.
|
|
4295
|
-
schema:
|
|
4296
|
-
$ref: '#/definitions/EnvironmentPost'
|
|
4297
|
-
ProjectKey:
|
|
4298
|
-
name: projectKey
|
|
4299
|
-
in: path
|
|
4300
|
-
required: true
|
|
4301
|
-
description: >-
|
|
4302
|
-
The project key, used to tie the flags together under one project so they
|
|
4303
|
-
can be managed together.
|
|
4304
|
-
type: string
|
|
4305
|
-
EnvironmentKey:
|
|
4306
|
-
name: environmentKey
|
|
4307
|
-
in: path
|
|
4308
|
-
required: true
|
|
4309
|
-
description: >-
|
|
4310
|
-
The environment key, used to tie together flag configuration and users
|
|
4311
|
-
under one environment so they can be managed together.
|
|
4312
|
-
type: string
|
|
4313
|
-
EnvironmentKeyQuery:
|
|
4314
|
-
name: env
|
|
4315
|
-
in: query
|
|
4316
|
-
required: false
|
|
4317
|
-
description: >-
|
|
4318
|
-
By default, each feature will include configurations for each environment.
|
|
4319
|
-
You can filter environments with the env query parameter. For example,
|
|
4320
|
-
setting env=["production"] will restrict the returned configurations to
|
|
4321
|
-
just your production environment.
|
|
4322
|
-
type: array
|
|
4323
|
-
items:
|
|
4324
|
-
type: string
|
|
4325
|
-
collectionFormat: multi
|
|
4326
|
-
EnvironmentSDKKeyExpiry:
|
|
4327
|
-
name: expiry
|
|
4328
|
-
in: query
|
|
4329
|
-
required: false
|
|
4330
|
-
type: integer
|
|
4331
|
-
format: int64
|
|
4332
|
-
description: >-
|
|
4333
|
-
An expiration time for the old environment SDK key, expressed as a Unix
|
|
4334
|
-
epoch time in milliseconds. By default, the key will expire immediately.
|
|
4335
|
-
EnvironmentMobileKeyExpiry:
|
|
4336
|
-
name: expiry
|
|
4337
|
-
in: query
|
|
4338
|
-
required: false
|
|
4339
|
-
type: integer
|
|
4340
|
-
format: int64
|
|
4341
|
-
description: >-
|
|
4342
|
-
The expiry parameter is deprecated for this endpoint, so the old mobile
|
|
4343
|
-
key will always expire immediately. This parameter will be removed in an
|
|
4344
|
-
upcoming major API client version.
|
|
4345
|
-
SummaryQuery:
|
|
4346
|
-
name: summary
|
|
4347
|
-
in: query
|
|
4348
|
-
required: false
|
|
4349
|
-
description: >-
|
|
4350
|
-
By default in api version >= 1, flags will _not_ include their list of
|
|
4351
|
-
prerequisites, targets or rules. Set summary=0 to include these fields
|
|
4352
|
-
for each flag returned.
|
|
4353
|
-
type: boolean
|
|
4354
|
-
ArchivedQuery:
|
|
4355
|
-
name: archived
|
|
4356
|
-
in: query
|
|
4357
|
-
required: false
|
|
4358
|
-
description: >-
|
|
4359
|
-
When set to 1, only archived flags will be included in the list of flags
|
|
4360
|
-
returned. By default, archived flags are not included in the list of
|
|
4361
|
-
flags.
|
|
4362
|
-
type: boolean
|
|
4363
|
-
LimitQuery:
|
|
4364
|
-
name: limit
|
|
4365
|
-
in: query
|
|
4366
|
-
required: false
|
|
4367
|
-
description: 'The number of objects to return. Defaults to -1, which returns everything.'
|
|
4368
|
-
type: number
|
|
4369
|
-
OffsetQuery:
|
|
4370
|
-
name: offset
|
|
4371
|
-
in: query
|
|
4372
|
-
required: false
|
|
4373
|
-
description: >-
|
|
4374
|
-
Where to start in the list. This is for use with pagination. For example,
|
|
4375
|
-
an offset of 10 would skip the first 10 items and then return the next
|
|
4376
|
-
limit items.
|
|
4377
|
-
type: number
|
|
4378
|
-
FilterQuery:
|
|
4379
|
-
name: filter
|
|
4380
|
-
in: query
|
|
4381
|
-
required: false
|
|
4382
|
-
description: 'A comma-separated list of filters. Each filter is of the form field:value.'
|
|
4383
|
-
type: string
|
|
4384
|
-
SortQuery:
|
|
4385
|
-
name: sort
|
|
4386
|
-
in: query
|
|
4387
|
-
required: false
|
|
4388
|
-
description: >-
|
|
4389
|
-
A comma-separated list of fields to sort by. A field prefixed by a - will
|
|
4390
|
-
be sorted in descending order.
|
|
4391
|
-
type: string
|
|
4392
|
-
FeatureFlagKey:
|
|
4393
|
-
name: featureFlagKey
|
|
4394
|
-
in: path
|
|
4395
|
-
required: true
|
|
4396
|
-
description: The feature flag's key. The key identifies the flag in your code.
|
|
4397
|
-
type: string
|
|
4398
|
-
CloneFlagKeyQuery:
|
|
4399
|
-
name: clone
|
|
4400
|
-
in: query
|
|
4401
|
-
required: false
|
|
4402
|
-
description: >-
|
|
4403
|
-
The key of the feature flag to be cloned. The key identifies the flag in
|
|
4404
|
-
your code. For example, setting clone=flagKey will copy the full
|
|
4405
|
-
targeting configuration for all environments (including on/off state) from
|
|
4406
|
-
the original flag to the new flag.
|
|
4407
|
-
type: string
|
|
4408
|
-
UserSegmentKey:
|
|
4409
|
-
name: userSegmentKey
|
|
4410
|
-
in: path
|
|
4411
|
-
required: true
|
|
4412
|
-
description: The user segment's key. The key identifies the user segment in your code.
|
|
4413
|
-
type: string
|
|
4414
|
-
DestinationId:
|
|
4415
|
-
name: destinationId
|
|
4416
|
-
in: path
|
|
4417
|
-
required: true
|
|
4418
|
-
description: The data export destination ID.
|
|
4419
|
-
type: string
|
|
4420
|
-
UserKey:
|
|
4421
|
-
name: userKey
|
|
4422
|
-
in: path
|
|
4423
|
-
required: true
|
|
4424
|
-
description: The user's key.
|
|
4425
|
-
type: string
|
|
4426
|
-
Tag:
|
|
4427
|
-
name: tag
|
|
4428
|
-
in: query
|
|
4429
|
-
required: false
|
|
4430
|
-
description: Filter by tag. A tag can be used to group flags across projects.
|
|
4431
|
-
type: string
|
|
4432
|
-
Limit:
|
|
4433
|
-
name: limit
|
|
4434
|
-
in: query
|
|
4435
|
-
required: false
|
|
4436
|
-
description: Pagination limit.
|
|
4437
|
-
type: integer
|
|
4438
|
-
Query:
|
|
4439
|
-
name: q
|
|
4440
|
-
in: query
|
|
4441
|
-
required: false
|
|
4442
|
-
description: Search query.
|
|
4443
|
-
type: string
|
|
4444
|
-
HMAC:
|
|
4445
|
-
name: h
|
|
4446
|
-
in: query
|
|
4447
|
-
required: false
|
|
4448
|
-
description: This parameter is required when following "next" links.
|
|
4449
|
-
type: string
|
|
4450
|
-
ScrollId:
|
|
4451
|
-
name: scrollId
|
|
4452
|
-
in: query
|
|
4453
|
-
required: false
|
|
4454
|
-
description: This parameter is required when following "next" links.
|
|
4455
|
-
type: string
|
|
4456
|
-
Offset:
|
|
4457
|
-
name: offset
|
|
4458
|
-
in: query
|
|
4459
|
-
required: false
|
|
4460
|
-
description: Specifies the first item to return in the collection.
|
|
4461
|
-
type: integer
|
|
4462
|
-
After:
|
|
4463
|
-
name: after
|
|
4464
|
-
in: query
|
|
4465
|
-
required: false
|
|
4466
|
-
description: >-
|
|
4467
|
-
A timestamp filter, expressed as a Unix epoch time in milliseconds. All
|
|
4468
|
-
entries returned will have occurred after this timestamp.
|
|
4469
|
-
format: int64
|
|
4470
|
-
type: integer
|
|
4471
|
-
PatchRequest:
|
|
4472
|
-
name: patchDelta
|
|
4473
|
-
in: body
|
|
4474
|
-
required: true
|
|
4475
|
-
description: >-
|
|
4476
|
-
Requires a JSON Patch representation of the desired changes to the
|
|
4477
|
-
project. 'http://jsonpatch.com/'
|
|
4478
|
-
schema:
|
|
4479
|
-
type: array
|
|
4480
|
-
items:
|
|
4481
|
-
$ref: '#/definitions/PatchOperation'
|
|
4482
|
-
UserSettingsPutRequest:
|
|
4483
|
-
name: userSettingsBody
|
|
4484
|
-
in: body
|
|
4485
|
-
required: true
|
|
4486
|
-
schema:
|
|
4487
|
-
type: object
|
|
4488
|
-
properties:
|
|
4489
|
-
setting:
|
|
4490
|
-
type: boolean
|
|
4491
|
-
description: >
|
|
4492
|
-
The variation value to set for the user. Must match the variation
|
|
4493
|
-
type of the flag.
|
|
4494
|
-
Before:
|
|
4495
|
-
name: before
|
|
4496
|
-
in: query
|
|
4497
|
-
required: false
|
|
4498
|
-
description: >-
|
|
4499
|
-
A timestamp filter, expressed as a Unix epoch time in milliseconds. All
|
|
4500
|
-
entries returned will have before this timestamp.
|
|
4501
|
-
format: int64
|
|
4502
|
-
type: integer
|
|
4503
|
-
Q:
|
|
4504
|
-
name: q
|
|
4505
|
-
in: query
|
|
4506
|
-
required: false
|
|
4507
|
-
description: >-
|
|
4508
|
-
Text to search for. You can search for the full or partial name of the
|
|
4509
|
-
resource involved or full or partial email address of the member who made
|
|
4510
|
-
the change.
|
|
4511
|
-
type: string
|
|
4512
|
-
AuditLimit:
|
|
4513
|
-
name: limit
|
|
4514
|
-
in: query
|
|
4515
|
-
required: false
|
|
4516
|
-
description: >-
|
|
4517
|
-
A limit on the number of audit log entries to be returned, between 1 and
|
|
4518
|
-
20.
|
|
4519
|
-
type: number
|
|
4520
|
-
Spec:
|
|
4521
|
-
name: spec
|
|
4522
|
-
in: query
|
|
4523
|
-
required: false
|
|
4524
|
-
description: >-
|
|
4525
|
-
A resource specifier, allowing you to filter audit log listings by
|
|
4526
|
-
resource.
|
|
4527
|
-
type: string
|
|
4528
|
-
MembersPostRequest:
|
|
4529
|
-
name: membersBody
|
|
4530
|
-
in: body
|
|
4531
|
-
required: true
|
|
4532
|
-
description: New members to invite.
|
|
4533
|
-
schema:
|
|
4534
|
-
type: array
|
|
4535
|
-
items:
|
|
4536
|
-
type: object
|
|
4537
|
-
properties:
|
|
4538
|
-
email:
|
|
4539
|
-
type: string
|
|
4540
|
-
example: exampleuser@email.com
|
|
4541
|
-
firstName:
|
|
4542
|
-
type: string
|
|
4543
|
-
example: Bob
|
|
4544
|
-
lastName:
|
|
4545
|
-
type: string
|
|
4546
|
-
example: Loblaw
|
|
4547
|
-
role:
|
|
4548
|
-
$ref: '#/definitions/Role'
|
|
4549
|
-
customRoles:
|
|
4550
|
-
type: array
|
|
4551
|
-
items:
|
|
4552
|
-
type: string
|
|
4553
|
-
description: The 20-hexdigit id or the key for a custom role.
|
|
4554
|
-
example: revenue-team
|
|
4555
|
-
inlineRole:
|
|
4556
|
-
type: array
|
|
4557
|
-
items:
|
|
4558
|
-
$ref: '#/definitions/Statement'
|
|
4559
|
-
required:
|
|
4560
|
-
- email
|
|
4561
|
-
MemberId:
|
|
4562
|
-
name: memberId
|
|
4563
|
-
in: path
|
|
4564
|
-
required: true
|
|
4565
|
-
description: The member ID.
|
|
4566
|
-
type: string
|
|
4567
|
-
CustomRolePostRequest:
|
|
4568
|
-
name: customRoleBody
|
|
4569
|
-
in: body
|
|
4570
|
-
required: true
|
|
4571
|
-
description: New role or roles to create.
|
|
4572
|
-
schema:
|
|
4573
|
-
type: object
|
|
4574
|
-
properties:
|
|
4575
|
-
name:
|
|
4576
|
-
type: string
|
|
4577
|
-
description: Name of the custom role.
|
|
4578
|
-
example: revenue team
|
|
4579
|
-
description:
|
|
4580
|
-
type: string
|
|
4581
|
-
description: Description of the custom role.
|
|
4582
|
-
example: Description of revenue team role here
|
|
4583
|
-
key:
|
|
4584
|
-
type: string
|
|
4585
|
-
description: The 20-hexdigit id or the key for a custom role.
|
|
4586
|
-
example: revenue-team
|
|
4587
|
-
policy:
|
|
4588
|
-
type: array
|
|
4589
|
-
items:
|
|
4590
|
-
$ref: '#/definitions/Policy'
|
|
4591
|
-
required:
|
|
4592
|
-
- name
|
|
4593
|
-
- key
|
|
4594
|
-
- policy
|
|
4595
|
-
CustomRoleKey:
|
|
4596
|
-
name: customRoleKey
|
|
4597
|
-
in: path
|
|
4598
|
-
required: true
|
|
4599
|
-
description: The custom role key.
|
|
4600
|
-
type: string
|
|
4601
|
-
PatchWithComment:
|
|
4602
|
-
name: patchComment
|
|
4603
|
-
in: body
|
|
4604
|
-
required: true
|
|
4605
|
-
description: >-
|
|
4606
|
-
Requires a JSON Patch representation of the desired changes to the
|
|
4607
|
-
project, and an optional comment. 'http://jsonpatch.com/' Feature flag
|
|
4608
|
-
patches also support JSON Merge Patch format.
|
|
4609
|
-
'https://tools.ietf.org/html/rfc7386' The addition of comments is also
|
|
4610
|
-
supported.
|
|
4611
|
-
schema:
|
|
4612
|
-
type: object
|
|
4613
|
-
properties:
|
|
4614
|
-
comment:
|
|
4615
|
-
type: string
|
|
4616
|
-
example: This is a comment string
|
|
4617
|
-
patch:
|
|
4618
|
-
type: array
|
|
4619
|
-
items:
|
|
4620
|
-
$ref: '#/definitions/PatchOperation'
|
|
4621
|
-
PatchOnly:
|
|
4622
|
-
name: PatchOnly
|
|
4623
|
-
in: body
|
|
4624
|
-
required: true
|
|
4625
|
-
description: >-
|
|
4626
|
-
Requires a JSON Patch representation of the desired changes to the
|
|
4627
|
-
project. 'http://jsonpatch.com/' Feature flag patches also support JSON
|
|
4628
|
-
Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of
|
|
4629
|
-
comments is also supported.
|
|
4630
|
-
schema:
|
|
4631
|
-
type: array
|
|
4632
|
-
items:
|
|
4633
|
-
$ref: '#/definitions/PatchOperation'
|
|
4634
|
-
SemanticPatchWithComment:
|
|
4635
|
-
name: SemanticPatchWithComment
|
|
4636
|
-
in: body
|
|
4637
|
-
required: true
|
|
4638
|
-
description: >-
|
|
4639
|
-
Requires a Semantic Patch representation of the desired changes to the
|
|
4640
|
-
resource.
|
|
4641
|
-
'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'.
|
|
4642
|
-
The addition of comments is also supported.
|
|
4643
|
-
schema:
|
|
4644
|
-
type: object
|
|
4645
|
-
items:
|
|
4646
|
-
$ref: '#/definitions/SemanticPatchOperation'
|
|
4647
|
-
StreamSource:
|
|
4648
|
-
name: source
|
|
4649
|
-
in: path
|
|
4650
|
-
required: true
|
|
4651
|
-
description: The source of where the stream comes from.
|
|
4652
|
-
type: string
|
|
4653
|
-
EventType:
|
|
4654
|
-
name: type
|
|
4655
|
-
in: path
|
|
4656
|
-
required: true
|
|
4657
|
-
description: The type of event we would like to track.
|
|
4658
|
-
type: string
|
|
4659
|
-
EvaluationEnvId:
|
|
4660
|
-
name: envId
|
|
4661
|
-
in: path
|
|
4662
|
-
required: true
|
|
4663
|
-
description: The environment id for the flag evaluations in question.
|
|
4664
|
-
type: string
|
|
4665
|
-
EvaluationFlagKey:
|
|
4666
|
-
name: flagKey
|
|
4667
|
-
in: path
|
|
4668
|
-
required: true
|
|
4669
|
-
description: The key of the flag we want metrics for.
|
|
4670
|
-
type: string
|
|
4671
|
-
TokensPostRequest:
|
|
4672
|
-
name: tokenBody
|
|
4673
|
-
in: body
|
|
4674
|
-
required: true
|
|
4675
|
-
description: Create a new access token.
|
|
4676
|
-
schema:
|
|
4677
|
-
type: object
|
|
4678
|
-
properties:
|
|
4679
|
-
name:
|
|
4680
|
-
type: string
|
|
4681
|
-
description: A human-friendly name for the access token
|
|
4682
|
-
example: My access token
|
|
4683
|
-
role:
|
|
4684
|
-
type: string
|
|
4685
|
-
description: The name of a built-in role for the token
|
|
4686
|
-
example: writer
|
|
4687
|
-
customRoleIds:
|
|
4688
|
-
type: array
|
|
4689
|
-
items:
|
|
4690
|
-
type: string
|
|
4691
|
-
example: []
|
|
4692
|
-
description: >-
|
|
4693
|
-
A list of custom role IDs to use as access limits for the access
|
|
4694
|
-
token
|
|
4695
|
-
inlineRole:
|
|
4696
|
-
type: array
|
|
4697
|
-
items:
|
|
4698
|
-
$ref: '#/definitions/Statement'
|
|
4699
|
-
serviceToken:
|
|
4700
|
-
type: boolean
|
|
4701
|
-
description: >-
|
|
4702
|
-
Whether the token will be a service token
|
|
4703
|
-
https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
|
|
4704
|
-
defaultApiVersion:
|
|
4705
|
-
type: integer
|
|
4706
|
-
description: The default API version for this token
|
|
4707
|
-
TokenId:
|
|
4708
|
-
name: tokenId
|
|
4709
|
-
in: path
|
|
4710
|
-
required: true
|
|
4711
|
-
description: The access token ID.
|
|
4712
|
-
type: string
|
|
4713
|
-
TokenShowAllQuery:
|
|
4714
|
-
name: showAll
|
|
4715
|
-
in: query
|
|
4716
|
-
required: false
|
|
4717
|
-
description: >-
|
|
4718
|
-
If set to true, and the authentication access token has the "Admin" role,
|
|
4719
|
-
personal access tokens for all members will be retrieved.
|
|
4720
|
-
type: boolean
|
|
4721
|
-
TokenExpiry:
|
|
4722
|
-
name: expiry
|
|
4723
|
-
in: query
|
|
4724
|
-
required: false
|
|
4725
|
-
type: integer
|
|
4726
|
-
format: int64
|
|
4727
|
-
description: >-
|
|
4728
|
-
An expiration time for the old token key, expressed as a Unix epoch time
|
|
4729
|
-
in milliseconds. By default, the token will expire immediately.
|
|
4730
|
-
RelayProxyConfigPostRequest:
|
|
4731
|
-
name: relayProxyConfigBody
|
|
4732
|
-
in: body
|
|
4733
|
-
required: true
|
|
4734
|
-
description: Create a new relay proxy configuration
|
|
4735
|
-
schema:
|
|
4736
|
-
type: object
|
|
4737
|
-
properties:
|
|
4738
|
-
name:
|
|
4739
|
-
type: string
|
|
4740
|
-
description: A human-friendly name for the relay proxy configuration
|
|
4741
|
-
example: My relay proxy config
|
|
4742
|
-
policy:
|
|
4743
|
-
type: array
|
|
4744
|
-
items:
|
|
4745
|
-
$ref: '#/definitions/Policy'
|
|
4746
|
-
RelayProxyConfigId:
|
|
4747
|
-
name: id
|
|
4748
|
-
in: path
|
|
4749
|
-
required: true
|
|
4750
|
-
description: The relay proxy configuration ID
|
|
4751
|
-
type: string
|
|
4752
|
-
RelayProxyConfigsExpiry:
|
|
4753
|
-
name: expiry
|
|
4754
|
-
in: query
|
|
4755
|
-
required: false
|
|
4756
|
-
type: integer
|
|
4757
|
-
format: int64
|
|
4758
|
-
description: >-
|
|
4759
|
-
An expiration time for the old relay proxy configuration key, expressed as
|
|
4760
|
-
a Unix epoch time in milliseconds. By default, the relay proxy
|
|
4761
|
-
configuration will expire immediately
|
|
4762
|
-
ApprovalRequestId:
|
|
4763
|
-
name: approvalRequestId
|
|
4764
|
-
in: path
|
|
4765
|
-
required: true
|
|
4766
|
-
description: The approval request ID
|
|
4767
|
-
type: string
|
|
4768
|
-
ApprovalRequestPostRequest:
|
|
4769
|
-
name: approvalRequestConfigBody
|
|
4770
|
-
in: body
|
|
4771
|
-
description: Create a new approval request
|
|
4772
|
-
schema:
|
|
4773
|
-
type: object
|
|
4774
|
-
properties:
|
|
4775
|
-
description:
|
|
4776
|
-
type: string
|
|
4777
|
-
description: >-
|
|
4778
|
-
A name that describes the changes you would like to apply to a
|
|
4779
|
-
feature flag configuration
|
|
4780
|
-
instructions:
|
|
4781
|
-
$ref: '#/definitions/SemanticPatchInstruction'
|
|
4782
|
-
notifyMemberIds:
|
|
4783
|
-
type: array
|
|
4784
|
-
items:
|
|
4785
|
-
type: string
|
|
4786
|
-
example:
|
|
4787
|
-
- memberId
|
|
4788
|
-
- memberId2
|
|
4789
|
-
comment:
|
|
4790
|
-
type: string
|
|
4791
|
-
description: comment will be included in audit log item for change.
|
|
4792
|
-
executionDate:
|
|
4793
|
-
type: integer
|
|
4794
|
-
format: int64
|
|
4795
|
-
description: Timestamp for when instructions will be executed
|
|
4796
|
-
operatingOnId:
|
|
4797
|
-
type: string
|
|
4798
|
-
description: ID of scheduled change to edit or delete
|
|
4799
|
-
required:
|
|
4800
|
-
- description
|
|
4801
|
-
- instructions
|
|
4802
|
-
- notifyMemberIds
|
|
4803
|
-
ApprovalRequestFlagCopyPostRequest:
|
|
4804
|
-
name: approvalRequestFlagConfigCopyBody
|
|
4805
|
-
in: body
|
|
4806
|
-
description: Create a new approval request
|
|
4807
|
-
schema:
|
|
4808
|
-
type: object
|
|
4809
|
-
properties:
|
|
4810
|
-
description:
|
|
4811
|
-
type: string
|
|
4812
|
-
description: >-
|
|
4813
|
-
A name that describes the changes you would like to apply to a
|
|
4814
|
-
feature flag configuration
|
|
4815
|
-
notifyMemberIds:
|
|
4816
|
-
type: array
|
|
4817
|
-
items:
|
|
4818
|
-
type: string
|
|
4819
|
-
example:
|
|
4820
|
-
- memberId
|
|
4821
|
-
- memberId2
|
|
4822
|
-
source:
|
|
4823
|
-
$ref: '#/definitions/Source'
|
|
4824
|
-
comment:
|
|
4825
|
-
type: string
|
|
4826
|
-
description: comment will be included in audit log item for change.
|
|
4827
|
-
includedActions:
|
|
4828
|
-
type: array
|
|
4829
|
-
items:
|
|
4830
|
-
$ref: '#/definitions/CopyActions'
|
|
4831
|
-
description: Define the parts of the flag configuration that will be copied.
|
|
4832
|
-
excludedActions:
|
|
4833
|
-
type: array
|
|
4834
|
-
items:
|
|
4835
|
-
$ref: '#/definitions/CopyActions'
|
|
4836
|
-
description: Define the parts of the flag configuration that will not be copied.
|
|
4837
|
-
required:
|
|
4838
|
-
- description
|
|
4839
|
-
- notifyMemberIds
|
|
4840
|
-
- source
|
|
4841
|
-
ApprovalRequestReviewPostRequest:
|
|
4842
|
-
name: approvalRequestReviewConfigBody
|
|
4843
|
-
in: body
|
|
4844
|
-
required: true
|
|
4845
|
-
description: Review an approval request
|
|
4846
|
-
schema:
|
|
4847
|
-
type: object
|
|
4848
|
-
properties:
|
|
4849
|
-
kind:
|
|
4850
|
-
type: string
|
|
4851
|
-
description: 'One of approve, decline, or comment.'
|
|
4852
|
-
enum:
|
|
4853
|
-
- approve
|
|
4854
|
-
- decline
|
|
4855
|
-
- comment
|
|
4856
|
-
example: approve
|
|
4857
|
-
comment:
|
|
4858
|
-
type: string
|
|
4859
|
-
description: comment will be included in audit log item for change.
|
|
4860
|
-
example: This is a comment string
|
|
4861
|
-
required:
|
|
4862
|
-
- kind
|
|
4863
|
-
ApprovalRequestApplyPostRequest:
|
|
4864
|
-
name: approvalRequestApplyConfigBody
|
|
4865
|
-
in: body
|
|
4866
|
-
required: true
|
|
4867
|
-
description: Apply an approval request
|
|
4868
|
-
schema:
|
|
4869
|
-
type: object
|
|
4870
|
-
properties:
|
|
4871
|
-
comment:
|
|
4872
|
-
type: string
|
|
4873
|
-
description: comment will be included in audit log item for change.
|
|
4874
|
-
example: Applying approved changes
|
|
4875
|
-
IntegrationKey:
|
|
4876
|
-
name: integrationKey
|
|
4877
|
-
in: path
|
|
4878
|
-
required: true
|
|
4879
|
-
description: The key used to specify the integration kind.
|
|
4880
|
-
type: string
|
|
4881
|
-
IntegrationId:
|
|
4882
|
-
name: integrationId
|
|
4883
|
-
in: path
|
|
4884
|
-
required: true
|
|
4885
|
-
description: The integration ID.
|
|
4886
|
-
type: string
|
|
4887
|
-
IntegrationPostRequest:
|
|
4888
|
-
name: subscriptionBody
|
|
4889
|
-
in: body
|
|
4890
|
-
required: true
|
|
4891
|
-
description: Create a new integration subscription.
|
|
4892
|
-
schema:
|
|
4893
|
-
type: object
|
|
4894
|
-
properties:
|
|
4895
|
-
name:
|
|
4896
|
-
type: string
|
|
4897
|
-
description: A human-readable name for your subscription configuration.
|
|
4898
|
-
example: Example Datadog Integration
|
|
4899
|
-
statements:
|
|
4900
|
-
type: array
|
|
4901
|
-
items:
|
|
4902
|
-
$ref: '#/definitions/Statement'
|
|
4903
|
-
config:
|
|
4904
|
-
type: object
|
|
4905
|
-
description: Integration-specific configuration fields.
|
|
4906
|
-
example:
|
|
4907
|
-
apiKey: 582**************************116
|
|
4908
|
-
hostURL: 'https://api.datadoghq.com'
|
|
4909
|
-
'on':
|
|
4910
|
-
type: boolean
|
|
4911
|
-
example: true
|
|
4912
|
-
description: Whether the integration subscription is active or not.
|
|
4913
|
-
tags:
|
|
4914
|
-
type: array
|
|
4915
|
-
items:
|
|
4916
|
-
type: string
|
|
4917
|
-
example: []
|
|
4918
|
-
description: Tags for the integration subscription.
|
|
4919
|
-
required:
|
|
4920
|
-
- name
|
|
4921
|
-
- config
|
|
4922
|
-
|