github.com/launchdarkly/api-client-go@v5.3.0+incompatible/api/swagger.yaml (about) 1 --- 2 swagger: "2.0" 3 info: 4 description: "Build custom integrations with the LaunchDarkly REST API" 5 version: "5.3.0" 6 title: "LaunchDarkly REST API" 7 termsOfService: "https://launchdarkly.com/terms" 8 contact: 9 name: "LaunchDarkly Support" 10 url: "https://support.launchdarkly.com" 11 email: "support@launchdarkly.com" 12 license: 13 name: "Apache 2.0" 14 url: "http://www.apache.org/licenses/LICENSE-2.0.html" 15 host: "app.launchdarkly.com" 16 basePath: "/api/v2" 17 schemes: 18 - "https" 19 consumes: 20 - "application/json" 21 produces: 22 - "application/json" 23 security: 24 - Token: [] 25 paths: 26 /projects: 27 get: 28 tags: 29 - "Projects" 30 summary: "Returns a list of all projects in the account." 31 operationId: "getProjects" 32 parameters: [] 33 responses: 34 "200": 35 description: "Projects response" 36 schema: 37 $ref: "#/definitions/Projects" 38 "401": 39 description: "Invalid access token." 40 post: 41 tags: 42 - "Projects" 43 summary: "Create a new project with the given key and name." 44 operationId: "postProject" 45 parameters: 46 - in: "body" 47 name: "projectBody" 48 description: "Project keys must be unique within an account." 49 required: true 50 schema: 51 $ref: "#/definitions/projectBody" 52 x-exportParamName: "ProjectBody" 53 responses: 54 "201": 55 description: "Successful Project response." 56 schema: 57 $ref: "#/definitions/Project" 58 "400": 59 description: "Invalid request body." 60 "401": 61 description: "Invalid access token." 62 "409": 63 description: "Status conflict." 64 /projects/{projectKey}: 65 get: 66 tags: 67 - "Projects" 68 summary: "Fetch a single project by key." 69 operationId: "getProject" 70 parameters: 71 - name: "projectKey" 72 in: "path" 73 description: "The project key, used to tie the flags together under one project\ 74 \ so they can be managed together." 75 required: true 76 type: "string" 77 x-exportParamName: "ProjectKey" 78 responses: 79 "200": 80 description: "Successful Project response." 81 schema: 82 $ref: "#/definitions/Project" 83 "401": 84 description: "Invalid access token." 85 "404": 86 description: "Invalid resource specifier." 87 delete: 88 tags: 89 - "Projects" 90 summary: "Delete a project by key. Caution-- deleting a project will delete\ 91 \ all associated environments and feature flags. You cannot delete the last\ 92 \ project in an account." 93 operationId: "deleteProject" 94 parameters: 95 - name: "projectKey" 96 in: "path" 97 description: "The project key, used to tie the flags together under one project\ 98 \ so they can be managed together." 99 required: true 100 type: "string" 101 x-exportParamName: "ProjectKey" 102 responses: 103 "204": 104 description: "Action completed successfully." 105 "401": 106 description: "Invalid access token." 107 "404": 108 description: "Invalid resource specifier." 109 patch: 110 tags: 111 - "Projects" 112 summary: "Modify a project by ID." 113 operationId: "patchProject" 114 parameters: 115 - name: "projectKey" 116 in: "path" 117 description: "The project key, used to tie the flags together under one project\ 118 \ so they can be managed together." 119 required: true 120 type: "string" 121 x-exportParamName: "ProjectKey" 122 - in: "body" 123 name: "patchDelta" 124 description: "Requires a JSON Patch representation of the desired changes\ 125 \ to the project. 'http://jsonpatch.com/'" 126 required: true 127 schema: 128 type: "array" 129 items: 130 $ref: "#/definitions/PatchOperation" 131 x-exportParamName: "PatchDelta" 132 responses: 133 "200": 134 description: "Successful Project response." 135 schema: 136 $ref: "#/definitions/Project" 137 "400": 138 description: "Invalid request body." 139 "401": 140 description: "Invalid access token." 141 "404": 142 description: "Invalid resource specifier." 143 "409": 144 description: "Status conflict." 145 /projects/{projectKey}/environments: 146 post: 147 tags: 148 - "Environments" 149 summary: "Create a new environment in a specified project with a given name,\ 150 \ key, and swatch color." 151 operationId: "postEnvironment" 152 parameters: 153 - name: "projectKey" 154 in: "path" 155 description: "The project key, used to tie the flags together under one project\ 156 \ so they can be managed together." 157 required: true 158 type: "string" 159 x-exportParamName: "ProjectKey" 160 - in: "body" 161 name: "environmentBody" 162 description: "New environment." 163 required: true 164 schema: 165 $ref: "#/definitions/EnvironmentPost" 166 x-exportParamName: "EnvironmentBody" 167 responses: 168 "201": 169 description: "Environment response." 170 schema: 171 $ref: "#/definitions/Environment" 172 "400": 173 description: "Invalid request body." 174 "401": 175 description: "Invalid access token." 176 "409": 177 description: "Status conflict." 178 /projects/{projectKey}/environments/{environmentKey}: 179 get: 180 tags: 181 - "Environments" 182 summary: "Get an environment given a project and key." 183 operationId: "getEnvironment" 184 parameters: 185 - name: "projectKey" 186 in: "path" 187 description: "The project key, used to tie the flags together under one project\ 188 \ so they can be managed together." 189 required: true 190 type: "string" 191 x-exportParamName: "ProjectKey" 192 - name: "environmentKey" 193 in: "path" 194 description: "The environment key, used to tie together flag configuration\ 195 \ and users under one environment so they can be managed together." 196 required: true 197 type: "string" 198 x-exportParamName: "EnvironmentKey" 199 responses: 200 "200": 201 description: "Environment response." 202 schema: 203 $ref: "#/definitions/Environment" 204 "401": 205 description: "Invalid access token." 206 "404": 207 description: "Invalid resource specifier." 208 delete: 209 tags: 210 - "Environments" 211 summary: "Delete an environment in a specific project." 212 operationId: "deleteEnvironment" 213 parameters: 214 - name: "projectKey" 215 in: "path" 216 description: "The project key, used to tie the flags together under one project\ 217 \ so they can be managed together." 218 required: true 219 type: "string" 220 x-exportParamName: "ProjectKey" 221 - name: "environmentKey" 222 in: "path" 223 description: "The environment key, used to tie together flag configuration\ 224 \ and users under one environment so they can be managed together." 225 required: true 226 type: "string" 227 x-exportParamName: "EnvironmentKey" 228 responses: 229 "204": 230 description: "Action completed successfully." 231 "401": 232 description: "Invalid access token." 233 "404": 234 description: "Invalid resource specifier." 235 patch: 236 tags: 237 - "Environments" 238 summary: "Modify an environment by ID. If you try to patch the environment by\ 239 \ setting both required and requiredApprovalTags, it will result in an error.\ 240 \ Users can specify either required approvals for all flags in an environment\ 241 \ or those with specific tags, but not both. Only customers on an Enterprise\ 242 \ plan can require approval for flag updates with either mechanism." 243 operationId: "patchEnvironment" 244 parameters: 245 - name: "projectKey" 246 in: "path" 247 description: "The project key, used to tie the flags together under one project\ 248 \ so they can be managed together." 249 required: true 250 type: "string" 251 x-exportParamName: "ProjectKey" 252 - name: "environmentKey" 253 in: "path" 254 description: "The environment key, used to tie together flag configuration\ 255 \ and users under one environment so they can be managed together." 256 required: true 257 type: "string" 258 x-exportParamName: "EnvironmentKey" 259 - in: "body" 260 name: "patchDelta" 261 description: "Requires a JSON Patch representation of the desired changes\ 262 \ to the project. 'http://jsonpatch.com/'" 263 required: true 264 schema: 265 type: "array" 266 items: 267 $ref: "#/definitions/PatchOperation" 268 x-exportParamName: "PatchDelta" 269 responses: 270 "200": 271 description: "Environment response." 272 schema: 273 $ref: "#/definitions/Environment" 274 "400": 275 description: "Invalid request body." 276 "401": 277 description: "Invalid access token." 278 "404": 279 description: "Invalid resource specifier." 280 "409": 281 description: "Status conflict." 282 /projects/{projectKey}/environments/{environmentKey}/apiKey: 283 post: 284 tags: 285 - "Environments" 286 summary: "Reset an environment's SDK key with an optional expiry time for the\ 287 \ old key." 288 operationId: "resetEnvironmentSDKKey" 289 parameters: 290 - name: "projectKey" 291 in: "path" 292 description: "The project key, used to tie the flags together under one project\ 293 \ so they can be managed together." 294 required: true 295 type: "string" 296 x-exportParamName: "ProjectKey" 297 - name: "environmentKey" 298 in: "path" 299 description: "The environment key, used to tie together flag configuration\ 300 \ and users under one environment so they can be managed together." 301 required: true 302 type: "string" 303 x-exportParamName: "EnvironmentKey" 304 - name: "expiry" 305 in: "query" 306 description: "An expiration time for the old environment SDK key, expressed\ 307 \ as a Unix epoch time in milliseconds. By default, the key will expire\ 308 \ immediately." 309 required: false 310 type: "integer" 311 format: "int64" 312 x-exportParamName: "Expiry" 313 x-optionalDataType: "Int64" 314 responses: 315 "200": 316 description: "Environment response." 317 schema: 318 $ref: "#/definitions/Environment" 319 "404": 320 description: "Invalid resource specifier." 321 "409": 322 description: "Status conflict." 323 /projects/{projectKey}/environments/{environmentKey}/mobileKey: 324 post: 325 tags: 326 - "Environments" 327 summary: "Reset an environment's mobile key. The optional expiry for the old\ 328 \ key is deprecated for this endpoint, so the old key will always expire immediately." 329 operationId: "resetEnvironmentMobileKey" 330 parameters: 331 - name: "projectKey" 332 in: "path" 333 description: "The project key, used to tie the flags together under one project\ 334 \ so they can be managed together." 335 required: true 336 type: "string" 337 x-exportParamName: "ProjectKey" 338 - name: "environmentKey" 339 in: "path" 340 description: "The environment key, used to tie together flag configuration\ 341 \ and users under one environment so they can be managed together." 342 required: true 343 type: "string" 344 x-exportParamName: "EnvironmentKey" 345 - name: "expiry" 346 in: "query" 347 description: "The expiry parameter is deprecated for this endpoint, so the\ 348 \ old mobile key will always expire immediately. This parameter will be\ 349 \ removed in an upcoming major API client version." 350 required: false 351 type: "integer" 352 format: "int64" 353 x-exportParamName: "Expiry" 354 x-optionalDataType: "Int64" 355 responses: 356 "200": 357 description: "Environment response." 358 schema: 359 $ref: "#/definitions/Environment" 360 "404": 361 description: "Invalid resource specifier." 362 "409": 363 description: "Status conflict." 364 /flags/{projectKey}: 365 get: 366 tags: 367 - "Feature flags" 368 summary: "Get a list of all features in the given project." 369 operationId: "getFeatureFlags" 370 parameters: 371 - name: "projectKey" 372 in: "path" 373 description: "The project key, used to tie the flags together under one project\ 374 \ so they can be managed together." 375 required: true 376 type: "string" 377 x-exportParamName: "ProjectKey" 378 - name: "env" 379 in: "query" 380 description: "By default, each feature will include configurations for each\ 381 \ environment. You can filter environments with the env query parameter.\ 382 \ For example, setting env=[\"production\"] will restrict the returned configurations\ 383 \ to just your production environment." 384 required: false 385 type: "array" 386 items: 387 type: "string" 388 collectionFormat: "multi" 389 x-exportParamName: "Env" 390 - name: "summary" 391 in: "query" 392 description: "By default in api version >= 1, flags will _not_ include their\ 393 \ list of prerequisites, targets or rules. Set summary=0 to include these\ 394 \ fields for each flag returned." 395 required: false 396 type: "boolean" 397 x-exportParamName: "Summary" 398 x-optionalDataType: "Bool" 399 - name: "archived" 400 in: "query" 401 description: "When set to 1, only archived flags will be included in the list\ 402 \ of flags returned. By default, archived flags are not included in the\ 403 \ list of flags." 404 required: false 405 type: "boolean" 406 x-exportParamName: "Archived" 407 x-optionalDataType: "Bool" 408 - name: "limit" 409 in: "query" 410 description: "The number of objects to return. Defaults to -1, which returns\ 411 \ everything." 412 required: false 413 type: "number" 414 x-exportParamName: "Limit" 415 x-optionalDataType: "Float32" 416 - name: "offset" 417 in: "query" 418 description: "Where to start in the list. This is for use with pagination.\ 419 \ For example, an offset of 10 would skip the first 10 items and then return\ 420 \ the next limit items." 421 required: false 422 type: "number" 423 x-exportParamName: "Offset" 424 x-optionalDataType: "Float32" 425 - name: "filter" 426 in: "query" 427 description: "A comma-separated list of filters. Each filter is of the form\ 428 \ field:value." 429 required: false 430 type: "string" 431 x-exportParamName: "Filter" 432 x-optionalDataType: "String" 433 - name: "sort" 434 in: "query" 435 description: "A comma-separated list of fields to sort by. A field prefixed\ 436 \ by a - will be sorted in descending order." 437 required: false 438 type: "string" 439 x-exportParamName: "Sort" 440 x-optionalDataType: "String" 441 - name: "tag" 442 in: "query" 443 description: "Filter by tag. A tag can be used to group flags across projects." 444 required: false 445 type: "string" 446 x-exportParamName: "Tag" 447 x-optionalDataType: "String" 448 responses: 449 "200": 450 description: "Flags response." 451 schema: 452 $ref: "#/definitions/FeatureFlags" 453 "401": 454 description: "Invalid access token." 455 post: 456 tags: 457 - "Feature flags" 458 summary: "Creates a new feature flag." 459 operationId: "postFeatureFlag" 460 parameters: 461 - name: "projectKey" 462 in: "path" 463 description: "The project key, used to tie the flags together under one project\ 464 \ so they can be managed together." 465 required: true 466 type: "string" 467 x-exportParamName: "ProjectKey" 468 - in: "body" 469 name: "featureFlagBody" 470 description: "Create a new feature flag." 471 required: true 472 schema: 473 $ref: "#/definitions/featureFlagBody" 474 x-exportParamName: "FeatureFlagBody" 475 - name: "clone" 476 in: "query" 477 description: "The key of the feature flag to be cloned. The key identifies\ 478 \ the flag in your code. For example, setting clone=flagKey will copy the\ 479 \ full targeting configuration for all environments (including on/off state)\ 480 \ from the original flag to the new flag." 481 required: false 482 type: "string" 483 x-exportParamName: "Clone" 484 x-optionalDataType: "String" 485 responses: 486 "201": 487 description: "Flag response." 488 schema: 489 $ref: "#/definitions/FeatureFlag" 490 "400": 491 description: "Invalid request body." 492 "401": 493 description: "Invalid access token." 494 "409": 495 description: "Status conflict." 496 /flags/{projectKey}/{featureFlagKey}: 497 get: 498 tags: 499 - "Feature flags" 500 summary: "Get a single feature flag by key." 501 operationId: "getFeatureFlag" 502 parameters: 503 - name: "projectKey" 504 in: "path" 505 description: "The project key, used to tie the flags together under one project\ 506 \ so they can be managed together." 507 required: true 508 type: "string" 509 x-exportParamName: "ProjectKey" 510 - name: "featureFlagKey" 511 in: "path" 512 description: "The feature flag's key. The key identifies the flag in your\ 513 \ code." 514 required: true 515 type: "string" 516 x-exportParamName: "FeatureFlagKey" 517 - name: "env" 518 in: "query" 519 description: "By default, each feature will include configurations for each\ 520 \ environment. You can filter environments with the env query parameter.\ 521 \ For example, setting env=[\"production\"] will restrict the returned configurations\ 522 \ to just your production environment." 523 required: false 524 type: "array" 525 items: 526 type: "string" 527 collectionFormat: "multi" 528 x-exportParamName: "Env" 529 responses: 530 "200": 531 description: "Flag response." 532 schema: 533 $ref: "#/definitions/FeatureFlag" 534 "401": 535 description: "Invalid access token." 536 "404": 537 description: "Invalid resource specifier." 538 delete: 539 tags: 540 - "Feature flags" 541 summary: "Delete a feature flag in all environments. Be careful-- only delete\ 542 \ feature flags that are no longer being used by your application." 543 operationId: "deleteFeatureFlag" 544 parameters: 545 - name: "projectKey" 546 in: "path" 547 description: "The project key, used to tie the flags together under one project\ 548 \ so they can be managed together." 549 required: true 550 type: "string" 551 x-exportParamName: "ProjectKey" 552 - name: "featureFlagKey" 553 in: "path" 554 description: "The feature flag's key. The key identifies the flag in your\ 555 \ code." 556 required: true 557 type: "string" 558 x-exportParamName: "FeatureFlagKey" 559 responses: 560 "204": 561 description: "Action completed successfully." 562 "401": 563 description: "Invalid access token." 564 "404": 565 description: "Invalid resource specifier." 566 patch: 567 tags: 568 - "Feature flags" 569 summary: "Perform a partial update to a feature." 570 operationId: "patchFeatureFlag" 571 parameters: 572 - name: "projectKey" 573 in: "path" 574 description: "The project key, used to tie the flags together under one project\ 575 \ so they can be managed together." 576 required: true 577 type: "string" 578 x-exportParamName: "ProjectKey" 579 - name: "featureFlagKey" 580 in: "path" 581 description: "The feature flag's key. The key identifies the flag in your\ 582 \ code." 583 required: true 584 type: "string" 585 x-exportParamName: "FeatureFlagKey" 586 - in: "body" 587 name: "patchComment" 588 description: "Requires a JSON Patch representation of the desired changes\ 589 \ to the project, and an optional comment. 'http://jsonpatch.com/' Feature\ 590 \ flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386'\ 591 \ The addition of comments is also supported." 592 required: true 593 schema: 594 $ref: "#/definitions/patchComment" 595 x-exportParamName: "PatchComment" 596 responses: 597 "200": 598 description: "Feature flag response." 599 schema: 600 $ref: "#/definitions/FeatureFlag" 601 "400": 602 description: "Invalid request body." 603 "401": 604 description: "Invalid access token." 605 "404": 606 description: "Invalid resource specifier." 607 "409": 608 description: "Status conflict." 609 /flags/{projectKey}/{featureFlagKey}/copy: 610 post: 611 tags: 612 - "Feature flags" 613 summary: "Copies the feature flag configuration from one environment to the\ 614 \ same feature flag in another environment." 615 operationId: "copyFeatureFlag" 616 parameters: 617 - name: "projectKey" 618 in: "path" 619 description: "The project key, used to tie the flags together under one project\ 620 \ so they can be managed together." 621 required: true 622 type: "string" 623 x-exportParamName: "ProjectKey" 624 - name: "featureFlagKey" 625 in: "path" 626 description: "The feature flag's key. The key identifies the flag in your\ 627 \ code." 628 required: true 629 type: "string" 630 x-exportParamName: "FeatureFlagKey" 631 - in: "body" 632 name: "featureFlagCopyBody" 633 description: "Copy feature flag configurations between environments." 634 required: true 635 schema: 636 $ref: "#/definitions/featureFlagCopyBody" 637 x-exportParamName: "FeatureFlagCopyBody" 638 responses: 639 "201": 640 description: "Flag configuration copy response." 641 schema: 642 $ref: "#/definitions/FeatureFlag" 643 "400": 644 description: "Invalid request body." 645 "401": 646 description: "Invalid access token." 647 "409": 648 description: "Status conflict." 649 /flag-statuses/{projectKey}/{environmentKey}: 650 get: 651 tags: 652 - "Feature flags" 653 summary: "Get a list of statuses for all feature flags. The status includes\ 654 \ the last time the feature flag was requested, as well as the state of the\ 655 \ flag." 656 operationId: "getFeatureFlagStatuses" 657 parameters: 658 - name: "projectKey" 659 in: "path" 660 description: "The project key, used to tie the flags together under one project\ 661 \ so they can be managed together." 662 required: true 663 type: "string" 664 x-exportParamName: "ProjectKey" 665 - name: "environmentKey" 666 in: "path" 667 description: "The environment key, used to tie together flag configuration\ 668 \ and users under one environment so they can be managed together." 669 required: true 670 type: "string" 671 x-exportParamName: "EnvironmentKey" 672 responses: 673 "200": 674 description: "List of feature flag statuses." 675 schema: 676 $ref: "#/definitions/FeatureFlagStatuses" 677 "401": 678 description: "Invalid access token." 679 /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}: 680 get: 681 tags: 682 - "Feature flags" 683 summary: "Get the status for a particular feature flag." 684 operationId: "getFeatureFlagStatus" 685 parameters: 686 - name: "projectKey" 687 in: "path" 688 description: "The project key, used to tie the flags together under one project\ 689 \ so they can be managed together." 690 required: true 691 type: "string" 692 x-exportParamName: "ProjectKey" 693 - name: "environmentKey" 694 in: "path" 695 description: "The environment key, used to tie together flag configuration\ 696 \ and users under one environment so they can be managed together." 697 required: true 698 type: "string" 699 x-exportParamName: "EnvironmentKey" 700 - name: "featureFlagKey" 701 in: "path" 702 description: "The feature flag's key. The key identifies the flag in your\ 703 \ code." 704 required: true 705 type: "string" 706 x-exportParamName: "FeatureFlagKey" 707 responses: 708 "200": 709 description: "Status of the requested feature flag." 710 schema: 711 $ref: "#/definitions/FeatureFlagStatus" 712 "401": 713 description: "Invalid access token." 714 /flag-status/{projectKey}/{featureFlagKey}: 715 get: 716 tags: 717 - "Feature flags" 718 summary: "Get the status for a particular feature flag across environments" 719 operationId: "getFeatureFlagStatusAcrossEnvironments" 720 parameters: 721 - name: "projectKey" 722 in: "path" 723 description: "The project key, used to tie the flags together under one project\ 724 \ so they can be managed together." 725 required: true 726 type: "string" 727 x-exportParamName: "ProjectKey" 728 - name: "featureFlagKey" 729 in: "path" 730 description: "The feature flag's key. The key identifies the flag in your\ 731 \ code." 732 required: true 733 type: "string" 734 x-exportParamName: "FeatureFlagKey" 735 responses: 736 "200": 737 description: "Status of the requested feature flag across environments" 738 schema: 739 $ref: "#/definitions/FeatureFlagStatusAcrossEnvironments" 740 "401": 741 description: "Invalid access token." 742 "403": 743 description: "This is a beta API, you must pass beta in the LD-API-Version\ 744 \ header to use it." 745 schema: 746 $ref: "#/definitions/UsageError" 747 /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}: 748 get: 749 tags: 750 - "Feature flags" 751 summary: "Get expiring user targets for feature flag" 752 operationId: "getExpiringUserTargets" 753 parameters: 754 - name: "projectKey" 755 in: "path" 756 description: "The project key, used to tie the flags together under one project\ 757 \ so they can be managed together." 758 required: true 759 type: "string" 760 x-exportParamName: "ProjectKey" 761 - name: "environmentKey" 762 in: "path" 763 description: "The environment key, used to tie together flag configuration\ 764 \ and users under one environment so they can be managed together." 765 required: true 766 type: "string" 767 x-exportParamName: "EnvironmentKey" 768 - name: "featureFlagKey" 769 in: "path" 770 description: "The feature flag's key. The key identifies the flag in your\ 771 \ code." 772 required: true 773 type: "string" 774 x-exportParamName: "FeatureFlagKey" 775 responses: 776 "200": 777 description: "User targets of the requested feature flag." 778 schema: 779 $ref: "#/definitions/UserTargetingExpirationForFlags" 780 "401": 781 description: "Invalid access token." 782 patch: 783 tags: 784 - "Feature flags" 785 summary: "Update, add, or delete expiring user targets on feature flag" 786 operationId: "patchExpiringUserTargets" 787 parameters: 788 - name: "projectKey" 789 in: "path" 790 description: "The project key, used to tie the flags together under one project\ 791 \ so they can be managed together." 792 required: true 793 type: "string" 794 x-exportParamName: "ProjectKey" 795 - name: "environmentKey" 796 in: "path" 797 description: "The environment key, used to tie together flag configuration\ 798 \ and users under one environment so they can be managed together." 799 required: true 800 type: "string" 801 x-exportParamName: "EnvironmentKey" 802 - name: "featureFlagKey" 803 in: "path" 804 description: "The feature flag's key. The key identifies the flag in your\ 805 \ code." 806 required: true 807 type: "string" 808 x-exportParamName: "FeatureFlagKey" 809 - in: "body" 810 name: "SemanticPatchWithComment" 811 description: "Requires a Semantic Patch representation of the desired changes\ 812 \ to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'.\ 813 \ The addition of comments is also supported." 814 required: true 815 schema: 816 type: "object" 817 x-exportParamName: "SemanticPatchWithComment" 818 responses: 819 "200": 820 description: "User targeting expirations on feature flag response." 821 schema: 822 $ref: "#/definitions/UserTargetingExpirationForFlags" 823 "400": 824 description: "Invalid request body." 825 "401": 826 description: "Invalid access token." 827 "404": 828 description: "Invalid resource specifier." 829 "409": 830 description: "Status conflict." 831 /flags/{projectKey}/{featureFlagKey}/dependent-flags: 832 get: 833 tags: 834 - "Feature flags" 835 summary: "Get dependent flags across all environments for the flag specified\ 836 \ in the path parameters" 837 parameters: 838 - name: "projectKey" 839 in: "path" 840 description: "The project key, used to tie the flags together under one project\ 841 \ so they can be managed together." 842 required: true 843 type: "string" 844 x-exportParamName: "ProjectKey" 845 - name: "featureFlagKey" 846 in: "path" 847 description: "The feature flag's key. The key identifies the flag in your\ 848 \ code." 849 required: true 850 type: "string" 851 x-exportParamName: "FeatureFlagKey" 852 responses: 853 "200": 854 description: "Dependent flags accross all environemnts in the project response" 855 schema: 856 $ref: "#/definitions/MultiEnvironmentDependentFlags" 857 "401": 858 description: "Invalid access token." 859 "403": 860 description: "This is a beta API, you must pass beta in the LD-API-Version\ 861 \ header to use it." 862 schema: 863 $ref: "#/definitions/UsageError" 864 "404": 865 description: "Invalid resource specifier." 866 /flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags: 867 get: 868 tags: 869 - "Feature flags" 870 summary: "Get dependent flags for the flag in the environment specified in path\ 871 \ parameters" 872 parameters: 873 - name: "projectKey" 874 in: "path" 875 description: "The project key, used to tie the flags together under one project\ 876 \ so they can be managed together." 877 required: true 878 type: "string" 879 x-exportParamName: "ProjectKey" 880 - name: "environmentKey" 881 in: "path" 882 description: "The environment key, used to tie together flag configuration\ 883 \ and users under one environment so they can be managed together." 884 required: true 885 type: "string" 886 x-exportParamName: "EnvironmentKey" 887 - name: "featureFlagKey" 888 in: "path" 889 description: "The feature flag's key. The key identifies the flag in your\ 890 \ code." 891 required: true 892 type: "string" 893 x-exportParamName: "FeatureFlagKey" 894 responses: 895 "200": 896 description: "Dependent flags in a single envrionemnt response" 897 schema: 898 $ref: "#/definitions/DependentFlagsByEnvironment" 899 "401": 900 description: "Invalid access token." 901 "403": 902 description: "This is a beta API, you must pass beta in the LD-API-Version\ 903 \ header to use it." 904 schema: 905 $ref: "#/definitions/UsageError" 906 "404": 907 description: "Invalid resource specifier." 908 /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes: 909 get: 910 tags: 911 - "Feature flags" 912 summary: "Get all scheduled workflows for a feature flag by key." 913 operationId: "getFlagConfigScheduledChanges" 914 parameters: 915 - name: "projectKey" 916 in: "path" 917 description: "The project key, used to tie the flags together under one project\ 918 \ so they can be managed together." 919 required: true 920 type: "string" 921 x-exportParamName: "ProjectKey" 922 - name: "featureFlagKey" 923 in: "path" 924 description: "The feature flag's key. The key identifies the flag in your\ 925 \ code." 926 required: true 927 type: "string" 928 x-exportParamName: "FeatureFlagKey" 929 - name: "environmentKey" 930 in: "path" 931 description: "The environment key, used to tie together flag configuration\ 932 \ and users under one environment so they can be managed together." 933 required: true 934 type: "string" 935 x-exportParamName: "EnvironmentKey" 936 responses: 937 "200": 938 description: "A list of scheduled changes for feature flag response." 939 schema: 940 $ref: "#/definitions/FeatureFlagScheduledChanges" 941 "401": 942 description: "Invalid access token." 943 "404": 944 description: "Invalid resource specifier." 945 post: 946 tags: 947 - "Feature flags" 948 summary: "Creates a new scheduled change for a feature flag." 949 operationId: "postFlagConfigScheduledChanges" 950 parameters: 951 - name: "projectKey" 952 in: "path" 953 description: "The project key, used to tie the flags together under one project\ 954 \ so they can be managed together." 955 required: true 956 type: "string" 957 x-exportParamName: "ProjectKey" 958 - in: "body" 959 name: "flagConfigScheduledChangesPostBody" 960 description: "Create scheduled changes on a feature flag." 961 required: true 962 schema: 963 $ref: "#/definitions/flagConfigScheduledChangesPostBody" 964 x-exportParamName: "FlagConfigScheduledChangesPostBody" 965 - name: "featureFlagKey" 966 in: "path" 967 description: "The feature flag's key. The key identifies the flag in your\ 968 \ code." 969 required: true 970 type: "string" 971 x-exportParamName: "FeatureFlagKey" 972 - name: "environmentKey" 973 in: "path" 974 description: "The environment key, used to tie together flag configuration\ 975 \ and users under one environment so they can be managed together." 976 required: true 977 type: "string" 978 x-exportParamName: "EnvironmentKey" 979 responses: 980 "201": 981 description: "A scheduled change for feature flag response." 982 schema: 983 $ref: "#/definitions/FeatureFlagScheduledChange" 984 "400": 985 description: "Invalid request body." 986 "401": 987 description: "Invalid access token." 988 "409": 989 description: "Status conflict." 990 /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes-conflicts: 991 post: 992 tags: 993 - "Feature flags" 994 summary: "Lists conflicts between the given instructions and any existing scheduled\ 995 \ changes for the feature flag. The actual HTTP verb should be REPORT, not\ 996 \ POST." 997 operationId: "getFlagConfigScheduledChangesConflicts" 998 parameters: 999 - name: "projectKey" 1000 in: "path" 1001 description: "The project key, used to tie the flags together under one project\ 1002 \ so they can be managed together." 1003 required: true 1004 type: "string" 1005 x-exportParamName: "ProjectKey" 1006 - name: "featureFlagKey" 1007 in: "path" 1008 description: "The feature flag's key. The key identifies the flag in your\ 1009 \ code." 1010 required: true 1011 type: "string" 1012 x-exportParamName: "FeatureFlagKey" 1013 - name: "environmentKey" 1014 in: "path" 1015 description: "The environment key, used to tie together flag configuration\ 1016 \ and users under one environment so they can be managed together." 1017 required: true 1018 type: "string" 1019 x-exportParamName: "EnvironmentKey" 1020 - in: "body" 1021 name: "flagConfigScheduledChangesConflictsBody" 1022 description: "Used to determine if a semantic patch will result in conflicts\ 1023 \ with scheduled changes on a feature flag." 1024 required: true 1025 schema: 1026 $ref: "#/definitions/flagConfigScheduledChangesConflictsBody" 1027 x-exportParamName: "FlagConfigScheduledChangesConflictsBody" 1028 responses: 1029 "200": 1030 description: "Scheduled changes conflict response" 1031 schema: 1032 $ref: "#/definitions/FeatureFlagScheduledChangesConflicts" 1033 "401": 1034 description: "Invalid access token." 1035 "404": 1036 description: "Invalid resource specifier." 1037 /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId}: 1038 get: 1039 tags: 1040 - "Feature flags" 1041 summary: "Get a scheduled change on a feature flag by id." 1042 operationId: "getFlagConfigScheduledChange" 1043 parameters: 1044 - name: "projectKey" 1045 in: "path" 1046 description: "The project key, used to tie the flags together under one project\ 1047 \ so they can be managed together." 1048 required: true 1049 type: "string" 1050 x-exportParamName: "ProjectKey" 1051 - name: "featureFlagKey" 1052 in: "path" 1053 description: "The feature flag's key. The key identifies the flag in your\ 1054 \ code." 1055 required: true 1056 type: "string" 1057 x-exportParamName: "FeatureFlagKey" 1058 - name: "environmentKey" 1059 in: "path" 1060 description: "The environment key, used to tie together flag configuration\ 1061 \ and users under one environment so they can be managed together." 1062 required: true 1063 type: "string" 1064 x-exportParamName: "EnvironmentKey" 1065 - name: "scheduledChangeId" 1066 in: "path" 1067 description: "The id of the scheduled change" 1068 required: true 1069 type: "string" 1070 x-exportParamName: "ScheduledChangeId" 1071 responses: 1072 "200": 1073 description: "A scheduled change for feature flag response." 1074 schema: 1075 $ref: "#/definitions/FeatureFlagScheduledChange" 1076 "401": 1077 description: "Invalid access token." 1078 "404": 1079 description: "Invalid resource specifier." 1080 delete: 1081 tags: 1082 - "Feature flags" 1083 summary: "Delete a scheduled change on a feature flag in an environment." 1084 operationId: "deleteFlagConfigScheduledChanges" 1085 parameters: 1086 - name: "projectKey" 1087 in: "path" 1088 description: "The project key, used to tie the flags together under one project\ 1089 \ so they can be managed together." 1090 required: true 1091 type: "string" 1092 x-exportParamName: "ProjectKey" 1093 - name: "featureFlagKey" 1094 in: "path" 1095 description: "The feature flag's key. The key identifies the flag in your\ 1096 \ code." 1097 required: true 1098 type: "string" 1099 x-exportParamName: "FeatureFlagKey" 1100 - name: "environmentKey" 1101 in: "path" 1102 description: "The environment key, used to tie together flag configuration\ 1103 \ and users under one environment so they can be managed together." 1104 required: true 1105 type: "string" 1106 x-exportParamName: "EnvironmentKey" 1107 - name: "scheduledChangeId" 1108 in: "path" 1109 description: "The id of the scheduled change" 1110 required: true 1111 type: "string" 1112 x-exportParamName: "ScheduledChangeId" 1113 responses: 1114 "204": 1115 description: "Action completed successfully." 1116 "401": 1117 description: "Invalid access token." 1118 "404": 1119 description: "Invalid resource specifier." 1120 patch: 1121 tags: 1122 - "Feature flags" 1123 summary: "Updates an existing scheduled-change on a feature flag in an environment." 1124 operationId: "patchFlagConfigScheduledChange" 1125 parameters: 1126 - name: "projectKey" 1127 in: "path" 1128 description: "The project key, used to tie the flags together under one project\ 1129 \ so they can be managed together." 1130 required: true 1131 type: "string" 1132 x-exportParamName: "ProjectKey" 1133 - name: "featureFlagKey" 1134 in: "path" 1135 description: "The feature flag's key. The key identifies the flag in your\ 1136 \ code." 1137 required: true 1138 type: "string" 1139 x-exportParamName: "FeatureFlagKey" 1140 - in: "body" 1141 name: "flagConfigScheduledChangesPatchBody" 1142 description: "Update scheduled changes on a feature flag." 1143 required: true 1144 schema: 1145 $ref: "#/definitions/flagConfigScheduledChangesPatchBody" 1146 x-exportParamName: "FlagConfigScheduledChangesPatchBody" 1147 - name: "environmentKey" 1148 in: "path" 1149 description: "The environment key, used to tie together flag configuration\ 1150 \ and users under one environment so they can be managed together." 1151 required: true 1152 type: "string" 1153 x-exportParamName: "EnvironmentKey" 1154 - name: "scheduledChangeId" 1155 in: "path" 1156 description: "The id of the scheduled change" 1157 required: true 1158 type: "string" 1159 x-exportParamName: "ScheduledChangeId" 1160 responses: 1161 "201": 1162 description: "A Scheduled change for feature flag response." 1163 schema: 1164 $ref: "#/definitions/FeatureFlagScheduledChange" 1165 "400": 1166 description: "Invalid request body." 1167 "401": 1168 description: "Invalid access token." 1169 "409": 1170 description: "Status conflict." 1171 /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests: 1172 get: 1173 tags: 1174 - "Feature flags" 1175 summary: "Get all approval requests for a feature flag config" 1176 operationId: "getApprovalRequests" 1177 parameters: 1178 - name: "projectKey" 1179 in: "path" 1180 description: "The project key, used to tie the flags together under one project\ 1181 \ so they can be managed together." 1182 required: true 1183 type: "string" 1184 x-exportParamName: "ProjectKey" 1185 - name: "featureFlagKey" 1186 in: "path" 1187 description: "The feature flag's key. The key identifies the flag in your\ 1188 \ code." 1189 required: true 1190 type: "string" 1191 x-exportParamName: "FeatureFlagKey" 1192 - name: "environmentKey" 1193 in: "path" 1194 description: "The environment key, used to tie together flag configuration\ 1195 \ and users under one environment so they can be managed together." 1196 required: true 1197 type: "string" 1198 x-exportParamName: "EnvironmentKey" 1199 responses: 1200 "200": 1201 description: "Approval requests response" 1202 schema: 1203 $ref: "#/definitions/ApprovalRequests" 1204 "401": 1205 description: "Invalid access token." 1206 "404": 1207 description: "Invalid resource specifier." 1208 /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}: 1209 get: 1210 tags: 1211 - "Feature flags" 1212 summary: "Get a single approval request for a feature flag config" 1213 operationId: "getApprovalRequest" 1214 parameters: 1215 - name: "projectKey" 1216 in: "path" 1217 description: "The project key, used to tie the flags together under one project\ 1218 \ so they can be managed together." 1219 required: true 1220 type: "string" 1221 x-exportParamName: "ProjectKey" 1222 - name: "featureFlagKey" 1223 in: "path" 1224 description: "The feature flag's key. The key identifies the flag in your\ 1225 \ code." 1226 required: true 1227 type: "string" 1228 x-exportParamName: "FeatureFlagKey" 1229 - name: "environmentKey" 1230 in: "path" 1231 description: "The environment key, used to tie together flag configuration\ 1232 \ and users under one environment so they can be managed together." 1233 required: true 1234 type: "string" 1235 x-exportParamName: "EnvironmentKey" 1236 - name: "approvalRequestId" 1237 in: "path" 1238 description: "The approval request ID" 1239 required: true 1240 type: "string" 1241 x-exportParamName: "ApprovalRequestId" 1242 responses: 1243 "200": 1244 description: "Approval request response" 1245 schema: 1246 $ref: "#/definitions/ApprovalRequests" 1247 "401": 1248 description: "Invalid access token." 1249 "404": 1250 description: "Invalid resource specifier." 1251 post: 1252 tags: 1253 - "Feature flags" 1254 summary: "Create an approval request for a feature flag config" 1255 operationId: "postApprovalRequest" 1256 parameters: 1257 - name: "projectKey" 1258 in: "path" 1259 description: "The project key, used to tie the flags together under one project\ 1260 \ so they can be managed together." 1261 required: true 1262 type: "string" 1263 x-exportParamName: "ProjectKey" 1264 - name: "featureFlagKey" 1265 in: "path" 1266 description: "The feature flag's key. The key identifies the flag in your\ 1267 \ code." 1268 required: true 1269 type: "string" 1270 x-exportParamName: "FeatureFlagKey" 1271 - name: "environmentKey" 1272 in: "path" 1273 description: "The environment key, used to tie together flag configuration\ 1274 \ and users under one environment so they can be managed together." 1275 required: true 1276 type: "string" 1277 x-exportParamName: "EnvironmentKey" 1278 - name: "approvalRequestId" 1279 in: "path" 1280 description: "The approval request ID" 1281 required: true 1282 type: "string" 1283 x-exportParamName: "ApprovalRequestId" 1284 - in: "body" 1285 name: "approvalRequestConfigBody" 1286 description: "Create a new approval request" 1287 required: false 1288 schema: 1289 $ref: "#/definitions/approvalRequestConfigBody" 1290 x-exportParamName: "ApprovalRequestConfigBody" 1291 responses: 1292 "200": 1293 description: "Approval request response" 1294 schema: 1295 $ref: "#/definitions/ApprovalRequest" 1296 "401": 1297 description: "Invalid access token." 1298 "404": 1299 description: "Invalid resource specifier." 1300 delete: 1301 tags: 1302 - "Feature flags" 1303 summary: "Delete an approval request for a feature flag config" 1304 operationId: "deleteApprovalRequest" 1305 parameters: 1306 - name: "projectKey" 1307 in: "path" 1308 description: "The project key, used to tie the flags together under one project\ 1309 \ so they can be managed together." 1310 required: true 1311 type: "string" 1312 x-exportParamName: "ProjectKey" 1313 - name: "environmentKey" 1314 in: "path" 1315 description: "The environment key, used to tie together flag configuration\ 1316 \ and users under one environment so they can be managed together." 1317 required: true 1318 type: "string" 1319 x-exportParamName: "EnvironmentKey" 1320 - name: "featureFlagKey" 1321 in: "path" 1322 description: "The feature flag's key. The key identifies the flag in your\ 1323 \ code." 1324 required: true 1325 type: "string" 1326 x-exportParamName: "FeatureFlagKey" 1327 - name: "approvalRequestId" 1328 in: "path" 1329 description: "The approval request ID" 1330 required: true 1331 type: "string" 1332 x-exportParamName: "ApprovalRequestId" 1333 - in: "body" 1334 name: "approvalRequestConfigBody" 1335 description: "Create a new approval request" 1336 required: false 1337 schema: 1338 $ref: "#/definitions/approvalRequestConfigBody" 1339 x-exportParamName: "ApprovalRequestConfigBody" 1340 responses: 1341 "204": 1342 description: "Action completed successfully." 1343 "401": 1344 description: "Invalid access token." 1345 "404": 1346 description: "Invalid resource specifier." 1347 /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/apply: 1348 post: 1349 tags: 1350 - "Feature flags" 1351 summary: "Apply approval request for a feature flag config" 1352 operationId: "postApplyApprovalRequest" 1353 parameters: 1354 - name: "projectKey" 1355 in: "path" 1356 description: "The project key, used to tie the flags together under one project\ 1357 \ so they can be managed together." 1358 required: true 1359 type: "string" 1360 x-exportParamName: "ProjectKey" 1361 - name: "featureFlagKey" 1362 in: "path" 1363 description: "The feature flag's key. The key identifies the flag in your\ 1364 \ code." 1365 required: true 1366 type: "string" 1367 x-exportParamName: "FeatureFlagKey" 1368 - name: "environmentKey" 1369 in: "path" 1370 description: "The environment key, used to tie together flag configuration\ 1371 \ and users under one environment so they can be managed together." 1372 required: true 1373 type: "string" 1374 x-exportParamName: "EnvironmentKey" 1375 - name: "approvalRequestId" 1376 in: "path" 1377 description: "The approval request ID" 1378 required: true 1379 type: "string" 1380 x-exportParamName: "ApprovalRequestId" 1381 - in: "body" 1382 name: "approvalRequestApplyConfigBody" 1383 description: "Apply an approval request" 1384 required: true 1385 schema: 1386 $ref: "#/definitions/approvalRequestApplyConfigBody" 1387 x-exportParamName: "ApprovalRequestApplyConfigBody" 1388 responses: 1389 "200": 1390 description: "Approval request applied response" 1391 schema: 1392 $ref: "#/definitions/ApprovalRequests" 1393 "401": 1394 description: "Invalid access token." 1395 "404": 1396 description: "Invalid resource specifier." 1397 /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review: 1398 post: 1399 tags: 1400 - "Feature flags" 1401 summary: "Review approval request for a feature flag config" 1402 operationId: "postReviewApprovalRequest" 1403 parameters: 1404 - name: "projectKey" 1405 in: "path" 1406 description: "The project key, used to tie the flags together under one project\ 1407 \ so they can be managed together." 1408 required: true 1409 type: "string" 1410 x-exportParamName: "ProjectKey" 1411 - name: "featureFlagKey" 1412 in: "path" 1413 description: "The feature flag's key. The key identifies the flag in your\ 1414 \ code." 1415 required: true 1416 type: "string" 1417 x-exportParamName: "FeatureFlagKey" 1418 - name: "environmentKey" 1419 in: "path" 1420 description: "The environment key, used to tie together flag configuration\ 1421 \ and users under one environment so they can be managed together." 1422 required: true 1423 type: "string" 1424 x-exportParamName: "EnvironmentKey" 1425 - name: "approvalRequestId" 1426 in: "path" 1427 description: "The approval request ID" 1428 required: true 1429 type: "string" 1430 x-exportParamName: "ApprovalRequestId" 1431 - in: "body" 1432 name: "approvalRequestReviewConfigBody" 1433 description: "Review an approval request" 1434 required: true 1435 schema: 1436 $ref: "#/definitions/approvalRequestReviewConfigBody" 1437 x-exportParamName: "ApprovalRequestReviewConfigBody" 1438 responses: 1439 "200": 1440 description: "Approval request reviewed response" 1441 schema: 1442 $ref: "#/definitions/ApprovalRequests" 1443 "401": 1444 description: "Invalid access token." 1445 "404": 1446 description: "Invalid resource specifier." 1447 /segments/{projectKey}/{environmentKey}: 1448 get: 1449 tags: 1450 - "User segments" 1451 summary: "Get a list of all user segments in the given project." 1452 operationId: "getUserSegments" 1453 parameters: 1454 - name: "projectKey" 1455 in: "path" 1456 description: "The project key, used to tie the flags together under one project\ 1457 \ so they can be managed together." 1458 required: true 1459 type: "string" 1460 x-exportParamName: "ProjectKey" 1461 - name: "environmentKey" 1462 in: "path" 1463 description: "The environment key, used to tie together flag configuration\ 1464 \ and users under one environment so they can be managed together." 1465 required: true 1466 type: "string" 1467 x-exportParamName: "EnvironmentKey" 1468 - name: "tag" 1469 in: "query" 1470 description: "Filter by tag. A tag can be used to group flags across projects." 1471 required: false 1472 type: "string" 1473 x-exportParamName: "Tag" 1474 x-optionalDataType: "String" 1475 responses: 1476 "200": 1477 description: "Segments response." 1478 schema: 1479 $ref: "#/definitions/UserSegments" 1480 "401": 1481 description: "Invalid access token." 1482 post: 1483 tags: 1484 - "User segments" 1485 summary: "Creates a new user segment." 1486 operationId: "postUserSegment" 1487 parameters: 1488 - name: "projectKey" 1489 in: "path" 1490 description: "The project key, used to tie the flags together under one project\ 1491 \ so they can be managed together." 1492 required: true 1493 type: "string" 1494 x-exportParamName: "ProjectKey" 1495 - name: "environmentKey" 1496 in: "path" 1497 description: "The environment key, used to tie together flag configuration\ 1498 \ and users under one environment so they can be managed together." 1499 required: true 1500 type: "string" 1501 x-exportParamName: "EnvironmentKey" 1502 - in: "body" 1503 name: "userSegmentBody" 1504 description: "Create a new user segment." 1505 required: true 1506 schema: 1507 $ref: "#/definitions/userSegmentBody" 1508 x-exportParamName: "UserSegmentBody" 1509 responses: 1510 "201": 1511 description: "User segment response." 1512 schema: 1513 $ref: "#/definitions/UserSegment" 1514 "400": 1515 description: "Invalid request body." 1516 "401": 1517 description: "Invalid access token." 1518 "409": 1519 description: "Status conflict." 1520 /segments/{projectKey}/{environmentKey}/{userSegmentKey}: 1521 get: 1522 tags: 1523 - "User segments" 1524 summary: "Get a single user segment by key." 1525 operationId: "getUserSegment" 1526 parameters: 1527 - name: "projectKey" 1528 in: "path" 1529 description: "The project key, used to tie the flags together under one project\ 1530 \ so they can be managed together." 1531 required: true 1532 type: "string" 1533 x-exportParamName: "ProjectKey" 1534 - name: "environmentKey" 1535 in: "path" 1536 description: "The environment key, used to tie together flag configuration\ 1537 \ and users under one environment so they can be managed together." 1538 required: true 1539 type: "string" 1540 x-exportParamName: "EnvironmentKey" 1541 - name: "userSegmentKey" 1542 in: "path" 1543 description: "The user segment's key. The key identifies the user segment\ 1544 \ in your code." 1545 required: true 1546 type: "string" 1547 x-exportParamName: "UserSegmentKey" 1548 responses: 1549 "200": 1550 description: "User segment response." 1551 schema: 1552 $ref: "#/definitions/UserSegment" 1553 "401": 1554 description: "Invalid access token." 1555 "404": 1556 description: "Invalid resource specifier." 1557 delete: 1558 tags: 1559 - "User segments" 1560 summary: "Delete a user segment." 1561 operationId: "deleteUserSegment" 1562 parameters: 1563 - name: "projectKey" 1564 in: "path" 1565 description: "The project key, used to tie the flags together under one project\ 1566 \ so they can be managed together." 1567 required: true 1568 type: "string" 1569 x-exportParamName: "ProjectKey" 1570 - name: "environmentKey" 1571 in: "path" 1572 description: "The environment key, used to tie together flag configuration\ 1573 \ and users under one environment so they can be managed together." 1574 required: true 1575 type: "string" 1576 x-exportParamName: "EnvironmentKey" 1577 - name: "userSegmentKey" 1578 in: "path" 1579 description: "The user segment's key. The key identifies the user segment\ 1580 \ in your code." 1581 required: true 1582 type: "string" 1583 x-exportParamName: "UserSegmentKey" 1584 responses: 1585 "204": 1586 description: "Action completed successfully." 1587 "401": 1588 description: "Invalid access token." 1589 "404": 1590 description: "Invalid resource specifier." 1591 patch: 1592 tags: 1593 - "User segments" 1594 summary: "Perform a partial update to a user segment." 1595 operationId: "patchUserSegment" 1596 parameters: 1597 - name: "projectKey" 1598 in: "path" 1599 description: "The project key, used to tie the flags together under one project\ 1600 \ so they can be managed together." 1601 required: true 1602 type: "string" 1603 x-exportParamName: "ProjectKey" 1604 - name: "environmentKey" 1605 in: "path" 1606 description: "The environment key, used to tie together flag configuration\ 1607 \ and users under one environment so they can be managed together." 1608 required: true 1609 type: "string" 1610 x-exportParamName: "EnvironmentKey" 1611 - name: "userSegmentKey" 1612 in: "path" 1613 description: "The user segment's key. The key identifies the user segment\ 1614 \ in your code." 1615 required: true 1616 type: "string" 1617 x-exportParamName: "UserSegmentKey" 1618 - in: "body" 1619 name: "PatchOnly" 1620 description: "Requires a JSON Patch representation of the desired changes\ 1621 \ to the project. 'http://jsonpatch.com/' Feature flag patches also support\ 1622 \ JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition\ 1623 \ of comments is also supported." 1624 required: true 1625 schema: 1626 type: "array" 1627 items: 1628 $ref: "#/definitions/PatchOperation" 1629 x-exportParamName: "PatchOnly" 1630 responses: 1631 "200": 1632 description: "User segment response." 1633 schema: 1634 $ref: "#/definitions/UserSegment" 1635 "400": 1636 description: "Invalid request body." 1637 "401": 1638 description: "Invalid access token." 1639 "404": 1640 description: "Invalid resource specifier." 1641 "409": 1642 description: "Status conflict." 1643 /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey}: 1644 get: 1645 tags: 1646 - "User segments" 1647 summary: "Get expiring user targets for user segment" 1648 operationId: "getExpiringUserTargetsOnSegment" 1649 parameters: 1650 - name: "projectKey" 1651 in: "path" 1652 description: "The project key, used to tie the flags together under one project\ 1653 \ so they can be managed together." 1654 required: true 1655 type: "string" 1656 x-exportParamName: "ProjectKey" 1657 - name: "environmentKey" 1658 in: "path" 1659 description: "The environment key, used to tie together flag configuration\ 1660 \ and users under one environment so they can be managed together." 1661 required: true 1662 type: "string" 1663 x-exportParamName: "EnvironmentKey" 1664 - name: "userSegmentKey" 1665 in: "path" 1666 description: "The user segment's key. The key identifies the user segment\ 1667 \ in your code." 1668 required: true 1669 type: "string" 1670 x-exportParamName: "UserSegmentKey" 1671 responses: 1672 "200": 1673 description: "User targeting expirations on user segment response." 1674 schema: 1675 $ref: "#/definitions/UserTargetingExpirationForSegment" 1676 "401": 1677 description: "Invalid access token." 1678 "404": 1679 description: "Invalid resource specifier." 1680 patch: 1681 tags: 1682 - "User segments" 1683 summary: "Update, add, or delete expiring user targets on user segment" 1684 operationId: "patchExpiringUserTargetsOnSegment" 1685 parameters: 1686 - name: "projectKey" 1687 in: "path" 1688 description: "The project key, used to tie the flags together under one project\ 1689 \ so they can be managed together." 1690 required: true 1691 type: "string" 1692 x-exportParamName: "ProjectKey" 1693 - name: "environmentKey" 1694 in: "path" 1695 description: "The environment key, used to tie together flag configuration\ 1696 \ and users under one environment so they can be managed together." 1697 required: true 1698 type: "string" 1699 x-exportParamName: "EnvironmentKey" 1700 - name: "userSegmentKey" 1701 in: "path" 1702 description: "The user segment's key. The key identifies the user segment\ 1703 \ in your code." 1704 required: true 1705 type: "string" 1706 x-exportParamName: "UserSegmentKey" 1707 - in: "body" 1708 name: "SemanticPatchWithComment" 1709 description: "Requires a Semantic Patch representation of the desired changes\ 1710 \ to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'.\ 1711 \ The addition of comments is also supported." 1712 required: true 1713 schema: 1714 type: "object" 1715 x-exportParamName: "SemanticPatchWithComment" 1716 responses: 1717 "200": 1718 description: "User targeting expirations on user segment response." 1719 schema: 1720 $ref: "#/definitions/UserTargetingExpirationForSegment" 1721 "400": 1722 description: "Invalid request body." 1723 "401": 1724 description: "Invalid access token." 1725 "404": 1726 description: "Invalid resource specifier." 1727 "409": 1728 description: "Status conflict." 1729 /segments/{projectKey}/{environmentKey}/{userSegmentKey}/users: 1730 post: 1731 tags: 1732 - "User segments" 1733 summary: "Update targets included or excluded in a big segment" 1734 operationId: "updateBigSegmentTargets" 1735 parameters: 1736 - name: "projectKey" 1737 in: "path" 1738 description: "The project key, used to tie the flags together under one project\ 1739 \ so they can be managed together." 1740 required: true 1741 type: "string" 1742 x-exportParamName: "ProjectKey" 1743 - name: "environmentKey" 1744 in: "path" 1745 description: "The environment key, used to tie together flag configuration\ 1746 \ and users under one environment so they can be managed together." 1747 required: true 1748 type: "string" 1749 x-exportParamName: "EnvironmentKey" 1750 - name: "userSegmentKey" 1751 in: "path" 1752 description: "The user segment's key. The key identifies the user segment\ 1753 \ in your code." 1754 required: true 1755 type: "string" 1756 x-exportParamName: "UserSegmentKey" 1757 - in: "body" 1758 name: "bigSegmentTargetsBody" 1759 description: "Add or remove user targets to the included or excluded lists\ 1760 \ on a big segment. Contact your account manager for early access to this\ 1761 \ feature." 1762 required: true 1763 schema: 1764 $ref: "#/definitions/bigSegmentTargetsBody" 1765 x-exportParamName: "BigSegmentTargetsBody" 1766 responses: 1767 "204": 1768 description: "Action completed successfully." 1769 "400": 1770 description: "Invalid request body." 1771 "401": 1772 description: "Invalid access token." 1773 /users/{projectKey}/{environmentKey}: 1774 get: 1775 tags: 1776 - "Users" 1777 summary: "List all users in the environment. Includes the total count of users.\ 1778 \ In each page, there will be up to 'limit' users returned (default 20). This\ 1779 \ is useful for exporting all users in the system for further analysis. Paginated\ 1780 \ collections will include a next link containing a URL with the next set\ 1781 \ of elements in the collection." 1782 operationId: "getUsers" 1783 parameters: 1784 - name: "projectKey" 1785 in: "path" 1786 description: "The project key, used to tie the flags together under one project\ 1787 \ so they can be managed together." 1788 required: true 1789 type: "string" 1790 x-exportParamName: "ProjectKey" 1791 - name: "environmentKey" 1792 in: "path" 1793 description: "The environment key, used to tie together flag configuration\ 1794 \ and users under one environment so they can be managed together." 1795 required: true 1796 type: "string" 1797 x-exportParamName: "EnvironmentKey" 1798 - name: "limit" 1799 in: "query" 1800 description: "Pagination limit." 1801 required: false 1802 type: "integer" 1803 x-exportParamName: "Limit" 1804 x-optionalDataType: "Int32" 1805 - name: "h" 1806 in: "query" 1807 description: "This parameter is required when following \"next\" links." 1808 required: false 1809 type: "string" 1810 x-exportParamName: "H" 1811 x-optionalDataType: "String" 1812 - name: "scrollId" 1813 in: "query" 1814 description: "This parameter is required when following \"next\" links." 1815 required: false 1816 type: "string" 1817 x-exportParamName: "ScrollId" 1818 x-optionalDataType: "String" 1819 responses: 1820 "200": 1821 description: "Users response." 1822 schema: 1823 $ref: "#/definitions/Users" 1824 "401": 1825 description: "Invalid access token." 1826 /user-search/{projectKey}/{environmentKey}: 1827 get: 1828 tags: 1829 - "Users" 1830 summary: "Search users in LaunchDarkly based on their last active date, or a\ 1831 \ search query. It should not be used to enumerate all users in LaunchDarkly--\ 1832 \ use the List users API resource." 1833 operationId: "getSearchUsers" 1834 parameters: 1835 - name: "projectKey" 1836 in: "path" 1837 description: "The project key, used to tie the flags together under one project\ 1838 \ so they can be managed together." 1839 required: true 1840 type: "string" 1841 x-exportParamName: "ProjectKey" 1842 - name: "environmentKey" 1843 in: "path" 1844 description: "The environment key, used to tie together flag configuration\ 1845 \ and users under one environment so they can be managed together." 1846 required: true 1847 type: "string" 1848 x-exportParamName: "EnvironmentKey" 1849 - name: "q" 1850 in: "query" 1851 description: "Search query." 1852 required: false 1853 type: "string" 1854 x-exportParamName: "Q" 1855 x-optionalDataType: "String" 1856 - name: "limit" 1857 in: "query" 1858 description: "Pagination limit." 1859 required: false 1860 type: "integer" 1861 x-exportParamName: "Limit" 1862 x-optionalDataType: "Int32" 1863 - name: "offset" 1864 in: "query" 1865 description: "Specifies the first item to return in the collection." 1866 required: false 1867 type: "integer" 1868 x-exportParamName: "Offset" 1869 x-optionalDataType: "Int32" 1870 - name: "after" 1871 in: "query" 1872 description: "A timestamp filter, expressed as a Unix epoch time in milliseconds.\ 1873 \ All entries returned will have occurred after this timestamp." 1874 required: false 1875 type: "integer" 1876 format: "int64" 1877 x-exportParamName: "After" 1878 x-optionalDataType: "Int64" 1879 responses: 1880 "200": 1881 description: "Users response." 1882 schema: 1883 $ref: "#/definitions/Users" 1884 "401": 1885 description: "Invalid access token." 1886 /users/{projectKey}/{environmentKey}/{userKey}: 1887 get: 1888 tags: 1889 - "Users" 1890 summary: "Get a user by key." 1891 operationId: "getUser" 1892 parameters: 1893 - name: "projectKey" 1894 in: "path" 1895 description: "The project key, used to tie the flags together under one project\ 1896 \ so they can be managed together." 1897 required: true 1898 type: "string" 1899 x-exportParamName: "ProjectKey" 1900 - name: "environmentKey" 1901 in: "path" 1902 description: "The environment key, used to tie together flag configuration\ 1903 \ and users under one environment so they can be managed together." 1904 required: true 1905 type: "string" 1906 x-exportParamName: "EnvironmentKey" 1907 - name: "userKey" 1908 in: "path" 1909 description: "The user's key." 1910 required: true 1911 type: "string" 1912 x-exportParamName: "UserKey" 1913 responses: 1914 "200": 1915 description: "User response." 1916 schema: 1917 $ref: "#/definitions/UserRecord" 1918 "401": 1919 description: "Invalid access token." 1920 "404": 1921 description: "Invalid resource specifier." 1922 delete: 1923 tags: 1924 - "Users" 1925 summary: "Delete a user by ID." 1926 operationId: "deleteUser" 1927 parameters: 1928 - name: "projectKey" 1929 in: "path" 1930 description: "The project key, used to tie the flags together under one project\ 1931 \ so they can be managed together." 1932 required: true 1933 type: "string" 1934 x-exportParamName: "ProjectKey" 1935 - name: "environmentKey" 1936 in: "path" 1937 description: "The environment key, used to tie together flag configuration\ 1938 \ and users under one environment so they can be managed together." 1939 required: true 1940 type: "string" 1941 x-exportParamName: "EnvironmentKey" 1942 - name: "userKey" 1943 in: "path" 1944 description: "The user's key." 1945 required: true 1946 type: "string" 1947 x-exportParamName: "UserKey" 1948 responses: 1949 "204": 1950 description: "Action completed successfully." 1951 "401": 1952 description: "Invalid access token." 1953 "404": 1954 description: "Invalid resource specifier." 1955 /users/{projectKey}/{environmentKey}/{userKey}/flags: 1956 get: 1957 tags: 1958 - "User settings" 1959 summary: "Fetch a single flag setting for a user by key." 1960 operationId: "getUserFlagSettings" 1961 parameters: 1962 - name: "projectKey" 1963 in: "path" 1964 description: "The project key, used to tie the flags together under one project\ 1965 \ so they can be managed together." 1966 required: true 1967 type: "string" 1968 x-exportParamName: "ProjectKey" 1969 - name: "environmentKey" 1970 in: "path" 1971 description: "The environment key, used to tie together flag configuration\ 1972 \ and users under one environment so they can be managed together." 1973 required: true 1974 type: "string" 1975 x-exportParamName: "EnvironmentKey" 1976 - name: "userKey" 1977 in: "path" 1978 description: "The user's key." 1979 required: true 1980 type: "string" 1981 x-exportParamName: "UserKey" 1982 responses: 1983 "200": 1984 description: "User flags settings response." 1985 schema: 1986 $ref: "#/definitions/UserFlagSettings" 1987 "401": 1988 description: "Invalid access token." 1989 "404": 1990 description: "Invalid resource specifier." 1991 /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}: 1992 get: 1993 tags: 1994 - "User settings" 1995 summary: "Fetch a single flag setting for a user by key." 1996 operationId: "getUserFlagSetting" 1997 parameters: 1998 - name: "projectKey" 1999 in: "path" 2000 description: "The project key, used to tie the flags together under one project\ 2001 \ so they can be managed together." 2002 required: true 2003 type: "string" 2004 x-exportParamName: "ProjectKey" 2005 - name: "environmentKey" 2006 in: "path" 2007 description: "The environment key, used to tie together flag configuration\ 2008 \ and users under one environment so they can be managed together." 2009 required: true 2010 type: "string" 2011 x-exportParamName: "EnvironmentKey" 2012 - name: "userKey" 2013 in: "path" 2014 description: "The user's key." 2015 required: true 2016 type: "string" 2017 x-exportParamName: "UserKey" 2018 - name: "featureFlagKey" 2019 in: "path" 2020 description: "The feature flag's key. The key identifies the flag in your\ 2021 \ code." 2022 required: true 2023 type: "string" 2024 x-exportParamName: "FeatureFlagKey" 2025 responses: 2026 "200": 2027 description: "User flag setting response." 2028 schema: 2029 $ref: "#/definitions/UserFlagSetting" 2030 "401": 2031 description: "Invalid access token." 2032 "404": 2033 description: "Invalid resource specifier." 2034 put: 2035 tags: 2036 - "User settings" 2037 summary: "Specifically enable or disable a feature flag for a user based on\ 2038 \ their key." 2039 operationId: "putFlagSetting" 2040 parameters: 2041 - name: "projectKey" 2042 in: "path" 2043 description: "The project key, used to tie the flags together under one project\ 2044 \ so they can be managed together." 2045 required: true 2046 type: "string" 2047 x-exportParamName: "ProjectKey" 2048 - name: "environmentKey" 2049 in: "path" 2050 description: "The environment key, used to tie together flag configuration\ 2051 \ and users under one environment so they can be managed together." 2052 required: true 2053 type: "string" 2054 x-exportParamName: "EnvironmentKey" 2055 - name: "userKey" 2056 in: "path" 2057 description: "The user's key." 2058 required: true 2059 type: "string" 2060 x-exportParamName: "UserKey" 2061 - name: "featureFlagKey" 2062 in: "path" 2063 description: "The feature flag's key. The key identifies the flag in your\ 2064 \ code." 2065 required: true 2066 type: "string" 2067 x-exportParamName: "FeatureFlagKey" 2068 - in: "body" 2069 name: "userSettingsBody" 2070 required: true 2071 schema: 2072 $ref: "#/definitions/userSettingsBody" 2073 x-exportParamName: "UserSettingsBody" 2074 responses: 2075 "204": 2076 description: "Action completed successfully." 2077 "400": 2078 description: "Invalid request body." 2079 "401": 2080 description: "Invalid access token." 2081 "404": 2082 description: "Invalid resource specifier." 2083 /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}: 2084 get: 2085 tags: 2086 - "User settings" 2087 summary: "Get expiring dates on flags for user" 2088 operationId: "getExpiringUserTargetsForUser" 2089 parameters: 2090 - name: "projectKey" 2091 in: "path" 2092 description: "The project key, used to tie the flags together under one project\ 2093 \ so they can be managed together." 2094 required: true 2095 type: "string" 2096 x-exportParamName: "ProjectKey" 2097 - name: "environmentKey" 2098 in: "path" 2099 description: "The environment key, used to tie together flag configuration\ 2100 \ and users under one environment so they can be managed together." 2101 required: true 2102 type: "string" 2103 x-exportParamName: "EnvironmentKey" 2104 - name: "userKey" 2105 in: "path" 2106 description: "The user's key." 2107 required: true 2108 type: "string" 2109 x-exportParamName: "UserKey" 2110 responses: 2111 "200": 2112 description: "User targets of the requested feature flag." 2113 schema: 2114 $ref: "#/definitions/UserTargetingExpirationOnFlagsForUser" 2115 "401": 2116 description: "Invalid access token." 2117 patch: 2118 tags: 2119 - "User settings" 2120 summary: "Update, add, or delete expiring user targets for a single user on\ 2121 \ all flags" 2122 operationId: "patchExpiringUserTargetsForFlags" 2123 parameters: 2124 - name: "projectKey" 2125 in: "path" 2126 description: "The project key, used to tie the flags together under one project\ 2127 \ so they can be managed together." 2128 required: true 2129 type: "string" 2130 x-exportParamName: "ProjectKey" 2131 - name: "environmentKey" 2132 in: "path" 2133 description: "The environment key, used to tie together flag configuration\ 2134 \ and users under one environment so they can be managed together." 2135 required: true 2136 type: "string" 2137 x-exportParamName: "EnvironmentKey" 2138 - name: "userKey" 2139 in: "path" 2140 description: "The user's key." 2141 required: true 2142 type: "string" 2143 x-exportParamName: "UserKey" 2144 - in: "body" 2145 name: "SemanticPatchWithComment" 2146 description: "Requires a Semantic Patch representation of the desired changes\ 2147 \ to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'.\ 2148 \ The addition of comments is also supported." 2149 required: true 2150 schema: 2151 type: "object" 2152 x-exportParamName: "SemanticPatchWithComment" 2153 responses: 2154 "200": 2155 description: "User Targeting expiration for single user on all flags response." 2156 schema: 2157 $ref: "#/definitions/UserTargetingExpirationOnFlagsForUser" 2158 "400": 2159 description: "Invalid request body." 2160 "401": 2161 description: "Invalid access token." 2162 "404": 2163 description: "Invalid resource specifier." 2164 "409": 2165 description: "Status conflict." 2166 /auditlog: 2167 get: 2168 tags: 2169 - "Audit log" 2170 summary: "Get a list of all audit log entries. The query parameters allow you\ 2171 \ to restrict the returned results by date ranges, resource specifiers, or\ 2172 \ a full-text search query." 2173 operationId: "getAuditLogEntries" 2174 parameters: 2175 - name: "before" 2176 in: "query" 2177 description: "A timestamp filter, expressed as a Unix epoch time in milliseconds.\ 2178 \ All entries returned will have before this timestamp." 2179 required: false 2180 type: "integer" 2181 format: "int64" 2182 x-exportParamName: "Before" 2183 x-optionalDataType: "Int64" 2184 - name: "after" 2185 in: "query" 2186 description: "A timestamp filter, expressed as a Unix epoch time in milliseconds.\ 2187 \ All entries returned will have occurred after this timestamp." 2188 required: false 2189 type: "integer" 2190 format: "int64" 2191 x-exportParamName: "After" 2192 x-optionalDataType: "Int64" 2193 - name: "q" 2194 in: "query" 2195 description: "Text to search for. You can search for the full or partial name\ 2196 \ of the resource involved or full or partial email address of the member\ 2197 \ who made the change." 2198 required: false 2199 type: "string" 2200 x-exportParamName: "Q" 2201 x-optionalDataType: "String" 2202 - name: "limit" 2203 in: "query" 2204 description: "A limit on the number of audit log entries to be returned, between\ 2205 \ 1 and 20." 2206 required: false 2207 type: "number" 2208 x-exportParamName: "Limit" 2209 x-optionalDataType: "Float32" 2210 - name: "spec" 2211 in: "query" 2212 description: "A resource specifier, allowing you to filter audit log listings\ 2213 \ by resource." 2214 required: false 2215 type: "string" 2216 x-exportParamName: "Spec" 2217 x-optionalDataType: "String" 2218 responses: 2219 "200": 2220 description: "Audit log entries response." 2221 schema: 2222 $ref: "#/definitions/AuditLogEntries" 2223 "400": 2224 description: "Invalid request body." 2225 "401": 2226 description: "Invalid access token." 2227 /auditlog/{resourceId}: 2228 get: 2229 tags: 2230 - "Audit log" 2231 summary: "Use this endpoint to fetch a single audit log entry by its resouce\ 2232 \ ID." 2233 operationId: "getAuditLogEntry" 2234 parameters: 2235 - name: "resourceId" 2236 in: "path" 2237 description: "The resource ID." 2238 required: true 2239 type: "string" 2240 x-exportParamName: "ResourceId" 2241 responses: 2242 "200": 2243 description: "Audit log entry response." 2244 schema: 2245 $ref: "#/definitions/AuditLogEntry" 2246 "401": 2247 description: "Invalid access token." 2248 "404": 2249 description: "Invalid resource specifier." 2250 /webhooks: 2251 get: 2252 tags: 2253 - "Webhooks" 2254 summary: "Fetch a list of all webhooks." 2255 operationId: "getWebhooks" 2256 parameters: [] 2257 responses: 2258 "200": 2259 description: "Webhooks response." 2260 schema: 2261 $ref: "#/definitions/Webhooks" 2262 "401": 2263 description: "Invalid access token." 2264 post: 2265 tags: 2266 - "Webhooks" 2267 summary: "Create a webhook." 2268 operationId: "postWebhook" 2269 parameters: 2270 - in: "body" 2271 name: "webhookBody" 2272 description: "New webhook." 2273 required: true 2274 schema: 2275 $ref: "#/definitions/webhookBody" 2276 x-exportParamName: "WebhookBody" 2277 responses: 2278 "201": 2279 description: "Webhook response." 2280 schema: 2281 $ref: "#/definitions/Webhook" 2282 "400": 2283 description: "Invalid request body." 2284 "401": 2285 description: "Invalid access token." 2286 /webhooks/{resourceId}: 2287 get: 2288 tags: 2289 - "Webhooks" 2290 summary: "Get a webhook by ID." 2291 operationId: "getWebhook" 2292 parameters: 2293 - name: "resourceId" 2294 in: "path" 2295 description: "The resource ID." 2296 required: true 2297 type: "string" 2298 x-exportParamName: "ResourceId" 2299 responses: 2300 "200": 2301 description: "Webhook response." 2302 schema: 2303 $ref: "#/definitions/Webhook" 2304 "401": 2305 description: "Invalid access token." 2306 "404": 2307 description: "Invalid resource specifier." 2308 delete: 2309 tags: 2310 - "Webhooks" 2311 summary: "Delete a webhook by ID." 2312 operationId: "deleteWebhook" 2313 parameters: 2314 - name: "resourceId" 2315 in: "path" 2316 description: "The resource ID." 2317 required: true 2318 type: "string" 2319 x-exportParamName: "ResourceId" 2320 responses: 2321 "204": 2322 description: "Action completed successfully." 2323 "401": 2324 description: "Invalid access token." 2325 "404": 2326 description: "Invalid resource specifier." 2327 patch: 2328 tags: 2329 - "Webhooks" 2330 summary: "Modify a webhook by ID." 2331 operationId: "patchWebhook" 2332 parameters: 2333 - name: "resourceId" 2334 in: "path" 2335 description: "The resource ID." 2336 required: true 2337 type: "string" 2338 x-exportParamName: "ResourceId" 2339 - in: "body" 2340 name: "patchDelta" 2341 description: "Requires a JSON Patch representation of the desired changes\ 2342 \ to the project. 'http://jsonpatch.com/'" 2343 required: true 2344 schema: 2345 type: "array" 2346 items: 2347 $ref: "#/definitions/PatchOperation" 2348 x-exportParamName: "PatchDelta" 2349 responses: 2350 "200": 2351 description: "Webhook response." 2352 schema: 2353 $ref: "#/definitions/Webhook" 2354 "400": 2355 description: "Invalid request body." 2356 "401": 2357 description: "Invalid access token." 2358 "404": 2359 description: "Invalid resource specifier." 2360 "409": 2361 description: "Status conflict." 2362 /roles: 2363 get: 2364 tags: 2365 - "Custom roles" 2366 summary: "Return a complete list of custom roles." 2367 operationId: "getCustomRoles" 2368 parameters: [] 2369 responses: 2370 "200": 2371 description: "Custom roles response." 2372 schema: 2373 $ref: "#/definitions/CustomRoles" 2374 "401": 2375 description: "Invalid access token." 2376 post: 2377 tags: 2378 - "Custom roles" 2379 summary: "Create a new custom role." 2380 operationId: "postCustomRole" 2381 parameters: 2382 - in: "body" 2383 name: "customRoleBody" 2384 description: "New role or roles to create." 2385 required: true 2386 schema: 2387 $ref: "#/definitions/customRoleBody" 2388 x-exportParamName: "CustomRoleBody" 2389 responses: 2390 "201": 2391 description: "Custom role response." 2392 schema: 2393 $ref: "#/definitions/CustomRole" 2394 "400": 2395 description: "Invalid request body." 2396 "401": 2397 description: "Invalid access token." 2398 "409": 2399 description: "Status conflict." 2400 /roles/{customRoleKey}: 2401 get: 2402 tags: 2403 - "Custom roles" 2404 summary: "Get one custom role by key." 2405 operationId: "getCustomRole" 2406 parameters: 2407 - name: "customRoleKey" 2408 in: "path" 2409 description: "The custom role key." 2410 required: true 2411 type: "string" 2412 x-exportParamName: "CustomRoleKey" 2413 responses: 2414 "200": 2415 description: "Custom role response." 2416 schema: 2417 $ref: "#/definitions/CustomRole" 2418 "400": 2419 description: "Invalid request body." 2420 "401": 2421 description: "Invalid access token." 2422 delete: 2423 tags: 2424 - "Custom roles" 2425 summary: "Delete a custom role by key." 2426 operationId: "deleteCustomRole" 2427 parameters: 2428 - name: "customRoleKey" 2429 in: "path" 2430 description: "The custom role key." 2431 required: true 2432 type: "string" 2433 x-exportParamName: "CustomRoleKey" 2434 responses: 2435 "204": 2436 description: "Action completed successfully." 2437 "401": 2438 description: "Invalid access token." 2439 "404": 2440 description: "Invalid resource specifier." 2441 patch: 2442 tags: 2443 - "Custom roles" 2444 summary: "Modify a custom role by key." 2445 operationId: "patchCustomRole" 2446 parameters: 2447 - name: "customRoleKey" 2448 in: "path" 2449 description: "The custom role key." 2450 required: true 2451 type: "string" 2452 x-exportParamName: "CustomRoleKey" 2453 - in: "body" 2454 name: "patchDelta" 2455 description: "Requires a JSON Patch representation of the desired changes\ 2456 \ to the project. 'http://jsonpatch.com/'" 2457 required: true 2458 schema: 2459 type: "array" 2460 items: 2461 $ref: "#/definitions/PatchOperation" 2462 x-exportParamName: "PatchDelta" 2463 responses: 2464 "200": 2465 description: "Custom role response." 2466 schema: 2467 $ref: "#/definitions/CustomRole" 2468 "400": 2469 description: "Invalid request body." 2470 "401": 2471 description: "Invalid access token." 2472 "404": 2473 description: "Invalid resource specifier." 2474 "409": 2475 description: "Status conflict." 2476 /members: 2477 get: 2478 tags: 2479 - "Team members" 2480 summary: "Returns a list of all members in the account." 2481 operationId: "getMembers" 2482 parameters: 2483 - name: "limit" 2484 in: "query" 2485 description: "The number of objects to return. Defaults to -1, which returns\ 2486 \ everything." 2487 required: false 2488 type: "number" 2489 x-exportParamName: "Limit" 2490 x-optionalDataType: "Float32" 2491 - name: "offset" 2492 in: "query" 2493 description: "Where to start in the list. This is for use with pagination.\ 2494 \ For example, an offset of 10 would skip the first 10 items and then return\ 2495 \ the next limit items." 2496 required: false 2497 type: "number" 2498 x-exportParamName: "Offset" 2499 x-optionalDataType: "Float32" 2500 - name: "filter" 2501 in: "query" 2502 description: "A comma-separated list of filters. Each filter is of the form\ 2503 \ field:value." 2504 required: false 2505 type: "string" 2506 x-exportParamName: "Filter" 2507 x-optionalDataType: "String" 2508 - name: "sort" 2509 in: "query" 2510 description: "A comma-separated list of fields to sort by. A field prefixed\ 2511 \ by a - will be sorted in descending order." 2512 required: false 2513 type: "string" 2514 x-exportParamName: "Sort" 2515 x-optionalDataType: "String" 2516 responses: 2517 "200": 2518 description: "Members response." 2519 schema: 2520 $ref: "#/definitions/Members" 2521 "401": 2522 description: "Invalid access token." 2523 post: 2524 tags: 2525 - "Team members" 2526 summary: "Invite new members." 2527 operationId: "postMembers" 2528 parameters: 2529 - in: "body" 2530 name: "membersBody" 2531 description: "New members to invite." 2532 required: true 2533 schema: 2534 type: "array" 2535 items: 2536 $ref: "#/definitions/membersBody" 2537 x-exportParamName: "MembersBody" 2538 responses: 2539 "201": 2540 description: "Members response." 2541 schema: 2542 $ref: "#/definitions/Members" 2543 "400": 2544 description: "Invalid request body." 2545 "401": 2546 description: "Invalid access token." 2547 "409": 2548 description: "Status conflict." 2549 /members/me: 2550 get: 2551 tags: 2552 - "Team members" 2553 summary: "Get the current team member associated with the token" 2554 operationId: "getMe" 2555 parameters: [] 2556 responses: 2557 "200": 2558 description: "Member response." 2559 schema: 2560 $ref: "#/definitions/Member" 2561 "400": 2562 description: "Invalid request body." 2563 "401": 2564 description: "Invalid access token." 2565 /members/{memberId}: 2566 get: 2567 tags: 2568 - "Team members" 2569 summary: "Get a single team member by ID." 2570 operationId: "getMember" 2571 parameters: 2572 - name: "memberId" 2573 in: "path" 2574 description: "The member ID." 2575 required: true 2576 type: "string" 2577 x-exportParamName: "MemberId" 2578 responses: 2579 "200": 2580 description: "Member response." 2581 schema: 2582 $ref: "#/definitions/Member" 2583 "400": 2584 description: "Invalid request body." 2585 "401": 2586 description: "Invalid access token." 2587 delete: 2588 tags: 2589 - "Team members" 2590 summary: "Delete a team member by ID." 2591 operationId: "deleteMember" 2592 parameters: 2593 - name: "memberId" 2594 in: "path" 2595 description: "The member ID." 2596 required: true 2597 type: "string" 2598 x-exportParamName: "MemberId" 2599 responses: 2600 "204": 2601 description: "Action completed successfully." 2602 "401": 2603 description: "Invalid access token." 2604 "404": 2605 description: "Invalid resource specifier." 2606 patch: 2607 tags: 2608 - "Team members" 2609 summary: "Modify a team member by ID." 2610 operationId: "patchMember" 2611 parameters: 2612 - name: "memberId" 2613 in: "path" 2614 description: "The member ID." 2615 required: true 2616 type: "string" 2617 x-exportParamName: "MemberId" 2618 - in: "body" 2619 name: "patchDelta" 2620 description: "Requires a JSON Patch representation of the desired changes\ 2621 \ to the project. 'http://jsonpatch.com/'" 2622 required: true 2623 schema: 2624 type: "array" 2625 items: 2626 $ref: "#/definitions/PatchOperation" 2627 x-exportParamName: "PatchDelta" 2628 responses: 2629 "200": 2630 description: "Member response." 2631 schema: 2632 $ref: "#/definitions/Member" 2633 "400": 2634 description: "Invalid request body." 2635 "401": 2636 description: "Invalid access token." 2637 "404": 2638 description: "Invalid resource specifier." 2639 "409": 2640 description: "Status conflict." 2641 /destinations: 2642 get: 2643 tags: 2644 - "Data export destinations" 2645 summary: "Returns a list of all data export destinations." 2646 operationId: "getDestinations" 2647 parameters: [] 2648 responses: 2649 "200": 2650 description: "Destinations response." 2651 schema: 2652 $ref: "#/definitions/Destinations" 2653 "401": 2654 description: "Invalid access token." 2655 /destinations/{projectKey}/{environmentKey}: 2656 post: 2657 tags: 2658 - "Data export destinations" 2659 summary: "Create a new data export destination" 2660 operationId: "postDestination" 2661 parameters: 2662 - name: "projectKey" 2663 in: "path" 2664 description: "The project key, used to tie the flags together under one project\ 2665 \ so they can be managed together." 2666 required: true 2667 type: "string" 2668 x-exportParamName: "ProjectKey" 2669 - name: "environmentKey" 2670 in: "path" 2671 description: "The environment key, used to tie together flag configuration\ 2672 \ and users under one environment so they can be managed together." 2673 required: true 2674 type: "string" 2675 x-exportParamName: "EnvironmentKey" 2676 - in: "body" 2677 name: "destinationBody" 2678 description: "Create a new data export destination." 2679 required: true 2680 schema: 2681 $ref: "#/definitions/destinationBody" 2682 x-exportParamName: "DestinationBody" 2683 responses: 2684 "201": 2685 description: "Destination response." 2686 schema: 2687 $ref: "#/definitions/Destination" 2688 "400": 2689 description: "Invalid request body." 2690 "401": 2691 description: "Invalid access token." 2692 "409": 2693 description: "Status conflict." 2694 /destinations/{projectKey}/{environmentKey}/{destinationId}: 2695 get: 2696 tags: 2697 - "Data export destinations" 2698 summary: "Get a single data export destination by ID" 2699 operationId: "getDestination" 2700 parameters: 2701 - name: "projectKey" 2702 in: "path" 2703 description: "The project key, used to tie the flags together under one project\ 2704 \ so they can be managed together." 2705 required: true 2706 type: "string" 2707 x-exportParamName: "ProjectKey" 2708 - name: "environmentKey" 2709 in: "path" 2710 description: "The environment key, used to tie together flag configuration\ 2711 \ and users under one environment so they can be managed together." 2712 required: true 2713 type: "string" 2714 x-exportParamName: "EnvironmentKey" 2715 - name: "destinationId" 2716 in: "path" 2717 description: "The data export destination ID." 2718 required: true 2719 type: "string" 2720 x-exportParamName: "DestinationId" 2721 responses: 2722 "200": 2723 description: "Destination response." 2724 schema: 2725 $ref: "#/definitions/Destination" 2726 "401": 2727 description: "Invalid access token." 2728 "404": 2729 description: "Invalid resource specifier." 2730 delete: 2731 tags: 2732 - "Data export destinations" 2733 summary: "Get a single data export destination by ID" 2734 operationId: "deleteDestination" 2735 parameters: 2736 - name: "projectKey" 2737 in: "path" 2738 description: "The project key, used to tie the flags together under one project\ 2739 \ so they can be managed together." 2740 required: true 2741 type: "string" 2742 x-exportParamName: "ProjectKey" 2743 - name: "environmentKey" 2744 in: "path" 2745 description: "The environment key, used to tie together flag configuration\ 2746 \ and users under one environment so they can be managed together." 2747 required: true 2748 type: "string" 2749 x-exportParamName: "EnvironmentKey" 2750 - name: "destinationId" 2751 in: "path" 2752 description: "The data export destination ID." 2753 required: true 2754 type: "string" 2755 x-exportParamName: "DestinationId" 2756 responses: 2757 "204": 2758 description: "Action completed successfully." 2759 "401": 2760 description: "Invalid access token." 2761 "404": 2762 description: "Invalid resource specifier." 2763 patch: 2764 tags: 2765 - "Data export destinations" 2766 summary: "Perform a partial update to a data export destination." 2767 operationId: "patchDestination" 2768 parameters: 2769 - name: "projectKey" 2770 in: "path" 2771 description: "The project key, used to tie the flags together under one project\ 2772 \ so they can be managed together." 2773 required: true 2774 type: "string" 2775 x-exportParamName: "ProjectKey" 2776 - name: "environmentKey" 2777 in: "path" 2778 description: "The environment key, used to tie together flag configuration\ 2779 \ and users under one environment so they can be managed together." 2780 required: true 2781 type: "string" 2782 x-exportParamName: "EnvironmentKey" 2783 - name: "destinationId" 2784 in: "path" 2785 description: "The data export destination ID." 2786 required: true 2787 type: "string" 2788 x-exportParamName: "DestinationId" 2789 - in: "body" 2790 name: "PatchOnly" 2791 description: "Requires a JSON Patch representation of the desired changes\ 2792 \ to the project. 'http://jsonpatch.com/' Feature flag patches also support\ 2793 \ JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition\ 2794 \ of comments is also supported." 2795 required: true 2796 schema: 2797 type: "array" 2798 items: 2799 $ref: "#/definitions/PatchOperation" 2800 x-exportParamName: "PatchOnly" 2801 responses: 2802 "200": 2803 description: "Destination response." 2804 schema: 2805 $ref: "#/definitions/Destination" 2806 "400": 2807 description: "Invalid request body." 2808 "401": 2809 description: "Invalid access token." 2810 "404": 2811 description: "Invalid resource specifier." 2812 "409": 2813 description: "Status conflict." 2814 /usage: 2815 get: 2816 tags: 2817 - "Customer Metrics" 2818 summary: "Returns of the usage endpoints available." 2819 operationId: "getUsage" 2820 parameters: [] 2821 responses: 2822 "200": 2823 description: "Usage endpoints" 2824 schema: 2825 $ref: "#/definitions/Usage" 2826 "403": 2827 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2828 \ header to use it." 2829 schema: 2830 $ref: "#/definitions/UsageError" 2831 /usage/streams: 2832 get: 2833 tags: 2834 - "Customer Metrics" 2835 summary: "Returns a list of all streams." 2836 operationId: "getStreams" 2837 parameters: [] 2838 responses: 2839 "200": 2840 description: "Stream usage endpoints" 2841 schema: 2842 $ref: "#/definitions/Streams" 2843 "403": 2844 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2845 \ header to use it." 2846 schema: 2847 $ref: "#/definitions/UsageError" 2848 /usage/streams/{source}: 2849 get: 2850 tags: 2851 - "Customer Metrics" 2852 summary: "Get a stream endpoint and return timeseries data." 2853 operationId: "getStream" 2854 parameters: 2855 - name: "source" 2856 in: "path" 2857 description: "The source of where the stream comes from." 2858 required: true 2859 type: "string" 2860 x-exportParamName: "Source" 2861 responses: 2862 "200": 2863 description: "Responds with time series data on stream usage." 2864 schema: 2865 $ref: "#/definitions/Stream" 2866 "403": 2867 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2868 \ header to use it." 2869 schema: 2870 $ref: "#/definitions/UsageError" 2871 "404": 2872 description: "The stream source you requested could not be found" 2873 schema: 2874 $ref: "#/definitions/StreamUsageError" 2875 /usage/streams/{source}/bysdkversion: 2876 get: 2877 tags: 2878 - "Customer Metrics" 2879 summary: "Get a stream timeseries data by source show sdk version metadata." 2880 operationId: "getStreamBySDK" 2881 parameters: 2882 - name: "source" 2883 in: "path" 2884 description: "The source of where the stream comes from." 2885 required: true 2886 type: "string" 2887 x-exportParamName: "Source" 2888 responses: 2889 "200": 2890 description: "Returns timeseries data and metadata on sdk version." 2891 schema: 2892 $ref: "#/definitions/StreamBySDK" 2893 "403": 2894 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2895 \ header to use it." 2896 schema: 2897 $ref: "#/definitions/UsageError" 2898 "404": 2899 description: "The stream source you requested could not be found" 2900 schema: 2901 $ref: "#/definitions/StreamUsageError" 2902 /usage/streams/{source}/sdkversions: 2903 get: 2904 tags: 2905 - "Customer Metrics" 2906 summary: "Get a stream timeseries data by source and show all sdk version associated." 2907 operationId: "getStreamSDKVersion" 2908 parameters: 2909 - name: "source" 2910 in: "path" 2911 description: "The source of where the stream comes from." 2912 required: true 2913 type: "string" 2914 x-exportParamName: "Source" 2915 responses: 2916 "200": 2917 description: "Returns timeseries data and all sdk versions." 2918 schema: 2919 $ref: "#/definitions/StreamSDKVersion" 2920 "403": 2921 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2922 \ header to use it." 2923 schema: 2924 $ref: "#/definitions/UsageError" 2925 "404": 2926 description: "The stream source you requested could not be found" 2927 schema: 2928 $ref: "#/definitions/StreamUsageError" 2929 /usage/mau: 2930 get: 2931 tags: 2932 - "Customer Metrics" 2933 summary: "Get monthly active user data." 2934 operationId: "getMAU" 2935 parameters: [] 2936 responses: 2937 "200": 2938 description: "Returns timeseries data and all sdk versions." 2939 schema: 2940 $ref: "#/definitions/MAU" 2941 "403": 2942 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2943 \ header to use it." 2944 schema: 2945 $ref: "#/definitions/UsageError" 2946 /usage/mau/bycategory: 2947 get: 2948 tags: 2949 - "Customer Metrics" 2950 summary: "Get monthly active user data by category." 2951 operationId: "getMAUByCategory" 2952 parameters: [] 2953 responses: 2954 "200": 2955 description: "Returns timeseries data and all sdk versions." 2956 schema: 2957 $ref: "#/definitions/MAUbyCategory" 2958 "403": 2959 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2960 \ header to use it." 2961 schema: 2962 $ref: "#/definitions/UsageError" 2963 /usage/events: 2964 get: 2965 tags: 2966 - "Customer Metrics" 2967 summary: "Get events usage endpoints." 2968 operationId: "getEvents" 2969 parameters: [] 2970 responses: 2971 "200": 2972 description: "Returns timeseries data and all sdk versions." 2973 schema: 2974 $ref: "#/definitions/Events" 2975 "403": 2976 description: "This is a beta API, you must pass beta in the LD-API-Version\ 2977 \ header to use it." 2978 schema: 2979 $ref: "#/definitions/UsageError" 2980 /usage/events/{type}: 2981 get: 2982 tags: 2983 - "Customer Metrics" 2984 summary: "Get events usage by event type." 2985 operationId: "getEvent" 2986 parameters: 2987 - name: "type" 2988 in: "path" 2989 description: "The type of event we would like to track." 2990 required: true 2991 type: "string" 2992 x-exportParamName: "Type_" 2993 responses: 2994 "200": 2995 description: "Returns timeseries data and all sdk versions." 2996 schema: 2997 $ref: "#/definitions/StreamSDKVersion" 2998 "403": 2999 description: "This is a beta API, you must pass beta in the LD-API-Version\ 3000 \ header to use it." 3001 schema: 3002 $ref: "#/definitions/UsageError" 3003 "404": 3004 description: "The stream source you requested could not be found" 3005 schema: 3006 $ref: "#/definitions/StreamUsageError" 3007 /usage/evaluations/{envId}/{flagKey}: 3008 get: 3009 tags: 3010 - "Customer Metrics" 3011 summary: "Get events usage by event id and the feature flag key." 3012 operationId: "getEvaluations" 3013 parameters: 3014 - name: "envId" 3015 in: "path" 3016 description: "The environment id for the flag evaluations in question." 3017 required: true 3018 type: "string" 3019 x-exportParamName: "EnvId" 3020 - name: "flagKey" 3021 in: "path" 3022 description: "The key of the flag we want metrics for." 3023 required: true 3024 type: "string" 3025 x-exportParamName: "FlagKey" 3026 responses: 3027 "200": 3028 description: "Returns timeseries data and all sdk versions." 3029 schema: 3030 $ref: "#/definitions/StreamSDKVersion" 3031 "403": 3032 description: "This is a beta API, you must pass beta in the LD-API-Version\ 3033 \ header to use it." 3034 schema: 3035 $ref: "#/definitions/UsageError" 3036 "404": 3037 description: "The environment or flag you requested could not be found" 3038 schema: 3039 $ref: "#/definitions/EvaluationUsageError" 3040 /tokens: 3041 get: 3042 tags: 3043 - "Access tokens" 3044 summary: "Returns a list of tokens in the account." 3045 operationId: "getTokens" 3046 parameters: 3047 - name: "showAll" 3048 in: "query" 3049 description: "If set to true, and the authentication access token has the\ 3050 \ \"Admin\" role, personal access tokens for all members will be retrieved." 3051 required: false 3052 type: "boolean" 3053 x-exportParamName: "ShowAll" 3054 x-optionalDataType: "Bool" 3055 responses: 3056 "200": 3057 description: "Tokens response." 3058 schema: 3059 $ref: "#/definitions/Tokens" 3060 "401": 3061 description: "Invalid access token." 3062 post: 3063 tags: 3064 - "Access tokens" 3065 summary: "Create a new token." 3066 operationId: "postToken" 3067 parameters: 3068 - in: "body" 3069 name: "tokenBody" 3070 description: "Create a new access token." 3071 required: true 3072 schema: 3073 $ref: "#/definitions/tokenBody" 3074 x-exportParamName: "TokenBody" 3075 responses: 3076 "201": 3077 description: "Token response." 3078 schema: 3079 $ref: "#/definitions/Token" 3080 "400": 3081 description: "Invalid request body." 3082 "401": 3083 description: "Invalid access token." 3084 "409": 3085 description: "Status conflict." 3086 /tokens/{tokenId}: 3087 get: 3088 tags: 3089 - "Access tokens" 3090 summary: "Get a single access token by ID." 3091 operationId: "getToken" 3092 parameters: 3093 - name: "tokenId" 3094 in: "path" 3095 description: "The access token ID." 3096 required: true 3097 type: "string" 3098 x-exportParamName: "TokenId" 3099 responses: 3100 "200": 3101 description: "Token response." 3102 schema: 3103 $ref: "#/definitions/Token" 3104 "400": 3105 description: "Invalid request body." 3106 "401": 3107 description: "Invalid access token." 3108 delete: 3109 tags: 3110 - "Access tokens" 3111 summary: "Delete an access token by ID." 3112 operationId: "deleteToken" 3113 parameters: 3114 - name: "tokenId" 3115 in: "path" 3116 description: "The access token ID." 3117 required: true 3118 type: "string" 3119 x-exportParamName: "TokenId" 3120 responses: 3121 "204": 3122 description: "Action completed successfully." 3123 "401": 3124 description: "Invalid access token." 3125 "404": 3126 description: "Invalid resource specifier." 3127 patch: 3128 tags: 3129 - "Access tokens" 3130 summary: "Modify an access token by ID." 3131 operationId: "patchToken" 3132 parameters: 3133 - name: "tokenId" 3134 in: "path" 3135 description: "The access token ID." 3136 required: true 3137 type: "string" 3138 x-exportParamName: "TokenId" 3139 - in: "body" 3140 name: "patchDelta" 3141 description: "Requires a JSON Patch representation of the desired changes\ 3142 \ to the project. 'http://jsonpatch.com/'" 3143 required: true 3144 schema: 3145 type: "array" 3146 items: 3147 $ref: "#/definitions/PatchOperation" 3148 x-exportParamName: "PatchDelta" 3149 responses: 3150 "200": 3151 description: "Token response." 3152 schema: 3153 $ref: "#/definitions/Token" 3154 "400": 3155 description: "Invalid request body." 3156 "401": 3157 description: "Invalid access token." 3158 "404": 3159 description: "Invalid resource specifier." 3160 "409": 3161 description: "Status conflict." 3162 /tokens/{tokenId}/reset: 3163 post: 3164 tags: 3165 - "Access tokens" 3166 summary: "Reset an access token's secret key with an optional expiry time for\ 3167 \ the old key." 3168 operationId: "resetToken" 3169 parameters: 3170 - name: "tokenId" 3171 in: "path" 3172 description: "The access token ID." 3173 required: true 3174 type: "string" 3175 x-exportParamName: "TokenId" 3176 - name: "expiry" 3177 in: "query" 3178 description: "An expiration time for the old token key, expressed as a Unix\ 3179 \ epoch time in milliseconds. By default, the token will expire immediately." 3180 required: false 3181 type: "integer" 3182 format: "int64" 3183 x-exportParamName: "Expiry" 3184 x-optionalDataType: "Int64" 3185 responses: 3186 "200": 3187 description: "Token response." 3188 schema: 3189 $ref: "#/definitions/Token" 3190 "400": 3191 description: "Invalid request body." 3192 "401": 3193 description: "Invalid access token." 3194 /account/relay-auto-configs: 3195 get: 3196 tags: 3197 - "Relay proxy configurations" 3198 summary: "Returns a list of relay proxy configurations in the account." 3199 operationId: "getRelayProxyConfigs" 3200 parameters: [] 3201 responses: 3202 "200": 3203 description: "Relay proxy configs response." 3204 schema: 3205 $ref: "#/definitions/RelayProxyConfigs" 3206 post: 3207 tags: 3208 - "Relay proxy configurations" 3209 summary: "Create a new relay proxy config." 3210 operationId: "postRelayAutoConfig" 3211 parameters: 3212 - in: "body" 3213 name: "relayProxyConfigBody" 3214 description: "Create a new relay proxy configuration" 3215 required: true 3216 schema: 3217 $ref: "#/definitions/relayProxyConfigBody" 3218 x-exportParamName: "RelayProxyConfigBody" 3219 responses: 3220 "201": 3221 description: "Relay proxy config response." 3222 schema: 3223 $ref: "#/definitions/RelayProxyConfig" 3224 "400": 3225 description: "Invalid request body." 3226 "403": 3227 description: "Access to the requested resource was denied." 3228 /account/relay-auto-configs/{id}: 3229 get: 3230 tags: 3231 - "Relay proxy configurations" 3232 summary: "Get a single relay proxy configuration by ID." 3233 operationId: "getRelayProxyConfig" 3234 parameters: 3235 - name: "id" 3236 in: "path" 3237 description: "The relay proxy configuration ID" 3238 required: true 3239 type: "string" 3240 x-exportParamName: "Id" 3241 responses: 3242 "200": 3243 description: "Relay proxy config response." 3244 schema: 3245 $ref: "#/definitions/RelayProxyConfig" 3246 "404": 3247 description: "Invalid resource specifier." 3248 delete: 3249 tags: 3250 - "Relay proxy configurations" 3251 summary: "Delete a relay proxy configuration by ID." 3252 operationId: "deleteRelayProxyConfig" 3253 parameters: 3254 - name: "id" 3255 in: "path" 3256 description: "The relay proxy configuration ID" 3257 required: true 3258 type: "string" 3259 x-exportParamName: "Id" 3260 responses: 3261 "204": 3262 description: "Action completed successfully." 3263 "400": 3264 description: "Invalid request body." 3265 "404": 3266 description: "Invalid resource specifier." 3267 patch: 3268 tags: 3269 - "Relay proxy configurations" 3270 summary: "Modify a relay proxy configuration by ID." 3271 operationId: "patchRelayProxyConfig" 3272 parameters: 3273 - name: "id" 3274 in: "path" 3275 description: "The relay proxy configuration ID" 3276 required: true 3277 type: "string" 3278 x-exportParamName: "Id" 3279 - in: "body" 3280 name: "patchDelta" 3281 description: "Requires a JSON Patch representation of the desired changes\ 3282 \ to the project. 'http://jsonpatch.com/'" 3283 required: true 3284 schema: 3285 type: "array" 3286 items: 3287 $ref: "#/definitions/PatchOperation" 3288 x-exportParamName: "PatchDelta" 3289 responses: 3290 "200": 3291 description: "Relay proxy config response." 3292 schema: 3293 $ref: "#/definitions/RelayProxyConfig" 3294 "400": 3295 description: "Invalid request body." 3296 "404": 3297 description: "Invalid resource specifier." 3298 "409": 3299 description: "Status conflict." 3300 /account/relay-auto-configs/{id}/reset: 3301 post: 3302 tags: 3303 - "Relay proxy configurations" 3304 summary: "Reset a relay proxy configuration's secret key with an optional expiry\ 3305 \ time for the old key." 3306 operationId: "resetRelayProxyConfig" 3307 parameters: 3308 - name: "id" 3309 in: "path" 3310 description: "The relay proxy configuration ID" 3311 required: true 3312 type: "string" 3313 x-exportParamName: "Id" 3314 - name: "expiry" 3315 in: "query" 3316 description: "An expiration time for the old relay proxy configuration key,\ 3317 \ expressed as a Unix epoch time in milliseconds. By default, the relay\ 3318 \ proxy configuration will expire immediately" 3319 required: false 3320 type: "integer" 3321 format: "int64" 3322 x-exportParamName: "Expiry" 3323 x-optionalDataType: "Int64" 3324 responses: 3325 "200": 3326 description: "Relay proxy config response." 3327 schema: 3328 $ref: "#/definitions/RelayProxyConfig" 3329 "400": 3330 description: "Invalid request body." 3331 "404": 3332 description: "Invalid resource specifier." 3333 /: 3334 get: 3335 tags: 3336 - "Root" 3337 description: "You can issue a GET request to the root resource to find all of\ 3338 \ the resource categories supported by the API." 3339 operationId: "getRoot" 3340 parameters: [] 3341 responses: 3342 "200": 3343 description: "A list of links to available resources in the API." 3344 schema: 3345 $ref: "#/definitions/Links" 3346 "401": 3347 description: "Invalid access token." 3348 /integrations: 3349 get: 3350 tags: 3351 - "Integrations" 3352 summary: "Get a list of all configured audit log event integrations associated\ 3353 \ with this account." 3354 operationId: "getIntegrations" 3355 parameters: [] 3356 responses: 3357 "200": 3358 description: "Integrations response." 3359 schema: 3360 $ref: "#/definitions/Integrations" 3361 "403": 3362 description: "This is a beta API, you must pass beta in the LD-API-Version\ 3363 \ header to use it." 3364 schema: 3365 $ref: "#/definitions/UsageError" 3366 /integrations/{integrationKey}: 3367 get: 3368 tags: 3369 - "Integrations" 3370 summary: "Get a list of all configured integrations of a given kind." 3371 operationId: "getIntegrationSubscriptions" 3372 parameters: 3373 - name: "integrationKey" 3374 in: "path" 3375 description: "The key used to specify the integration kind." 3376 required: true 3377 type: "string" 3378 x-exportParamName: "IntegrationKey" 3379 responses: 3380 "200": 3381 description: "Integrations response." 3382 schema: 3383 $ref: "#/definitions/Integration" 3384 "403": 3385 description: "This is a beta API, you must pass beta in the LD-API-Version\ 3386 \ header to use it." 3387 schema: 3388 $ref: "#/definitions/UsageError" 3389 "404": 3390 description: "Invalid resource specifier." 3391 post: 3392 tags: 3393 - "Integrations" 3394 summary: "Create a new integration subscription of a given kind." 3395 operationId: "postIntegrationSubscription" 3396 parameters: 3397 - name: "integrationKey" 3398 in: "path" 3399 description: "The key used to specify the integration kind." 3400 required: true 3401 type: "string" 3402 x-exportParamName: "IntegrationKey" 3403 - in: "body" 3404 name: "subscriptionBody" 3405 description: "Create a new integration subscription." 3406 required: true 3407 schema: 3408 $ref: "#/definitions/subscriptionBody" 3409 x-exportParamName: "SubscriptionBody" 3410 responses: 3411 "201": 3412 description: "Integrations response." 3413 schema: 3414 $ref: "#/definitions/IntegrationSubscription" 3415 "400": 3416 description: "Invalid request body." 3417 "401": 3418 description: "Invalid access token." 3419 "409": 3420 description: "Status conflict." 3421 /integrations/{integrationKey}/{integrationId}: 3422 get: 3423 tags: 3424 - "Integrations" 3425 summary: "Get a single integration subscription by ID." 3426 operationId: "getIntegrationSubscription" 3427 parameters: 3428 - name: "integrationKey" 3429 in: "path" 3430 description: "The key used to specify the integration kind." 3431 required: true 3432 type: "string" 3433 x-exportParamName: "IntegrationKey" 3434 - name: "integrationId" 3435 in: "path" 3436 description: "The integration ID." 3437 required: true 3438 type: "string" 3439 x-exportParamName: "IntegrationId" 3440 responses: 3441 "200": 3442 description: "Integrations response." 3443 schema: 3444 $ref: "#/definitions/IntegrationSubscription" 3445 "403": 3446 description: "This is a beta API, you must pass beta in the LD-API-Version\ 3447 \ header to use it." 3448 schema: 3449 $ref: "#/definitions/UsageError" 3450 "404": 3451 description: "Invalid resource specifier." 3452 delete: 3453 tags: 3454 - "Integrations" 3455 summary: "Delete an integration subscription by ID." 3456 operationId: "deleteIntegrationSubscription" 3457 parameters: 3458 - name: "integrationKey" 3459 in: "path" 3460 description: "The key used to specify the integration kind." 3461 required: true 3462 type: "string" 3463 x-exportParamName: "IntegrationKey" 3464 - name: "integrationId" 3465 in: "path" 3466 description: "The integration ID." 3467 required: true 3468 type: "string" 3469 x-exportParamName: "IntegrationId" 3470 responses: 3471 "204": 3472 description: "Action completed successfully." 3473 "401": 3474 description: "Invalid access token." 3475 "404": 3476 description: "Invalid resource specifier." 3477 patch: 3478 tags: 3479 - "Integrations" 3480 summary: "Modify an integration subscription by ID." 3481 operationId: "patchIntegrationSubscription" 3482 parameters: 3483 - name: "integrationKey" 3484 in: "path" 3485 description: "The key used to specify the integration kind." 3486 required: true 3487 type: "string" 3488 x-exportParamName: "IntegrationKey" 3489 - name: "integrationId" 3490 in: "path" 3491 description: "The integration ID." 3492 required: true 3493 type: "string" 3494 x-exportParamName: "IntegrationId" 3495 - in: "body" 3496 name: "patchDelta" 3497 description: "Requires a JSON Patch representation of the desired changes\ 3498 \ to the project. 'http://jsonpatch.com/'" 3499 required: true 3500 schema: 3501 type: "array" 3502 items: 3503 $ref: "#/definitions/PatchOperation" 3504 x-exportParamName: "PatchDelta" 3505 responses: 3506 "200": 3507 description: "Integrations response." 3508 schema: 3509 $ref: "#/definitions/IntegrationSubscription" 3510 "400": 3511 description: "Invalid request body." 3512 "401": 3513 description: "Invalid access token." 3514 "404": 3515 description: "Invalid resource specifier." 3516 securityDefinitions: 3517 Token: 3518 description: "https://app.launchdarkly.com/settings#/tokens" 3519 type: "apiKey" 3520 name: "Authorization" 3521 in: "header" 3522 definitions: 3523 Link: 3524 type: "object" 3525 properties: 3526 href: 3527 type: "string" 3528 example: "/api/v2/endpoint" 3529 type: 3530 type: "string" 3531 example: "application/json" 3532 example: 3533 href: "/api/v2/endpoint" 3534 type: "application/json" 3535 Links: 3536 type: "object" 3537 properties: 3538 self: 3539 $ref: "#/definitions/Link" 3540 next: 3541 $ref: "#/definitions/Link" 3542 example: 3543 next: 3544 href: "/api/v2/endpoint" 3545 type: "application/json" 3546 self: 3547 href: "/api/v2/endpoint" 3548 type: "application/json" 3549 Site: 3550 type: "object" 3551 properties: 3552 href: 3553 type: "string" 3554 example: "/features/sort.order" 3555 type: 3556 type: "string" 3557 example: "text/html" 3558 example: 3559 href: "/features/sort.order" 3560 type: "text/html" 3561 Webhook: 3562 type: "object" 3563 properties: 3564 _links: 3565 $ref: "#/definitions/Links" 3566 _id: 3567 type: "string" 3568 example: "5a580a01b4ff89217bdf9dc1" 3569 description: "The unique resource id." 3570 url: 3571 type: "string" 3572 example: "https://example.com/example" 3573 description: "The URL of the remote webhook." 3574 secret: 3575 type: "string" 3576 example: "frobozz" 3577 description: "If defined, the webhooks post request will include a X-LD-Signature\ 3578 \ header whose value will contain an HMAC SHA256 hex digest of the webhook\ 3579 \ payload, using the secret as the key." 3580 "on": 3581 type: "boolean" 3582 example: true 3583 description: "Whether this webhook is enabled or not." 3584 name: 3585 type: "string" 3586 example: "Example hook" 3587 description: "The name of the webhook." 3588 statements: 3589 type: "array" 3590 items: 3591 $ref: "#/definitions/Statement" 3592 tags: 3593 type: "array" 3594 description: "Tags assigned to this webhook." 3595 items: 3596 type: "string" 3597 example: "" 3598 example: 3599 _links: 3600 next: 3601 href: "/api/v2/endpoint" 3602 type: "application/json" 3603 self: 3604 href: "/api/v2/endpoint" 3605 type: "application/json" 3606 name: "Example hook" 3607 statements: 3608 - notActions: 3609 - "updateOn" 3610 - "updateOn" 3611 notResources: 3612 - "proj/*:env/*:flag/my-flag" 3613 - "proj/*:env/*:flag/my-flag" 3614 effect: "allow" 3615 resources: 3616 - "proj/*:env/*:flag/my-flag" 3617 - "proj/*:env/*:flag/my-flag" 3618 actions: 3619 - "updateOn" 3620 - "updateOn" 3621 - notActions: 3622 - "updateOn" 3623 - "updateOn" 3624 notResources: 3625 - "proj/*:env/*:flag/my-flag" 3626 - "proj/*:env/*:flag/my-flag" 3627 effect: "allow" 3628 resources: 3629 - "proj/*:env/*:flag/my-flag" 3630 - "proj/*:env/*:flag/my-flag" 3631 actions: 3632 - "updateOn" 3633 - "updateOn" 3634 _id: "5a580a01b4ff89217bdf9dc1" 3635 secret: "frobozz" 3636 url: "https://example.com/example" 3637 "on": true 3638 tags: 3639 - "" 3640 - "" 3641 Webhooks: 3642 type: "object" 3643 properties: 3644 _links: 3645 $ref: "#/definitions/Links" 3646 items: 3647 type: "array" 3648 items: 3649 $ref: "#/definitions/Webhook" 3650 example: 3651 _links: 3652 next: 3653 href: "/api/v2/endpoint" 3654 type: "application/json" 3655 self: 3656 href: "/api/v2/endpoint" 3657 type: "application/json" 3658 items: 3659 - _links: 3660 next: 3661 href: "/api/v2/endpoint" 3662 type: "application/json" 3663 self: 3664 href: "/api/v2/endpoint" 3665 type: "application/json" 3666 name: "Example hook" 3667 statements: 3668 - notActions: 3669 - "updateOn" 3670 - "updateOn" 3671 notResources: 3672 - "proj/*:env/*:flag/my-flag" 3673 - "proj/*:env/*:flag/my-flag" 3674 effect: "allow" 3675 resources: 3676 - "proj/*:env/*:flag/my-flag" 3677 - "proj/*:env/*:flag/my-flag" 3678 actions: 3679 - "updateOn" 3680 - "updateOn" 3681 - notActions: 3682 - "updateOn" 3683 - "updateOn" 3684 notResources: 3685 - "proj/*:env/*:flag/my-flag" 3686 - "proj/*:env/*:flag/my-flag" 3687 effect: "allow" 3688 resources: 3689 - "proj/*:env/*:flag/my-flag" 3690 - "proj/*:env/*:flag/my-flag" 3691 actions: 3692 - "updateOn" 3693 - "updateOn" 3694 _id: "5a580a01b4ff89217bdf9dc1" 3695 secret: "frobozz" 3696 url: "https://example.com/example" 3697 "on": true 3698 tags: 3699 - "" 3700 - "" 3701 - _links: 3702 next: 3703 href: "/api/v2/endpoint" 3704 type: "application/json" 3705 self: 3706 href: "/api/v2/endpoint" 3707 type: "application/json" 3708 name: "Example hook" 3709 statements: 3710 - notActions: 3711 - "updateOn" 3712 - "updateOn" 3713 notResources: 3714 - "proj/*:env/*:flag/my-flag" 3715 - "proj/*:env/*:flag/my-flag" 3716 effect: "allow" 3717 resources: 3718 - "proj/*:env/*:flag/my-flag" 3719 - "proj/*:env/*:flag/my-flag" 3720 actions: 3721 - "updateOn" 3722 - "updateOn" 3723 - notActions: 3724 - "updateOn" 3725 - "updateOn" 3726 notResources: 3727 - "proj/*:env/*:flag/my-flag" 3728 - "proj/*:env/*:flag/my-flag" 3729 effect: "allow" 3730 resources: 3731 - "proj/*:env/*:flag/my-flag" 3732 - "proj/*:env/*:flag/my-flag" 3733 actions: 3734 - "updateOn" 3735 - "updateOn" 3736 _id: "5a580a01b4ff89217bdf9dc1" 3737 secret: "frobozz" 3738 url: "https://example.com/example" 3739 "on": true 3740 tags: 3741 - "" 3742 - "" 3743 FeatureFlag: 3744 type: "object" 3745 properties: 3746 key: 3747 type: "string" 3748 example: "test-feature" 3749 name: 3750 type: "string" 3751 example: "Test Feature" 3752 description: "Name of the feature flag." 3753 description: 3754 type: "string" 3755 example: "This flag controls whether test feature is turned on or not." 3756 description: "Description of the feature flag." 3757 kind: 3758 type: "string" 3759 example: "boolean" 3760 description: "Whether the feature flag is a boolean flag or multivariate." 3761 creationDate: 3762 type: "integer" 3763 format: "int64" 3764 example: 1443652232590 3765 description: "A unix epoch time in milliseconds specifying the creation time\ 3766 \ of this flag." 3767 includeInSnippet: 3768 type: "boolean" 3769 example: false 3770 temporary: 3771 type: "boolean" 3772 example: false 3773 description: "Whether or not this flag is temporary." 3774 maintainerId: 3775 type: "string" 3776 example: "561c579cd8fd5c2704000001" 3777 description: "The ID of the member that should maintain this flag." 3778 tags: 3779 type: "array" 3780 example: [] 3781 description: "An array of tags for this feature flag." 3782 items: 3783 type: "string" 3784 variations: 3785 type: "array" 3786 example: 3787 - value: "a" 3788 - value: "b" 3789 description: "The variations for this feature flag." 3790 items: 3791 $ref: "#/definitions/Variation" 3792 goalIds: 3793 type: "array" 3794 example: 3795 - "d7239405bd89c930e885aa76" 3796 - "405bc930e88d7239d895aa76" 3797 description: "An array goals from all environments associated with this feature\ 3798 \ flag" 3799 items: 3800 type: "string" 3801 _version: 3802 type: "integer" 3803 example: 23 3804 customProperties: 3805 type: "object" 3806 example: 3807 bugs: 3808 name: "Issue tracker ids" 3809 value: 3810 - "123" 3811 - "456" 3812 deprecated: 3813 name: "Deprecated Date" 3814 value: [] 3815 description: "A mapping of keys to CustomProperty entries." 3816 additionalProperties: 3817 $ref: "#/definitions/CustomProperty" 3818 _links: 3819 $ref: "#/definitions/Links" 3820 _maintainer: 3821 $ref: "#/definitions/Member" 3822 environments: 3823 type: "object" 3824 additionalProperties: 3825 $ref: "#/definitions/FeatureFlagConfig" 3826 archivedDate: 3827 type: "integer" 3828 format: "int64" 3829 example: 1443652232590 3830 description: "A unix epoch time in milliseconds specifying the archived time\ 3831 \ of this flag." 3832 archived: 3833 type: "boolean" 3834 example: false 3835 description: "Whether or not this flag is archived." 3836 clientSideAvailability: 3837 $ref: "#/definitions/ClientSideAvailability" 3838 defaults: 3839 $ref: "#/definitions/Defaults" 3840 example: 3841 archivedDate: 1443652232590 3842 temporary: false 3843 _maintainer: 3844 firstName: "Alan" 3845 lastName: "Turing" 3846 _verified: true 3847 role: {} 3848 _links: 3849 next: 3850 href: "/api/v2/endpoint" 3851 type: "application/json" 3852 self: 3853 href: "/api/v2/endpoint" 3854 type: "application/json" 3855 _pendingInvite: true 3856 _lastSeen: 1469326565348 3857 isBeta: true 3858 _id: "5a580a01b4ff89217bdf9dc1" 3859 _lastSeenMetadata: 3860 tokenId: "5fd2a1ee05600316d5cb3e96" 3861 email: "user@launchdarkly.com" 3862 customRoles: 3863 - "5a580a01b4ff89217bdf9dc1" 3864 - "5a580a01b4ff89217bdf9dc1" 3865 clientSideAvailability: 3866 usingEnvironmentId: true 3867 usingMobileKey: true 3868 _links: 3869 next: 3870 href: "/api/v2/endpoint" 3871 type: "application/json" 3872 self: 3873 href: "/api/v2/endpoint" 3874 type: "application/json" 3875 environments: 3876 key: 3877 salt: "YWx0ZXJuYXRlLnBhZ2U=" 3878 rules: 3879 - rollout: 3880 variations: 3881 - weight: 5 3882 variation: 1 3883 - weight: 5 3884 variation: 1 3885 bucketBy: "bucketBy" 3886 clauses: 3887 - op: "in" 3888 negate: true 3889 values: 3890 - "Top Customers" 3891 - "Top Customers" 3892 _id: "_id" 3893 attribute: "groups" 3894 - op: "in" 3895 negate: true 3896 values: 3897 - "Top Customers" 3898 - "Top Customers" 3899 _id: "_id" 3900 attribute: "groups" 3901 description: "description" 3902 _id: "_id" 3903 trackEvents: true 3904 variation: 6 3905 - rollout: 3906 variations: 3907 - weight: 5 3908 variation: 1 3909 - weight: 5 3910 variation: 1 3911 bucketBy: "bucketBy" 3912 clauses: 3913 - op: "in" 3914 negate: true 3915 values: 3916 - "Top Customers" 3917 - "Top Customers" 3918 _id: "_id" 3919 attribute: "groups" 3920 - op: "in" 3921 negate: true 3922 values: 3923 - "Top Customers" 3924 - "Top Customers" 3925 _id: "_id" 3926 attribute: "groups" 3927 description: "description" 3928 _id: "_id" 3929 trackEvents: true 3930 variation: 6 3931 version: 65 3932 targets: 3933 - values: 3934 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 3935 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 3936 variation: 0 3937 - values: 3938 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 3939 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 3940 variation: 0 3941 prerequisites: 3942 - key: "key" 3943 variation: 7 3944 - key: "key" 3945 variation: 7 3946 archived: true 3947 trackEventsFallthrough: true 3948 _environmentName: "_environmentName" 3949 _site: 3950 href: "/features/sort.order" 3951 type: "text/html" 3952 sel: "45501b9314dc4641841af774cb038b96" 3953 lastModified: 1469326565348 3954 trackEvents: false 3955 fallthrough: 3956 rollout: 3957 variations: 3958 - weight: 5 3959 variation: 1 3960 - weight: 5 3961 variation: 1 3962 bucketBy: "bucketBy" 3963 variation: 5 3964 offVariation: 2 3965 "on": true 3966 kind: "boolean" 3967 description: "This flag controls whether test feature is turned on or not." 3968 creationDate: 1443652232590 3969 tags: [] 3970 goalIds: 3971 - "d7239405bd89c930e885aa76" 3972 - "405bc930e88d7239d895aa76" 3973 archived: false 3974 includeInSnippet: false 3975 maintainerId: "561c579cd8fd5c2704000001" 3976 customProperties: 3977 bugs: 3978 name: "Issue tracker ids" 3979 value: 3980 - "123" 3981 - "456" 3982 deprecated: 3983 name: "Deprecated Date" 3984 value: [] 3985 defaults: 3986 onVariation: 9 3987 offVariation: 3 3988 variations: 3989 - value: "a" 3990 - value: "b" 3991 name: "Test Feature" 3992 _version: 23 3993 key: "test-feature" 3994 FeatureFlags: 3995 type: "object" 3996 properties: 3997 _links: 3998 $ref: "#/definitions/Links" 3999 items: 4000 type: "array" 4001 items: 4002 $ref: "#/definitions/FeatureFlag" 4003 totalCount: 4004 type: "number" 4005 example: 4006 _links: 4007 next: 4008 href: "/api/v2/endpoint" 4009 type: "application/json" 4010 self: 4011 href: "/api/v2/endpoint" 4012 type: "application/json" 4013 totalCount: 2.027123023002321833274663731572218239307403564453125 4014 items: 4015 - archivedDate: 1443652232590 4016 temporary: false 4017 _maintainer: 4018 firstName: "Alan" 4019 lastName: "Turing" 4020 _verified: true 4021 role: {} 4022 _links: 4023 next: 4024 href: "/api/v2/endpoint" 4025 type: "application/json" 4026 self: 4027 href: "/api/v2/endpoint" 4028 type: "application/json" 4029 _pendingInvite: true 4030 _lastSeen: 1469326565348 4031 isBeta: true 4032 _id: "5a580a01b4ff89217bdf9dc1" 4033 _lastSeenMetadata: 4034 tokenId: "5fd2a1ee05600316d5cb3e96" 4035 email: "user@launchdarkly.com" 4036 customRoles: 4037 - "5a580a01b4ff89217bdf9dc1" 4038 - "5a580a01b4ff89217bdf9dc1" 4039 clientSideAvailability: 4040 usingEnvironmentId: true 4041 usingMobileKey: true 4042 _links: 4043 next: 4044 href: "/api/v2/endpoint" 4045 type: "application/json" 4046 self: 4047 href: "/api/v2/endpoint" 4048 type: "application/json" 4049 environments: 4050 key: 4051 salt: "YWx0ZXJuYXRlLnBhZ2U=" 4052 rules: 4053 - rollout: 4054 variations: 4055 - weight: 5 4056 variation: 1 4057 - weight: 5 4058 variation: 1 4059 bucketBy: "bucketBy" 4060 clauses: 4061 - op: "in" 4062 negate: true 4063 values: 4064 - "Top Customers" 4065 - "Top Customers" 4066 _id: "_id" 4067 attribute: "groups" 4068 - op: "in" 4069 negate: true 4070 values: 4071 - "Top Customers" 4072 - "Top Customers" 4073 _id: "_id" 4074 attribute: "groups" 4075 description: "description" 4076 _id: "_id" 4077 trackEvents: true 4078 variation: 6 4079 - rollout: 4080 variations: 4081 - weight: 5 4082 variation: 1 4083 - weight: 5 4084 variation: 1 4085 bucketBy: "bucketBy" 4086 clauses: 4087 - op: "in" 4088 negate: true 4089 values: 4090 - "Top Customers" 4091 - "Top Customers" 4092 _id: "_id" 4093 attribute: "groups" 4094 - op: "in" 4095 negate: true 4096 values: 4097 - "Top Customers" 4098 - "Top Customers" 4099 _id: "_id" 4100 attribute: "groups" 4101 description: "description" 4102 _id: "_id" 4103 trackEvents: true 4104 variation: 6 4105 version: 65 4106 targets: 4107 - values: 4108 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4109 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4110 variation: 0 4111 - values: 4112 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4113 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4114 variation: 0 4115 prerequisites: 4116 - key: "key" 4117 variation: 7 4118 - key: "key" 4119 variation: 7 4120 archived: true 4121 trackEventsFallthrough: true 4122 _environmentName: "_environmentName" 4123 _site: 4124 href: "/features/sort.order" 4125 type: "text/html" 4126 sel: "45501b9314dc4641841af774cb038b96" 4127 lastModified: 1469326565348 4128 trackEvents: false 4129 fallthrough: 4130 rollout: 4131 variations: 4132 - weight: 5 4133 variation: 1 4134 - weight: 5 4135 variation: 1 4136 bucketBy: "bucketBy" 4137 variation: 5 4138 offVariation: 2 4139 "on": true 4140 kind: "boolean" 4141 description: "This flag controls whether test feature is turned on or not." 4142 creationDate: 1443652232590 4143 tags: [] 4144 goalIds: 4145 - "d7239405bd89c930e885aa76" 4146 - "405bc930e88d7239d895aa76" 4147 archived: false 4148 includeInSnippet: false 4149 maintainerId: "561c579cd8fd5c2704000001" 4150 customProperties: 4151 bugs: 4152 name: "Issue tracker ids" 4153 value: 4154 - "123" 4155 - "456" 4156 deprecated: 4157 name: "Deprecated Date" 4158 value: [] 4159 defaults: 4160 onVariation: 9 4161 offVariation: 3 4162 variations: 4163 - value: "a" 4164 - value: "b" 4165 name: "Test Feature" 4166 _version: 23 4167 key: "test-feature" 4168 - archivedDate: 1443652232590 4169 temporary: false 4170 _maintainer: 4171 firstName: "Alan" 4172 lastName: "Turing" 4173 _verified: true 4174 role: {} 4175 _links: 4176 next: 4177 href: "/api/v2/endpoint" 4178 type: "application/json" 4179 self: 4180 href: "/api/v2/endpoint" 4181 type: "application/json" 4182 _pendingInvite: true 4183 _lastSeen: 1469326565348 4184 isBeta: true 4185 _id: "5a580a01b4ff89217bdf9dc1" 4186 _lastSeenMetadata: 4187 tokenId: "5fd2a1ee05600316d5cb3e96" 4188 email: "user@launchdarkly.com" 4189 customRoles: 4190 - "5a580a01b4ff89217bdf9dc1" 4191 - "5a580a01b4ff89217bdf9dc1" 4192 clientSideAvailability: 4193 usingEnvironmentId: true 4194 usingMobileKey: true 4195 _links: 4196 next: 4197 href: "/api/v2/endpoint" 4198 type: "application/json" 4199 self: 4200 href: "/api/v2/endpoint" 4201 type: "application/json" 4202 environments: 4203 key: 4204 salt: "YWx0ZXJuYXRlLnBhZ2U=" 4205 rules: 4206 - rollout: 4207 variations: 4208 - weight: 5 4209 variation: 1 4210 - weight: 5 4211 variation: 1 4212 bucketBy: "bucketBy" 4213 clauses: 4214 - op: "in" 4215 negate: true 4216 values: 4217 - "Top Customers" 4218 - "Top Customers" 4219 _id: "_id" 4220 attribute: "groups" 4221 - op: "in" 4222 negate: true 4223 values: 4224 - "Top Customers" 4225 - "Top Customers" 4226 _id: "_id" 4227 attribute: "groups" 4228 description: "description" 4229 _id: "_id" 4230 trackEvents: true 4231 variation: 6 4232 - rollout: 4233 variations: 4234 - weight: 5 4235 variation: 1 4236 - weight: 5 4237 variation: 1 4238 bucketBy: "bucketBy" 4239 clauses: 4240 - op: "in" 4241 negate: true 4242 values: 4243 - "Top Customers" 4244 - "Top Customers" 4245 _id: "_id" 4246 attribute: "groups" 4247 - op: "in" 4248 negate: true 4249 values: 4250 - "Top Customers" 4251 - "Top Customers" 4252 _id: "_id" 4253 attribute: "groups" 4254 description: "description" 4255 _id: "_id" 4256 trackEvents: true 4257 variation: 6 4258 version: 65 4259 targets: 4260 - values: 4261 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4262 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4263 variation: 0 4264 - values: 4265 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4266 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4267 variation: 0 4268 prerequisites: 4269 - key: "key" 4270 variation: 7 4271 - key: "key" 4272 variation: 7 4273 archived: true 4274 trackEventsFallthrough: true 4275 _environmentName: "_environmentName" 4276 _site: 4277 href: "/features/sort.order" 4278 type: "text/html" 4279 sel: "45501b9314dc4641841af774cb038b96" 4280 lastModified: 1469326565348 4281 trackEvents: false 4282 fallthrough: 4283 rollout: 4284 variations: 4285 - weight: 5 4286 variation: 1 4287 - weight: 5 4288 variation: 1 4289 bucketBy: "bucketBy" 4290 variation: 5 4291 offVariation: 2 4292 "on": true 4293 kind: "boolean" 4294 description: "This flag controls whether test feature is turned on or not." 4295 creationDate: 1443652232590 4296 tags: [] 4297 goalIds: 4298 - "d7239405bd89c930e885aa76" 4299 - "405bc930e88d7239d895aa76" 4300 archived: false 4301 includeInSnippet: false 4302 maintainerId: "561c579cd8fd5c2704000001" 4303 customProperties: 4304 bugs: 4305 name: "Issue tracker ids" 4306 value: 4307 - "123" 4308 - "456" 4309 deprecated: 4310 name: "Deprecated Date" 4311 value: [] 4312 defaults: 4313 onVariation: 9 4314 offVariation: 3 4315 variations: 4316 - value: "a" 4317 - value: "b" 4318 name: "Test Feature" 4319 _version: 23 4320 key: "test-feature" 4321 Member: 4322 type: "object" 4323 properties: 4324 _links: 4325 $ref: "#/definitions/Links" 4326 _id: 4327 type: "string" 4328 example: "5a580a01b4ff89217bdf9dc1" 4329 description: "The unique resource id." 4330 role: 4331 $ref: "#/definitions/Role" 4332 email: 4333 type: "string" 4334 example: "user@launchdarkly.com" 4335 firstName: 4336 type: "string" 4337 example: "Alan" 4338 lastName: 4339 type: "string" 4340 example: "Turing" 4341 _verified: 4342 type: "boolean" 4343 _pendingInvite: 4344 type: "boolean" 4345 isBeta: 4346 type: "boolean" 4347 customRoles: 4348 type: "array" 4349 items: 4350 type: "string" 4351 example: "5a580a01b4ff89217bdf9dc1" 4352 description: "The unique resource id." 4353 _lastSeen: 4354 type: "integer" 4355 format: "int64" 4356 example: 1469326565348 4357 description: "A unix epoch time in milliseconds specifying the last time this\ 4358 \ member was active in LaunchDarkly." 4359 _lastSeenMetadata: 4360 $ref: "#/definitions/Member__lastSeenMetadata" 4361 example: 4362 firstName: "Alan" 4363 lastName: "Turing" 4364 _verified: true 4365 role: {} 4366 _links: 4367 next: 4368 href: "/api/v2/endpoint" 4369 type: "application/json" 4370 self: 4371 href: "/api/v2/endpoint" 4372 type: "application/json" 4373 _pendingInvite: true 4374 _lastSeen: 1469326565348 4375 isBeta: true 4376 _id: "5a580a01b4ff89217bdf9dc1" 4377 _lastSeenMetadata: 4378 tokenId: "5fd2a1ee05600316d5cb3e96" 4379 email: "user@launchdarkly.com" 4380 customRoles: 4381 - "5a580a01b4ff89217bdf9dc1" 4382 - "5a580a01b4ff89217bdf9dc1" 4383 Members: 4384 type: "object" 4385 properties: 4386 _links: 4387 $ref: "#/definitions/Links" 4388 items: 4389 type: "array" 4390 items: 4391 $ref: "#/definitions/Member" 4392 totalCount: 4393 type: "number" 4394 example: 4395 _links: 4396 next: 4397 href: "/api/v2/endpoint" 4398 type: "application/json" 4399 self: 4400 href: "/api/v2/endpoint" 4401 type: "application/json" 4402 totalCount: 0.80082819046101150206595775671303272247314453125 4403 items: 4404 - firstName: "Alan" 4405 lastName: "Turing" 4406 _verified: true 4407 role: {} 4408 _links: 4409 next: 4410 href: "/api/v2/endpoint" 4411 type: "application/json" 4412 self: 4413 href: "/api/v2/endpoint" 4414 type: "application/json" 4415 _pendingInvite: true 4416 _lastSeen: 1469326565348 4417 isBeta: true 4418 _id: "5a580a01b4ff89217bdf9dc1" 4419 _lastSeenMetadata: 4420 tokenId: "5fd2a1ee05600316d5cb3e96" 4421 email: "user@launchdarkly.com" 4422 customRoles: 4423 - "5a580a01b4ff89217bdf9dc1" 4424 - "5a580a01b4ff89217bdf9dc1" 4425 - firstName: "Alan" 4426 lastName: "Turing" 4427 _verified: true 4428 role: {} 4429 _links: 4430 next: 4431 href: "/api/v2/endpoint" 4432 type: "application/json" 4433 self: 4434 href: "/api/v2/endpoint" 4435 type: "application/json" 4436 _pendingInvite: true 4437 _lastSeen: 1469326565348 4438 isBeta: true 4439 _id: "5a580a01b4ff89217bdf9dc1" 4440 _lastSeenMetadata: 4441 tokenId: "5fd2a1ee05600316d5cb3e96" 4442 email: "user@launchdarkly.com" 4443 customRoles: 4444 - "5a580a01b4ff89217bdf9dc1" 4445 - "5a580a01b4ff89217bdf9dc1" 4446 FeatureFlagConfig: 4447 type: "object" 4448 properties: 4449 "on": 4450 type: "boolean" 4451 archived: 4452 type: "boolean" 4453 salt: 4454 type: "string" 4455 example: "YWx0ZXJuYXRlLnBhZ2U=" 4456 sel: 4457 type: "string" 4458 example: "45501b9314dc4641841af774cb038b96" 4459 lastModified: 4460 type: "integer" 4461 format: "int64" 4462 example: 1469326565348 4463 version: 4464 type: "integer" 4465 example: 65 4466 targets: 4467 type: "array" 4468 items: 4469 $ref: "#/definitions/Target" 4470 rules: 4471 type: "array" 4472 items: 4473 $ref: "#/definitions/Rule" 4474 fallthrough: 4475 $ref: "#/definitions/Fallthrough" 4476 offVariation: 4477 type: "integer" 4478 prerequisites: 4479 type: "array" 4480 items: 4481 $ref: "#/definitions/Prerequisite" 4482 trackEvents: 4483 type: "boolean" 4484 example: false 4485 description: "Set to true to send detailed event information for this flag." 4486 trackEventsFallthrough: 4487 type: "boolean" 4488 example: true 4489 description: "Set to true to send detailed event information when targeting\ 4490 \ is enabled but no individual targeting rule is matched." 4491 _site: 4492 $ref: "#/definitions/Site" 4493 _environmentName: 4494 type: "string" 4495 example: 4496 salt: "YWx0ZXJuYXRlLnBhZ2U=" 4497 rules: 4498 - rollout: 4499 variations: 4500 - weight: 5 4501 variation: 1 4502 - weight: 5 4503 variation: 1 4504 bucketBy: "bucketBy" 4505 clauses: 4506 - op: "in" 4507 negate: true 4508 values: 4509 - "Top Customers" 4510 - "Top Customers" 4511 _id: "_id" 4512 attribute: "groups" 4513 - op: "in" 4514 negate: true 4515 values: 4516 - "Top Customers" 4517 - "Top Customers" 4518 _id: "_id" 4519 attribute: "groups" 4520 description: "description" 4521 _id: "_id" 4522 trackEvents: true 4523 variation: 6 4524 - rollout: 4525 variations: 4526 - weight: 5 4527 variation: 1 4528 - weight: 5 4529 variation: 1 4530 bucketBy: "bucketBy" 4531 clauses: 4532 - op: "in" 4533 negate: true 4534 values: 4535 - "Top Customers" 4536 - "Top Customers" 4537 _id: "_id" 4538 attribute: "groups" 4539 - op: "in" 4540 negate: true 4541 values: 4542 - "Top Customers" 4543 - "Top Customers" 4544 _id: "_id" 4545 attribute: "groups" 4546 description: "description" 4547 _id: "_id" 4548 trackEvents: true 4549 variation: 6 4550 version: 65 4551 targets: 4552 - values: 4553 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4554 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4555 variation: 0 4556 - values: 4557 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4558 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4559 variation: 0 4560 prerequisites: 4561 - key: "key" 4562 variation: 7 4563 - key: "key" 4564 variation: 7 4565 archived: true 4566 trackEventsFallthrough: true 4567 _environmentName: "_environmentName" 4568 _site: 4569 href: "/features/sort.order" 4570 type: "text/html" 4571 sel: "45501b9314dc4641841af774cb038b96" 4572 lastModified: 1469326565348 4573 trackEvents: false 4574 fallthrough: 4575 rollout: 4576 variations: 4577 - weight: 5 4578 variation: 1 4579 - weight: 5 4580 variation: 1 4581 bucketBy: "bucketBy" 4582 variation: 5 4583 offVariation: 2 4584 "on": true 4585 Target: 4586 type: "object" 4587 properties: 4588 values: 4589 type: "array" 4590 items: 4591 type: "string" 4592 example: "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4593 variation: 4594 type: "integer" 4595 example: 4596 values: 4597 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4598 - "\"1461797806427-7-115540266\", \"00142875-a39d-4028-a3b7-987ccd151649\"" 4599 variation: 0 4600 Rule: 4601 type: "object" 4602 properties: 4603 _id: 4604 type: "string" 4605 variation: 4606 type: "integer" 4607 trackEvents: 4608 type: "boolean" 4609 rollout: 4610 $ref: "#/definitions/Rollout" 4611 clauses: 4612 type: "array" 4613 items: 4614 $ref: "#/definitions/Clause" 4615 description: 4616 type: "string" 4617 example: 4618 rollout: 4619 variations: 4620 - weight: 5 4621 variation: 1 4622 - weight: 5 4623 variation: 1 4624 bucketBy: "bucketBy" 4625 clauses: 4626 - op: "in" 4627 negate: true 4628 values: 4629 - "Top Customers" 4630 - "Top Customers" 4631 _id: "_id" 4632 attribute: "groups" 4633 - op: "in" 4634 negate: true 4635 values: 4636 - "Top Customers" 4637 - "Top Customers" 4638 _id: "_id" 4639 attribute: "groups" 4640 description: "description" 4641 _id: "_id" 4642 trackEvents: true 4643 variation: 6 4644 Fallthrough: 4645 type: "object" 4646 properties: 4647 variation: 4648 type: "integer" 4649 rollout: 4650 $ref: "#/definitions/Rollout" 4651 example: 4652 rollout: 4653 variations: 4654 - weight: 5 4655 variation: 1 4656 - weight: 5 4657 variation: 1 4658 bucketBy: "bucketBy" 4659 variation: 5 4660 Rollout: 4661 type: "object" 4662 properties: 4663 bucketBy: 4664 type: "string" 4665 variations: 4666 type: "array" 4667 items: 4668 $ref: "#/definitions/WeightedVariation" 4669 example: 4670 variations: 4671 - weight: 5 4672 variation: 1 4673 - weight: 5 4674 variation: 1 4675 bucketBy: "bucketBy" 4676 WeightedVariation: 4677 type: "object" 4678 properties: 4679 variation: 4680 type: "integer" 4681 weight: 4682 type: "integer" 4683 example: 4684 weight: 5 4685 variation: 1 4686 Clause: 4687 type: "object" 4688 properties: 4689 _id: 4690 type: "string" 4691 attribute: 4692 type: "string" 4693 example: "groups" 4694 op: 4695 type: "string" 4696 example: "in" 4697 values: 4698 type: "array" 4699 items: 4700 type: "object" 4701 example: "Top Customers" 4702 properties: {} 4703 negate: 4704 type: "boolean" 4705 example: 4706 op: "in" 4707 negate: true 4708 values: 4709 - "Top Customers" 4710 - "Top Customers" 4711 _id: "_id" 4712 attribute: "groups" 4713 Variation: 4714 type: "object" 4715 required: 4716 - "value" 4717 properties: 4718 _id: 4719 type: "string" 4720 example: "24b32dd3-0ba6-46ee-86af-230eebf3c7cb" 4721 name: 4722 type: "string" 4723 example: "True" 4724 description: 4725 type: "string" 4726 example: "The true variation" 4727 value: 4728 type: "object" 4729 properties: {} 4730 Defaults: 4731 type: "object" 4732 required: 4733 - "offVariation" 4734 - "onVariation" 4735 properties: 4736 onVariation: 4737 type: "integer" 4738 description: "The index of the variation to be served when a flag's targeting\ 4739 \ is on (default variation)." 4740 offVariation: 4741 type: "integer" 4742 description: "The index of the variation to be served when a flag is off." 4743 description: "Default values to be used when a new environment is created." 4744 example: 4745 onVariation: 9 4746 offVariation: 3 4747 Prerequisite: 4748 type: "object" 4749 properties: 4750 key: 4751 type: "string" 4752 variation: 4753 type: "integer" 4754 example: 4755 key: "key" 4756 variation: 7 4757 FeatureFlagScheduledChanges: 4758 type: "object" 4759 properties: 4760 _links: 4761 $ref: "#/definitions/Links" 4762 items: 4763 type: "array" 4764 items: 4765 $ref: "#/definitions/FeatureFlagScheduledChange" 4766 example: 4767 _links: 4768 next: 4769 href: "/api/v2/endpoint" 4770 type: "application/json" 4771 self: 4772 href: "/api/v2/endpoint" 4773 type: "application/json" 4774 items: 4775 - instructions: "" 4776 executionDate: 0 4777 _id: "_id" 4778 _version: 6 4779 - instructions: "" 4780 executionDate: 0 4781 _id: "_id" 4782 _version: 6 4783 FeatureFlagScheduledChange: 4784 type: "object" 4785 properties: 4786 executionDate: 4787 type: "integer" 4788 description: "A unix epoch time in milliseconds specifying the date the scheduled\ 4789 \ changes will be applied" 4790 _version: 4791 type: "integer" 4792 _id: 4793 type: "string" 4794 instructions: 4795 $ref: "#/definitions/SemanticPatchInstruction" 4796 example: 4797 instructions: "" 4798 executionDate: 0 4799 _id: "_id" 4800 _version: 6 4801 FeatureFlagScheduledChangesConflicts: 4802 type: "object" 4803 properties: 4804 instructions: 4805 type: "array" 4806 items: 4807 $ref: "#/definitions/FeatureFlagScheduledChangesConflicts_instructions" 4808 example: 4809 instructions: 4810 - kind: "removeUserTargets" 4811 conflicts: 4812 - reason: "reason" 4813 _id: "_id" 4814 - reason: "reason" 4815 _id: "_id" 4816 - kind: "removeUserTargets" 4817 conflicts: 4818 - reason: "reason" 4819 _id: "_id" 4820 - reason: "reason" 4821 _id: "_id" 4822 ScheduledChangesFeatureFlagConflict: 4823 type: "object" 4824 properties: 4825 _id: 4826 type: "string" 4827 description: "Feature flag scheduled change id this change will conflict with" 4828 reason: 4829 type: "string" 4830 description: "Feature flag scheduled change conflict reason" 4831 example: 4832 reason: "reason" 4833 _id: "_id" 4834 ApprovalRequests: 4835 type: "object" 4836 properties: 4837 _links: 4838 $ref: "#/definitions/Links" 4839 items: 4840 type: "array" 4841 items: 4842 $ref: "#/definitions/ApprovalRequest" 4843 example: 4844 _links: 4845 next: 4846 href: "/api/v2/endpoint" 4847 type: "application/json" 4848 self: 4849 href: "/api/v2/endpoint" 4850 type: "application/json" 4851 items: 4852 - allReviews: 4853 - _id: "5a580a01b4ff89217bdf9dc1" 4854 creationDate: 5 4855 memberId: "5a580a01b4ff89217bdf9dc1" 4856 - _id: "5a580a01b4ff89217bdf9dc1" 4857 creationDate: 5 4858 memberId: "5a580a01b4ff89217bdf9dc1" 4859 instructions: "" 4860 notifyMemberIds: 4861 - "memberId" 4862 - "memberId2" 4863 executionDate: 5 4864 appliedDate: 1 4865 creationDate: 6 4866 requestorId: "requestorId" 4867 reviewStatus: {} 4868 appliedByMemberID: "appliedByMemberID" 4869 operatingOnId: "operatingOnId" 4870 _id: "5a580a01b4ff89217bdf9dc1" 4871 _version: 0 4872 status: "pending" 4873 - allReviews: 4874 - _id: "5a580a01b4ff89217bdf9dc1" 4875 creationDate: 5 4876 memberId: "5a580a01b4ff89217bdf9dc1" 4877 - _id: "5a580a01b4ff89217bdf9dc1" 4878 creationDate: 5 4879 memberId: "5a580a01b4ff89217bdf9dc1" 4880 instructions: "" 4881 notifyMemberIds: 4882 - "memberId" 4883 - "memberId2" 4884 executionDate: 5 4885 appliedDate: 1 4886 creationDate: 6 4887 requestorId: "requestorId" 4888 reviewStatus: {} 4889 appliedByMemberID: "appliedByMemberID" 4890 operatingOnId: "operatingOnId" 4891 _id: "5a580a01b4ff89217bdf9dc1" 4892 _version: 0 4893 status: "pending" 4894 ApprovalRequest: 4895 type: "object" 4896 properties: 4897 _id: 4898 type: "string" 4899 example: "5a580a01b4ff89217bdf9dc1" 4900 description: "The unique resource id." 4901 _version: 4902 type: "integer" 4903 creationDate: 4904 type: "integer" 4905 description: "A unix epoch time in milliseconds specifying the date the approval\ 4906 \ request was requested" 4907 requestorId: 4908 type: "string" 4909 description: "The id of the member that requested the change" 4910 reviewStatus: 4911 $ref: "#/definitions/ApprovalRequestReviewStatus" 4912 status: 4913 type: "string" 4914 description: "| Name | Description |\n| ---------:| ----------- |\n|\ 4915 \ pending | the approval request has not been applied yet |\n| completed\ 4916 \ | the approval request has been applied successfully |\n| scheduled |\ 4917 \ the approval request for a scheduled change has been applied successfully\ 4918 \ |\n| failed | the approval request has been applied but the changes\ 4919 \ were not applied successfully |\n" 4920 enum: 4921 - "pending" 4922 - "completed" 4923 - "scheduled" 4924 - "failed" 4925 appliedByMemberID: 4926 type: "string" 4927 description: "The id of the member that applied the approval request" 4928 appliedDate: 4929 type: "integer" 4930 description: "A unix epoch time in milliseconds specifying the date the approval\ 4931 \ request was applied" 4932 allReviews: 4933 type: "array" 4934 items: 4935 $ref: "#/definitions/ApprovalRequestReview" 4936 notifyMemberIds: 4937 type: "array" 4938 example: 4939 - "memberId" 4940 - "memberId2" 4941 items: 4942 type: "string" 4943 instructions: 4944 $ref: "#/definitions/SemanticPatchInstruction" 4945 executionDate: 4946 type: "integer" 4947 format: "int64" 4948 description: "Timestamp for when instructions will be executed" 4949 operatingOnId: 4950 type: "string" 4951 description: "ID of scheduled change to edit or delete" 4952 example: 4953 allReviews: 4954 - _id: "5a580a01b4ff89217bdf9dc1" 4955 creationDate: 5 4956 memberId: "5a580a01b4ff89217bdf9dc1" 4957 - _id: "5a580a01b4ff89217bdf9dc1" 4958 creationDate: 5 4959 memberId: "5a580a01b4ff89217bdf9dc1" 4960 instructions: "" 4961 notifyMemberIds: 4962 - "memberId" 4963 - "memberId2" 4964 executionDate: 5 4965 appliedDate: 1 4966 creationDate: 6 4967 requestorId: "requestorId" 4968 reviewStatus: {} 4969 appliedByMemberID: "appliedByMemberID" 4970 operatingOnId: "operatingOnId" 4971 _id: "5a580a01b4ff89217bdf9dc1" 4972 _version: 0 4973 status: "pending" 4974 ApprovalRequestReview: 4975 type: "object" 4976 properties: 4977 creationDate: 4978 type: "integer" 4979 description: "A unix epoch time in milliseconds specifying the date the approval\ 4980 \ request was reviewed" 4981 kind: 4982 $ref: "#/definitions/ApprovalRequestReviewStatus" 4983 memberId: 4984 type: "string" 4985 example: "5a580a01b4ff89217bdf9dc1" 4986 description: "The unique resource id." 4987 _id: 4988 type: "string" 4989 example: "5a580a01b4ff89217bdf9dc1" 4990 description: "The unique resource id." 4991 example: 4992 _id: "5a580a01b4ff89217bdf9dc1" 4993 creationDate: 5 4994 memberId: "5a580a01b4ff89217bdf9dc1" 4995 ApprovalRequestReviewStatus: 4996 type: "string" 4997 description: "| Name | Description |\n| --------:| ----------- |\n| pending\ 4998 \ | the approval request has not been reviewed yet |\n| approved | the approval\ 4999 \ request has been approved and can now be applied |\n| declined | the approval\ 5000 \ request has been declined and cannot be applied |\n" 5001 enum: 5002 - "pending" 5003 - "approved" 5004 - "declined" 5005 ClientSideAvailability: 5006 type: "object" 5007 properties: 5008 usingEnvironmentId: 5009 type: "boolean" 5010 description: "When set to true, this flag will be available to SDKs using\ 5011 \ the client-side id." 5012 usingMobileKey: 5013 type: "boolean" 5014 description: "When set to true, this flag will be available to SDKS using\ 5015 \ a mobile key." 5016 example: 5017 usingEnvironmentId: true 5018 usingMobileKey: true 5019 FeatureFlagStatus: 5020 type: "object" 5021 properties: 5022 name: 5023 type: "string" 5024 description: "| Name | Description |\n| --------:| ----------- |\n| new\ 5025 \ | the feature flag was created within the last 7 days, and has not\ 5026 \ been requested yet |\n| active | the feature flag was requested by your\ 5027 \ servers or clients within the last 7 days |\n| inactive | the feature\ 5028 \ flag was created more than 7 days ago, and hasn't been requested by your\ 5029 \ servers or clients within the past 7 days |\n| launched | one variation\ 5030 \ of the feature flag has been rolled out to all your users for at least\ 5031 \ 7 days |\n" 5032 enum: 5033 - "new" 5034 - "active" 5035 - "inactive" 5036 - "launched" 5037 lastRequested: 5038 type: "string" 5039 example: "2016-08-16T21:10:11.886Z" 5040 default: 5041 type: "object" 5042 properties: {} 5043 _links: 5044 $ref: "#/definitions/FeatureFlagStatusLinks" 5045 example: 5046 lastRequested: "2016-08-16T21:10:11.886Z" 5047 default: "{}" 5048 _links: 5049 parent: 5050 href: "/api/v2/endpoint" 5051 type: "application/json" 5052 self: 5053 href: "/api/v2/endpoint" 5054 type: "application/json" 5055 name: "new" 5056 FeatureFlagStatuses: 5057 type: "object" 5058 properties: 5059 _links: 5060 $ref: "#/definitions/FeatureFlagStatusLinks" 5061 items: 5062 type: "array" 5063 items: 5064 $ref: "#/definitions/FeatureFlagStatus" 5065 example: 5066 _links: 5067 parent: 5068 href: "/api/v2/endpoint" 5069 type: "application/json" 5070 self: 5071 href: "/api/v2/endpoint" 5072 type: "application/json" 5073 items: 5074 - lastRequested: "2016-08-16T21:10:11.886Z" 5075 default: "{}" 5076 _links: 5077 parent: 5078 href: "/api/v2/endpoint" 5079 type: "application/json" 5080 self: 5081 href: "/api/v2/endpoint" 5082 type: "application/json" 5083 name: "new" 5084 - lastRequested: "2016-08-16T21:10:11.886Z" 5085 default: "{}" 5086 _links: 5087 parent: 5088 href: "/api/v2/endpoint" 5089 type: "application/json" 5090 self: 5091 href: "/api/v2/endpoint" 5092 type: "application/json" 5093 name: "new" 5094 FeatureFlagStatusForQueriedEnvironment: 5095 type: "object" 5096 properties: 5097 name: 5098 type: "string" 5099 description: "| Name | Description |\n| --------:| ----------- |\n| new\ 5100 \ | the feature flag was created within the last 7 days, and has not\ 5101 \ been requested yet |\n| active | the feature flag was requested by your\ 5102 \ servers or clients within the last 7 days |\n| inactive | the feature\ 5103 \ flag was created more than 7 days ago, and hasn't been requested by your\ 5104 \ servers or clients within the past 7 days |\n| launched | one variation\ 5105 \ of the feature flag has been rolled out to all your users for at least\ 5106 \ 7 days |\n" 5107 enum: 5108 - "new" 5109 - "active" 5110 - "inactive" 5111 - "launched" 5112 lastRequested: 5113 type: "string" 5114 example: "2016-08-16T21:10:11.886Z" 5115 default: 5116 type: "object" 5117 properties: {} 5118 example: 5119 lastRequested: "2016-08-16T21:10:11.886Z" 5120 default: "{}" 5121 name: "new" 5122 FeatureFlagStatusAcrossEnvironments: 5123 type: "object" 5124 properties: 5125 _links: 5126 $ref: "#/definitions/FeatureFlagStatusLinks" 5127 key: 5128 type: "string" 5129 environments: 5130 type: "object" 5131 additionalProperties: 5132 $ref: "#/definitions/FeatureFlagStatusForQueriedEnvironment" 5133 example: 5134 _links: 5135 parent: 5136 href: "/api/v2/endpoint" 5137 type: "application/json" 5138 self: 5139 href: "/api/v2/endpoint" 5140 type: "application/json" 5141 environments: 5142 key: 5143 lastRequested: "2016-08-16T21:10:11.886Z" 5144 default: "{}" 5145 name: "new" 5146 key: "key" 5147 FeatureFlagStatusLinks: 5148 type: "object" 5149 properties: 5150 parent: 5151 $ref: "#/definitions/Link" 5152 self: 5153 $ref: "#/definitions/Link" 5154 example: 5155 parent: 5156 href: "/api/v2/endpoint" 5157 type: "application/json" 5158 self: 5159 href: "/api/v2/endpoint" 5160 type: "application/json" 5161 DependentFlagsByEnvironment: 5162 type: "object" 5163 properties: 5164 items: 5165 type: "array" 5166 items: 5167 $ref: "#/definitions/DependentFlag" 5168 _links: 5169 $ref: "#/definitions/DependentFlagsLinks" 5170 _site: 5171 $ref: "#/definitions/Site" 5172 example: 5173 _links: 5174 parent: 5175 href: "/api/v2/endpoint" 5176 type: "application/json" 5177 self: 5178 href: "/api/v2/endpoint" 5179 type: "application/json" 5180 _site: 5181 href: "/features/sort.order" 5182 type: "text/html" 5183 items: 5184 - _links: 5185 self: 5186 href: "/api/v2/endpoint" 5187 type: "application/json" 5188 _site: 5189 href: "/features/sort.order" 5190 type: "text/html" 5191 name: "name" 5192 key: "key" 5193 - _links: 5194 self: 5195 href: "/api/v2/endpoint" 5196 type: "application/json" 5197 _site: 5198 href: "/features/sort.order" 5199 type: "text/html" 5200 name: "name" 5201 key: "key" 5202 DependentFlag: 5203 type: "object" 5204 properties: 5205 name: 5206 type: "string" 5207 key: 5208 type: "string" 5209 _links: 5210 $ref: "#/definitions/DependentFlag__links" 5211 _site: 5212 $ref: "#/definitions/Site" 5213 example: 5214 _links: 5215 self: 5216 href: "/api/v2/endpoint" 5217 type: "application/json" 5218 _site: 5219 href: "/features/sort.order" 5220 type: "text/html" 5221 name: "name" 5222 key: "key" 5223 DependentFlagsLinks: 5224 type: "object" 5225 properties: 5226 parent: 5227 $ref: "#/definitions/Link" 5228 self: 5229 $ref: "#/definitions/Link" 5230 example: 5231 parent: 5232 href: "/api/v2/endpoint" 5233 type: "application/json" 5234 self: 5235 href: "/api/v2/endpoint" 5236 type: "application/json" 5237 MultiEnvironmentDependentFlags: 5238 type: "object" 5239 properties: 5240 items: 5241 type: "array" 5242 items: 5243 $ref: "#/definitions/MultiEnvironmentDependentFlag" 5244 _links: 5245 $ref: "#/definitions/DependentFlagsLinks" 5246 _site: 5247 $ref: "#/definitions/Site" 5248 example: 5249 _links: 5250 parent: 5251 href: "/api/v2/endpoint" 5252 type: "application/json" 5253 self: 5254 href: "/api/v2/endpoint" 5255 type: "application/json" 5256 _site: 5257 href: "/features/sort.order" 5258 type: "text/html" 5259 items: 5260 - environments: 5261 - _links: 5262 flagLink: 5263 href: "/api/v2/endpoint" 5264 type: "application/json" 5265 self: 5266 href: "/api/v2/endpoint" 5267 type: "application/json" 5268 _site: 5269 href: "/features/sort.order" 5270 type: "text/html" 5271 name: "name" 5272 key: "key" 5273 - _links: 5274 flagLink: 5275 href: "/api/v2/endpoint" 5276 type: "application/json" 5277 self: 5278 href: "/api/v2/endpoint" 5279 type: "application/json" 5280 _site: 5281 href: "/features/sort.order" 5282 type: "text/html" 5283 name: "name" 5284 key: "key" 5285 _links: 5286 parent: 5287 href: "/api/v2/endpoint" 5288 type: "application/json" 5289 self: 5290 href: "/api/v2/endpoint" 5291 type: "application/json" 5292 _site: 5293 href: "/features/sort.order" 5294 type: "text/html" 5295 name: "name" 5296 key: "key" 5297 - environments: 5298 - _links: 5299 flagLink: 5300 href: "/api/v2/endpoint" 5301 type: "application/json" 5302 self: 5303 href: "/api/v2/endpoint" 5304 type: "application/json" 5305 _site: 5306 href: "/features/sort.order" 5307 type: "text/html" 5308 name: "name" 5309 key: "key" 5310 - _links: 5311 flagLink: 5312 href: "/api/v2/endpoint" 5313 type: "application/json" 5314 self: 5315 href: "/api/v2/endpoint" 5316 type: "application/json" 5317 _site: 5318 href: "/features/sort.order" 5319 type: "text/html" 5320 name: "name" 5321 key: "key" 5322 _links: 5323 parent: 5324 href: "/api/v2/endpoint" 5325 type: "application/json" 5326 self: 5327 href: "/api/v2/endpoint" 5328 type: "application/json" 5329 _site: 5330 href: "/features/sort.order" 5331 type: "text/html" 5332 name: "name" 5333 key: "key" 5334 MultiEnvironmentDependentFlag: 5335 type: "object" 5336 properties: 5337 name: 5338 type: "string" 5339 key: 5340 type: "string" 5341 environments: 5342 type: "array" 5343 items: 5344 $ref: "#/definitions/DependentFlagEnvironment" 5345 _links: 5346 $ref: "#/definitions/DependentFlagsLinks" 5347 _site: 5348 $ref: "#/definitions/Site" 5349 example: 5350 environments: 5351 - _links: 5352 flagLink: 5353 href: "/api/v2/endpoint" 5354 type: "application/json" 5355 self: 5356 href: "/api/v2/endpoint" 5357 type: "application/json" 5358 _site: 5359 href: "/features/sort.order" 5360 type: "text/html" 5361 name: "name" 5362 key: "key" 5363 - _links: 5364 flagLink: 5365 href: "/api/v2/endpoint" 5366 type: "application/json" 5367 self: 5368 href: "/api/v2/endpoint" 5369 type: "application/json" 5370 _site: 5371 href: "/features/sort.order" 5372 type: "text/html" 5373 name: "name" 5374 key: "key" 5375 _links: 5376 parent: 5377 href: "/api/v2/endpoint" 5378 type: "application/json" 5379 self: 5380 href: "/api/v2/endpoint" 5381 type: "application/json" 5382 _site: 5383 href: "/features/sort.order" 5384 type: "text/html" 5385 name: "name" 5386 key: "key" 5387 DependentFlagEnvironment: 5388 type: "object" 5389 properties: 5390 name: 5391 type: "string" 5392 key: 5393 type: "string" 5394 _links: 5395 $ref: "#/definitions/DependentFlagEnvironment__links" 5396 _site: 5397 $ref: "#/definitions/Site" 5398 example: 5399 _links: 5400 flagLink: 5401 href: "/api/v2/endpoint" 5402 type: "application/json" 5403 self: 5404 href: "/api/v2/endpoint" 5405 type: "application/json" 5406 _site: 5407 href: "/features/sort.order" 5408 type: "text/html" 5409 name: "name" 5410 key: "key" 5411 UserTargetingExpirationForFlags: 5412 type: "object" 5413 properties: 5414 _links: 5415 $ref: "#/definitions/Links" 5416 items: 5417 type: "array" 5418 items: 5419 $ref: "#/definitions/UserTargetingExpirationForFlag" 5420 example: 5421 _links: 5422 next: 5423 href: "/api/v2/endpoint" 5424 type: "application/json" 5425 self: 5426 href: "/api/v2/endpoint" 5427 type: "application/json" 5428 items: 5429 - _resourceId: 5430 projectKey: "projectKey" 5431 kind: "kind" 5432 flagKey: "flagKey" 5433 key: "key" 5434 environmentKey: "environmentKey" 5435 variationId: "variationId" 5436 _links: 5437 next: 5438 href: "/api/v2/endpoint" 5439 type: "application/json" 5440 self: 5441 href: "/api/v2/endpoint" 5442 type: "application/json" 5443 _id: "_id" 5444 _version: 0 5445 userKey: "userKey" 5446 expirationDate: 1735689600000 5447 - _resourceId: 5448 projectKey: "projectKey" 5449 kind: "kind" 5450 flagKey: "flagKey" 5451 key: "key" 5452 environmentKey: "environmentKey" 5453 variationId: "variationId" 5454 _links: 5455 next: 5456 href: "/api/v2/endpoint" 5457 type: "application/json" 5458 self: 5459 href: "/api/v2/endpoint" 5460 type: "application/json" 5461 _id: "_id" 5462 _version: 0 5463 userKey: "userKey" 5464 expirationDate: 1735689600000 5465 UserTargetingExpirationOnFlagsForUser: 5466 type: "object" 5467 properties: 5468 _links: 5469 $ref: "#/definitions/Links" 5470 items: 5471 type: "array" 5472 items: 5473 $ref: "#/definitions/UserTargetingExpirationForFlag" 5474 example: 5475 _links: 5476 next: 5477 href: "/api/v2/endpoint" 5478 type: "application/json" 5479 self: 5480 href: "/api/v2/endpoint" 5481 type: "application/json" 5482 items: 5483 - _resourceId: 5484 projectKey: "projectKey" 5485 kind: "kind" 5486 flagKey: "flagKey" 5487 key: "key" 5488 environmentKey: "environmentKey" 5489 variationId: "variationId" 5490 _links: 5491 next: 5492 href: "/api/v2/endpoint" 5493 type: "application/json" 5494 self: 5495 href: "/api/v2/endpoint" 5496 type: "application/json" 5497 _id: "_id" 5498 _version: 0 5499 userKey: "userKey" 5500 expirationDate: 1735689600000 5501 - _resourceId: 5502 projectKey: "projectKey" 5503 kind: "kind" 5504 flagKey: "flagKey" 5505 key: "key" 5506 environmentKey: "environmentKey" 5507 variationId: "variationId" 5508 _links: 5509 next: 5510 href: "/api/v2/endpoint" 5511 type: "application/json" 5512 self: 5513 href: "/api/v2/endpoint" 5514 type: "application/json" 5515 _id: "_id" 5516 _version: 0 5517 userKey: "userKey" 5518 expirationDate: 1735689600000 5519 UserTargetingExpirationForFlag: 5520 type: "object" 5521 properties: 5522 expirationDate: 5523 type: "integer" 5524 format: "int64" 5525 example: 1735689600000 5526 description: "Unix epoch time in milliseconds specifying the expiration date" 5527 variationId: 5528 type: "string" 5529 description: "the ID of the variation that the user is targeted on a flag" 5530 userKey: 5531 type: "string" 5532 description: "Unique identifier for the user" 5533 _id: 5534 type: "string" 5535 _resourceId: 5536 $ref: "#/definitions/UserTargetingExpirationResourceIdForFlag" 5537 _links: 5538 $ref: "#/definitions/Links" 5539 _version: 5540 type: "integer" 5541 example: 5542 _resourceId: 5543 projectKey: "projectKey" 5544 kind: "kind" 5545 flagKey: "flagKey" 5546 key: "key" 5547 environmentKey: "environmentKey" 5548 variationId: "variationId" 5549 _links: 5550 next: 5551 href: "/api/v2/endpoint" 5552 type: "application/json" 5553 self: 5554 href: "/api/v2/endpoint" 5555 type: "application/json" 5556 _id: "_id" 5557 _version: 0 5558 userKey: "userKey" 5559 expirationDate: 1735689600000 5560 UserTargetingExpirationForSegment: 5561 type: "object" 5562 properties: 5563 expirationDate: 5564 type: "integer" 5565 format: "int64" 5566 example: 1735689600000 5567 description: "Unix epoch time in milliseconds specifying the expiration date" 5568 targetType: 5569 type: "string" 5570 description: "either the included or excluded variation that the user is targeted\ 5571 \ on a segment" 5572 userKey: 5573 type: "string" 5574 description: "Unique identifier for the user" 5575 _id: 5576 type: "string" 5577 _resourceId: 5578 $ref: "#/definitions/UserTargetingExpirationResourceIdForFlag" 5579 _links: 5580 $ref: "#/definitions/Links" 5581 _version: 5582 type: "integer" 5583 example: 5584 _resourceId: 5585 projectKey: "projectKey" 5586 kind: "kind" 5587 flagKey: "flagKey" 5588 key: "key" 5589 environmentKey: "environmentKey" 5590 _links: 5591 next: 5592 href: "/api/v2/endpoint" 5593 type: "application/json" 5594 self: 5595 href: "/api/v2/endpoint" 5596 type: "application/json" 5597 targetType: "targetType" 5598 _id: "_id" 5599 _version: 0 5600 userKey: "userKey" 5601 expirationDate: 1735689600000 5602 UserTargetingExpirationResourceIdForFlag: 5603 type: "object" 5604 properties: 5605 kind: 5606 type: "string" 5607 projectKey: 5608 type: "string" 5609 environmentKey: 5610 type: "string" 5611 flagKey: 5612 type: "string" 5613 key: 5614 type: "string" 5615 example: 5616 projectKey: "projectKey" 5617 kind: "kind" 5618 flagKey: "flagKey" 5619 key: "key" 5620 environmentKey: "environmentKey" 5621 UserSegment: 5622 type: "object" 5623 required: 5624 - "creationDate" 5625 - "key" 5626 - "name" 5627 properties: 5628 key: 5629 type: "string" 5630 example: "beta-testers" 5631 description: "Unique identifier for the user segment." 5632 name: 5633 type: "string" 5634 example: "Beta Testers" 5635 description: "Name of the user segment." 5636 description: 5637 type: "string" 5638 example: "Users in this segment can access beta features." 5639 description: "Description of the user segment." 5640 tags: 5641 type: "array" 5642 example: 5643 - "dev" 5644 - "ops" 5645 description: "An array of tags for this user segment." 5646 items: 5647 type: "string" 5648 creationDate: 5649 type: "integer" 5650 format: "int64" 5651 example: 1443652232590 5652 description: "A unix epoch time in milliseconds specifying the creation time\ 5653 \ of this flag." 5654 included: 5655 type: "array" 5656 description: "An array of user keys that are included in this segment." 5657 items: 5658 type: "string" 5659 excluded: 5660 type: "array" 5661 description: "An array of user keys that should not be included in this segment,\ 5662 \ unless they are also listed in \"included\"." 5663 items: 5664 type: "string" 5665 rules: 5666 type: "array" 5667 description: "An array of rules that can cause a user to be included in this\ 5668 \ segment." 5669 items: 5670 $ref: "#/definitions/UserSegmentRule" 5671 unbounded: 5672 type: "boolean" 5673 example: false 5674 description: "Controls whether this is considered a \"big segment\" which\ 5675 \ can support an unlimited numbers of users. Include/exclude lists sent\ 5676 \ with this payload are not used in big segments. Contact your account manager\ 5677 \ for early access to this feature." 5678 version: 5679 type: "integer" 5680 _links: 5681 $ref: "#/definitions/Links" 5682 _flags: 5683 type: "array" 5684 readOnly: true 5685 items: 5686 $ref: "#/definitions/FlagListItem" 5687 example: 5688 excluded: 5689 - "excluded" 5690 - "excluded" 5691 _flags: 5692 - _links: 5693 next: 5694 href: "/api/v2/endpoint" 5695 type: "application/json" 5696 self: 5697 href: "/api/v2/endpoint" 5698 type: "application/json" 5699 _site: 5700 href: "/features/sort.order" 5701 type: "text/html" 5702 name: "name" 5703 key: "key" 5704 - _links: 5705 next: 5706 href: "/api/v2/endpoint" 5707 type: "application/json" 5708 self: 5709 href: "/api/v2/endpoint" 5710 type: "application/json" 5711 _site: 5712 href: "/features/sort.order" 5713 type: "text/html" 5714 name: "name" 5715 key: "key" 5716 _links: 5717 next: 5718 href: "/api/v2/endpoint" 5719 type: "application/json" 5720 self: 5721 href: "/api/v2/endpoint" 5722 type: "application/json" 5723 name: "Beta Testers" 5724 description: "Users in this segment can access beta features." 5725 rules: 5726 - clauses: 5727 - op: "in" 5728 negate: true 5729 values: 5730 - "Top Customers" 5731 - "Top Customers" 5732 _id: "_id" 5733 attribute: "groups" 5734 - op: "in" 5735 negate: true 5736 values: 5737 - "Top Customers" 5738 - "Top Customers" 5739 _id: "_id" 5740 attribute: "groups" 5741 weight: 0 5742 bucketBy: "bucketBy" 5743 - clauses: 5744 - op: "in" 5745 negate: true 5746 values: 5747 - "Top Customers" 5748 - "Top Customers" 5749 _id: "_id" 5750 attribute: "groups" 5751 - op: "in" 5752 negate: true 5753 values: 5754 - "Top Customers" 5755 - "Top Customers" 5756 _id: "_id" 5757 attribute: "groups" 5758 weight: 0 5759 bucketBy: "bucketBy" 5760 creationDate: 1443652232590 5761 unbounded: false 5762 included: 5763 - "included" 5764 - "included" 5765 version: 6 5766 key: "beta-testers" 5767 tags: 5768 - "dev" 5769 - "ops" 5770 UserSegmentRule: 5771 type: "object" 5772 properties: 5773 clauses: 5774 type: "array" 5775 items: 5776 $ref: "#/definitions/Clause" 5777 weight: 5778 type: "integer" 5779 bucketBy: 5780 type: "string" 5781 example: 5782 clauses: 5783 - op: "in" 5784 negate: true 5785 values: 5786 - "Top Customers" 5787 - "Top Customers" 5788 _id: "_id" 5789 attribute: "groups" 5790 - op: "in" 5791 negate: true 5792 values: 5793 - "Top Customers" 5794 - "Top Customers" 5795 _id: "_id" 5796 attribute: "groups" 5797 weight: 0 5798 bucketBy: "bucketBy" 5799 UserSegments: 5800 type: "object" 5801 properties: 5802 _links: 5803 $ref: "#/definitions/Links" 5804 items: 5805 type: "array" 5806 items: 5807 $ref: "#/definitions/UserSegment" 5808 example: 5809 _links: 5810 next: 5811 href: "/api/v2/endpoint" 5812 type: "application/json" 5813 self: 5814 href: "/api/v2/endpoint" 5815 type: "application/json" 5816 items: 5817 - excluded: 5818 - "excluded" 5819 - "excluded" 5820 _flags: 5821 - _links: 5822 next: 5823 href: "/api/v2/endpoint" 5824 type: "application/json" 5825 self: 5826 href: "/api/v2/endpoint" 5827 type: "application/json" 5828 _site: 5829 href: "/features/sort.order" 5830 type: "text/html" 5831 name: "name" 5832 key: "key" 5833 - _links: 5834 next: 5835 href: "/api/v2/endpoint" 5836 type: "application/json" 5837 self: 5838 href: "/api/v2/endpoint" 5839 type: "application/json" 5840 _site: 5841 href: "/features/sort.order" 5842 type: "text/html" 5843 name: "name" 5844 key: "key" 5845 _links: 5846 next: 5847 href: "/api/v2/endpoint" 5848 type: "application/json" 5849 self: 5850 href: "/api/v2/endpoint" 5851 type: "application/json" 5852 name: "Beta Testers" 5853 description: "Users in this segment can access beta features." 5854 rules: 5855 - clauses: 5856 - op: "in" 5857 negate: true 5858 values: 5859 - "Top Customers" 5860 - "Top Customers" 5861 _id: "_id" 5862 attribute: "groups" 5863 - op: "in" 5864 negate: true 5865 values: 5866 - "Top Customers" 5867 - "Top Customers" 5868 _id: "_id" 5869 attribute: "groups" 5870 weight: 0 5871 bucketBy: "bucketBy" 5872 - clauses: 5873 - op: "in" 5874 negate: true 5875 values: 5876 - "Top Customers" 5877 - "Top Customers" 5878 _id: "_id" 5879 attribute: "groups" 5880 - op: "in" 5881 negate: true 5882 values: 5883 - "Top Customers" 5884 - "Top Customers" 5885 _id: "_id" 5886 attribute: "groups" 5887 weight: 0 5888 bucketBy: "bucketBy" 5889 creationDate: 1443652232590 5890 unbounded: false 5891 included: 5892 - "included" 5893 - "included" 5894 version: 6 5895 key: "beta-testers" 5896 tags: 5897 - "dev" 5898 - "ops" 5899 - excluded: 5900 - "excluded" 5901 - "excluded" 5902 _flags: 5903 - _links: 5904 next: 5905 href: "/api/v2/endpoint" 5906 type: "application/json" 5907 self: 5908 href: "/api/v2/endpoint" 5909 type: "application/json" 5910 _site: 5911 href: "/features/sort.order" 5912 type: "text/html" 5913 name: "name" 5914 key: "key" 5915 - _links: 5916 next: 5917 href: "/api/v2/endpoint" 5918 type: "application/json" 5919 self: 5920 href: "/api/v2/endpoint" 5921 type: "application/json" 5922 _site: 5923 href: "/features/sort.order" 5924 type: "text/html" 5925 name: "name" 5926 key: "key" 5927 _links: 5928 next: 5929 href: "/api/v2/endpoint" 5930 type: "application/json" 5931 self: 5932 href: "/api/v2/endpoint" 5933 type: "application/json" 5934 name: "Beta Testers" 5935 description: "Users in this segment can access beta features." 5936 rules: 5937 - clauses: 5938 - op: "in" 5939 negate: true 5940 values: 5941 - "Top Customers" 5942 - "Top Customers" 5943 _id: "_id" 5944 attribute: "groups" 5945 - op: "in" 5946 negate: true 5947 values: 5948 - "Top Customers" 5949 - "Top Customers" 5950 _id: "_id" 5951 attribute: "groups" 5952 weight: 0 5953 bucketBy: "bucketBy" 5954 - clauses: 5955 - op: "in" 5956 negate: true 5957 values: 5958 - "Top Customers" 5959 - "Top Customers" 5960 _id: "_id" 5961 attribute: "groups" 5962 - op: "in" 5963 negate: true 5964 values: 5965 - "Top Customers" 5966 - "Top Customers" 5967 _id: "_id" 5968 attribute: "groups" 5969 weight: 0 5970 bucketBy: "bucketBy" 5971 creationDate: 1443652232590 5972 unbounded: false 5973 included: 5974 - "included" 5975 - "included" 5976 version: 6 5977 key: "beta-testers" 5978 tags: 5979 - "dev" 5980 - "ops" 5981 BigSegmentTargetChanges: 5982 type: "object" 5983 properties: 5984 add: 5985 type: "array" 5986 example: 5987 - "user@launchdarkly.com" 5988 description: "Users to add to this list of targets" 5989 items: 5990 type: "string" 5991 remove: 5992 type: "array" 5993 example: [] 5994 description: "Users to remove from this list of targets" 5995 items: 5996 type: "string" 5997 Project: 5998 type: "object" 5999 properties: 6000 _links: 6001 $ref: "#/definitions/Links" 6002 _id: 6003 type: "string" 6004 example: "5a580a01b4ff89217bdf9dc1" 6005 description: "The unique resource id." 6006 key: 6007 type: "string" 6008 example: "zentasks" 6009 name: 6010 type: "string" 6011 example: "Zentasks" 6012 includeInSnippetByDefault: 6013 type: "boolean" 6014 example: true 6015 environments: 6016 type: "array" 6017 items: 6018 $ref: "#/definitions/Environment" 6019 tags: 6020 type: "array" 6021 description: "An array of tags for this project." 6022 items: 6023 type: "string" 6024 defaultClientSideAvailability: 6025 $ref: "#/definitions/ClientSideAvailability" 6026 example: 6027 includeInSnippetByDefault: true 6028 _links: 6029 next: 6030 href: "/api/v2/endpoint" 6031 type: "application/json" 6032 self: 6033 href: "/api/v2/endpoint" 6034 type: "application/json" 6035 environments: 6036 - approvalSettings: 6037 serviceKind: "launchdarkly" 6038 canReviewOwnRequest: true 6039 requiredApprovalTags: 6040 - "requiredApprovalTags" 6041 - "requiredApprovalTags" 6042 canApplyDeclinedChanges: true 6043 minNumApprovals: 2 6044 required: true 6045 apiKey: "XXX" 6046 color: "417505" 6047 _links: 6048 next: 6049 href: "/api/v2/endpoint" 6050 type: "application/json" 6051 self: 6052 href: "/api/v2/endpoint" 6053 type: "application/json" 6054 confirmChanges: false 6055 requireComments: false 6056 mobileKey: "XXX" 6057 defaultTrackEvents: false 6058 tags: 6059 - "tags" 6060 - "tags" 6061 name: "Production" 6062 defaultTtl: 0.0 6063 _id: "5a580a01b4ff89217bdf9dc1" 6064 secureMode: false 6065 key: "production" 6066 - approvalSettings: 6067 serviceKind: "launchdarkly" 6068 canReviewOwnRequest: true 6069 requiredApprovalTags: 6070 - "requiredApprovalTags" 6071 - "requiredApprovalTags" 6072 canApplyDeclinedChanges: true 6073 minNumApprovals: 2 6074 required: true 6075 apiKey: "XXX" 6076 color: "417505" 6077 _links: 6078 next: 6079 href: "/api/v2/endpoint" 6080 type: "application/json" 6081 self: 6082 href: "/api/v2/endpoint" 6083 type: "application/json" 6084 confirmChanges: false 6085 requireComments: false 6086 mobileKey: "XXX" 6087 defaultTrackEvents: false 6088 tags: 6089 - "tags" 6090 - "tags" 6091 name: "Production" 6092 defaultTtl: 0.0 6093 _id: "5a580a01b4ff89217bdf9dc1" 6094 secureMode: false 6095 key: "production" 6096 defaultClientSideAvailability: 6097 usingEnvironmentId: true 6098 usingMobileKey: true 6099 name: "Zentasks" 6100 _id: "5a580a01b4ff89217bdf9dc1" 6101 key: "zentasks" 6102 tags: 6103 - "tags" 6104 - "tags" 6105 Projects: 6106 type: "object" 6107 properties: 6108 _links: 6109 $ref: "#/definitions/Links" 6110 items: 6111 type: "array" 6112 items: 6113 $ref: "#/definitions/Project" 6114 example: 6115 _links: 6116 next: 6117 href: "/api/v2/endpoint" 6118 type: "application/json" 6119 self: 6120 href: "/api/v2/endpoint" 6121 type: "application/json" 6122 items: 6123 - includeInSnippetByDefault: true 6124 _links: 6125 next: 6126 href: "/api/v2/endpoint" 6127 type: "application/json" 6128 self: 6129 href: "/api/v2/endpoint" 6130 type: "application/json" 6131 environments: 6132 - approvalSettings: 6133 serviceKind: "launchdarkly" 6134 canReviewOwnRequest: true 6135 requiredApprovalTags: 6136 - "requiredApprovalTags" 6137 - "requiredApprovalTags" 6138 canApplyDeclinedChanges: true 6139 minNumApprovals: 2 6140 required: true 6141 apiKey: "XXX" 6142 color: "417505" 6143 _links: 6144 next: 6145 href: "/api/v2/endpoint" 6146 type: "application/json" 6147 self: 6148 href: "/api/v2/endpoint" 6149 type: "application/json" 6150 confirmChanges: false 6151 requireComments: false 6152 mobileKey: "XXX" 6153 defaultTrackEvents: false 6154 tags: 6155 - "tags" 6156 - "tags" 6157 name: "Production" 6158 defaultTtl: 0.0 6159 _id: "5a580a01b4ff89217bdf9dc1" 6160 secureMode: false 6161 key: "production" 6162 - approvalSettings: 6163 serviceKind: "launchdarkly" 6164 canReviewOwnRequest: true 6165 requiredApprovalTags: 6166 - "requiredApprovalTags" 6167 - "requiredApprovalTags" 6168 canApplyDeclinedChanges: true 6169 minNumApprovals: 2 6170 required: true 6171 apiKey: "XXX" 6172 color: "417505" 6173 _links: 6174 next: 6175 href: "/api/v2/endpoint" 6176 type: "application/json" 6177 self: 6178 href: "/api/v2/endpoint" 6179 type: "application/json" 6180 confirmChanges: false 6181 requireComments: false 6182 mobileKey: "XXX" 6183 defaultTrackEvents: false 6184 tags: 6185 - "tags" 6186 - "tags" 6187 name: "Production" 6188 defaultTtl: 0.0 6189 _id: "5a580a01b4ff89217bdf9dc1" 6190 secureMode: false 6191 key: "production" 6192 defaultClientSideAvailability: 6193 usingEnvironmentId: true 6194 usingMobileKey: true 6195 name: "Zentasks" 6196 _id: "5a580a01b4ff89217bdf9dc1" 6197 key: "zentasks" 6198 tags: 6199 - "tags" 6200 - "tags" 6201 - includeInSnippetByDefault: true 6202 _links: 6203 next: 6204 href: "/api/v2/endpoint" 6205 type: "application/json" 6206 self: 6207 href: "/api/v2/endpoint" 6208 type: "application/json" 6209 environments: 6210 - approvalSettings: 6211 serviceKind: "launchdarkly" 6212 canReviewOwnRequest: true 6213 requiredApprovalTags: 6214 - "requiredApprovalTags" 6215 - "requiredApprovalTags" 6216 canApplyDeclinedChanges: true 6217 minNumApprovals: 2 6218 required: true 6219 apiKey: "XXX" 6220 color: "417505" 6221 _links: 6222 next: 6223 href: "/api/v2/endpoint" 6224 type: "application/json" 6225 self: 6226 href: "/api/v2/endpoint" 6227 type: "application/json" 6228 confirmChanges: false 6229 requireComments: false 6230 mobileKey: "XXX" 6231 defaultTrackEvents: false 6232 tags: 6233 - "tags" 6234 - "tags" 6235 name: "Production" 6236 defaultTtl: 0.0 6237 _id: "5a580a01b4ff89217bdf9dc1" 6238 secureMode: false 6239 key: "production" 6240 - approvalSettings: 6241 serviceKind: "launchdarkly" 6242 canReviewOwnRequest: true 6243 requiredApprovalTags: 6244 - "requiredApprovalTags" 6245 - "requiredApprovalTags" 6246 canApplyDeclinedChanges: true 6247 minNumApprovals: 2 6248 required: true 6249 apiKey: "XXX" 6250 color: "417505" 6251 _links: 6252 next: 6253 href: "/api/v2/endpoint" 6254 type: "application/json" 6255 self: 6256 href: "/api/v2/endpoint" 6257 type: "application/json" 6258 confirmChanges: false 6259 requireComments: false 6260 mobileKey: "XXX" 6261 defaultTrackEvents: false 6262 tags: 6263 - "tags" 6264 - "tags" 6265 name: "Production" 6266 defaultTtl: 0.0 6267 _id: "5a580a01b4ff89217bdf9dc1" 6268 secureMode: false 6269 key: "production" 6270 defaultClientSideAvailability: 6271 usingEnvironmentId: true 6272 usingMobileKey: true 6273 name: "Zentasks" 6274 _id: "5a580a01b4ff89217bdf9dc1" 6275 key: "zentasks" 6276 tags: 6277 - "tags" 6278 - "tags" 6279 Destination: 6280 type: "object" 6281 properties: 6282 _links: 6283 $ref: "#/definitions/Links" 6284 _id: 6285 type: "string" 6286 example: "37ed9aad-de0a-4665-932e-41c35587aeea" 6287 description: "Unique destination ID." 6288 name: 6289 type: "string" 6290 example: "Example Google Pub/Sub Destination" 6291 description: "The destination name" 6292 kind: 6293 type: "string" 6294 example: "google-pubsub" 6295 description: "Destination type (\"google-pubsub\", \"kinesis\", \"mparticle\"\ 6296 , or \"segment\")" 6297 enum: 6298 - "google-pubsub" 6299 - "kinesis" 6300 - "mparticle" 6301 - "segment" 6302 config: 6303 type: "object" 6304 example: 6305 project: "cool-project" 6306 topic: "test" 6307 description: "destination-specific configuration." 6308 properties: {} 6309 "on": 6310 type: "boolean" 6311 example: true 6312 description: "Whether the data export destination is on or not." 6313 version: 6314 type: "integer" 6315 example: 2 6316 example: 6317 _links: 6318 next: 6319 href: "/api/v2/endpoint" 6320 type: "application/json" 6321 self: 6322 href: "/api/v2/endpoint" 6323 type: "application/json" 6324 kind: "google-pubsub" 6325 name: "Example Google Pub/Sub Destination" 6326 _id: "37ed9aad-de0a-4665-932e-41c35587aeea" 6327 config: 6328 project: "cool-project" 6329 topic: "test" 6330 version: 2 6331 "on": true 6332 Destinations: 6333 type: "object" 6334 properties: 6335 _links: 6336 $ref: "#/definitions/Links" 6337 items: 6338 type: "array" 6339 items: 6340 $ref: "#/definitions/Destination" 6341 example: 6342 _links: 6343 next: 6344 href: "/api/v2/endpoint" 6345 type: "application/json" 6346 self: 6347 href: "/api/v2/endpoint" 6348 type: "application/json" 6349 items: 6350 - _links: 6351 next: 6352 href: "/api/v2/endpoint" 6353 type: "application/json" 6354 self: 6355 href: "/api/v2/endpoint" 6356 type: "application/json" 6357 kind: "google-pubsub" 6358 name: "Example Google Pub/Sub Destination" 6359 _id: "37ed9aad-de0a-4665-932e-41c35587aeea" 6360 config: 6361 project: "cool-project" 6362 topic: "test" 6363 version: 2 6364 "on": true 6365 - _links: 6366 next: 6367 href: "/api/v2/endpoint" 6368 type: "application/json" 6369 self: 6370 href: "/api/v2/endpoint" 6371 type: "application/json" 6372 kind: "google-pubsub" 6373 name: "Example Google Pub/Sub Destination" 6374 _id: "37ed9aad-de0a-4665-932e-41c35587aeea" 6375 config: 6376 project: "cool-project" 6377 topic: "test" 6378 version: 2 6379 "on": true 6380 DestinationGooglePubSub: 6381 type: "object" 6382 properties: 6383 project: 6384 type: "string" 6385 example: "cool-project" 6386 topic: 6387 type: "string" 6388 example: "test" 6389 DestinationAmazonKinesis: 6390 type: "object" 6391 properties: 6392 region: 6393 type: "string" 6394 example: "us-east-1" 6395 roleArn: 6396 type: "string" 6397 example: "arn:aws:iam::123456789012:role/marketingadmin" 6398 streamName: 6399 type: "string" 6400 example: "cat-stream" 6401 DestinationMParticle: 6402 type: "object" 6403 properties: 6404 apiKey: 6405 type: "string" 6406 example: "apiKeyfromMParticle" 6407 secret: 6408 type: "string" 6409 example: "mParticleSecret" 6410 userIdentity: 6411 type: "string" 6412 example: "customer_id" 6413 environment: 6414 type: "string" 6415 example: "production" 6416 DestinationSegment: 6417 type: "object" 6418 properties: 6419 writeKey: 6420 type: "string" 6421 example: "segmentWriteKey" 6422 Environment: 6423 type: "object" 6424 properties: 6425 _links: 6426 $ref: "#/definitions/Links" 6427 _id: 6428 type: "string" 6429 example: "5a580a01b4ff89217bdf9dc1" 6430 description: "The unique resource id." 6431 key: 6432 type: "string" 6433 example: "production" 6434 description: "The key for the environment." 6435 name: 6436 type: "string" 6437 example: "Production" 6438 description: "The name of the environment." 6439 apiKey: 6440 type: "string" 6441 example: "XXX" 6442 description: "The SDK key for backend LaunchDarkly SDKs." 6443 mobileKey: 6444 type: "string" 6445 example: "XXX" 6446 description: "The SDK key for mobile LaunchDarkly SDKs." 6447 color: 6448 type: "string" 6449 example: "417505" 6450 description: "The swatch color for the environment." 6451 defaultTtl: 6452 type: "number" 6453 example: 0.0 6454 description: "The default TTL." 6455 secureMode: 6456 type: "boolean" 6457 example: false 6458 description: "Determines if this environment is in safe mode." 6459 defaultTrackEvents: 6460 type: "boolean" 6461 example: false 6462 description: "Set to true to send detailed event information for new flags." 6463 tags: 6464 type: "array" 6465 description: "An array of tags for this environment." 6466 items: 6467 type: "string" 6468 requireComments: 6469 type: "boolean" 6470 example: false 6471 description: "Determines if this environment requires comments for flag and\ 6472 \ segment changes." 6473 confirmChanges: 6474 type: "boolean" 6475 example: false 6476 description: "Determines if this environment requires confirmation for flag\ 6477 \ and segment changes." 6478 approvalSettings: 6479 $ref: "#/definitions/Environment_approvalSettings" 6480 example: 6481 approvalSettings: 6482 serviceKind: "launchdarkly" 6483 canReviewOwnRequest: true 6484 requiredApprovalTags: 6485 - "requiredApprovalTags" 6486 - "requiredApprovalTags" 6487 canApplyDeclinedChanges: true 6488 minNumApprovals: 2 6489 required: true 6490 apiKey: "XXX" 6491 color: "417505" 6492 _links: 6493 next: 6494 href: "/api/v2/endpoint" 6495 type: "application/json" 6496 self: 6497 href: "/api/v2/endpoint" 6498 type: "application/json" 6499 confirmChanges: false 6500 requireComments: false 6501 mobileKey: "XXX" 6502 defaultTrackEvents: false 6503 tags: 6504 - "tags" 6505 - "tags" 6506 name: "Production" 6507 defaultTtl: 0.0 6508 _id: "5a580a01b4ff89217bdf9dc1" 6509 secureMode: false 6510 key: "production" 6511 EnvironmentPost: 6512 type: "object" 6513 required: 6514 - "color" 6515 - "key" 6516 - "name" 6517 properties: 6518 name: 6519 type: "string" 6520 example: "Development" 6521 description: "The name of the new environment." 6522 key: 6523 type: "string" 6524 example: "dev" 6525 description: "A project-unique key for the new environment." 6526 color: 6527 type: "string" 6528 example: "417505" 6529 description: "A color swatch (as an RGB hex value with no leading '#', e.g.\ 6530 \ C8C8C8)." 6531 defaultTtl: 6532 type: "number" 6533 example: 0.0 6534 description: "The default TTL for the new environment." 6535 secureMode: 6536 type: "boolean" 6537 example: false 6538 description: "Determines whether the environment is in secure mode." 6539 defaultTrackEvents: 6540 type: "boolean" 6541 example: false 6542 description: "Set to true to send detailed event information for newly created\ 6543 \ flags." 6544 tags: 6545 type: "array" 6546 example: 6547 - "tag1" 6548 - "tag2" 6549 description: "An array of tags for this environment." 6550 items: 6551 type: "string" 6552 requireComments: 6553 type: "boolean" 6554 example: false 6555 description: "Determines if this environment requires comments for flag and\ 6556 \ segment changes." 6557 confirmChanges: 6558 type: "boolean" 6559 example: false 6560 description: "Determines if this environment requires confirmation for flag\ 6561 \ and segment changes." 6562 example: 6563 color: "417505" 6564 confirmChanges: false 6565 name: "Development" 6566 defaultTtl: 0.0 6567 requireComments: false 6568 secureMode: false 6569 defaultTrackEvents: false 6570 key: "dev" 6571 tags: 6572 - "tag1" 6573 - "tag2" 6574 User: 6575 type: "object" 6576 properties: 6577 key: 6578 type: "string" 6579 example: "a00bea" 6580 secondary: 6581 type: "string" 6582 ip: 6583 type: "string" 6584 country: 6585 type: "string" 6586 email: 6587 type: "string" 6588 firstName: 6589 type: "string" 6590 lastName: 6591 type: "string" 6592 avatar: 6593 type: "string" 6594 name: 6595 type: "string" 6596 example: "Bob Loblaw" 6597 anonymous: 6598 type: "boolean" 6599 custom: 6600 type: "object" 6601 example: 6602 company: "example.com" 6603 properties: {} 6604 example: 6605 secondary: "secondary" 6606 country: "country" 6607 firstName: "firstName" 6608 lastName: "lastName" 6609 ip: "ip" 6610 custom: 6611 company: "example.com" 6612 name: "Bob Loblaw" 6613 anonymous: true 6614 avatar: "avatar" 6615 key: "a00bea" 6616 email: "email" 6617 UserRecord: 6618 type: "object" 6619 properties: 6620 lastPing: 6621 type: "string" 6622 example: "2015-03-03T02:37:22.492Z" 6623 environmentId: 6624 type: "string" 6625 example: "54ac2d97de674204ddd61096" 6626 ownerId: 6627 type: "string" 6628 example: "5a580a01b4ff89217bdf9dc1" 6629 description: "The unique resource id." 6630 user: 6631 $ref: "#/definitions/User" 6632 avatar: 6633 type: "string" 6634 example: "https://s3.amazonaws.com/uifaces/faces/twitter/shylockjoy/73.jpg" 6635 example: 6636 environmentId: "54ac2d97de674204ddd61096" 6637 lastPing: "2015-03-03T02:37:22.492Z" 6638 avatar: "https://s3.amazonaws.com/uifaces/faces/twitter/shylockjoy/73.jpg" 6639 ownerId: "5a580a01b4ff89217bdf9dc1" 6640 user: 6641 secondary: "secondary" 6642 country: "country" 6643 firstName: "firstName" 6644 lastName: "lastName" 6645 ip: "ip" 6646 custom: 6647 company: "example.com" 6648 name: "Bob Loblaw" 6649 anonymous: true 6650 avatar: "avatar" 6651 key: "a00bea" 6652 email: "email" 6653 Users: 6654 type: "object" 6655 properties: 6656 _links: 6657 $ref: "#/definitions/Links" 6658 totalCount: 6659 type: "number" 6660 example: 3.0 6661 items: 6662 type: "array" 6663 items: 6664 $ref: "#/definitions/UserRecord" 6665 example: 6666 _links: 6667 next: 6668 href: "/api/v2/endpoint" 6669 type: "application/json" 6670 self: 6671 href: "/api/v2/endpoint" 6672 type: "application/json" 6673 totalCount: 3.0 6674 items: 6675 - environmentId: "54ac2d97de674204ddd61096" 6676 lastPing: "2015-03-03T02:37:22.492Z" 6677 avatar: "https://s3.amazonaws.com/uifaces/faces/twitter/shylockjoy/73.jpg" 6678 ownerId: "5a580a01b4ff89217bdf9dc1" 6679 user: 6680 secondary: "secondary" 6681 country: "country" 6682 firstName: "firstName" 6683 lastName: "lastName" 6684 ip: "ip" 6685 custom: 6686 company: "example.com" 6687 name: "Bob Loblaw" 6688 anonymous: true 6689 avatar: "avatar" 6690 key: "a00bea" 6691 email: "email" 6692 - environmentId: "54ac2d97de674204ddd61096" 6693 lastPing: "2015-03-03T02:37:22.492Z" 6694 avatar: "https://s3.amazonaws.com/uifaces/faces/twitter/shylockjoy/73.jpg" 6695 ownerId: "5a580a01b4ff89217bdf9dc1" 6696 user: 6697 secondary: "secondary" 6698 country: "country" 6699 firstName: "firstName" 6700 lastName: "lastName" 6701 ip: "ip" 6702 custom: 6703 company: "example.com" 6704 name: "Bob Loblaw" 6705 anonymous: true 6706 avatar: "avatar" 6707 key: "a00bea" 6708 email: "email" 6709 AuditLogEntry: 6710 type: "object" 6711 properties: 6712 _links: 6713 $ref: "#/definitions/Links" 6714 _id: 6715 type: "string" 6716 example: "5a580a01b4ff89217bdf9dc1" 6717 description: "The unique resource id." 6718 date: 6719 type: "integer" 6720 format: "int64" 6721 example: 1472243938774 6722 kind: 6723 type: "string" 6724 example: "environment" 6725 name: 6726 type: "string" 6727 example: "Testing" 6728 description: 6729 type: "string" 6730 example: "Changed the name from Test to Testing" 6731 shortDescription: 6732 type: "string" 6733 example: "\"\"" 6734 comment: 6735 type: "string" 6736 example: "This is a comment string" 6737 member: 6738 $ref: "#/definitions/Member" 6739 titleVerb: 6740 type: "string" 6741 example: "changed the name of" 6742 title: 6743 type: "string" 6744 example: "[Reese Applebaum](mailto:refapp@launchdarkly.com) changed the name\ 6745 \ of [Testing](https://app.launchdarkly.com/settings#/projects)" 6746 target: 6747 $ref: "#/definitions/AuditLogEntry_target" 6748 example: 6749 date: 1472243938774 6750 titleVerb: "changed the name of" 6751 _links: 6752 next: 6753 href: "/api/v2/endpoint" 6754 type: "application/json" 6755 self: 6756 href: "/api/v2/endpoint" 6757 type: "application/json" 6758 kind: "environment" 6759 name: "Testing" 6760 member: 6761 firstName: "Alan" 6762 lastName: "Turing" 6763 _verified: true 6764 role: {} 6765 _links: 6766 next: 6767 href: "/api/v2/endpoint" 6768 type: "application/json" 6769 self: 6770 href: "/api/v2/endpoint" 6771 type: "application/json" 6772 _pendingInvite: true 6773 _lastSeen: 1469326565348 6774 isBeta: true 6775 _id: "5a580a01b4ff89217bdf9dc1" 6776 _lastSeenMetadata: 6777 tokenId: "5fd2a1ee05600316d5cb3e96" 6778 email: "user@launchdarkly.com" 6779 customRoles: 6780 - "5a580a01b4ff89217bdf9dc1" 6781 - "5a580a01b4ff89217bdf9dc1" 6782 description: "Changed the name from Test to Testing" 6783 comment: "This is a comment string" 6784 _id: "5a580a01b4ff89217bdf9dc1" 6785 shortDescription: "\"\"" 6786 title: "[Reese Applebaum](mailto:refapp@launchdarkly.com) changed the name of\ 6787 \ [Testing](https://app.launchdarkly.com/settings#/projects)" 6788 target: 6789 _links: 6790 next: 6791 href: "/api/v2/endpoint" 6792 type: "application/json" 6793 self: 6794 href: "/api/v2/endpoint" 6795 type: "application/json" 6796 name: "Testing" 6797 resources: 6798 - "proj/alexis:env/test" 6799 - "proj/alexis:env/test" 6800 AuditLogEntries: 6801 type: "object" 6802 properties: 6803 _links: 6804 $ref: "#/definitions/Links" 6805 items: 6806 type: "array" 6807 items: 6808 $ref: "#/definitions/AuditLogEntry" 6809 example: 6810 _links: 6811 next: 6812 href: "/api/v2/endpoint" 6813 type: "application/json" 6814 self: 6815 href: "/api/v2/endpoint" 6816 type: "application/json" 6817 items: 6818 - date: 1472243938774 6819 titleVerb: "changed the name of" 6820 _links: 6821 next: 6822 href: "/api/v2/endpoint" 6823 type: "application/json" 6824 self: 6825 href: "/api/v2/endpoint" 6826 type: "application/json" 6827 kind: "environment" 6828 name: "Testing" 6829 member: 6830 firstName: "Alan" 6831 lastName: "Turing" 6832 _verified: true 6833 role: {} 6834 _links: 6835 next: 6836 href: "/api/v2/endpoint" 6837 type: "application/json" 6838 self: 6839 href: "/api/v2/endpoint" 6840 type: "application/json" 6841 _pendingInvite: true 6842 _lastSeen: 1469326565348 6843 isBeta: true 6844 _id: "5a580a01b4ff89217bdf9dc1" 6845 _lastSeenMetadata: 6846 tokenId: "5fd2a1ee05600316d5cb3e96" 6847 email: "user@launchdarkly.com" 6848 customRoles: 6849 - "5a580a01b4ff89217bdf9dc1" 6850 - "5a580a01b4ff89217bdf9dc1" 6851 description: "Changed the name from Test to Testing" 6852 comment: "This is a comment string" 6853 _id: "5a580a01b4ff89217bdf9dc1" 6854 shortDescription: "\"\"" 6855 title: "[Reese Applebaum](mailto:refapp@launchdarkly.com) changed the name\ 6856 \ of [Testing](https://app.launchdarkly.com/settings#/projects)" 6857 target: 6858 _links: 6859 next: 6860 href: "/api/v2/endpoint" 6861 type: "application/json" 6862 self: 6863 href: "/api/v2/endpoint" 6864 type: "application/json" 6865 name: "Testing" 6866 resources: 6867 - "proj/alexis:env/test" 6868 - "proj/alexis:env/test" 6869 - date: 1472243938774 6870 titleVerb: "changed the name of" 6871 _links: 6872 next: 6873 href: "/api/v2/endpoint" 6874 type: "application/json" 6875 self: 6876 href: "/api/v2/endpoint" 6877 type: "application/json" 6878 kind: "environment" 6879 name: "Testing" 6880 member: 6881 firstName: "Alan" 6882 lastName: "Turing" 6883 _verified: true 6884 role: {} 6885 _links: 6886 next: 6887 href: "/api/v2/endpoint" 6888 type: "application/json" 6889 self: 6890 href: "/api/v2/endpoint" 6891 type: "application/json" 6892 _pendingInvite: true 6893 _lastSeen: 1469326565348 6894 isBeta: true 6895 _id: "5a580a01b4ff89217bdf9dc1" 6896 _lastSeenMetadata: 6897 tokenId: "5fd2a1ee05600316d5cb3e96" 6898 email: "user@launchdarkly.com" 6899 customRoles: 6900 - "5a580a01b4ff89217bdf9dc1" 6901 - "5a580a01b4ff89217bdf9dc1" 6902 description: "Changed the name from Test to Testing" 6903 comment: "This is a comment string" 6904 _id: "5a580a01b4ff89217bdf9dc1" 6905 shortDescription: "\"\"" 6906 title: "[Reese Applebaum](mailto:refapp@launchdarkly.com) changed the name\ 6907 \ of [Testing](https://app.launchdarkly.com/settings#/projects)" 6908 target: 6909 _links: 6910 next: 6911 href: "/api/v2/endpoint" 6912 type: "application/json" 6913 self: 6914 href: "/api/v2/endpoint" 6915 type: "application/json" 6916 name: "Testing" 6917 resources: 6918 - "proj/alexis:env/test" 6919 - "proj/alexis:env/test" 6920 UserFlagSetting: 6921 type: "object" 6922 properties: 6923 _links: 6924 $ref: "#/definitions/Links" 6925 _value: 6926 type: "boolean" 6927 example: true 6928 description: "The most important attribute in the response. The _value is\ 6929 \ the current setting for the user. For a boolean feature toggle, this will\ 6930 \ be true, false, or null if there is no defined fallthrough value." 6931 setting: 6932 type: "boolean" 6933 description: "The setting attribute indicates whether you've explicitly targeted\ 6934 \ this user to receive a particular variation. For example, if you have\ 6935 \ explicitly turned off a feature toggle for a user, setting will be false.\ 6936 \ A setting of null means that you haven't assigned that user to a specific\ 6937 \ variation." 6938 example: 6939 _links: 6940 next: 6941 href: "/api/v2/endpoint" 6942 type: "application/json" 6943 self: 6944 href: "/api/v2/endpoint" 6945 type: "application/json" 6946 _value: true 6947 setting: true 6948 UserFlagSettings: 6949 type: "object" 6950 properties: 6951 _links: 6952 $ref: "#/definitions/Links" 6953 items: 6954 type: "object" 6955 example: 6956 sort.order: 6957 _links: 6958 self: 6959 href: "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order" 6960 type: "application/json" 6961 _value: true 6962 alternate.page: 6963 _links: 6964 self: 6965 href: "/api/v2/users/lacuna/production/Abbie_Braun/flags/alternate.page" 6966 type: "application/json" 6967 _value: "false," 6968 additionalProperties: 6969 $ref: "#/definitions/UserFlagSetting" 6970 example: 6971 _links: 6972 next: 6973 href: "/api/v2/endpoint" 6974 type: "application/json" 6975 self: 6976 href: "/api/v2/endpoint" 6977 type: "application/json" 6978 items: 6979 sort.order: 6980 _links: 6981 self: 6982 href: "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order" 6983 type: "application/json" 6984 _value: true 6985 alternate.page: 6986 _links: 6987 self: 6988 href: "/api/v2/users/lacuna/production/Abbie_Braun/flags/alternate.page" 6989 type: "application/json" 6990 _value: "false," 6991 Statement: 6992 type: "object" 6993 properties: 6994 resources: 6995 type: "array" 6996 items: 6997 type: "string" 6998 example: "proj/*:env/*:flag/my-flag" 6999 description: "A resource specifier string" 7000 notResources: 7001 type: "array" 7002 description: "Targeted resource will be those resources NOT in this list.\ 7003 \ The \"resources`\" field must be empty to use this field." 7004 items: 7005 type: "string" 7006 example: "proj/*:env/*:flag/my-flag" 7007 description: "A resource specifier string" 7008 actions: 7009 type: "array" 7010 items: 7011 type: "string" 7012 example: "updateOn" 7013 description: "An action to perform on a resource." 7014 notActions: 7015 type: "array" 7016 description: "Targeted actions will be those actions NOT in this list. The\ 7017 \ \"actions\" field must be empty to use this field." 7018 items: 7019 type: "string" 7020 example: "updateOn" 7021 description: "An action to perform on a resource." 7022 effect: 7023 type: "string" 7024 enum: 7025 - "allow" 7026 - "deny" 7027 example: 7028 notActions: 7029 - "updateOn" 7030 - "updateOn" 7031 notResources: 7032 - "proj/*:env/*:flag/my-flag" 7033 - "proj/*:env/*:flag/my-flag" 7034 effect: "allow" 7035 resources: 7036 - "proj/*:env/*:flag/my-flag" 7037 - "proj/*:env/*:flag/my-flag" 7038 actions: 7039 - "updateOn" 7040 - "updateOn" 7041 Role: 7042 type: "string" 7043 enum: 7044 - "writer" 7045 - "reader" 7046 - "admin" 7047 - "owner" 7048 CustomRole: 7049 type: "object" 7050 properties: 7051 _links: 7052 $ref: "#/definitions/Links" 7053 name: 7054 type: "string" 7055 example: "revenue team" 7056 description: "Name of the custom role." 7057 key: 7058 type: "string" 7059 example: "revenue-team" 7060 description: "The 20-hexdigit id or the key for a custom role." 7061 description: 7062 type: "string" 7063 example: "Description of revenue team role here" 7064 description: "Description of the custom role." 7065 _id: 7066 type: "string" 7067 example: "5a580a01b4ff89217bdf9dc1" 7068 description: "The unique resource id." 7069 policy: 7070 type: "array" 7071 items: 7072 $ref: "#/definitions/Policy" 7073 example: 7074 _links: 7075 next: 7076 href: "/api/v2/endpoint" 7077 type: "application/json" 7078 self: 7079 href: "/api/v2/endpoint" 7080 type: "application/json" 7081 name: "revenue team" 7082 description: "Description of revenue team role here" 7083 _id: "5a580a01b4ff89217bdf9dc1" 7084 key: "revenue-team" 7085 policy: 7086 - notActions: 7087 - "updateOn" 7088 - "updateOn" 7089 notResources: 7090 - "proj/*:env/*:flag/my-flag" 7091 - "proj/*:env/*:flag/my-flag" 7092 effect: "deny" 7093 resources: 7094 - "proj/*:env/*:flag/my-flag" 7095 - "proj/*:env/*:flag/my-flag" 7096 actions: 7097 - "updateOn" 7098 - "updateOn" 7099 - notActions: 7100 - "updateOn" 7101 - "updateOn" 7102 notResources: 7103 - "proj/*:env/*:flag/my-flag" 7104 - "proj/*:env/*:flag/my-flag" 7105 effect: "deny" 7106 resources: 7107 - "proj/*:env/*:flag/my-flag" 7108 - "proj/*:env/*:flag/my-flag" 7109 actions: 7110 - "updateOn" 7111 - "updateOn" 7112 CustomRoles: 7113 type: "object" 7114 properties: 7115 _links: 7116 $ref: "#/definitions/Links" 7117 items: 7118 type: "array" 7119 items: 7120 $ref: "#/definitions/CustomRole" 7121 example: 7122 _links: 7123 next: 7124 href: "/api/v2/endpoint" 7125 type: "application/json" 7126 self: 7127 href: "/api/v2/endpoint" 7128 type: "application/json" 7129 items: 7130 - _links: 7131 next: 7132 href: "/api/v2/endpoint" 7133 type: "application/json" 7134 self: 7135 href: "/api/v2/endpoint" 7136 type: "application/json" 7137 name: "revenue team" 7138 description: "Description of revenue team role here" 7139 _id: "5a580a01b4ff89217bdf9dc1" 7140 key: "revenue-team" 7141 policy: 7142 - notActions: 7143 - "updateOn" 7144 - "updateOn" 7145 notResources: 7146 - "proj/*:env/*:flag/my-flag" 7147 - "proj/*:env/*:flag/my-flag" 7148 effect: "deny" 7149 resources: 7150 - "proj/*:env/*:flag/my-flag" 7151 - "proj/*:env/*:flag/my-flag" 7152 actions: 7153 - "updateOn" 7154 - "updateOn" 7155 - notActions: 7156 - "updateOn" 7157 - "updateOn" 7158 notResources: 7159 - "proj/*:env/*:flag/my-flag" 7160 - "proj/*:env/*:flag/my-flag" 7161 effect: "deny" 7162 resources: 7163 - "proj/*:env/*:flag/my-flag" 7164 - "proj/*:env/*:flag/my-flag" 7165 actions: 7166 - "updateOn" 7167 - "updateOn" 7168 - _links: 7169 next: 7170 href: "/api/v2/endpoint" 7171 type: "application/json" 7172 self: 7173 href: "/api/v2/endpoint" 7174 type: "application/json" 7175 name: "revenue team" 7176 description: "Description of revenue team role here" 7177 _id: "5a580a01b4ff89217bdf9dc1" 7178 key: "revenue-team" 7179 policy: 7180 - notActions: 7181 - "updateOn" 7182 - "updateOn" 7183 notResources: 7184 - "proj/*:env/*:flag/my-flag" 7185 - "proj/*:env/*:flag/my-flag" 7186 effect: "deny" 7187 resources: 7188 - "proj/*:env/*:flag/my-flag" 7189 - "proj/*:env/*:flag/my-flag" 7190 actions: 7191 - "updateOn" 7192 - "updateOn" 7193 - notActions: 7194 - "updateOn" 7195 - "updateOn" 7196 notResources: 7197 - "proj/*:env/*:flag/my-flag" 7198 - "proj/*:env/*:flag/my-flag" 7199 effect: "deny" 7200 resources: 7201 - "proj/*:env/*:flag/my-flag" 7202 - "proj/*:env/*:flag/my-flag" 7203 actions: 7204 - "updateOn" 7205 - "updateOn" 7206 Policy: 7207 type: "object" 7208 properties: 7209 resources: 7210 type: "array" 7211 items: 7212 type: "string" 7213 example: "proj/*:env/*:flag/my-flag" 7214 description: "A resource specifier string" 7215 notResources: 7216 type: "array" 7217 description: "Targeted resource will be those resources NOT in this list.\ 7218 \ The \"resources`\" field must be empty to use this field." 7219 items: 7220 type: "string" 7221 example: "proj/*:env/*:flag/my-flag" 7222 description: "A resource specifier string" 7223 actions: 7224 type: "array" 7225 items: 7226 type: "string" 7227 example: "updateOn" 7228 description: "An action to perform on a resource." 7229 notActions: 7230 type: "array" 7231 description: "Targeted actions will be those actions NOT in this list. The\ 7232 \ \"actions\" field must be empty to use this field." 7233 items: 7234 type: "string" 7235 example: "updateOn" 7236 description: "An action to perform on a resource." 7237 effect: 7238 type: "string" 7239 example: "deny" 7240 description: "Effect of the policy - allow or deny." 7241 example: 7242 notActions: 7243 - "updateOn" 7244 - "updateOn" 7245 notResources: 7246 - "proj/*:env/*:flag/my-flag" 7247 - "proj/*:env/*:flag/my-flag" 7248 effect: "deny" 7249 resources: 7250 - "proj/*:env/*:flag/my-flag" 7251 - "proj/*:env/*:flag/my-flag" 7252 actions: 7253 - "updateOn" 7254 - "updateOn" 7255 Id: 7256 type: "string" 7257 description: "The unique resource id." 7258 example: "5a580a01b4ff89217bdf9dc1" 7259 PatchOperation: 7260 type: "object" 7261 required: 7262 - "op" 7263 - "path" 7264 - "value" 7265 properties: 7266 op: 7267 type: "string" 7268 example: "replace" 7269 path: 7270 type: "string" 7271 example: "/name" 7272 value: 7273 type: "object" 7274 example: "My resource name" 7275 properties: {} 7276 SemanticPatchOperation: 7277 type: "object" 7278 required: 7279 - "instructions" 7280 properties: 7281 comment: 7282 type: "string" 7283 example: "This is a comment string" 7284 instructions: 7285 $ref: "#/definitions/SemanticPatchInstruction" 7286 SemanticPatchInstruction: 7287 type: "array" 7288 items: 7289 $ref: "#/definitions/SemanticPatchInstruction_inner" 7290 CustomProperty: 7291 type: "object" 7292 required: 7293 - "name" 7294 properties: 7295 name: 7296 type: "string" 7297 example: "My property" 7298 description: "The name of the property." 7299 value: 7300 type: "array" 7301 description: "Values for this property." 7302 items: 7303 type: "string" 7304 example: "" 7305 description: "A name and value describing a custom property." 7306 CustomPropertyValues: 7307 type: "array" 7308 description: "Values for this property." 7309 items: 7310 type: "string" 7311 example: 7312 - "Value 1" 7313 - "Value 2" 7314 UsageLinks: 7315 type: "object" 7316 properties: 7317 parent: 7318 $ref: "#/definitions/Link" 7319 self: 7320 $ref: "#/definitions/Link" 7321 subseries: 7322 type: "array" 7323 description: "The following links that are in the response." 7324 items: 7325 $ref: "#/definitions/Link" 7326 example: 7327 parent: 7328 href: "/api/v2/endpoint" 7329 type: "application/json" 7330 self: 7331 href: "/api/v2/endpoint" 7332 type: "application/json" 7333 subseries: 7334 - href: "/api/v2/endpoint" 7335 type: "application/json" 7336 - href: "/api/v2/endpoint" 7337 type: "application/json" 7338 StreamLinks: 7339 type: "object" 7340 properties: 7341 parent: 7342 $ref: "#/definitions/Link" 7343 self: 7344 $ref: "#/definitions/Link" 7345 subseries: 7346 type: "array" 7347 description: "Links to endpoints that are in the request path." 7348 items: 7349 $ref: "#/definitions/Link" 7350 Usage: 7351 type: "object" 7352 properties: 7353 _links: 7354 $ref: "#/definitions/UsageLinks" 7355 series: 7356 type: "array" 7357 items: 7358 $ref: "#/definitions/StreamUsageSeries" 7359 example: 7360 _links: 7361 parent: 7362 href: "/api/v2/endpoint" 7363 type: "application/json" 7364 self: 7365 href: "/api/v2/endpoint" 7366 type: "application/json" 7367 subseries: 7368 - href: "/api/v2/endpoint" 7369 type: "application/json" 7370 - href: "/api/v2/endpoint" 7371 type: "application/json" 7372 series: 7373 - "0": 0 7374 time: 1551740400000 7375 - "0": 0 7376 time: 1551740400000 7377 UsageError: 7378 type: "object" 7379 properties: 7380 message: 7381 type: "string" 7382 example: "This is a beta API, you must pass beta in the LD-API-Version header\ 7383 \ to use it." 7384 Streams: 7385 type: "object" 7386 properties: 7387 _links: 7388 $ref: "#/definitions/StreamUsageLinks" 7389 example: 7390 _links: 7391 parent: 7392 href: "/api/v2/endpoint" 7393 type: "application/json" 7394 self: 7395 href: "/api/v2/endpoint" 7396 type: "application/json" 7397 subseries: 7398 - href: "/api/v2/endpoint" 7399 type: "application/json" 7400 - href: "/api/v2/endpoint" 7401 type: "application/json" 7402 Stream: 7403 type: "object" 7404 properties: 7405 _links: 7406 $ref: "#/definitions/StreamUsageLinks" 7407 metadata: 7408 type: "array" 7409 items: 7410 $ref: "#/definitions/StreamUsageMetadata" 7411 series: 7412 type: "array" 7413 items: 7414 $ref: "#/definitions/StreamUsageSeries" 7415 example: 7416 metadata: 7417 - sdk: "ruby" 7418 source: "server" 7419 version: "5.4.3" 7420 - sdk: "ruby" 7421 source: "server" 7422 version: "5.4.3" 7423 _links: 7424 parent: 7425 href: "/api/v2/endpoint" 7426 type: "application/json" 7427 self: 7428 href: "/api/v2/endpoint" 7429 type: "application/json" 7430 subseries: 7431 - href: "/api/v2/endpoint" 7432 type: "application/json" 7433 - href: "/api/v2/endpoint" 7434 type: "application/json" 7435 series: 7436 - "0": 0 7437 time: 1551740400000 7438 - "0": 0 7439 time: 1551740400000 7440 StreamUsageLinks: 7441 type: "object" 7442 properties: 7443 parent: 7444 $ref: "#/definitions/Link" 7445 self: 7446 $ref: "#/definitions/Link" 7447 subseries: 7448 type: "array" 7449 description: "The following links that are in the response." 7450 items: 7451 $ref: "#/definitions/Link" 7452 example: 7453 parent: 7454 href: "/api/v2/endpoint" 7455 type: "application/json" 7456 self: 7457 href: "/api/v2/endpoint" 7458 type: "application/json" 7459 subseries: 7460 - href: "/api/v2/endpoint" 7461 type: "application/json" 7462 - href: "/api/v2/endpoint" 7463 type: "application/json" 7464 StreamUsageSeries: 7465 type: "object" 7466 properties: 7467 "0": 7468 type: "integer" 7469 format: "int64" 7470 example: 0 7471 description: "A key corresponding to a time series data point." 7472 time: 7473 type: "integer" 7474 format: "int64" 7475 example: 1551740400000 7476 description: "A unix epoch time in milliseconds specifying the creation time\ 7477 \ of this flag." 7478 example: 7479 "0": 0 7480 time: 1551740400000 7481 StreamUsageMetadata: 7482 type: "object" 7483 properties: 7484 sdk: 7485 type: "string" 7486 example: "ruby" 7487 description: "The language of the sdk" 7488 version: 7489 type: "string" 7490 example: "5.4.3" 7491 description: "The version of the SDK" 7492 source: 7493 type: "string" 7494 example: "server" 7495 example: 7496 sdk: "ruby" 7497 source: "server" 7498 version: "5.4.3" 7499 StreamUsageError: 7500 type: "object" 7501 properties: 7502 code: 7503 type: "string" 7504 example: "not_found" 7505 message: 7506 type: "string" 7507 example: "Stream source not found" 7508 StreamBySDK: 7509 type: "object" 7510 properties: 7511 _links: 7512 $ref: "#/definitions/StreamBySDKLinks" 7513 metadata: 7514 type: "array" 7515 items: 7516 $ref: "#/definitions/StreamBySDKLinksMetadata" 7517 series: 7518 type: "array" 7519 items: 7520 $ref: "#/definitions/StreamUsageSeries" 7521 example: 7522 metadata: 7523 - sdk: "ruby" 7524 source: "server" 7525 version: "5.4.3" 7526 - sdk: "ruby" 7527 source: "server" 7528 version: "5.4.3" 7529 _links: 7530 parent: 7531 href: "/api/v2/endpoint" 7532 type: "application/json" 7533 self: 7534 href: "/api/v2/endpoint" 7535 type: "application/json" 7536 series: 7537 - "0": 0 7538 time: 1551740400000 7539 - "0": 0 7540 time: 1551740400000 7541 StreamBySDKLinks: 7542 type: "object" 7543 properties: 7544 parent: 7545 $ref: "#/definitions/Link" 7546 self: 7547 $ref: "#/definitions/Link" 7548 example: 7549 parent: 7550 href: "/api/v2/endpoint" 7551 type: "application/json" 7552 self: 7553 href: "/api/v2/endpoint" 7554 type: "application/json" 7555 StreamBySDKLinksMetadata: 7556 type: "object" 7557 properties: 7558 sdk: 7559 type: "string" 7560 example: "ruby" 7561 version: 7562 type: "string" 7563 example: "5.4.3" 7564 source: 7565 type: "string" 7566 example: "server" 7567 example: 7568 sdk: "ruby" 7569 source: "server" 7570 version: "5.4.3" 7571 StreamSDKVersion: 7572 type: "object" 7573 properties: 7574 _links: 7575 $ref: "#/definitions/StreamBySDKLinks" 7576 sdkVersions: 7577 type: "array" 7578 items: 7579 $ref: "#/definitions/StreamSDKVersionData" 7580 example: 7581 _links: 7582 parent: 7583 href: "/api/v2/endpoint" 7584 type: "application/json" 7585 self: 7586 href: "/api/v2/endpoint" 7587 type: "application/json" 7588 sdkVersions: 7589 - sdk: "ruby" 7590 version: "5.4.3" 7591 - sdk: "ruby" 7592 version: "5.4.3" 7593 StreamSDKVersionData: 7594 type: "object" 7595 properties: 7596 sdk: 7597 type: "string" 7598 example: "ruby" 7599 description: "The language of the sdk" 7600 version: 7601 type: "string" 7602 example: "5.4.3" 7603 description: "The version of the sdk" 7604 example: 7605 sdk: "ruby" 7606 version: "5.4.3" 7607 MAU: 7608 type: "object" 7609 properties: 7610 _links: 7611 $ref: "#/definitions/UsageLinks" 7612 metadata: 7613 type: "array" 7614 items: 7615 $ref: "#/definitions/StreamBySDKLinksMetadata" 7616 series: 7617 type: "array" 7618 items: 7619 $ref: "#/definitions/StreamUsageSeries" 7620 example: 7621 metadata: 7622 - sdk: "ruby" 7623 source: "server" 7624 version: "5.4.3" 7625 - sdk: "ruby" 7626 source: "server" 7627 version: "5.4.3" 7628 _links: 7629 parent: 7630 href: "/api/v2/endpoint" 7631 type: "application/json" 7632 self: 7633 href: "/api/v2/endpoint" 7634 type: "application/json" 7635 subseries: 7636 - href: "/api/v2/endpoint" 7637 type: "application/json" 7638 - href: "/api/v2/endpoint" 7639 type: "application/json" 7640 series: 7641 - "0": 0 7642 time: 1551740400000 7643 - "0": 0 7644 time: 1551740400000 7645 MAUbyCategory: 7646 type: "object" 7647 properties: 7648 _links: 7649 $ref: "#/definitions/StreamBySDKLinks" 7650 metadata: 7651 type: "array" 7652 items: 7653 $ref: "#/definitions/MAUMetadata" 7654 series: 7655 type: "array" 7656 items: 7657 $ref: "#/definitions/StreamUsageSeries" 7658 example: 7659 metadata: 7660 - {} 7661 - {} 7662 _links: 7663 parent: 7664 href: "/api/v2/endpoint" 7665 type: "application/json" 7666 self: 7667 href: "/api/v2/endpoint" 7668 type: "application/json" 7669 series: 7670 - "0": 0 7671 time: 1551740400000 7672 - "0": 0 7673 time: 1551740400000 7674 MAUMetadata: 7675 type: "object" 7676 Events: 7677 type: "object" 7678 properties: 7679 links: 7680 $ref: "#/definitions/UsageLinks" 7681 example: 7682 links: 7683 parent: 7684 href: "/api/v2/endpoint" 7685 type: "application/json" 7686 self: 7687 href: "/api/v2/endpoint" 7688 type: "application/json" 7689 subseries: 7690 - href: "/api/v2/endpoint" 7691 type: "application/json" 7692 - href: "/api/v2/endpoint" 7693 type: "application/json" 7694 EvaluationUsageError: 7695 type: "object" 7696 properties: 7697 code: 7698 type: "string" 7699 example: "not_found" 7700 message: 7701 type: "string" 7702 example: "unknown environment" 7703 FeatureFlagCopyObject: 7704 type: "object" 7705 required: 7706 - "key" 7707 properties: 7708 key: 7709 type: "string" 7710 example: "staging" 7711 description: "The environment key to be used." 7712 currentVersion: 7713 type: "integer" 7714 example: 65 7715 description: "If the latest version of the flag matches provided version it\ 7716 \ will copy, otherwise it will return a conflict." 7717 CopyActions: 7718 type: "string" 7719 example: [] 7720 enum: 7721 - "updateOn" 7722 - "updatePrerequisites" 7723 - "updateTargets" 7724 - "updateRules" 7725 - "updateFallthrough" 7726 - "updateOffVariation" 7727 FlagListItem: 7728 type: "object" 7729 properties: 7730 name: 7731 type: "string" 7732 key: 7733 type: "string" 7734 _links: 7735 $ref: "#/definitions/Links" 7736 _site: 7737 $ref: "#/definitions/Site" 7738 example: 7739 _links: 7740 next: 7741 href: "/api/v2/endpoint" 7742 type: "application/json" 7743 self: 7744 href: "/api/v2/endpoint" 7745 type: "application/json" 7746 _site: 7747 href: "/features/sort.order" 7748 type: "text/html" 7749 name: "name" 7750 key: "key" 7751 Tokens: 7752 type: "object" 7753 properties: 7754 _links: 7755 $ref: "#/definitions/Links" 7756 items: 7757 type: "array" 7758 items: 7759 $ref: "#/definitions/Token" 7760 example: 7761 _links: 7762 next: 7763 href: "/api/v2/endpoint" 7764 type: "application/json" 7765 self: 7766 href: "/api/v2/endpoint" 7767 type: "application/json" 7768 items: 7769 - role: "writer" 7770 customRoleIds: 7771 - "customRoleIds" 7772 - "customRoleIds" 7773 _links: 7774 next: 7775 href: "/api/v2/endpoint" 7776 type: "application/json" 7777 self: 7778 href: "/api/v2/endpoint" 7779 type: "application/json" 7780 _member: 7781 firstName: "Alan" 7782 lastName: "Turing" 7783 _verified: true 7784 role: {} 7785 _links: 7786 next: 7787 href: "/api/v2/endpoint" 7788 type: "application/json" 7789 self: 7790 href: "/api/v2/endpoint" 7791 type: "application/json" 7792 _pendingInvite: true 7793 _lastSeen: 1469326565348 7794 isBeta: true 7795 _id: "5a580a01b4ff89217bdf9dc1" 7796 _lastSeenMetadata: 7797 tokenId: "5fd2a1ee05600316d5cb3e96" 7798 email: "user@launchdarkly.com" 7799 customRoles: 7800 - "5a580a01b4ff89217bdf9dc1" 7801 - "5a580a01b4ff89217bdf9dc1" 7802 ownerId: "5a580a01b4ff89217bdf9dc1" 7803 creationDate: 1443652232590 7804 defaultApiVersion: 0 7805 token: "3243" 7806 lastUsed: 1469326565348 7807 inlineRole: 7808 - notActions: 7809 - "updateOn" 7810 - "updateOn" 7811 notResources: 7812 - "proj/*:env/*:flag/my-flag" 7813 - "proj/*:env/*:flag/my-flag" 7814 effect: "allow" 7815 resources: 7816 - "proj/*:env/*:flag/my-flag" 7817 - "proj/*:env/*:flag/my-flag" 7818 actions: 7819 - "updateOn" 7820 - "updateOn" 7821 - notActions: 7822 - "updateOn" 7823 - "updateOn" 7824 notResources: 7825 - "proj/*:env/*:flag/my-flag" 7826 - "proj/*:env/*:flag/my-flag" 7827 effect: "allow" 7828 resources: 7829 - "proj/*:env/*:flag/my-flag" 7830 - "proj/*:env/*:flag/my-flag" 7831 actions: 7832 - "updateOn" 7833 - "updateOn" 7834 name: "My access token" 7835 _id: "5a580a01b4ff89217bdf9dc1" 7836 lastModified: 1469326565348 7837 serviceToken: true 7838 memberId: "5a580a01b4ff89217bdf9dc1" 7839 - role: "writer" 7840 customRoleIds: 7841 - "customRoleIds" 7842 - "customRoleIds" 7843 _links: 7844 next: 7845 href: "/api/v2/endpoint" 7846 type: "application/json" 7847 self: 7848 href: "/api/v2/endpoint" 7849 type: "application/json" 7850 _member: 7851 firstName: "Alan" 7852 lastName: "Turing" 7853 _verified: true 7854 role: {} 7855 _links: 7856 next: 7857 href: "/api/v2/endpoint" 7858 type: "application/json" 7859 self: 7860 href: "/api/v2/endpoint" 7861 type: "application/json" 7862 _pendingInvite: true 7863 _lastSeen: 1469326565348 7864 isBeta: true 7865 _id: "5a580a01b4ff89217bdf9dc1" 7866 _lastSeenMetadata: 7867 tokenId: "5fd2a1ee05600316d5cb3e96" 7868 email: "user@launchdarkly.com" 7869 customRoles: 7870 - "5a580a01b4ff89217bdf9dc1" 7871 - "5a580a01b4ff89217bdf9dc1" 7872 ownerId: "5a580a01b4ff89217bdf9dc1" 7873 creationDate: 1443652232590 7874 defaultApiVersion: 0 7875 token: "3243" 7876 lastUsed: 1469326565348 7877 inlineRole: 7878 - notActions: 7879 - "updateOn" 7880 - "updateOn" 7881 notResources: 7882 - "proj/*:env/*:flag/my-flag" 7883 - "proj/*:env/*:flag/my-flag" 7884 effect: "allow" 7885 resources: 7886 - "proj/*:env/*:flag/my-flag" 7887 - "proj/*:env/*:flag/my-flag" 7888 actions: 7889 - "updateOn" 7890 - "updateOn" 7891 - notActions: 7892 - "updateOn" 7893 - "updateOn" 7894 notResources: 7895 - "proj/*:env/*:flag/my-flag" 7896 - "proj/*:env/*:flag/my-flag" 7897 effect: "allow" 7898 resources: 7899 - "proj/*:env/*:flag/my-flag" 7900 - "proj/*:env/*:flag/my-flag" 7901 actions: 7902 - "updateOn" 7903 - "updateOn" 7904 name: "My access token" 7905 _id: "5a580a01b4ff89217bdf9dc1" 7906 lastModified: 1469326565348 7907 serviceToken: true 7908 memberId: "5a580a01b4ff89217bdf9dc1" 7909 Token: 7910 type: "object" 7911 properties: 7912 _links: 7913 $ref: "#/definitions/Links" 7914 _id: 7915 type: "string" 7916 example: "5a580a01b4ff89217bdf9dc1" 7917 description: "The unique resource id." 7918 ownerId: 7919 type: "string" 7920 example: "5a580a01b4ff89217bdf9dc1" 7921 description: "The unique resource id." 7922 memberId: 7923 type: "string" 7924 example: "5a580a01b4ff89217bdf9dc1" 7925 description: "The unique resource id." 7926 _member: 7927 $ref: "#/definitions/Member" 7928 creationDate: 7929 type: "integer" 7930 format: "int64" 7931 example: 1443652232590 7932 description: "A unix epoch time in milliseconds specifying the creation time\ 7933 \ of this access token." 7934 lastModified: 7935 type: "integer" 7936 format: "int64" 7937 example: 1469326565348 7938 description: "A unix epoch time in milliseconds specifying the last time this\ 7939 \ access token was modified." 7940 lastUsed: 7941 type: "integer" 7942 format: "int64" 7943 example: 1469326565348 7944 description: "A unix epoch time in milliseconds specifying the last time this\ 7945 \ access token was used to authorize access to the LaunchDarkly REST API." 7946 token: 7947 type: "string" 7948 example: "3243" 7949 description: "The last 4 digits of the unique secret key for this access token.\ 7950 \ If creating or resetting the token, this will be the full token secret." 7951 name: 7952 type: "string" 7953 example: "My access token" 7954 description: "A human-friendly name for the access token" 7955 role: 7956 type: "string" 7957 example: "writer" 7958 description: "The name of a built-in role for the token" 7959 customRoleIds: 7960 type: "array" 7961 description: "A list of custom role IDs to use as access limits for the access\ 7962 \ token" 7963 items: 7964 type: "string" 7965 inlineRole: 7966 type: "array" 7967 items: 7968 $ref: "#/definitions/Statement" 7969 serviceToken: 7970 type: "boolean" 7971 description: "Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens" 7972 defaultApiVersion: 7973 type: "integer" 7974 description: "The default API version for this token" 7975 example: 7976 role: "writer" 7977 customRoleIds: 7978 - "customRoleIds" 7979 - "customRoleIds" 7980 _links: 7981 next: 7982 href: "/api/v2/endpoint" 7983 type: "application/json" 7984 self: 7985 href: "/api/v2/endpoint" 7986 type: "application/json" 7987 _member: 7988 firstName: "Alan" 7989 lastName: "Turing" 7990 _verified: true 7991 role: {} 7992 _links: 7993 next: 7994 href: "/api/v2/endpoint" 7995 type: "application/json" 7996 self: 7997 href: "/api/v2/endpoint" 7998 type: "application/json" 7999 _pendingInvite: true 8000 _lastSeen: 1469326565348 8001 isBeta: true 8002 _id: "5a580a01b4ff89217bdf9dc1" 8003 _lastSeenMetadata: 8004 tokenId: "5fd2a1ee05600316d5cb3e96" 8005 email: "user@launchdarkly.com" 8006 customRoles: 8007 - "5a580a01b4ff89217bdf9dc1" 8008 - "5a580a01b4ff89217bdf9dc1" 8009 ownerId: "5a580a01b4ff89217bdf9dc1" 8010 creationDate: 1443652232590 8011 defaultApiVersion: 0 8012 token: "3243" 8013 lastUsed: 1469326565348 8014 inlineRole: 8015 - notActions: 8016 - "updateOn" 8017 - "updateOn" 8018 notResources: 8019 - "proj/*:env/*:flag/my-flag" 8020 - "proj/*:env/*:flag/my-flag" 8021 effect: "allow" 8022 resources: 8023 - "proj/*:env/*:flag/my-flag" 8024 - "proj/*:env/*:flag/my-flag" 8025 actions: 8026 - "updateOn" 8027 - "updateOn" 8028 - notActions: 8029 - "updateOn" 8030 - "updateOn" 8031 notResources: 8032 - "proj/*:env/*:flag/my-flag" 8033 - "proj/*:env/*:flag/my-flag" 8034 effect: "allow" 8035 resources: 8036 - "proj/*:env/*:flag/my-flag" 8037 - "proj/*:env/*:flag/my-flag" 8038 actions: 8039 - "updateOn" 8040 - "updateOn" 8041 name: "My access token" 8042 _id: "5a580a01b4ff89217bdf9dc1" 8043 lastModified: 1469326565348 8044 serviceToken: true 8045 memberId: "5a580a01b4ff89217bdf9dc1" 8046 RelayProxyConfigs: 8047 type: "object" 8048 properties: 8049 items: 8050 type: "array" 8051 items: 8052 $ref: "#/definitions/RelayProxyConfig" 8053 example: 8054 items: 8055 - displayKey: "66eo" 8056 _creator: 8057 firstName: "Alan" 8058 lastName: "Turing" 8059 _verified: true 8060 role: {} 8061 _links: 8062 next: 8063 href: "/api/v2/endpoint" 8064 type: "application/json" 8065 self: 8066 href: "/api/v2/endpoint" 8067 type: "application/json" 8068 _pendingInvite: true 8069 _lastSeen: 1469326565348 8070 isBeta: true 8071 _id: "5a580a01b4ff89217bdf9dc1" 8072 _lastSeenMetadata: 8073 tokenId: "5fd2a1ee05600316d5cb3e96" 8074 email: "user@launchdarkly.com" 8075 customRoles: 8076 - "5a580a01b4ff89217bdf9dc1" 8077 - "5a580a01b4ff89217bdf9dc1" 8078 fullKey: "rel-8a3a773d-b75e-48eb-a850-492cda9266eo" 8079 name: "My relay proxy config" 8080 _id: "5a580a01b4ff89217bdf9dc1" 8081 lastModified: 1469326565348 8082 creationDate: 1443652232590 8083 policy: 8084 - notActions: 8085 - "updateOn" 8086 - "updateOn" 8087 notResources: 8088 - "proj/*:env/*:flag/my-flag" 8089 - "proj/*:env/*:flag/my-flag" 8090 effect: "deny" 8091 resources: 8092 - "proj/*:env/*:flag/my-flag" 8093 - "proj/*:env/*:flag/my-flag" 8094 actions: 8095 - "updateOn" 8096 - "updateOn" 8097 - notActions: 8098 - "updateOn" 8099 - "updateOn" 8100 notResources: 8101 - "proj/*:env/*:flag/my-flag" 8102 - "proj/*:env/*:flag/my-flag" 8103 effect: "deny" 8104 resources: 8105 - "proj/*:env/*:flag/my-flag" 8106 - "proj/*:env/*:flag/my-flag" 8107 actions: 8108 - "updateOn" 8109 - "updateOn" 8110 - displayKey: "66eo" 8111 _creator: 8112 firstName: "Alan" 8113 lastName: "Turing" 8114 _verified: true 8115 role: {} 8116 _links: 8117 next: 8118 href: "/api/v2/endpoint" 8119 type: "application/json" 8120 self: 8121 href: "/api/v2/endpoint" 8122 type: "application/json" 8123 _pendingInvite: true 8124 _lastSeen: 1469326565348 8125 isBeta: true 8126 _id: "5a580a01b4ff89217bdf9dc1" 8127 _lastSeenMetadata: 8128 tokenId: "5fd2a1ee05600316d5cb3e96" 8129 email: "user@launchdarkly.com" 8130 customRoles: 8131 - "5a580a01b4ff89217bdf9dc1" 8132 - "5a580a01b4ff89217bdf9dc1" 8133 fullKey: "rel-8a3a773d-b75e-48eb-a850-492cda9266eo" 8134 name: "My relay proxy config" 8135 _id: "5a580a01b4ff89217bdf9dc1" 8136 lastModified: 1469326565348 8137 creationDate: 1443652232590 8138 policy: 8139 - notActions: 8140 - "updateOn" 8141 - "updateOn" 8142 notResources: 8143 - "proj/*:env/*:flag/my-flag" 8144 - "proj/*:env/*:flag/my-flag" 8145 effect: "deny" 8146 resources: 8147 - "proj/*:env/*:flag/my-flag" 8148 - "proj/*:env/*:flag/my-flag" 8149 actions: 8150 - "updateOn" 8151 - "updateOn" 8152 - notActions: 8153 - "updateOn" 8154 - "updateOn" 8155 notResources: 8156 - "proj/*:env/*:flag/my-flag" 8157 - "proj/*:env/*:flag/my-flag" 8158 effect: "deny" 8159 resources: 8160 - "proj/*:env/*:flag/my-flag" 8161 - "proj/*:env/*:flag/my-flag" 8162 actions: 8163 - "updateOn" 8164 - "updateOn" 8165 RelayProxyConfig: 8166 type: "object" 8167 required: 8168 - "_creator" 8169 - "_id" 8170 - "creationDate" 8171 - "displayKey" 8172 - "lastModified" 8173 - "name" 8174 - "policy" 8175 properties: 8176 _id: 8177 type: "string" 8178 example: "5a580a01b4ff89217bdf9dc1" 8179 description: "The unique resource id." 8180 _creator: 8181 $ref: "#/definitions/Member" 8182 name: 8183 type: "string" 8184 example: "My relay proxy config" 8185 description: "A human-friendly name for the relay proxy configuration" 8186 policy: 8187 type: "array" 8188 items: 8189 $ref: "#/definitions/Policy" 8190 fullKey: 8191 type: "string" 8192 example: "rel-8a3a773d-b75e-48eb-a850-492cda9266eo" 8193 description: "Full secret key. Only included if creating or resetting the\ 8194 \ relay proxy configuration" 8195 displayKey: 8196 type: "string" 8197 example: "66eo" 8198 description: "The last 4 digits of the unique secret key for this relay proxy\ 8199 \ configuration" 8200 creationDate: 8201 type: "integer" 8202 format: "int64" 8203 example: 1443652232590 8204 description: "A unix epoch time in milliseconds specifying the creation time\ 8205 \ of this relay proxy configuration" 8206 lastModified: 8207 type: "integer" 8208 format: "int64" 8209 example: 1469326565348 8210 description: "A unix epoch time in milliseconds specifying the last time this\ 8211 \ relay proxy configuration was modified" 8212 example: 8213 displayKey: "66eo" 8214 _creator: 8215 firstName: "Alan" 8216 lastName: "Turing" 8217 _verified: true 8218 role: {} 8219 _links: 8220 next: 8221 href: "/api/v2/endpoint" 8222 type: "application/json" 8223 self: 8224 href: "/api/v2/endpoint" 8225 type: "application/json" 8226 _pendingInvite: true 8227 _lastSeen: 1469326565348 8228 isBeta: true 8229 _id: "5a580a01b4ff89217bdf9dc1" 8230 _lastSeenMetadata: 8231 tokenId: "5fd2a1ee05600316d5cb3e96" 8232 email: "user@launchdarkly.com" 8233 customRoles: 8234 - "5a580a01b4ff89217bdf9dc1" 8235 - "5a580a01b4ff89217bdf9dc1" 8236 fullKey: "rel-8a3a773d-b75e-48eb-a850-492cda9266eo" 8237 name: "My relay proxy config" 8238 _id: "5a580a01b4ff89217bdf9dc1" 8239 lastModified: 1469326565348 8240 creationDate: 1443652232590 8241 policy: 8242 - notActions: 8243 - "updateOn" 8244 - "updateOn" 8245 notResources: 8246 - "proj/*:env/*:flag/my-flag" 8247 - "proj/*:env/*:flag/my-flag" 8248 effect: "deny" 8249 resources: 8250 - "proj/*:env/*:flag/my-flag" 8251 - "proj/*:env/*:flag/my-flag" 8252 actions: 8253 - "updateOn" 8254 - "updateOn" 8255 - notActions: 8256 - "updateOn" 8257 - "updateOn" 8258 notResources: 8259 - "proj/*:env/*:flag/my-flag" 8260 - "proj/*:env/*:flag/my-flag" 8261 effect: "deny" 8262 resources: 8263 - "proj/*:env/*:flag/my-flag" 8264 - "proj/*:env/*:flag/my-flag" 8265 actions: 8266 - "updateOn" 8267 - "updateOn" 8268 HierarchicalLinks: 8269 type: "object" 8270 properties: 8271 parent: 8272 $ref: "#/definitions/Link" 8273 self: 8274 $ref: "#/definitions/Link" 8275 example: 8276 parent: 8277 href: "/api/v2/endpoint" 8278 type: "application/json" 8279 self: 8280 href: "/api/v2/endpoint" 8281 type: "application/json" 8282 IntegrationSubscription: 8283 type: "object" 8284 properties: 8285 _links: 8286 $ref: "#/definitions/HierarchicalLinks" 8287 _id: 8288 type: "string" 8289 example: "5a580a01b4ff89217bdf9dc1" 8290 description: "The unique resource id." 8291 kind: 8292 type: "string" 8293 example: "datadog" 8294 description: "The type of integration associated with this configuration." 8295 name: 8296 type: "string" 8297 example: "V2" 8298 description: "The user-defined name associated with this configuration." 8299 config: 8300 type: "object" 8301 example: 8302 apiKey: "582**************************116" 8303 hostURL: "https://api.datadoghq.com" 8304 description: "A key-value mapping of configuration fields." 8305 properties: {} 8306 statements: 8307 type: "array" 8308 items: 8309 $ref: "#/definitions/Statement" 8310 "on": 8311 type: "boolean" 8312 example: true 8313 description: "Whether or not the integration is currently active." 8314 tags: 8315 type: "array" 8316 description: "An array of tags for this integration configuration." 8317 items: 8318 type: "string" 8319 _status: 8320 $ref: "#/definitions/IntegrationSubscription__status" 8321 example: 8322 _links: 8323 parent: 8324 href: "/api/v2/endpoint" 8325 type: "application/json" 8326 self: 8327 href: "/api/v2/endpoint" 8328 type: "application/json" 8329 kind: "datadog" 8330 name: "V2" 8331 statements: 8332 - notActions: 8333 - "updateOn" 8334 - "updateOn" 8335 notResources: 8336 - "proj/*:env/*:flag/my-flag" 8337 - "proj/*:env/*:flag/my-flag" 8338 effect: "allow" 8339 resources: 8340 - "proj/*:env/*:flag/my-flag" 8341 - "proj/*:env/*:flag/my-flag" 8342 actions: 8343 - "updateOn" 8344 - "updateOn" 8345 - notActions: 8346 - "updateOn" 8347 - "updateOn" 8348 notResources: 8349 - "proj/*:env/*:flag/my-flag" 8350 - "proj/*:env/*:flag/my-flag" 8351 effect: "allow" 8352 resources: 8353 - "proj/*:env/*:flag/my-flag" 8354 - "proj/*:env/*:flag/my-flag" 8355 actions: 8356 - "updateOn" 8357 - "updateOn" 8358 _id: "5a580a01b4ff89217bdf9dc1" 8359 _status: 8360 successCount: 6 8361 lastSuccess: 1443652232590 8362 errorCount: 2 8363 config: 8364 apiKey: "582**************************116" 8365 hostURL: "https://api.datadoghq.com" 8366 "on": true 8367 tags: 8368 - "tags" 8369 - "tags" 8370 Integration: 8371 type: "object" 8372 properties: 8373 _links: 8374 $ref: "#/definitions/DependentFlag__links" 8375 items: 8376 type: "array" 8377 items: 8378 $ref: "#/definitions/IntegrationSubscription" 8379 example: 8380 _links: 8381 self: 8382 href: "/api/v2/endpoint" 8383 type: "application/json" 8384 items: 8385 - _links: 8386 parent: 8387 href: "/api/v2/endpoint" 8388 type: "application/json" 8389 self: 8390 href: "/api/v2/endpoint" 8391 type: "application/json" 8392 kind: "datadog" 8393 name: "V2" 8394 statements: 8395 - notActions: 8396 - "updateOn" 8397 - "updateOn" 8398 notResources: 8399 - "proj/*:env/*:flag/my-flag" 8400 - "proj/*:env/*:flag/my-flag" 8401 effect: "allow" 8402 resources: 8403 - "proj/*:env/*:flag/my-flag" 8404 - "proj/*:env/*:flag/my-flag" 8405 actions: 8406 - "updateOn" 8407 - "updateOn" 8408 - notActions: 8409 - "updateOn" 8410 - "updateOn" 8411 notResources: 8412 - "proj/*:env/*:flag/my-flag" 8413 - "proj/*:env/*:flag/my-flag" 8414 effect: "allow" 8415 resources: 8416 - "proj/*:env/*:flag/my-flag" 8417 - "proj/*:env/*:flag/my-flag" 8418 actions: 8419 - "updateOn" 8420 - "updateOn" 8421 _id: "5a580a01b4ff89217bdf9dc1" 8422 _status: 8423 successCount: 6 8424 lastSuccess: 1443652232590 8425 errorCount: 2 8426 config: 8427 apiKey: "582**************************116" 8428 hostURL: "https://api.datadoghq.com" 8429 "on": true 8430 tags: 8431 - "tags" 8432 - "tags" 8433 - _links: 8434 parent: 8435 href: "/api/v2/endpoint" 8436 type: "application/json" 8437 self: 8438 href: "/api/v2/endpoint" 8439 type: "application/json" 8440 kind: "datadog" 8441 name: "V2" 8442 statements: 8443 - notActions: 8444 - "updateOn" 8445 - "updateOn" 8446 notResources: 8447 - "proj/*:env/*:flag/my-flag" 8448 - "proj/*:env/*:flag/my-flag" 8449 effect: "allow" 8450 resources: 8451 - "proj/*:env/*:flag/my-flag" 8452 - "proj/*:env/*:flag/my-flag" 8453 actions: 8454 - "updateOn" 8455 - "updateOn" 8456 - notActions: 8457 - "updateOn" 8458 - "updateOn" 8459 notResources: 8460 - "proj/*:env/*:flag/my-flag" 8461 - "proj/*:env/*:flag/my-flag" 8462 effect: "allow" 8463 resources: 8464 - "proj/*:env/*:flag/my-flag" 8465 - "proj/*:env/*:flag/my-flag" 8466 actions: 8467 - "updateOn" 8468 - "updateOn" 8469 _id: "5a580a01b4ff89217bdf9dc1" 8470 _status: 8471 successCount: 6 8472 lastSuccess: 1443652232590 8473 errorCount: 2 8474 config: 8475 apiKey: "582**************************116" 8476 hostURL: "https://api.datadoghq.com" 8477 "on": true 8478 tags: 8479 - "tags" 8480 - "tags" 8481 Integrations: 8482 type: "object" 8483 properties: 8484 _links: 8485 type: "object" 8486 example: 8487 appdynamics: 8488 href: "/api/v2/integrations/appdynamics" 8489 type: "application/json" 8490 splunk: 8491 href: "/api/v2/integrations/splunk" 8492 type: "application/json" 8493 description: "A mapping of integration types to their respective API endpoints." 8494 properties: {} 8495 items: 8496 type: "array" 8497 items: 8498 $ref: "#/definitions/IntegrationSubscription" 8499 example: 8500 _links: 8501 appdynamics: 8502 href: "/api/v2/integrations/appdynamics" 8503 type: "application/json" 8504 splunk: 8505 href: "/api/v2/integrations/splunk" 8506 type: "application/json" 8507 items: 8508 - _links: 8509 parent: 8510 href: "/api/v2/endpoint" 8511 type: "application/json" 8512 self: 8513 href: "/api/v2/endpoint" 8514 type: "application/json" 8515 kind: "datadog" 8516 name: "V2" 8517 statements: 8518 - notActions: 8519 - "updateOn" 8520 - "updateOn" 8521 notResources: 8522 - "proj/*:env/*:flag/my-flag" 8523 - "proj/*:env/*:flag/my-flag" 8524 effect: "allow" 8525 resources: 8526 - "proj/*:env/*:flag/my-flag" 8527 - "proj/*:env/*:flag/my-flag" 8528 actions: 8529 - "updateOn" 8530 - "updateOn" 8531 - notActions: 8532 - "updateOn" 8533 - "updateOn" 8534 notResources: 8535 - "proj/*:env/*:flag/my-flag" 8536 - "proj/*:env/*:flag/my-flag" 8537 effect: "allow" 8538 resources: 8539 - "proj/*:env/*:flag/my-flag" 8540 - "proj/*:env/*:flag/my-flag" 8541 actions: 8542 - "updateOn" 8543 - "updateOn" 8544 _id: "5a580a01b4ff89217bdf9dc1" 8545 _status: 8546 successCount: 6 8547 lastSuccess: 1443652232590 8548 errorCount: 2 8549 config: 8550 apiKey: "582**************************116" 8551 hostURL: "https://api.datadoghq.com" 8552 "on": true 8553 tags: 8554 - "tags" 8555 - "tags" 8556 - _links: 8557 parent: 8558 href: "/api/v2/endpoint" 8559 type: "application/json" 8560 self: 8561 href: "/api/v2/endpoint" 8562 type: "application/json" 8563 kind: "datadog" 8564 name: "V2" 8565 statements: 8566 - notActions: 8567 - "updateOn" 8568 - "updateOn" 8569 notResources: 8570 - "proj/*:env/*:flag/my-flag" 8571 - "proj/*:env/*:flag/my-flag" 8572 effect: "allow" 8573 resources: 8574 - "proj/*:env/*:flag/my-flag" 8575 - "proj/*:env/*:flag/my-flag" 8576 actions: 8577 - "updateOn" 8578 - "updateOn" 8579 - notActions: 8580 - "updateOn" 8581 - "updateOn" 8582 notResources: 8583 - "proj/*:env/*:flag/my-flag" 8584 - "proj/*:env/*:flag/my-flag" 8585 effect: "allow" 8586 resources: 8587 - "proj/*:env/*:flag/my-flag" 8588 - "proj/*:env/*:flag/my-flag" 8589 actions: 8590 - "updateOn" 8591 - "updateOn" 8592 _id: "5a580a01b4ff89217bdf9dc1" 8593 _status: 8594 successCount: 6 8595 lastSuccess: 1443652232590 8596 errorCount: 2 8597 config: 8598 apiKey: "582**************************116" 8599 hostURL: "https://api.datadoghq.com" 8600 "on": true 8601 tags: 8602 - "tags" 8603 - "tags" 8604 projectBody: 8605 type: "object" 8606 required: 8607 - "key" 8608 - "name" 8609 properties: 8610 name: 8611 type: "string" 8612 example: "New Project" 8613 key: 8614 type: "string" 8615 example: "new-project" 8616 includeInSnippetByDefault: 8617 type: "boolean" 8618 example: false 8619 tags: 8620 type: "array" 8621 example: 8622 - "ops" 8623 - "dev" 8624 items: 8625 type: "string" 8626 environments: 8627 type: "array" 8628 items: 8629 $ref: "#/definitions/EnvironmentPost" 8630 defaultClientSideAvailability: 8631 $ref: "#/definitions/ClientSideAvailability" 8632 featureFlagBody: 8633 type: "object" 8634 required: 8635 - "key" 8636 - "name" 8637 - "variations" 8638 properties: 8639 name: 8640 type: "string" 8641 example: "new test flag" 8642 description: "A human-friendly name for the feature flag. Remember to note\ 8643 \ if this flag is intended to be temporary or permanent." 8644 key: 8645 type: "string" 8646 example: "new-test-flag" 8647 description: "A unique key that will be used to reference the flag in your\ 8648 \ code." 8649 description: 8650 type: "string" 8651 example: "This flag controls whether test feature is turned on or not." 8652 description: "A description of the feature flag." 8653 variations: 8654 type: "array" 8655 description: "An array of possible variations for the flag." 8656 items: 8657 $ref: "#/definitions/Variation" 8658 temporary: 8659 type: "boolean" 8660 description: "Whether or not the flag is a temporary flag." 8661 tags: 8662 type: "array" 8663 description: "Tags for the feature flag." 8664 items: 8665 type: "string" 8666 example: "" 8667 includeInSnippet: 8668 type: "boolean" 8669 description: "Whether or not this flag should be made available to the client-side\ 8670 \ JavaScript SDK." 8671 clientSideAvailability: 8672 $ref: "#/definitions/ClientSideAvailability" 8673 defaults: 8674 $ref: "#/definitions/Defaults" 8675 patchComment: 8676 type: "object" 8677 properties: 8678 comment: 8679 type: "string" 8680 example: "This is a comment string" 8681 patch: 8682 type: "array" 8683 items: 8684 $ref: "#/definitions/PatchOperation" 8685 featureFlagCopyBody: 8686 type: "object" 8687 properties: 8688 source: 8689 $ref: "#/definitions/FeatureFlagCopyObject" 8690 target: 8691 $ref: "#/definitions/FeatureFlagCopyObject" 8692 comment: 8693 type: "string" 8694 example: "This is a comment string" 8695 description: "comment will be included in audit log item for change." 8696 includedActions: 8697 type: "array" 8698 description: "Define the parts of the flag configuration that will be copied." 8699 items: 8700 $ref: "#/definitions/CopyActions" 8701 excludedActions: 8702 type: "array" 8703 description: "Define the parts of the flag configuration that will not be\ 8704 \ copied." 8705 items: 8706 $ref: "#/definitions/CopyActions" 8707 flagConfigScheduledChangesPostBody: 8708 type: "object" 8709 properties: 8710 comment: 8711 type: "string" 8712 description: "Used to describe the scheduled changes." 8713 executionDate: 8714 type: "integer" 8715 description: "A unix epoch time in milliseconds specifying the date the scheduled\ 8716 \ changes will be applied" 8717 instructions: 8718 $ref: "#/definitions/SemanticPatchInstruction" 8719 flagConfigScheduledChangesConflictsBody: 8720 type: "object" 8721 properties: 8722 executionDate: 8723 type: "integer" 8724 description: "A unix epoch time in milliseconds specifying the date the scheduled\ 8725 \ changes will be applied" 8726 instructions: 8727 $ref: "#/definitions/SemanticPatchInstruction" 8728 flagConfigScheduledChangesPatchBody: 8729 type: "object" 8730 properties: 8731 comment: 8732 type: "string" 8733 description: "Used to describe the scheduled changes." 8734 instructions: 8735 $ref: "#/definitions/SemanticPatchInstruction" 8736 approvalRequestConfigBody: 8737 type: "object" 8738 required: 8739 - "description" 8740 - "instructions" 8741 - "notifyMemberIds" 8742 properties: 8743 description: 8744 type: "string" 8745 description: "A name that describes the changes you would like to apply to\ 8746 \ a feature flag configuration" 8747 instructions: 8748 $ref: "#/definitions/SemanticPatchInstruction" 8749 notifyMemberIds: 8750 type: "array" 8751 example: 8752 - "memberId" 8753 - "memberId2" 8754 items: 8755 type: "string" 8756 comment: 8757 type: "string" 8758 description: "comment will be included in audit log item for change." 8759 executionDate: 8760 type: "integer" 8761 format: "int64" 8762 description: "Timestamp for when instructions will be executed" 8763 operatingOnId: 8764 type: "string" 8765 description: "ID of scheduled change to edit or delete" 8766 approvalRequestApplyConfigBody: 8767 type: "object" 8768 properties: 8769 comment: 8770 type: "string" 8771 example: "Applying approved changes" 8772 description: "comment will be included in audit log item for change." 8773 approvalRequestReviewConfigBody: 8774 type: "object" 8775 required: 8776 - "kind" 8777 properties: 8778 kind: 8779 type: "string" 8780 example: "approve" 8781 description: "One of approve, decline, or comment." 8782 enum: 8783 - "approve" 8784 - "decline" 8785 - "comment" 8786 comment: 8787 type: "string" 8788 example: "This is a comment string" 8789 description: "comment will be included in audit log item for change." 8790 userSegmentBody: 8791 type: "object" 8792 required: 8793 - "key" 8794 - "name" 8795 properties: 8796 name: 8797 type: "string" 8798 example: "new segment" 8799 description: "A human-friendly name for the user segment." 8800 key: 8801 type: "string" 8802 example: "new-segment" 8803 description: "A unique key that will be used to reference the user segment\ 8804 \ in feature flags." 8805 description: 8806 type: "string" 8807 example: "Users in this segment will have access to beta features." 8808 description: "A description for the user segment." 8809 unbounded: 8810 type: "boolean" 8811 example: false 8812 description: "Controls whether this is considered a \"big segment\" which\ 8813 \ can support an unlimited numbers of users. Include/exclude lists sent\ 8814 \ with this payload are not used in big segments. Contact your account manager\ 8815 \ for early access to this feature." 8816 tags: 8817 type: "array" 8818 description: "Tags for the user segment." 8819 items: 8820 type: "string" 8821 example: "" 8822 bigSegmentTargetsBody: 8823 type: "object" 8824 properties: 8825 included: 8826 $ref: "#/definitions/BigSegmentTargetChanges" 8827 excluded: 8828 $ref: "#/definitions/BigSegmentTargetChanges" 8829 userSettingsBody: 8830 type: "object" 8831 properties: 8832 setting: 8833 type: "boolean" 8834 description: "The variation value to set for the user. Must match the variation\ 8835 \ type of the flag.\n" 8836 webhookBody: 8837 type: "object" 8838 required: 8839 - "on" 8840 - "sign" 8841 - "url" 8842 properties: 8843 url: 8844 type: "string" 8845 example: "https://example.com/example" 8846 description: "The URL of the remote webhook." 8847 secret: 8848 type: "string" 8849 example: "<password>" 8850 description: "If sign is true, and the secret attribute is omitted, LaunchDarkly\ 8851 \ will automatically generate a secret for you." 8852 sign: 8853 type: "boolean" 8854 description: "If sign is false, the webhook will not include a signature header,\ 8855 \ and the secret can be omitted." 8856 "on": 8857 type: "boolean" 8858 example: true 8859 description: "Whether this webhook is enabled or not." 8860 name: 8861 type: "string" 8862 example: "Example hook" 8863 description: "The name of the webhook." 8864 statements: 8865 type: "array" 8866 items: 8867 $ref: "#/definitions/Statement" 8868 tags: 8869 type: "array" 8870 example: [] 8871 description: "Tags for the webhook." 8872 items: 8873 type: "string" 8874 customRoleBody: 8875 type: "object" 8876 required: 8877 - "key" 8878 - "name" 8879 - "policy" 8880 properties: 8881 name: 8882 type: "string" 8883 example: "revenue team" 8884 description: "Name of the custom role." 8885 description: 8886 type: "string" 8887 example: "Description of revenue team role here" 8888 description: "Description of the custom role." 8889 key: 8890 type: "string" 8891 example: "revenue-team" 8892 description: "The 20-hexdigit id or the key for a custom role." 8893 policy: 8894 type: "array" 8895 items: 8896 $ref: "#/definitions/Policy" 8897 membersBody: 8898 type: "object" 8899 required: 8900 - "email" 8901 properties: 8902 email: 8903 type: "string" 8904 example: "exampleuser@email.com" 8905 firstName: 8906 type: "string" 8907 example: "Bob" 8908 lastName: 8909 type: "string" 8910 example: "Loblaw" 8911 role: 8912 $ref: "#/definitions/Role" 8913 customRoles: 8914 type: "array" 8915 items: 8916 type: "string" 8917 example: "revenue-team" 8918 description: "The 20-hexdigit id or the key for a custom role." 8919 inlineRole: 8920 type: "array" 8921 items: 8922 $ref: "#/definitions/Statement" 8923 destinationBody: 8924 type: "object" 8925 required: 8926 - "config" 8927 - "kind" 8928 - "name" 8929 properties: 8930 name: 8931 type: "string" 8932 example: "Example Google Pub/Sub Destination" 8933 description: "A human-readable name for your data export destination." 8934 kind: 8935 type: "string" 8936 example: "google-pubsub" 8937 description: "The data export destination type. Available choices are kinesis,\ 8938 \ google-pubsub, mparticle, or segment." 8939 enum: 8940 - "google-pubsub" 8941 - "kinesis" 8942 - "mparticle" 8943 - "segment" 8944 config: 8945 type: "object" 8946 example: 8947 project: "cool-project" 8948 topic: "test" 8949 description: "destination-specific configuration." 8950 properties: {} 8951 "on": 8952 type: "boolean" 8953 example: true 8954 description: "Whether the data export destination is on or not." 8955 tokenBody: 8956 type: "object" 8957 properties: 8958 name: 8959 type: "string" 8960 example: "My access token" 8961 description: "A human-friendly name for the access token" 8962 role: 8963 type: "string" 8964 example: "writer" 8965 description: "The name of a built-in role for the token" 8966 customRoleIds: 8967 type: "array" 8968 description: "A list of custom role IDs to use as access limits for the access\ 8969 \ token" 8970 items: 8971 type: "string" 8972 example: "" 8973 inlineRole: 8974 type: "array" 8975 items: 8976 $ref: "#/definitions/Statement" 8977 serviceToken: 8978 type: "boolean" 8979 description: "Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens" 8980 defaultApiVersion: 8981 type: "integer" 8982 description: "The default API version for this token" 8983 relayProxyConfigBody: 8984 type: "object" 8985 properties: 8986 name: 8987 type: "string" 8988 example: "My relay proxy config" 8989 description: "A human-friendly name for the relay proxy configuration" 8990 policy: 8991 type: "array" 8992 items: 8993 $ref: "#/definitions/Policy" 8994 subscriptionBody: 8995 type: "object" 8996 required: 8997 - "config" 8998 - "name" 8999 properties: 9000 name: 9001 type: "string" 9002 example: "Example Datadog Integration" 9003 description: "A human-readable name for your subscription configuration." 9004 statements: 9005 type: "array" 9006 items: 9007 $ref: "#/definitions/Statement" 9008 config: 9009 type: "object" 9010 example: 9011 apiKey: "582**************************116" 9012 hostURL: "https://api.datadoghq.com" 9013 description: "Integration-specific configuration fields." 9014 properties: {} 9015 "on": 9016 type: "boolean" 9017 example: true 9018 description: "Whether the integration subscription is active or not." 9019 tags: 9020 type: "array" 9021 example: [] 9022 description: "Tags for the integration subscription." 9023 items: 9024 type: "string" 9025 Member__lastSeenMetadata: 9026 type: "object" 9027 properties: 9028 tokenId: 9029 type: "string" 9030 example: "5fd2a1ee05600316d5cb3e96" 9031 description: "If the last time this member accessed LaunchDarkly was using\ 9032 \ the REST API, this value will be set to the ID of the personal access\ 9033 \ token used." 9034 example: 9035 tokenId: "5fd2a1ee05600316d5cb3e96" 9036 FeatureFlagScheduledChangesConflicts_instructions: 9037 type: "object" 9038 properties: 9039 kind: 9040 type: "string" 9041 example: "removeUserTargets" 9042 description: "The name of the modification you would like to perform on a\ 9043 \ resource." 9044 conflicts: 9045 type: "array" 9046 items: 9047 $ref: "#/definitions/ScheduledChangesFeatureFlagConflict" 9048 example: 9049 kind: "removeUserTargets" 9050 conflicts: 9051 - reason: "reason" 9052 _id: "_id" 9053 - reason: "reason" 9054 _id: "_id" 9055 DependentFlag__links: 9056 type: "object" 9057 properties: 9058 self: 9059 $ref: "#/definitions/Link" 9060 example: 9061 self: 9062 href: "/api/v2/endpoint" 9063 type: "application/json" 9064 DependentFlagEnvironment__links: 9065 type: "object" 9066 properties: 9067 self: 9068 $ref: "#/definitions/Link" 9069 flagLink: 9070 $ref: "#/definitions/Link" 9071 example: 9072 flagLink: 9073 href: "/api/v2/endpoint" 9074 type: "application/json" 9075 self: 9076 href: "/api/v2/endpoint" 9077 type: "application/json" 9078 Environment_approvalSettings: 9079 type: "object" 9080 properties: 9081 serviceKind: 9082 type: "string" 9083 description: "The approvals system used." 9084 enum: 9085 - "launchdarkly" 9086 - "service-now" 9087 required: 9088 type: "boolean" 9089 description: "Whether any changes to flags in this environment will require\ 9090 \ approval. You may only set required or requiredApprovalTags, not both." 9091 canReviewOwnRequest: 9092 type: "boolean" 9093 description: "Whether requesters can approve or decline their own request.\ 9094 \ They may always comment." 9095 minNumApprovals: 9096 type: "integer" 9097 format: "int64" 9098 example: 2 9099 description: "The number of approvals required before an approval request\ 9100 \ can be applied." 9101 canApplyDeclinedChanges: 9102 type: "boolean" 9103 description: "Whether changes can be applied as long as minNumApprovals is\ 9104 \ met, regardless of if any reviewers have declined a request." 9105 requiredApprovalTags: 9106 type: "array" 9107 description: "An array of tags used to specify which flags with those tags\ 9108 \ require approval. You may only set requiredApprovalTags or required, not\ 9109 \ both." 9110 items: 9111 type: "string" 9112 description: "Approval settings for an environment. Only appears if the approvals\ 9113 \ feature is enabled." 9114 example: 9115 serviceKind: "launchdarkly" 9116 canReviewOwnRequest: true 9117 requiredApprovalTags: 9118 - "requiredApprovalTags" 9119 - "requiredApprovalTags" 9120 canApplyDeclinedChanges: true 9121 minNumApprovals: 2 9122 required: true 9123 AuditLogEntry_target: 9124 type: "object" 9125 properties: 9126 _links: 9127 $ref: "#/definitions/Links" 9128 name: 9129 type: "string" 9130 example: "Testing" 9131 resources: 9132 type: "array" 9133 items: 9134 type: "string" 9135 example: "proj/alexis:env/test" 9136 example: 9137 _links: 9138 next: 9139 href: "/api/v2/endpoint" 9140 type: "application/json" 9141 self: 9142 href: "/api/v2/endpoint" 9143 type: "application/json" 9144 name: "Testing" 9145 resources: 9146 - "proj/alexis:env/test" 9147 - "proj/alexis:env/test" 9148 SemanticPatchInstruction_inner: 9149 type: "object" 9150 properties: 9151 kind: 9152 type: "string" 9153 example: "removeUserTargets" 9154 description: "The name of the modification you would like to perform on a\ 9155 \ resource." 9156 IntegrationSubscription__status: 9157 type: "object" 9158 properties: 9159 successCount: 9160 type: "integer" 9161 example: 6 9162 lastSuccess: 9163 type: "integer" 9164 format: "int64" 9165 example: 1443652232590 9166 description: "A unix epoch time in milliseconds specifying the last time this\ 9167 \ integration was successfully used." 9168 errorCount: 9169 type: "integer" 9170 example: 2 9171 example: 9172 successCount: 6 9173 lastSuccess: 1443652232590 9174 errorCount: 2 9175 parameters: 9176 ResourceId: 9177 name: "resourceId" 9178 in: "path" 9179 description: "The resource ID." 9180 required: true 9181 type: "string" 9182 x-exportParamName: "ResourceId" 9183 WebhookPostRequest: 9184 in: "body" 9185 name: "webhookBody" 9186 description: "New webhook." 9187 required: true 9188 schema: 9189 $ref: "#/definitions/webhookBody" 9190 x-exportParamName: "WebhookBody" 9191 FeatureFlagCopyBody: 9192 in: "body" 9193 name: "featureFlagCopyBody" 9194 description: "Copy feature flag configurations between environments." 9195 required: true 9196 schema: 9197 $ref: "#/definitions/featureFlagCopyBody" 9198 x-exportParamName: "FeatureFlagCopyBody" 9199 FeatureFlagPostRequest: 9200 in: "body" 9201 name: "featureFlagBody" 9202 description: "Create a new feature flag." 9203 required: true 9204 schema: 9205 $ref: "#/definitions/featureFlagBody" 9206 x-exportParamName: "FeatureFlagBody" 9207 ScheduledChangeId: 9208 name: "scheduledChangeId" 9209 in: "path" 9210 description: "The id of the scheduled change" 9211 required: true 9212 type: "string" 9213 x-exportParamName: "ScheduledChangeId" 9214 FlagConfigScheduledChangesConflictsBody: 9215 in: "body" 9216 name: "flagConfigScheduledChangesConflictsBody" 9217 description: "Used to determine if a semantic patch will result in conflicts with\ 9218 \ scheduled changes on a feature flag." 9219 required: true 9220 schema: 9221 $ref: "#/definitions/flagConfigScheduledChangesConflictsBody" 9222 x-exportParamName: "FlagConfigScheduledChangesConflictsBody" 9223 FlagConfigScheduledChangesPostBody: 9224 in: "body" 9225 name: "flagConfigScheduledChangesPostBody" 9226 description: "Create scheduled changes on a feature flag." 9227 required: true 9228 schema: 9229 $ref: "#/definitions/flagConfigScheduledChangesPostBody" 9230 x-exportParamName: "FlagConfigScheduledChangesPostBody" 9231 FlagConfigScheduledChangesPatchBody: 9232 in: "body" 9233 name: "flagConfigScheduledChangesPatchBody" 9234 description: "Update scheduled changes on a feature flag." 9235 required: true 9236 schema: 9237 $ref: "#/definitions/flagConfigScheduledChangesPatchBody" 9238 x-exportParamName: "FlagConfigScheduledChangesPatchBody" 9239 DestinationPostRequest: 9240 in: "body" 9241 name: "destinationBody" 9242 description: "Create a new data export destination." 9243 required: true 9244 schema: 9245 $ref: "#/definitions/destinationBody" 9246 x-exportParamName: "DestinationBody" 9247 UserSegmentPostRequest: 9248 in: "body" 9249 name: "userSegmentBody" 9250 description: "Create a new user segment." 9251 required: true 9252 schema: 9253 $ref: "#/definitions/userSegmentBody" 9254 x-exportParamName: "UserSegmentBody" 9255 BigSegmentTargetsPostRequest: 9256 in: "body" 9257 name: "bigSegmentTargetsBody" 9258 description: "Add or remove user targets to the included or excluded lists on\ 9259 \ a big segment. Contact your account manager for early access to this feature." 9260 required: true 9261 schema: 9262 $ref: "#/definitions/bigSegmentTargetsBody" 9263 x-exportParamName: "BigSegmentTargetsBody" 9264 ProjectPostRequest: 9265 in: "body" 9266 name: "projectBody" 9267 description: "Project keys must be unique within an account." 9268 required: true 9269 schema: 9270 $ref: "#/definitions/projectBody" 9271 x-exportParamName: "ProjectBody" 9272 EnvironmentPostRequest: 9273 in: "body" 9274 name: "environmentBody" 9275 description: "New environment." 9276 required: true 9277 schema: 9278 $ref: "#/definitions/EnvironmentPost" 9279 x-exportParamName: "EnvironmentBody" 9280 ProjectKey: 9281 name: "projectKey" 9282 in: "path" 9283 description: "The project key, used to tie the flags together under one project\ 9284 \ so they can be managed together." 9285 required: true 9286 type: "string" 9287 x-exportParamName: "ProjectKey" 9288 EnvironmentKey: 9289 name: "environmentKey" 9290 in: "path" 9291 description: "The environment key, used to tie together flag configuration and\ 9292 \ users under one environment so they can be managed together." 9293 required: true 9294 type: "string" 9295 x-exportParamName: "EnvironmentKey" 9296 EnvironmentKeyQuery: 9297 name: "env" 9298 in: "query" 9299 description: "By default, each feature will include configurations for each environment.\ 9300 \ You can filter environments with the env query parameter. For example, setting\ 9301 \ env=[\"production\"] will restrict the returned configurations to just your\ 9302 \ production environment." 9303 required: false 9304 type: "array" 9305 items: 9306 type: "string" 9307 collectionFormat: "multi" 9308 x-exportParamName: "Env" 9309 EnvironmentSDKKeyExpiry: 9310 name: "expiry" 9311 in: "query" 9312 description: "An expiration time for the old environment SDK key, expressed as\ 9313 \ a Unix epoch time in milliseconds. By default, the key will expire immediately." 9314 required: false 9315 type: "integer" 9316 format: "int64" 9317 x-exportParamName: "Expiry" 9318 x-optionalDataType: "Int64" 9319 EnvironmentMobileKeyExpiry: 9320 name: "expiry" 9321 in: "query" 9322 description: "The expiry parameter is deprecated for this endpoint, so the old\ 9323 \ mobile key will always expire immediately. This parameter will be removed\ 9324 \ in an upcoming major API client version." 9325 required: false 9326 type: "integer" 9327 format: "int64" 9328 x-exportParamName: "Expiry" 9329 x-optionalDataType: "Int64" 9330 SummaryQuery: 9331 name: "summary" 9332 in: "query" 9333 description: "By default in api version >= 1, flags will _not_ include their list\ 9334 \ of prerequisites, targets or rules. Set summary=0 to include these fields\ 9335 \ for each flag returned." 9336 required: false 9337 type: "boolean" 9338 x-exportParamName: "Summary" 9339 x-optionalDataType: "Bool" 9340 ArchivedQuery: 9341 name: "archived" 9342 in: "query" 9343 description: "When set to 1, only archived flags will be included in the list\ 9344 \ of flags returned. By default, archived flags are not included in the list\ 9345 \ of flags." 9346 required: false 9347 type: "boolean" 9348 x-exportParamName: "Archived" 9349 x-optionalDataType: "Bool" 9350 LimitQuery: 9351 name: "limit" 9352 in: "query" 9353 description: "The number of objects to return. Defaults to -1, which returns everything." 9354 required: false 9355 type: "number" 9356 x-exportParamName: "Limit" 9357 x-optionalDataType: "Float32" 9358 OffsetQuery: 9359 name: "offset" 9360 in: "query" 9361 description: "Where to start in the list. This is for use with pagination. For\ 9362 \ example, an offset of 10 would skip the first 10 items and then return the\ 9363 \ next limit items." 9364 required: false 9365 type: "number" 9366 x-exportParamName: "Offset" 9367 x-optionalDataType: "Float32" 9368 FilterQuery: 9369 name: "filter" 9370 in: "query" 9371 description: "A comma-separated list of filters. Each filter is of the form field:value." 9372 required: false 9373 type: "string" 9374 x-exportParamName: "Filter" 9375 x-optionalDataType: "String" 9376 SortQuery: 9377 name: "sort" 9378 in: "query" 9379 description: "A comma-separated list of fields to sort by. A field prefixed by\ 9380 \ a - will be sorted in descending order." 9381 required: false 9382 type: "string" 9383 x-exportParamName: "Sort" 9384 x-optionalDataType: "String" 9385 FeatureFlagKey: 9386 name: "featureFlagKey" 9387 in: "path" 9388 description: "The feature flag's key. The key identifies the flag in your code." 9389 required: true 9390 type: "string" 9391 x-exportParamName: "FeatureFlagKey" 9392 CloneFlagKeyQuery: 9393 name: "clone" 9394 in: "query" 9395 description: "The key of the feature flag to be cloned. The key identifies the\ 9396 \ flag in your code. For example, setting clone=flagKey will copy the full\ 9397 \ targeting configuration for all environments (including on/off state) from\ 9398 \ the original flag to the new flag." 9399 required: false 9400 type: "string" 9401 x-exportParamName: "Clone" 9402 x-optionalDataType: "String" 9403 UserSegmentKey: 9404 name: "userSegmentKey" 9405 in: "path" 9406 description: "The user segment's key. The key identifies the user segment in your\ 9407 \ code." 9408 required: true 9409 type: "string" 9410 x-exportParamName: "UserSegmentKey" 9411 DestinationId: 9412 name: "destinationId" 9413 in: "path" 9414 description: "The data export destination ID." 9415 required: true 9416 type: "string" 9417 x-exportParamName: "DestinationId" 9418 UserKey: 9419 name: "userKey" 9420 in: "path" 9421 description: "The user's key." 9422 required: true 9423 type: "string" 9424 x-exportParamName: "UserKey" 9425 Tag: 9426 name: "tag" 9427 in: "query" 9428 description: "Filter by tag. A tag can be used to group flags across projects." 9429 required: false 9430 type: "string" 9431 x-exportParamName: "Tag" 9432 x-optionalDataType: "String" 9433 Limit: 9434 name: "limit" 9435 in: "query" 9436 description: "Pagination limit." 9437 required: false 9438 type: "integer" 9439 x-exportParamName: "Limit" 9440 x-optionalDataType: "Int32" 9441 Query: 9442 name: "q" 9443 in: "query" 9444 description: "Search query." 9445 required: false 9446 type: "string" 9447 x-exportParamName: "Q" 9448 x-optionalDataType: "String" 9449 HMAC: 9450 name: "h" 9451 in: "query" 9452 description: "This parameter is required when following \"next\" links." 9453 required: false 9454 type: "string" 9455 x-exportParamName: "H" 9456 x-optionalDataType: "String" 9457 ScrollId: 9458 name: "scrollId" 9459 in: "query" 9460 description: "This parameter is required when following \"next\" links." 9461 required: false 9462 type: "string" 9463 x-exportParamName: "ScrollId" 9464 x-optionalDataType: "String" 9465 Offset: 9466 name: "offset" 9467 in: "query" 9468 description: "Specifies the first item to return in the collection." 9469 required: false 9470 type: "integer" 9471 x-exportParamName: "Offset" 9472 x-optionalDataType: "Int32" 9473 After: 9474 name: "after" 9475 in: "query" 9476 description: "A timestamp filter, expressed as a Unix epoch time in milliseconds.\ 9477 \ All entries returned will have occurred after this timestamp." 9478 required: false 9479 type: "integer" 9480 format: "int64" 9481 x-exportParamName: "After" 9482 x-optionalDataType: "Int64" 9483 PatchRequest: 9484 in: "body" 9485 name: "patchDelta" 9486 description: "Requires a JSON Patch representation of the desired changes to the\ 9487 \ project. 'http://jsonpatch.com/'" 9488 required: true 9489 schema: 9490 type: "array" 9491 items: 9492 $ref: "#/definitions/PatchOperation" 9493 x-exportParamName: "PatchDelta" 9494 UserSettingsPutRequest: 9495 in: "body" 9496 name: "userSettingsBody" 9497 required: true 9498 schema: 9499 $ref: "#/definitions/userSettingsBody" 9500 x-exportParamName: "UserSettingsBody" 9501 Before: 9502 name: "before" 9503 in: "query" 9504 description: "A timestamp filter, expressed as a Unix epoch time in milliseconds.\ 9505 \ All entries returned will have before this timestamp." 9506 required: false 9507 type: "integer" 9508 format: "int64" 9509 x-exportParamName: "Before" 9510 x-optionalDataType: "Int64" 9511 Q: 9512 name: "q" 9513 in: "query" 9514 description: "Text to search for. You can search for the full or partial name\ 9515 \ of the resource involved or full or partial email address of the member who\ 9516 \ made the change." 9517 required: false 9518 type: "string" 9519 x-exportParamName: "Q" 9520 x-optionalDataType: "String" 9521 AuditLimit: 9522 name: "limit" 9523 in: "query" 9524 description: "A limit on the number of audit log entries to be returned, between\ 9525 \ 1 and 20." 9526 required: false 9527 type: "number" 9528 x-exportParamName: "Limit" 9529 x-optionalDataType: "Float32" 9530 Spec: 9531 name: "spec" 9532 in: "query" 9533 description: "A resource specifier, allowing you to filter audit log listings\ 9534 \ by resource." 9535 required: false 9536 type: "string" 9537 x-exportParamName: "Spec" 9538 x-optionalDataType: "String" 9539 MembersPostRequest: 9540 in: "body" 9541 name: "membersBody" 9542 description: "New members to invite." 9543 required: true 9544 schema: 9545 type: "array" 9546 items: 9547 $ref: "#/definitions/membersBody" 9548 x-exportParamName: "MembersBody" 9549 MemberId: 9550 name: "memberId" 9551 in: "path" 9552 description: "The member ID." 9553 required: true 9554 type: "string" 9555 x-exportParamName: "MemberId" 9556 CustomRolePostRequest: 9557 in: "body" 9558 name: "customRoleBody" 9559 description: "New role or roles to create." 9560 required: true 9561 schema: 9562 $ref: "#/definitions/customRoleBody" 9563 x-exportParamName: "CustomRoleBody" 9564 CustomRoleKey: 9565 name: "customRoleKey" 9566 in: "path" 9567 description: "The custom role key." 9568 required: true 9569 type: "string" 9570 x-exportParamName: "CustomRoleKey" 9571 PatchWithComment: 9572 in: "body" 9573 name: "patchComment" 9574 description: "Requires a JSON Patch representation of the desired changes to the\ 9575 \ project, and an optional comment. 'http://jsonpatch.com/' Feature flag patches\ 9576 \ also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386'\ 9577 \ The addition of comments is also supported." 9578 required: true 9579 schema: 9580 $ref: "#/definitions/patchComment" 9581 x-exportParamName: "PatchComment" 9582 PatchOnly: 9583 in: "body" 9584 name: "PatchOnly" 9585 description: "Requires a JSON Patch representation of the desired changes to the\ 9586 \ project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge\ 9587 \ Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments\ 9588 \ is also supported." 9589 required: true 9590 schema: 9591 type: "array" 9592 items: 9593 $ref: "#/definitions/PatchOperation" 9594 x-exportParamName: "PatchOnly" 9595 SemanticPatchWithComment: 9596 in: "body" 9597 name: "SemanticPatchWithComment" 9598 description: "Requires a Semantic Patch representation of the desired changes\ 9599 \ to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'.\ 9600 \ The addition of comments is also supported." 9601 required: true 9602 schema: 9603 type: "object" 9604 x-exportParamName: "SemanticPatchWithComment" 9605 StreamSource: 9606 name: "source" 9607 in: "path" 9608 description: "The source of where the stream comes from." 9609 required: true 9610 type: "string" 9611 x-exportParamName: "Source" 9612 EventType: 9613 name: "type" 9614 in: "path" 9615 description: "The type of event we would like to track." 9616 required: true 9617 type: "string" 9618 x-exportParamName: "Type_" 9619 EvaluationEnvId: 9620 name: "envId" 9621 in: "path" 9622 description: "The environment id for the flag evaluations in question." 9623 required: true 9624 type: "string" 9625 x-exportParamName: "EnvId" 9626 EvaluationFlagKey: 9627 name: "flagKey" 9628 in: "path" 9629 description: "The key of the flag we want metrics for." 9630 required: true 9631 type: "string" 9632 x-exportParamName: "FlagKey" 9633 TokensPostRequest: 9634 in: "body" 9635 name: "tokenBody" 9636 description: "Create a new access token." 9637 required: true 9638 schema: 9639 $ref: "#/definitions/tokenBody" 9640 x-exportParamName: "TokenBody" 9641 TokenId: 9642 name: "tokenId" 9643 in: "path" 9644 description: "The access token ID." 9645 required: true 9646 type: "string" 9647 x-exportParamName: "TokenId" 9648 TokenShowAllQuery: 9649 name: "showAll" 9650 in: "query" 9651 description: "If set to true, and the authentication access token has the \"Admin\"\ 9652 \ role, personal access tokens for all members will be retrieved." 9653 required: false 9654 type: "boolean" 9655 x-exportParamName: "ShowAll" 9656 x-optionalDataType: "Bool" 9657 TokenExpiry: 9658 name: "expiry" 9659 in: "query" 9660 description: "An expiration time for the old token key, expressed as a Unix epoch\ 9661 \ time in milliseconds. By default, the token will expire immediately." 9662 required: false 9663 type: "integer" 9664 format: "int64" 9665 x-exportParamName: "Expiry" 9666 x-optionalDataType: "Int64" 9667 RelayProxyConfigPostRequest: 9668 in: "body" 9669 name: "relayProxyConfigBody" 9670 description: "Create a new relay proxy configuration" 9671 required: true 9672 schema: 9673 $ref: "#/definitions/relayProxyConfigBody" 9674 x-exportParamName: "RelayProxyConfigBody" 9675 RelayProxyConfigId: 9676 name: "id" 9677 in: "path" 9678 description: "The relay proxy configuration ID" 9679 required: true 9680 type: "string" 9681 x-exportParamName: "Id" 9682 RelayProxyConfigsExpiry: 9683 name: "expiry" 9684 in: "query" 9685 description: "An expiration time for the old relay proxy configuration key, expressed\ 9686 \ as a Unix epoch time in milliseconds. By default, the relay proxy configuration\ 9687 \ will expire immediately" 9688 required: false 9689 type: "integer" 9690 format: "int64" 9691 x-exportParamName: "Expiry" 9692 x-optionalDataType: "Int64" 9693 ApprovalRequestId: 9694 name: "approvalRequestId" 9695 in: "path" 9696 description: "The approval request ID" 9697 required: true 9698 type: "string" 9699 x-exportParamName: "ApprovalRequestId" 9700 ApprovalRequestPostRequest: 9701 in: "body" 9702 name: "approvalRequestConfigBody" 9703 description: "Create a new approval request" 9704 required: false 9705 schema: 9706 $ref: "#/definitions/approvalRequestConfigBody" 9707 x-exportParamName: "ApprovalRequestConfigBody" 9708 ApprovalRequestReviewPostRequest: 9709 in: "body" 9710 name: "approvalRequestReviewConfigBody" 9711 description: "Review an approval request" 9712 required: true 9713 schema: 9714 $ref: "#/definitions/approvalRequestReviewConfigBody" 9715 x-exportParamName: "ApprovalRequestReviewConfigBody" 9716 ApprovalRequestApplyPostRequest: 9717 in: "body" 9718 name: "approvalRequestApplyConfigBody" 9719 description: "Apply an approval request" 9720 required: true 9721 schema: 9722 $ref: "#/definitions/approvalRequestApplyConfigBody" 9723 x-exportParamName: "ApprovalRequestApplyConfigBody" 9724 IntegrationKey: 9725 name: "integrationKey" 9726 in: "path" 9727 description: "The key used to specify the integration kind." 9728 required: true 9729 type: "string" 9730 x-exportParamName: "IntegrationKey" 9731 IntegrationId: 9732 name: "integrationId" 9733 in: "path" 9734 description: "The integration ID." 9735 required: true 9736 type: "string" 9737 x-exportParamName: "IntegrationId" 9738 IntegrationPostRequest: 9739 in: "body" 9740 name: "subscriptionBody" 9741 description: "Create a new integration subscription." 9742 required: true 9743 schema: 9744 $ref: "#/definitions/subscriptionBody" 9745 x-exportParamName: "SubscriptionBody" 9746 responses: 9747 BetaApi403: 9748 description: "This is a beta API, you must pass beta in the LD-API-Version header\ 9749 \ to use it." 9750 schema: 9751 $ref: "#/definitions/UsageError" 9752 CustomRole2xx: 9753 description: "Custom role response." 9754 schema: 9755 $ref: "#/definitions/CustomRole" 9756 Destination2xx: 9757 description: "Destination response." 9758 schema: 9759 $ref: "#/definitions/Destination" 9760 Environment2xx: 9761 description: "Environment response." 9762 schema: 9763 $ref: "#/definitions/Environment" 9764 EvaluationUsage404: 9765 description: "The environment or flag you requested could not be found" 9766 schema: 9767 $ref: "#/definitions/EvaluationUsageError" 9768 Member2xx: 9769 description: "Member response." 9770 schema: 9771 $ref: "#/definitions/Member" 9772 Project2xx: 9773 description: "Successful Project response." 9774 schema: 9775 $ref: "#/definitions/Project" 9776 RelayProxyConfig2xx: 9777 description: "Relay proxy config response." 9778 schema: 9779 $ref: "#/definitions/RelayProxyConfig" 9780 Root200: 9781 description: "A list of links to available resources in the API." 9782 schema: 9783 $ref: "#/definitions/Links" 9784 Standard201: 9785 description: "Resource created." 9786 Standard204: 9787 description: "Action completed successfully." 9788 Standard400: 9789 description: "Invalid request body." 9790 Standard401: 9791 description: "Invalid access token." 9792 Standard403: 9793 description: "Access to the requested resource was denied." 9794 Standard404: 9795 description: "Invalid resource specifier." 9796 Standard409: 9797 description: "Status conflict." 9798 StreamUsage404: 9799 description: "The stream source you requested could not be found" 9800 schema: 9801 $ref: "#/definitions/StreamUsageError" 9802 Token2xx: 9803 description: "Token response." 9804 schema: 9805 $ref: "#/definitions/Token" 9806 UserSegment2xx: 9807 description: "User segment response." 9808 schema: 9809 $ref: "#/definitions/UserSegment" 9810 Webhook2xx: 9811 description: "Webhook response." 9812 schema: 9813 $ref: "#/definitions/Webhook"