launchdarkly_api 5.1.0 → 6.0.1

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