launchdarkly_api 5.0.3 → 6.0.0

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