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