github.com/minio/console@v1.4.1/api/embedded_spec.go (about) 1 // Code generated by go-swagger; DO NOT EDIT. 2 3 // This file is part of MinIO Console Server 4 // Copyright (c) 2023 MinIO, Inc. 5 // 6 // This program is free software: you can redistribute it and/or modify 7 // it under the terms of the GNU Affero General Public License as published by 8 // the Free Software Foundation, either version 3 of the License, or 9 // (at your option) any later version. 10 // 11 // This program is distributed in the hope that it will be useful, 12 // but WITHOUT ANY WARRANTY; without even the implied warranty of 13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 // GNU Affero General Public License for more details. 15 // 16 // You should have received a copy of the GNU Affero General Public License 17 // along with this program. If not, see <http://www.gnu.org/licenses/>. 18 // 19 20 package api 21 22 // This file was generated by the swagger tool. 23 // Editing this file might prove futile when you re-run the swagger generate command 24 25 import ( 26 "encoding/json" 27 ) 28 29 var ( 30 // SwaggerJSON embedded version of the swagger document used at generation time 31 SwaggerJSON json.RawMessage 32 // FlatSwaggerJSON embedded flattened version of the swagger document used at generation time 33 FlatSwaggerJSON json.RawMessage 34 ) 35 36 func init() { 37 SwaggerJSON = json.RawMessage([]byte(`{ 38 "consumes": [ 39 "application/json" 40 ], 41 "produces": [ 42 "application/json" 43 ], 44 "schemes": [ 45 "http", 46 "ws" 47 ], 48 "swagger": "2.0", 49 "info": { 50 "title": "MinIO Console Server", 51 "version": "0.1.0" 52 }, 53 "basePath": "/api/v1", 54 "paths": { 55 "/account/change-password": { 56 "post": { 57 "tags": [ 58 "Account" 59 ], 60 "summary": "Change password of currently logged in user.", 61 "operationId": "AccountChangePassword", 62 "parameters": [ 63 { 64 "name": "body", 65 "in": "body", 66 "required": true, 67 "schema": { 68 "$ref": "#/definitions/accountChangePasswordRequest" 69 } 70 } 71 ], 72 "responses": { 73 "204": { 74 "description": "A successful login." 75 }, 76 "default": { 77 "description": "Generic error response.", 78 "schema": { 79 "$ref": "#/definitions/ApiError" 80 } 81 } 82 } 83 } 84 }, 85 "/account/change-user-password": { 86 "post": { 87 "tags": [ 88 "Account" 89 ], 90 "summary": "Change password of currently logged in user.", 91 "operationId": "ChangeUserPassword", 92 "parameters": [ 93 { 94 "name": "body", 95 "in": "body", 96 "required": true, 97 "schema": { 98 "$ref": "#/definitions/changeUserPasswordRequest" 99 } 100 } 101 ], 102 "responses": { 103 "201": { 104 "description": "Password successfully changed." 105 }, 106 "default": { 107 "description": "Generic error response.", 108 "schema": { 109 "$ref": "#/definitions/ApiError" 110 } 111 } 112 } 113 } 114 }, 115 "/admin/arns": { 116 "get": { 117 "tags": [ 118 "System" 119 ], 120 "summary": "Returns a list of active ARNs in the instance", 121 "operationId": "ArnList", 122 "responses": { 123 "200": { 124 "description": "A successful response.", 125 "schema": { 126 "$ref": "#/definitions/arnsResponse" 127 } 128 }, 129 "default": { 130 "description": "Generic error response.", 131 "schema": { 132 "$ref": "#/definitions/ApiError" 133 } 134 } 135 } 136 } 137 }, 138 "/admin/info": { 139 "get": { 140 "tags": [ 141 "System" 142 ], 143 "summary": "Returns information about the deployment", 144 "operationId": "AdminInfo", 145 "parameters": [ 146 { 147 "type": "boolean", 148 "default": false, 149 "name": "defaultOnly", 150 "in": "query" 151 } 152 ], 153 "responses": { 154 "200": { 155 "description": "A successful response.", 156 "schema": { 157 "$ref": "#/definitions/adminInfoResponse" 158 } 159 }, 160 "default": { 161 "description": "Generic error response.", 162 "schema": { 163 "$ref": "#/definitions/ApiError" 164 } 165 } 166 } 167 } 168 }, 169 "/admin/info/widgets/{widgetId}": { 170 "get": { 171 "tags": [ 172 "System" 173 ], 174 "summary": "Returns information about the deployment", 175 "operationId": "DashboardWidgetDetails", 176 "parameters": [ 177 { 178 "type": "integer", 179 "format": "int32", 180 "name": "widgetId", 181 "in": "path", 182 "required": true 183 }, 184 { 185 "type": "integer", 186 "name": "start", 187 "in": "query" 188 }, 189 { 190 "type": "integer", 191 "name": "end", 192 "in": "query" 193 }, 194 { 195 "type": "integer", 196 "format": "int32", 197 "name": "step", 198 "in": "query" 199 } 200 ], 201 "responses": { 202 "200": { 203 "description": "A successful response.", 204 "schema": { 205 "$ref": "#/definitions/widgetDetails" 206 } 207 }, 208 "default": { 209 "description": "Generic error response.", 210 "schema": { 211 "$ref": "#/definitions/ApiError" 212 } 213 } 214 } 215 } 216 }, 217 "/admin/inspect": { 218 "get": { 219 "produces": [ 220 "application/octet-stream" 221 ], 222 "tags": [ 223 "Inspect" 224 ], 225 "summary": "Inspect Files on Drive", 226 "operationId": "Inspect", 227 "parameters": [ 228 { 229 "type": "string", 230 "name": "file", 231 "in": "query", 232 "required": true 233 }, 234 { 235 "type": "string", 236 "name": "volume", 237 "in": "query", 238 "required": true 239 }, 240 { 241 "type": "boolean", 242 "name": "encrypt", 243 "in": "query" 244 } 245 ], 246 "responses": { 247 "200": { 248 "description": "A successful response.", 249 "schema": { 250 "type": "file" 251 } 252 }, 253 "default": { 254 "description": "Generic error response.", 255 "schema": { 256 "$ref": "#/definitions/ApiError" 257 } 258 } 259 } 260 } 261 }, 262 "/admin/notification_endpoints": { 263 "get": { 264 "tags": [ 265 "Configuration" 266 ], 267 "summary": "Returns a list of active notification endpoints", 268 "operationId": "NotificationEndpointList", 269 "responses": { 270 "200": { 271 "description": "A successful response.", 272 "schema": { 273 "$ref": "#/definitions/notifEndpointResponse" 274 } 275 }, 276 "default": { 277 "description": "Generic error response.", 278 "schema": { 279 "$ref": "#/definitions/ApiError" 280 } 281 } 282 } 283 }, 284 "post": { 285 "tags": [ 286 "Configuration" 287 ], 288 "summary": "Allows to configure a new notification endpoint", 289 "operationId": "AddNotificationEndpoint", 290 "parameters": [ 291 { 292 "name": "body", 293 "in": "body", 294 "required": true, 295 "schema": { 296 "$ref": "#/definitions/notificationEndpoint" 297 } 298 } 299 ], 300 "responses": { 301 "201": { 302 "description": "A successful response.", 303 "schema": { 304 "$ref": "#/definitions/setNotificationEndpointResponse" 305 } 306 }, 307 "default": { 308 "description": "Generic error response.", 309 "schema": { 310 "$ref": "#/definitions/ApiError" 311 } 312 } 313 } 314 } 315 }, 316 "/admin/site-replication": { 317 "get": { 318 "tags": [ 319 "SiteReplication" 320 ], 321 "summary": "Get list of Replication Sites", 322 "operationId": "GetSiteReplicationInfo", 323 "responses": { 324 "200": { 325 "description": "A successful response.", 326 "schema": { 327 "$ref": "#/definitions/siteReplicationInfoResponse" 328 } 329 }, 330 "default": { 331 "description": "Generic error response.", 332 "schema": { 333 "$ref": "#/definitions/ApiError" 334 } 335 } 336 } 337 }, 338 "put": { 339 "tags": [ 340 "SiteReplication" 341 ], 342 "summary": "Edit a Replication Site", 343 "operationId": "SiteReplicationEdit", 344 "parameters": [ 345 { 346 "name": "body", 347 "in": "body", 348 "required": true, 349 "schema": { 350 "$ref": "#/definitions/peerInfo" 351 } 352 } 353 ], 354 "responses": { 355 "200": { 356 "description": "A successful response.", 357 "schema": { 358 "$ref": "#/definitions/peerSiteEditResponse" 359 } 360 }, 361 "default": { 362 "description": "Generic error response.", 363 "schema": { 364 "$ref": "#/definitions/ApiError" 365 } 366 } 367 } 368 }, 369 "post": { 370 "tags": [ 371 "SiteReplication" 372 ], 373 "summary": "Add a Replication Site", 374 "operationId": "SiteReplicationInfoAdd", 375 "parameters": [ 376 { 377 "name": "body", 378 "in": "body", 379 "required": true, 380 "schema": { 381 "$ref": "#/definitions/siteReplicationAddRequest" 382 } 383 } 384 ], 385 "responses": { 386 "200": { 387 "description": "A successful response.", 388 "schema": { 389 "$ref": "#/definitions/siteReplicationAddResponse" 390 } 391 }, 392 "default": { 393 "description": "Generic error response.", 394 "schema": { 395 "$ref": "#/definitions/ApiError" 396 } 397 } 398 } 399 }, 400 "delete": { 401 "tags": [ 402 "SiteReplication" 403 ], 404 "summary": "Remove a Replication Site", 405 "operationId": "SiteReplicationRemove", 406 "parameters": [ 407 { 408 "name": "body", 409 "in": "body", 410 "required": true, 411 "schema": { 412 "$ref": "#/definitions/peerInfoRemove" 413 } 414 } 415 ], 416 "responses": { 417 "204": { 418 "description": "A successful response.", 419 "schema": { 420 "$ref": "#/definitions/peerSiteRemoveResponse" 421 } 422 }, 423 "default": { 424 "description": "Generic error response.", 425 "schema": { 426 "$ref": "#/definitions/ApiError" 427 } 428 } 429 } 430 } 431 }, 432 "/admin/site-replication/status": { 433 "get": { 434 "tags": [ 435 "SiteReplication" 436 ], 437 "summary": "Display overall site replication status", 438 "operationId": "GetSiteReplicationStatus", 439 "parameters": [ 440 { 441 "type": "boolean", 442 "default": true, 443 "description": "Include Bucket stats", 444 "name": "buckets", 445 "in": "query" 446 }, 447 { 448 "type": "boolean", 449 "default": true, 450 "description": "Include Group stats", 451 "name": "groups", 452 "in": "query" 453 }, 454 { 455 "type": "boolean", 456 "default": true, 457 "description": "Include Policies stats", 458 "name": "policies", 459 "in": "query" 460 }, 461 { 462 "type": "boolean", 463 "default": true, 464 "description": "Include Policies stats", 465 "name": "users", 466 "in": "query" 467 }, 468 { 469 "type": "string", 470 "description": "Entity Type to lookup", 471 "name": "entityType", 472 "in": "query" 473 }, 474 { 475 "type": "string", 476 "description": "Entity Value to lookup", 477 "name": "entityValue", 478 "in": "query" 479 } 480 ], 481 "responses": { 482 "200": { 483 "description": "A successful response.", 484 "schema": { 485 "$ref": "#/definitions/siteReplicationStatusResponse" 486 } 487 }, 488 "default": { 489 "description": "Generic error response.", 490 "schema": { 491 "$ref": "#/definitions/ApiError" 492 } 493 } 494 } 495 } 496 }, 497 "/admin/tiers": { 498 "get": { 499 "tags": [ 500 "Tiering" 501 ], 502 "summary": "Returns a list of tiers for ilm", 503 "operationId": "TiersList", 504 "responses": { 505 "200": { 506 "description": "A successful response.", 507 "schema": { 508 "$ref": "#/definitions/tierListResponse" 509 } 510 }, 511 "default": { 512 "description": "Generic error response.", 513 "schema": { 514 "$ref": "#/definitions/ApiError" 515 } 516 } 517 } 518 }, 519 "post": { 520 "tags": [ 521 "Tiering" 522 ], 523 "summary": "Allows to configure a new tier", 524 "operationId": "AddTier", 525 "parameters": [ 526 { 527 "name": "body", 528 "in": "body", 529 "required": true, 530 "schema": { 531 "$ref": "#/definitions/tier" 532 } 533 } 534 ], 535 "responses": { 536 "201": { 537 "description": "A successful response." 538 }, 539 "default": { 540 "description": "Generic error response.", 541 "schema": { 542 "$ref": "#/definitions/ApiError" 543 } 544 } 545 } 546 } 547 }, 548 "/admin/tiers/{type}/{name}": { 549 "get": { 550 "tags": [ 551 "Tiering" 552 ], 553 "summary": "Get Tier", 554 "operationId": "GetTier", 555 "parameters": [ 556 { 557 "enum": [ 558 "s3", 559 "gcs", 560 "azure", 561 "minio" 562 ], 563 "type": "string", 564 "name": "type", 565 "in": "path", 566 "required": true 567 }, 568 { 569 "type": "string", 570 "name": "name", 571 "in": "path", 572 "required": true 573 } 574 ], 575 "responses": { 576 "200": { 577 "description": "A successful response.", 578 "schema": { 579 "$ref": "#/definitions/tier" 580 } 581 }, 582 "default": { 583 "description": "Generic error response.", 584 "schema": { 585 "$ref": "#/definitions/ApiError" 586 } 587 } 588 } 589 } 590 }, 591 "/admin/tiers/{type}/{name}/credentials": { 592 "put": { 593 "tags": [ 594 "Tiering" 595 ], 596 "summary": "Edit Tier Credentials", 597 "operationId": "EditTierCredentials", 598 "parameters": [ 599 { 600 "enum": [ 601 "s3", 602 "gcs", 603 "azure", 604 "minio" 605 ], 606 "type": "string", 607 "name": "type", 608 "in": "path", 609 "required": true 610 }, 611 { 612 "type": "string", 613 "name": "name", 614 "in": "path", 615 "required": true 616 }, 617 { 618 "name": "body", 619 "in": "body", 620 "required": true, 621 "schema": { 622 "$ref": "#/definitions/tierCredentialsRequest" 623 } 624 } 625 ], 626 "responses": { 627 "200": { 628 "description": "A successful response." 629 }, 630 "default": { 631 "description": "Generic error response.", 632 "schema": { 633 "$ref": "#/definitions/ApiError" 634 } 635 } 636 } 637 } 638 }, 639 "/bucket-policy/{bucket}": { 640 "get": { 641 "tags": [ 642 "Bucket" 643 ], 644 "summary": "List Policies With Given Bucket", 645 "operationId": "ListPoliciesWithBucket", 646 "parameters": [ 647 { 648 "type": "string", 649 "name": "bucket", 650 "in": "path", 651 "required": true 652 }, 653 { 654 "$ref": "#/parameters/offset" 655 }, 656 { 657 "$ref": "#/parameters/limit" 658 } 659 ], 660 "responses": { 661 "200": { 662 "description": "A successful response.", 663 "schema": { 664 "$ref": "#/definitions/listPoliciesResponse" 665 } 666 }, 667 "default": { 668 "description": "Generic error response.", 669 "schema": { 670 "$ref": "#/definitions/ApiError" 671 } 672 } 673 } 674 } 675 }, 676 "/bucket-users/{bucket}": { 677 "get": { 678 "tags": [ 679 "Bucket" 680 ], 681 "summary": "List Users With Access to a Given Bucket", 682 "operationId": "ListUsersWithAccessToBucket", 683 "parameters": [ 684 { 685 "type": "string", 686 "name": "bucket", 687 "in": "path", 688 "required": true 689 }, 690 { 691 "$ref": "#/parameters/offset" 692 }, 693 { 694 "$ref": "#/parameters/limit" 695 } 696 ], 697 "responses": { 698 "200": { 699 "description": "A successful response.", 700 "schema": { 701 "type": "array", 702 "items": { 703 "type": "string" 704 } 705 } 706 }, 707 "default": { 708 "description": "Generic error response.", 709 "schema": { 710 "$ref": "#/definitions/ApiError" 711 } 712 } 713 } 714 } 715 }, 716 "/bucket/{bucket}/access-rules": { 717 "get": { 718 "tags": [ 719 "Bucket" 720 ], 721 "summary": "List Access Rules With Given Bucket", 722 "operationId": "ListAccessRulesWithBucket", 723 "parameters": [ 724 { 725 "type": "string", 726 "name": "bucket", 727 "in": "path", 728 "required": true 729 }, 730 { 731 "$ref": "#/parameters/offset" 732 }, 733 { 734 "$ref": "#/parameters/limit" 735 } 736 ], 737 "responses": { 738 "200": { 739 "description": "A successful response.", 740 "schema": { 741 "$ref": "#/definitions/listAccessRulesResponse" 742 } 743 }, 744 "default": { 745 "description": "Generic error response.", 746 "schema": { 747 "$ref": "#/definitions/ApiError" 748 } 749 } 750 } 751 }, 752 "put": { 753 "tags": [ 754 "Bucket" 755 ], 756 "summary": "Add Access Rule To Given Bucket", 757 "operationId": "SetAccessRuleWithBucket", 758 "parameters": [ 759 { 760 "type": "string", 761 "name": "bucket", 762 "in": "path", 763 "required": true 764 }, 765 { 766 "name": "prefixaccess", 767 "in": "body", 768 "required": true, 769 "schema": { 770 "$ref": "#/definitions/prefixAccessPair" 771 } 772 } 773 ], 774 "responses": { 775 "200": { 776 "description": "A successful response.", 777 "schema": { 778 "type": "boolean" 779 } 780 }, 781 "default": { 782 "description": "Generic error response.", 783 "schema": { 784 "$ref": "#/definitions/ApiError" 785 } 786 } 787 } 788 }, 789 "delete": { 790 "tags": [ 791 "Bucket" 792 ], 793 "summary": "Delete Access Rule From Given Bucket", 794 "operationId": "DeleteAccessRuleWithBucket", 795 "parameters": [ 796 { 797 "type": "string", 798 "name": "bucket", 799 "in": "path", 800 "required": true 801 }, 802 { 803 "name": "prefix", 804 "in": "body", 805 "required": true, 806 "schema": { 807 "$ref": "#/definitions/prefixWrapper" 808 } 809 } 810 ], 811 "responses": { 812 "200": { 813 "description": "A successful response.", 814 "schema": { 815 "type": "boolean" 816 } 817 }, 818 "default": { 819 "description": "Generic error response.", 820 "schema": { 821 "$ref": "#/definitions/ApiError" 822 } 823 } 824 } 825 } 826 }, 827 "/buckets": { 828 "get": { 829 "tags": [ 830 "Bucket" 831 ], 832 "summary": "List Buckets", 833 "operationId": "ListBuckets", 834 "responses": { 835 "200": { 836 "description": "A successful response.", 837 "schema": { 838 "$ref": "#/definitions/listBucketsResponse" 839 } 840 }, 841 "default": { 842 "description": "Generic error response.", 843 "schema": { 844 "$ref": "#/definitions/ApiError" 845 } 846 } 847 } 848 }, 849 "post": { 850 "tags": [ 851 "Bucket" 852 ], 853 "summary": "Make bucket", 854 "operationId": "MakeBucket", 855 "parameters": [ 856 { 857 "name": "body", 858 "in": "body", 859 "required": true, 860 "schema": { 861 "$ref": "#/definitions/makeBucketRequest" 862 } 863 } 864 ], 865 "responses": { 866 "200": { 867 "description": "A successful response.", 868 "schema": { 869 "$ref": "#/definitions/makeBucketsResponse" 870 } 871 }, 872 "default": { 873 "description": "Generic error response.", 874 "schema": { 875 "$ref": "#/definitions/ApiError" 876 } 877 } 878 } 879 } 880 }, 881 "/buckets-replication": { 882 "post": { 883 "tags": [ 884 "Bucket" 885 ], 886 "summary": "Sets Multi Bucket Replication in multiple Buckets", 887 "operationId": "SetMultiBucketReplication", 888 "parameters": [ 889 { 890 "name": "body", 891 "in": "body", 892 "required": true, 893 "schema": { 894 "$ref": "#/definitions/multiBucketReplication" 895 } 896 } 897 ], 898 "responses": { 899 "200": { 900 "description": "A successful response.", 901 "schema": { 902 "$ref": "#/definitions/multiBucketResponseState" 903 } 904 }, 905 "default": { 906 "description": "Generic error response.", 907 "schema": { 908 "$ref": "#/definitions/ApiError" 909 } 910 } 911 } 912 } 913 }, 914 "/buckets/max-share-exp": { 915 "get": { 916 "tags": [ 917 "Bucket" 918 ], 919 "summary": "Get max expiration time for share link in seconds", 920 "operationId": "GetMaxShareLinkExp", 921 "responses": { 922 "200": { 923 "description": "A successful response.", 924 "schema": { 925 "$ref": "#/definitions/maxShareLinkExpResponse" 926 } 927 }, 928 "default": { 929 "description": "Generic error response.", 930 "schema": { 931 "$ref": "#/definitions/ApiError" 932 } 933 } 934 } 935 } 936 }, 937 "/buckets/multi-lifecycle": { 938 "post": { 939 "tags": [ 940 "Bucket" 941 ], 942 "summary": "Add Multi Bucket Lifecycle", 943 "operationId": "AddMultiBucketLifecycle", 944 "parameters": [ 945 { 946 "name": "body", 947 "in": "body", 948 "required": true, 949 "schema": { 950 "$ref": "#/definitions/addMultiBucketLifecycle" 951 } 952 } 953 ], 954 "responses": { 955 "200": { 956 "description": "A successful response.", 957 "schema": { 958 "$ref": "#/definitions/multiLifecycleResult" 959 } 960 }, 961 "default": { 962 "description": "Generic error response.", 963 "schema": { 964 "$ref": "#/definitions/ApiError" 965 } 966 } 967 } 968 } 969 }, 970 "/buckets/{bucket_name}/delete-all-replication-rules": { 971 "delete": { 972 "tags": [ 973 "Bucket" 974 ], 975 "summary": "Deletes all replication rules from a bucket", 976 "operationId": "DeleteAllReplicationRules", 977 "parameters": [ 978 { 979 "type": "string", 980 "name": "bucket_name", 981 "in": "path", 982 "required": true 983 } 984 ], 985 "responses": { 986 "204": { 987 "description": "A successful response." 988 }, 989 "default": { 990 "description": "Generic error response.", 991 "schema": { 992 "$ref": "#/definitions/ApiError" 993 } 994 } 995 } 996 } 997 }, 998 "/buckets/{bucket_name}/delete-objects": { 999 "post": { 1000 "tags": [ 1001 "Object" 1002 ], 1003 "summary": "Delete Multiple Objects", 1004 "operationId": "DeleteMultipleObjects", 1005 "parameters": [ 1006 { 1007 "type": "string", 1008 "name": "bucket_name", 1009 "in": "path", 1010 "required": true 1011 }, 1012 { 1013 "type": "boolean", 1014 "name": "all_versions", 1015 "in": "query" 1016 }, 1017 { 1018 "type": "boolean", 1019 "name": "bypass", 1020 "in": "query" 1021 }, 1022 { 1023 "name": "files", 1024 "in": "body", 1025 "required": true, 1026 "schema": { 1027 "type": "array", 1028 "items": { 1029 "$ref": "#/definitions/deleteFile" 1030 } 1031 } 1032 } 1033 ], 1034 "responses": { 1035 "200": { 1036 "description": "A successful response." 1037 }, 1038 "default": { 1039 "description": "Generic error response.", 1040 "schema": { 1041 "$ref": "#/definitions/ApiError" 1042 } 1043 } 1044 } 1045 } 1046 }, 1047 "/buckets/{bucket_name}/delete-selected-replication-rules": { 1048 "delete": { 1049 "tags": [ 1050 "Bucket" 1051 ], 1052 "summary": "Deletes selected replication rules from a bucket", 1053 "operationId": "DeleteSelectedReplicationRules", 1054 "parameters": [ 1055 { 1056 "type": "string", 1057 "name": "bucket_name", 1058 "in": "path", 1059 "required": true 1060 }, 1061 { 1062 "name": "rules", 1063 "in": "body", 1064 "required": true, 1065 "schema": { 1066 "$ref": "#/definitions/bucketReplicationRuleList" 1067 } 1068 } 1069 ], 1070 "responses": { 1071 "204": { 1072 "description": "A successful response." 1073 }, 1074 "default": { 1075 "description": "Generic error response.", 1076 "schema": { 1077 "$ref": "#/definitions/ApiError" 1078 } 1079 } 1080 } 1081 } 1082 }, 1083 "/buckets/{bucket_name}/encryption/disable": { 1084 "post": { 1085 "tags": [ 1086 "Bucket" 1087 ], 1088 "summary": "Disable bucket encryption.", 1089 "operationId": "DisableBucketEncryption", 1090 "parameters": [ 1091 { 1092 "type": "string", 1093 "name": "bucket_name", 1094 "in": "path", 1095 "required": true 1096 } 1097 ], 1098 "responses": { 1099 "200": { 1100 "description": "A successful response." 1101 }, 1102 "default": { 1103 "description": "Generic error response.", 1104 "schema": { 1105 "$ref": "#/definitions/ApiError" 1106 } 1107 } 1108 } 1109 } 1110 }, 1111 "/buckets/{bucket_name}/encryption/enable": { 1112 "post": { 1113 "tags": [ 1114 "Bucket" 1115 ], 1116 "summary": "Enable bucket encryption.", 1117 "operationId": "EnableBucketEncryption", 1118 "parameters": [ 1119 { 1120 "type": "string", 1121 "name": "bucket_name", 1122 "in": "path", 1123 "required": true 1124 }, 1125 { 1126 "name": "body", 1127 "in": "body", 1128 "required": true, 1129 "schema": { 1130 "$ref": "#/definitions/bucketEncryptionRequest" 1131 } 1132 } 1133 ], 1134 "responses": { 1135 "200": { 1136 "description": "A successful response." 1137 }, 1138 "default": { 1139 "description": "Generic error response.", 1140 "schema": { 1141 "$ref": "#/definitions/ApiError" 1142 } 1143 } 1144 } 1145 } 1146 }, 1147 "/buckets/{bucket_name}/encryption/info": { 1148 "get": { 1149 "tags": [ 1150 "Bucket" 1151 ], 1152 "summary": "Get bucket encryption information.", 1153 "operationId": "GetBucketEncryptionInfo", 1154 "parameters": [ 1155 { 1156 "type": "string", 1157 "name": "bucket_name", 1158 "in": "path", 1159 "required": true 1160 } 1161 ], 1162 "responses": { 1163 "200": { 1164 "description": "A successful response.", 1165 "schema": { 1166 "$ref": "#/definitions/bucketEncryptionInfo" 1167 } 1168 }, 1169 "default": { 1170 "description": "Generic error response.", 1171 "schema": { 1172 "$ref": "#/definitions/ApiError" 1173 } 1174 } 1175 } 1176 } 1177 }, 1178 "/buckets/{bucket_name}/events": { 1179 "get": { 1180 "tags": [ 1181 "Bucket" 1182 ], 1183 "summary": "List Bucket Events", 1184 "operationId": "ListBucketEvents", 1185 "parameters": [ 1186 { 1187 "type": "string", 1188 "name": "bucket_name", 1189 "in": "path", 1190 "required": true 1191 }, 1192 { 1193 "$ref": "#/parameters/offset" 1194 }, 1195 { 1196 "$ref": "#/parameters/limit" 1197 } 1198 ], 1199 "responses": { 1200 "200": { 1201 "description": "A successful response.", 1202 "schema": { 1203 "$ref": "#/definitions/listBucketEventsResponse" 1204 } 1205 }, 1206 "default": { 1207 "description": "Generic error response.", 1208 "schema": { 1209 "$ref": "#/definitions/ApiError" 1210 } 1211 } 1212 } 1213 }, 1214 "post": { 1215 "tags": [ 1216 "Bucket" 1217 ], 1218 "summary": "Create Bucket Event", 1219 "operationId": "CreateBucketEvent", 1220 "parameters": [ 1221 { 1222 "type": "string", 1223 "name": "bucket_name", 1224 "in": "path", 1225 "required": true 1226 }, 1227 { 1228 "name": "body", 1229 "in": "body", 1230 "required": true, 1231 "schema": { 1232 "$ref": "#/definitions/bucketEventRequest" 1233 } 1234 } 1235 ], 1236 "responses": { 1237 "201": { 1238 "description": "A successful response." 1239 }, 1240 "default": { 1241 "description": "Generic error response.", 1242 "schema": { 1243 "$ref": "#/definitions/ApiError" 1244 } 1245 } 1246 } 1247 } 1248 }, 1249 "/buckets/{bucket_name}/events/{arn}": { 1250 "delete": { 1251 "tags": [ 1252 "Bucket" 1253 ], 1254 "summary": "Delete Bucket Event", 1255 "operationId": "DeleteBucketEvent", 1256 "parameters": [ 1257 { 1258 "type": "string", 1259 "name": "bucket_name", 1260 "in": "path", 1261 "required": true 1262 }, 1263 { 1264 "type": "string", 1265 "name": "arn", 1266 "in": "path", 1267 "required": true 1268 }, 1269 { 1270 "name": "body", 1271 "in": "body", 1272 "required": true, 1273 "schema": { 1274 "$ref": "#/definitions/notificationDeleteRequest" 1275 } 1276 } 1277 ], 1278 "responses": { 1279 "204": { 1280 "description": "A successful response." 1281 }, 1282 "default": { 1283 "description": "Generic error response.", 1284 "schema": { 1285 "$ref": "#/definitions/ApiError" 1286 } 1287 } 1288 } 1289 } 1290 }, 1291 "/buckets/{bucket_name}/lifecycle": { 1292 "get": { 1293 "tags": [ 1294 "Bucket" 1295 ], 1296 "summary": "Bucket Lifecycle", 1297 "operationId": "GetBucketLifecycle", 1298 "parameters": [ 1299 { 1300 "type": "string", 1301 "name": "bucket_name", 1302 "in": "path", 1303 "required": true 1304 } 1305 ], 1306 "responses": { 1307 "200": { 1308 "description": "A successful response.", 1309 "schema": { 1310 "$ref": "#/definitions/bucketLifecycleResponse" 1311 } 1312 }, 1313 "default": { 1314 "description": "Generic error response.", 1315 "schema": { 1316 "$ref": "#/definitions/ApiError" 1317 } 1318 } 1319 } 1320 }, 1321 "post": { 1322 "tags": [ 1323 "Bucket" 1324 ], 1325 "summary": "Add Bucket Lifecycle", 1326 "operationId": "AddBucketLifecycle", 1327 "parameters": [ 1328 { 1329 "type": "string", 1330 "name": "bucket_name", 1331 "in": "path", 1332 "required": true 1333 }, 1334 { 1335 "name": "body", 1336 "in": "body", 1337 "required": true, 1338 "schema": { 1339 "$ref": "#/definitions/addBucketLifecycle" 1340 } 1341 } 1342 ], 1343 "responses": { 1344 "201": { 1345 "description": "A successful response." 1346 }, 1347 "default": { 1348 "description": "Generic error response.", 1349 "schema": { 1350 "$ref": "#/definitions/ApiError" 1351 } 1352 } 1353 } 1354 } 1355 }, 1356 "/buckets/{bucket_name}/lifecycle/{lifecycle_id}": { 1357 "put": { 1358 "tags": [ 1359 "Bucket" 1360 ], 1361 "summary": "Update Lifecycle rule", 1362 "operationId": "UpdateBucketLifecycle", 1363 "parameters": [ 1364 { 1365 "type": "string", 1366 "name": "bucket_name", 1367 "in": "path", 1368 "required": true 1369 }, 1370 { 1371 "type": "string", 1372 "name": "lifecycle_id", 1373 "in": "path", 1374 "required": true 1375 }, 1376 { 1377 "name": "body", 1378 "in": "body", 1379 "required": true, 1380 "schema": { 1381 "$ref": "#/definitions/updateBucketLifecycle" 1382 } 1383 } 1384 ], 1385 "responses": { 1386 "200": { 1387 "description": "A successful response." 1388 }, 1389 "default": { 1390 "description": "Generic error response.", 1391 "schema": { 1392 "$ref": "#/definitions/ApiError" 1393 } 1394 } 1395 } 1396 }, 1397 "delete": { 1398 "tags": [ 1399 "Bucket" 1400 ], 1401 "summary": "Delete Lifecycle rule", 1402 "operationId": "DeleteBucketLifecycleRule", 1403 "parameters": [ 1404 { 1405 "type": "string", 1406 "name": "bucket_name", 1407 "in": "path", 1408 "required": true 1409 }, 1410 { 1411 "type": "string", 1412 "name": "lifecycle_id", 1413 "in": "path", 1414 "required": true 1415 } 1416 ], 1417 "responses": { 1418 "204": { 1419 "description": "A successful response." 1420 }, 1421 "default": { 1422 "description": "Generic error response.", 1423 "schema": { 1424 "$ref": "#/definitions/ApiError" 1425 } 1426 } 1427 } 1428 } 1429 }, 1430 "/buckets/{bucket_name}/object-locking": { 1431 "get": { 1432 "tags": [ 1433 "Bucket" 1434 ], 1435 "summary": "Returns the status of object locking support on the bucket", 1436 "operationId": "GetBucketObjectLockingStatus", 1437 "parameters": [ 1438 { 1439 "type": "string", 1440 "name": "bucket_name", 1441 "in": "path", 1442 "required": true 1443 } 1444 ], 1445 "responses": { 1446 "200": { 1447 "description": "A successful response.", 1448 "schema": { 1449 "$ref": "#/definitions/bucketObLockingResponse" 1450 } 1451 }, 1452 "default": { 1453 "description": "Generic error response.", 1454 "schema": { 1455 "$ref": "#/definitions/ApiError" 1456 } 1457 } 1458 } 1459 } 1460 }, 1461 "/buckets/{bucket_name}/objects": { 1462 "get": { 1463 "security": [ 1464 { 1465 "key": [] 1466 }, 1467 { 1468 "anonymous": [] 1469 } 1470 ], 1471 "tags": [ 1472 "Object" 1473 ], 1474 "summary": "List Objects", 1475 "operationId": "ListObjects", 1476 "parameters": [ 1477 { 1478 "type": "string", 1479 "name": "bucket_name", 1480 "in": "path", 1481 "required": true 1482 }, 1483 { 1484 "type": "string", 1485 "name": "prefix", 1486 "in": "query" 1487 }, 1488 { 1489 "type": "boolean", 1490 "name": "recursive", 1491 "in": "query" 1492 }, 1493 { 1494 "type": "boolean", 1495 "name": "with_versions", 1496 "in": "query" 1497 }, 1498 { 1499 "type": "boolean", 1500 "name": "with_metadata", 1501 "in": "query" 1502 }, 1503 { 1504 "$ref": "#/parameters/limit" 1505 } 1506 ], 1507 "responses": { 1508 "200": { 1509 "description": "A successful response.", 1510 "schema": { 1511 "$ref": "#/definitions/listObjectsResponse" 1512 } 1513 }, 1514 "default": { 1515 "description": "Generic error response.", 1516 "schema": { 1517 "$ref": "#/definitions/ApiError" 1518 } 1519 } 1520 } 1521 }, 1522 "delete": { 1523 "tags": [ 1524 "Object" 1525 ], 1526 "summary": "Delete Object", 1527 "operationId": "DeleteObject", 1528 "parameters": [ 1529 { 1530 "type": "string", 1531 "name": "bucket_name", 1532 "in": "path", 1533 "required": true 1534 }, 1535 { 1536 "type": "string", 1537 "name": "prefix", 1538 "in": "query", 1539 "required": true 1540 }, 1541 { 1542 "type": "string", 1543 "name": "version_id", 1544 "in": "query" 1545 }, 1546 { 1547 "type": "boolean", 1548 "name": "recursive", 1549 "in": "query" 1550 }, 1551 { 1552 "type": "boolean", 1553 "name": "all_versions", 1554 "in": "query" 1555 }, 1556 { 1557 "type": "boolean", 1558 "name": "non_current_versions", 1559 "in": "query" 1560 }, 1561 { 1562 "type": "boolean", 1563 "name": "bypass", 1564 "in": "query" 1565 } 1566 ], 1567 "responses": { 1568 "200": { 1569 "description": "A successful response." 1570 }, 1571 "default": { 1572 "description": "Generic error response.", 1573 "schema": { 1574 "$ref": "#/definitions/ApiError" 1575 } 1576 } 1577 } 1578 } 1579 }, 1580 "/buckets/{bucket_name}/objects/download": { 1581 "get": { 1582 "security": [ 1583 { 1584 "key": [] 1585 }, 1586 { 1587 "anonymous": [] 1588 } 1589 ], 1590 "produces": [ 1591 "application/octet-stream" 1592 ], 1593 "tags": [ 1594 "Object" 1595 ], 1596 "summary": "Download Object", 1597 "operationId": "Download Object", 1598 "parameters": [ 1599 { 1600 "type": "string", 1601 "name": "bucket_name", 1602 "in": "path", 1603 "required": true 1604 }, 1605 { 1606 "type": "string", 1607 "name": "prefix", 1608 "in": "query", 1609 "required": true 1610 }, 1611 { 1612 "type": "string", 1613 "name": "version_id", 1614 "in": "query" 1615 }, 1616 { 1617 "type": "boolean", 1618 "default": false, 1619 "name": "preview", 1620 "in": "query" 1621 }, 1622 { 1623 "type": "string", 1624 "default": "", 1625 "name": "override_file_name", 1626 "in": "query" 1627 } 1628 ], 1629 "responses": { 1630 "200": { 1631 "description": "A successful response.", 1632 "schema": { 1633 "type": "file" 1634 } 1635 }, 1636 "default": { 1637 "description": "Generic error response.", 1638 "schema": { 1639 "$ref": "#/definitions/ApiError" 1640 } 1641 } 1642 } 1643 } 1644 }, 1645 "/buckets/{bucket_name}/objects/download-multiple": { 1646 "post": { 1647 "security": [ 1648 { 1649 "key": [] 1650 }, 1651 { 1652 "anonymous": [] 1653 } 1654 ], 1655 "produces": [ 1656 "application/octet-stream" 1657 ], 1658 "tags": [ 1659 "Object" 1660 ], 1661 "summary": "Download Multiple Objects", 1662 "operationId": "DownloadMultipleObjects", 1663 "parameters": [ 1664 { 1665 "type": "string", 1666 "name": "bucket_name", 1667 "in": "path", 1668 "required": true 1669 }, 1670 { 1671 "name": "objectList", 1672 "in": "body", 1673 "required": true, 1674 "schema": { 1675 "type": "array", 1676 "items": { 1677 "type": "string" 1678 } 1679 } 1680 } 1681 ], 1682 "responses": { 1683 "200": { 1684 "description": "A successful response.", 1685 "schema": { 1686 "type": "file" 1687 } 1688 }, 1689 "default": { 1690 "description": "Generic error response.", 1691 "schema": { 1692 "$ref": "#/definitions/ApiError" 1693 } 1694 } 1695 } 1696 } 1697 }, 1698 "/buckets/{bucket_name}/objects/legalhold": { 1699 "put": { 1700 "tags": [ 1701 "Object" 1702 ], 1703 "summary": "Put Object's legalhold status", 1704 "operationId": "PutObjectLegalHold", 1705 "parameters": [ 1706 { 1707 "type": "string", 1708 "name": "bucket_name", 1709 "in": "path", 1710 "required": true 1711 }, 1712 { 1713 "type": "string", 1714 "name": "prefix", 1715 "in": "query", 1716 "required": true 1717 }, 1718 { 1719 "type": "string", 1720 "name": "version_id", 1721 "in": "query", 1722 "required": true 1723 }, 1724 { 1725 "name": "body", 1726 "in": "body", 1727 "required": true, 1728 "schema": { 1729 "$ref": "#/definitions/putObjectLegalHoldRequest" 1730 } 1731 } 1732 ], 1733 "responses": { 1734 "200": { 1735 "description": "A successful response." 1736 }, 1737 "default": { 1738 "description": "Generic error response.", 1739 "schema": { 1740 "$ref": "#/definitions/ApiError" 1741 } 1742 } 1743 } 1744 } 1745 }, 1746 "/buckets/{bucket_name}/objects/metadata": { 1747 "get": { 1748 "tags": [ 1749 "Object" 1750 ], 1751 "summary": "Gets the metadata of an object", 1752 "operationId": "GetObjectMetadata", 1753 "parameters": [ 1754 { 1755 "type": "string", 1756 "name": "bucket_name", 1757 "in": "path", 1758 "required": true 1759 }, 1760 { 1761 "type": "string", 1762 "name": "prefix", 1763 "in": "query", 1764 "required": true 1765 }, 1766 { 1767 "type": "string", 1768 "name": "versionID", 1769 "in": "query" 1770 } 1771 ], 1772 "responses": { 1773 "200": { 1774 "description": "A successful response.", 1775 "schema": { 1776 "$ref": "#/definitions/metadata" 1777 } 1778 }, 1779 "default": { 1780 "description": "Generic error response.", 1781 "schema": { 1782 "$ref": "#/definitions/ApiError" 1783 } 1784 } 1785 } 1786 } 1787 }, 1788 "/buckets/{bucket_name}/objects/restore": { 1789 "put": { 1790 "tags": [ 1791 "Object" 1792 ], 1793 "summary": "Restore Object to a selected version", 1794 "operationId": "PutObjectRestore", 1795 "parameters": [ 1796 { 1797 "type": "string", 1798 "name": "bucket_name", 1799 "in": "path", 1800 "required": true 1801 }, 1802 { 1803 "type": "string", 1804 "name": "prefix", 1805 "in": "query", 1806 "required": true 1807 }, 1808 { 1809 "type": "string", 1810 "name": "version_id", 1811 "in": "query", 1812 "required": true 1813 } 1814 ], 1815 "responses": { 1816 "200": { 1817 "description": "A successful response." 1818 }, 1819 "default": { 1820 "description": "Generic error response.", 1821 "schema": { 1822 "$ref": "#/definitions/ApiError" 1823 } 1824 } 1825 } 1826 } 1827 }, 1828 "/buckets/{bucket_name}/objects/retention": { 1829 "put": { 1830 "tags": [ 1831 "Object" 1832 ], 1833 "summary": "Put Object's retention status", 1834 "operationId": "PutObjectRetention", 1835 "parameters": [ 1836 { 1837 "type": "string", 1838 "name": "bucket_name", 1839 "in": "path", 1840 "required": true 1841 }, 1842 { 1843 "type": "string", 1844 "name": "prefix", 1845 "in": "query", 1846 "required": true 1847 }, 1848 { 1849 "type": "string", 1850 "name": "version_id", 1851 "in": "query", 1852 "required": true 1853 }, 1854 { 1855 "name": "body", 1856 "in": "body", 1857 "required": true, 1858 "schema": { 1859 "$ref": "#/definitions/putObjectRetentionRequest" 1860 } 1861 } 1862 ], 1863 "responses": { 1864 "200": { 1865 "description": "A successful response." 1866 }, 1867 "default": { 1868 "description": "Generic error response.", 1869 "schema": { 1870 "$ref": "#/definitions/ApiError" 1871 } 1872 } 1873 } 1874 }, 1875 "delete": { 1876 "tags": [ 1877 "Object" 1878 ], 1879 "summary": "Delete Object retention from an object", 1880 "operationId": "DeleteObjectRetention", 1881 "parameters": [ 1882 { 1883 "type": "string", 1884 "name": "bucket_name", 1885 "in": "path", 1886 "required": true 1887 }, 1888 { 1889 "type": "string", 1890 "name": "prefix", 1891 "in": "query", 1892 "required": true 1893 }, 1894 { 1895 "type": "string", 1896 "name": "version_id", 1897 "in": "query", 1898 "required": true 1899 } 1900 ], 1901 "responses": { 1902 "200": { 1903 "description": "A successful response." 1904 }, 1905 "default": { 1906 "description": "Generic error response.", 1907 "schema": { 1908 "$ref": "#/definitions/ApiError" 1909 } 1910 } 1911 } 1912 } 1913 }, 1914 "/buckets/{bucket_name}/objects/share": { 1915 "get": { 1916 "tags": [ 1917 "Object" 1918 ], 1919 "summary": "Shares an Object on a url", 1920 "operationId": "ShareObject", 1921 "parameters": [ 1922 { 1923 "type": "string", 1924 "name": "bucket_name", 1925 "in": "path", 1926 "required": true 1927 }, 1928 { 1929 "type": "string", 1930 "name": "prefix", 1931 "in": "query", 1932 "required": true 1933 }, 1934 { 1935 "type": "string", 1936 "name": "version_id", 1937 "in": "query", 1938 "required": true 1939 }, 1940 { 1941 "type": "string", 1942 "name": "expires", 1943 "in": "query" 1944 } 1945 ], 1946 "responses": { 1947 "200": { 1948 "description": "A successful response.", 1949 "schema": { 1950 "type": "string" 1951 } 1952 }, 1953 "default": { 1954 "description": "Generic error response.", 1955 "schema": { 1956 "$ref": "#/definitions/ApiError" 1957 } 1958 } 1959 } 1960 } 1961 }, 1962 "/buckets/{bucket_name}/objects/tags": { 1963 "put": { 1964 "tags": [ 1965 "Object" 1966 ], 1967 "summary": "Put Object's tags", 1968 "operationId": "PutObjectTags", 1969 "parameters": [ 1970 { 1971 "type": "string", 1972 "name": "bucket_name", 1973 "in": "path", 1974 "required": true 1975 }, 1976 { 1977 "type": "string", 1978 "name": "prefix", 1979 "in": "query", 1980 "required": true 1981 }, 1982 { 1983 "type": "string", 1984 "name": "version_id", 1985 "in": "query", 1986 "required": true 1987 }, 1988 { 1989 "name": "body", 1990 "in": "body", 1991 "required": true, 1992 "schema": { 1993 "$ref": "#/definitions/putObjectTagsRequest" 1994 } 1995 } 1996 ], 1997 "responses": { 1998 "200": { 1999 "description": "A successful response." 2000 }, 2001 "default": { 2002 "description": "Generic error response.", 2003 "schema": { 2004 "$ref": "#/definitions/ApiError" 2005 } 2006 } 2007 } 2008 } 2009 }, 2010 "/buckets/{bucket_name}/objects/upload": { 2011 "post": { 2012 "security": [ 2013 { 2014 "key": [] 2015 }, 2016 { 2017 "anonymous": [] 2018 } 2019 ], 2020 "consumes": [ 2021 "multipart/form-data" 2022 ], 2023 "tags": [ 2024 "Object" 2025 ], 2026 "summary": "Uploads an Object.", 2027 "parameters": [ 2028 { 2029 "type": "string", 2030 "name": "bucket_name", 2031 "in": "path", 2032 "required": true 2033 }, 2034 { 2035 "type": "string", 2036 "name": "prefix", 2037 "in": "query" 2038 } 2039 ], 2040 "responses": { 2041 "200": { 2042 "description": "A successful response." 2043 }, 2044 "default": { 2045 "description": "Generic error response.", 2046 "schema": { 2047 "$ref": "#/definitions/ApiError" 2048 } 2049 } 2050 } 2051 } 2052 }, 2053 "/buckets/{bucket_name}/replication": { 2054 "get": { 2055 "tags": [ 2056 "Bucket" 2057 ], 2058 "summary": "Bucket Replication", 2059 "operationId": "GetBucketReplication", 2060 "parameters": [ 2061 { 2062 "type": "string", 2063 "name": "bucket_name", 2064 "in": "path", 2065 "required": true 2066 } 2067 ], 2068 "responses": { 2069 "200": { 2070 "description": "A successful response.", 2071 "schema": { 2072 "$ref": "#/definitions/bucketReplicationResponse" 2073 } 2074 }, 2075 "default": { 2076 "description": "Generic error response.", 2077 "schema": { 2078 "$ref": "#/definitions/ApiError" 2079 } 2080 } 2081 } 2082 } 2083 }, 2084 "/buckets/{bucket_name}/replication/{rule_id}": { 2085 "get": { 2086 "tags": [ 2087 "Bucket" 2088 ], 2089 "summary": "Bucket Replication", 2090 "operationId": "GetBucketReplicationRule", 2091 "parameters": [ 2092 { 2093 "type": "string", 2094 "name": "bucket_name", 2095 "in": "path", 2096 "required": true 2097 }, 2098 { 2099 "type": "string", 2100 "name": "rule_id", 2101 "in": "path", 2102 "required": true 2103 } 2104 ], 2105 "responses": { 2106 "200": { 2107 "description": "A successful response.", 2108 "schema": { 2109 "$ref": "#/definitions/bucketReplicationRule" 2110 } 2111 }, 2112 "default": { 2113 "description": "Generic error response.", 2114 "schema": { 2115 "$ref": "#/definitions/ApiError" 2116 } 2117 } 2118 } 2119 }, 2120 "put": { 2121 "tags": [ 2122 "Bucket" 2123 ], 2124 "summary": "Update Replication rule", 2125 "operationId": "UpdateMultiBucketReplication", 2126 "parameters": [ 2127 { 2128 "type": "string", 2129 "name": "bucket_name", 2130 "in": "path", 2131 "required": true 2132 }, 2133 { 2134 "type": "string", 2135 "name": "rule_id", 2136 "in": "path", 2137 "required": true 2138 }, 2139 { 2140 "name": "body", 2141 "in": "body", 2142 "required": true, 2143 "schema": { 2144 "$ref": "#/definitions/multiBucketReplicationEdit" 2145 } 2146 } 2147 ], 2148 "responses": { 2149 "201": { 2150 "description": "A successful response." 2151 }, 2152 "default": { 2153 "description": "Generic error response.", 2154 "schema": { 2155 "$ref": "#/definitions/ApiError" 2156 } 2157 } 2158 } 2159 }, 2160 "delete": { 2161 "tags": [ 2162 "Bucket" 2163 ], 2164 "summary": "Bucket Replication Rule Delete", 2165 "operationId": "DeleteBucketReplicationRule", 2166 "parameters": [ 2167 { 2168 "type": "string", 2169 "name": "bucket_name", 2170 "in": "path", 2171 "required": true 2172 }, 2173 { 2174 "type": "string", 2175 "name": "rule_id", 2176 "in": "path", 2177 "required": true 2178 } 2179 ], 2180 "responses": { 2181 "204": { 2182 "description": "A successful response." 2183 }, 2184 "default": { 2185 "description": "Generic error response.", 2186 "schema": { 2187 "$ref": "#/definitions/ApiError" 2188 } 2189 } 2190 } 2191 } 2192 }, 2193 "/buckets/{bucket_name}/retention": { 2194 "get": { 2195 "tags": [ 2196 "Bucket" 2197 ], 2198 "summary": "Get Bucket's retention config", 2199 "operationId": "GetBucketRetentionConfig", 2200 "parameters": [ 2201 { 2202 "type": "string", 2203 "name": "bucket_name", 2204 "in": "path", 2205 "required": true 2206 } 2207 ], 2208 "responses": { 2209 "200": { 2210 "description": "A successful response.", 2211 "schema": { 2212 "$ref": "#/definitions/getBucketRetentionConfig" 2213 } 2214 }, 2215 "default": { 2216 "description": "Generic error response.", 2217 "schema": { 2218 "$ref": "#/definitions/ApiError" 2219 } 2220 } 2221 } 2222 }, 2223 "put": { 2224 "tags": [ 2225 "Bucket" 2226 ], 2227 "summary": "Set Bucket's retention config", 2228 "operationId": "SetBucketRetentionConfig", 2229 "parameters": [ 2230 { 2231 "type": "string", 2232 "name": "bucket_name", 2233 "in": "path", 2234 "required": true 2235 }, 2236 { 2237 "name": "body", 2238 "in": "body", 2239 "required": true, 2240 "schema": { 2241 "$ref": "#/definitions/putBucketRetentionRequest" 2242 } 2243 } 2244 ], 2245 "responses": { 2246 "200": { 2247 "description": "A successful response." 2248 }, 2249 "default": { 2250 "description": "Generic error response.", 2251 "schema": { 2252 "$ref": "#/definitions/ApiError" 2253 } 2254 } 2255 } 2256 } 2257 }, 2258 "/buckets/{bucket_name}/rewind/{date}": { 2259 "get": { 2260 "tags": [ 2261 "Bucket" 2262 ], 2263 "summary": "Get objects in a bucket for a rewind date", 2264 "operationId": "GetBucketRewind", 2265 "parameters": [ 2266 { 2267 "type": "string", 2268 "name": "bucket_name", 2269 "in": "path", 2270 "required": true 2271 }, 2272 { 2273 "type": "string", 2274 "name": "date", 2275 "in": "path", 2276 "required": true 2277 }, 2278 { 2279 "type": "string", 2280 "name": "prefix", 2281 "in": "query" 2282 } 2283 ], 2284 "responses": { 2285 "200": { 2286 "description": "A successful response.", 2287 "schema": { 2288 "$ref": "#/definitions/rewindResponse" 2289 } 2290 }, 2291 "default": { 2292 "description": "Generic error response.", 2293 "schema": { 2294 "$ref": "#/definitions/ApiError" 2295 } 2296 } 2297 } 2298 } 2299 }, 2300 "/buckets/{bucket_name}/tags": { 2301 "put": { 2302 "tags": [ 2303 "Bucket" 2304 ], 2305 "summary": "Put Bucket's tags", 2306 "operationId": "PutBucketTags", 2307 "parameters": [ 2308 { 2309 "type": "string", 2310 "name": "bucket_name", 2311 "in": "path", 2312 "required": true 2313 }, 2314 { 2315 "name": "body", 2316 "in": "body", 2317 "required": true, 2318 "schema": { 2319 "$ref": "#/definitions/putBucketTagsRequest" 2320 } 2321 } 2322 ], 2323 "responses": { 2324 "200": { 2325 "description": "A successful response." 2326 }, 2327 "default": { 2328 "description": "Generic error response.", 2329 "schema": { 2330 "$ref": "#/definitions/ApiError" 2331 } 2332 } 2333 } 2334 } 2335 }, 2336 "/buckets/{bucket_name}/versioning": { 2337 "get": { 2338 "tags": [ 2339 "Bucket" 2340 ], 2341 "summary": "Bucket Versioning", 2342 "operationId": "GetBucketVersioning", 2343 "parameters": [ 2344 { 2345 "type": "string", 2346 "name": "bucket_name", 2347 "in": "path", 2348 "required": true 2349 } 2350 ], 2351 "responses": { 2352 "200": { 2353 "description": "A successful response.", 2354 "schema": { 2355 "$ref": "#/definitions/bucketVersioningResponse" 2356 } 2357 }, 2358 "default": { 2359 "description": "Generic error response.", 2360 "schema": { 2361 "$ref": "#/definitions/ApiError" 2362 } 2363 } 2364 } 2365 }, 2366 "put": { 2367 "tags": [ 2368 "Bucket" 2369 ], 2370 "summary": "Set Bucket Versioning", 2371 "operationId": "SetBucketVersioning", 2372 "parameters": [ 2373 { 2374 "type": "string", 2375 "name": "bucket_name", 2376 "in": "path", 2377 "required": true 2378 }, 2379 { 2380 "name": "body", 2381 "in": "body", 2382 "required": true, 2383 "schema": { 2384 "$ref": "#/definitions/setBucketVersioning" 2385 } 2386 } 2387 ], 2388 "responses": { 2389 "201": { 2390 "description": "A successful response." 2391 }, 2392 "default": { 2393 "description": "Generic error response.", 2394 "schema": { 2395 "$ref": "#/definitions/ApiError" 2396 } 2397 } 2398 } 2399 } 2400 }, 2401 "/buckets/{name}": { 2402 "get": { 2403 "tags": [ 2404 "Bucket" 2405 ], 2406 "summary": "Bucket Info", 2407 "operationId": "BucketInfo", 2408 "parameters": [ 2409 { 2410 "type": "string", 2411 "name": "name", 2412 "in": "path", 2413 "required": true 2414 } 2415 ], 2416 "responses": { 2417 "200": { 2418 "description": "A successful response.", 2419 "schema": { 2420 "$ref": "#/definitions/bucket" 2421 } 2422 }, 2423 "default": { 2424 "description": "Generic error response.", 2425 "schema": { 2426 "$ref": "#/definitions/ApiError" 2427 } 2428 } 2429 } 2430 }, 2431 "delete": { 2432 "tags": [ 2433 "Bucket" 2434 ], 2435 "summary": "Delete Bucket", 2436 "operationId": "DeleteBucket", 2437 "parameters": [ 2438 { 2439 "type": "string", 2440 "name": "name", 2441 "in": "path", 2442 "required": true 2443 } 2444 ], 2445 "responses": { 2446 "204": { 2447 "description": "A successful response." 2448 }, 2449 "default": { 2450 "description": "Generic error response.", 2451 "schema": { 2452 "$ref": "#/definitions/ApiError" 2453 } 2454 } 2455 } 2456 } 2457 }, 2458 "/buckets/{name}/quota": { 2459 "get": { 2460 "tags": [ 2461 "Bucket" 2462 ], 2463 "summary": "Get Bucket Quota", 2464 "operationId": "GetBucketQuota", 2465 "parameters": [ 2466 { 2467 "type": "string", 2468 "name": "name", 2469 "in": "path", 2470 "required": true 2471 } 2472 ], 2473 "responses": { 2474 "200": { 2475 "description": "A successful response.", 2476 "schema": { 2477 "$ref": "#/definitions/bucketQuota" 2478 } 2479 }, 2480 "default": { 2481 "description": "Generic error response.", 2482 "schema": { 2483 "$ref": "#/definitions/ApiError" 2484 } 2485 } 2486 } 2487 }, 2488 "put": { 2489 "tags": [ 2490 "Bucket" 2491 ], 2492 "summary": "Bucket Quota", 2493 "operationId": "SetBucketQuota", 2494 "parameters": [ 2495 { 2496 "type": "string", 2497 "name": "name", 2498 "in": "path", 2499 "required": true 2500 }, 2501 { 2502 "name": "body", 2503 "in": "body", 2504 "required": true, 2505 "schema": { 2506 "$ref": "#/definitions/setBucketQuota" 2507 } 2508 } 2509 ], 2510 "responses": { 2511 "200": { 2512 "description": "A successful response.", 2513 "schema": { 2514 "$ref": "#/definitions/bucket" 2515 } 2516 }, 2517 "default": { 2518 "description": "Generic error response.", 2519 "schema": { 2520 "$ref": "#/definitions/ApiError" 2521 } 2522 } 2523 } 2524 } 2525 }, 2526 "/buckets/{name}/set-policy": { 2527 "put": { 2528 "tags": [ 2529 "Bucket" 2530 ], 2531 "summary": "Bucket Set Policy", 2532 "operationId": "BucketSetPolicy", 2533 "parameters": [ 2534 { 2535 "type": "string", 2536 "name": "name", 2537 "in": "path", 2538 "required": true 2539 }, 2540 { 2541 "name": "body", 2542 "in": "body", 2543 "required": true, 2544 "schema": { 2545 "$ref": "#/definitions/setBucketPolicyRequest" 2546 } 2547 } 2548 ], 2549 "responses": { 2550 "200": { 2551 "description": "A successful response.", 2552 "schema": { 2553 "$ref": "#/definitions/bucket" 2554 } 2555 }, 2556 "default": { 2557 "description": "Generic error response.", 2558 "schema": { 2559 "$ref": "#/definitions/ApiError" 2560 } 2561 } 2562 } 2563 } 2564 }, 2565 "/configs": { 2566 "get": { 2567 "tags": [ 2568 "Configuration" 2569 ], 2570 "summary": "List Configurations", 2571 "operationId": "ListConfig", 2572 "parameters": [ 2573 { 2574 "$ref": "#/parameters/offset" 2575 }, 2576 { 2577 "$ref": "#/parameters/limit" 2578 } 2579 ], 2580 "responses": { 2581 "200": { 2582 "description": "A successful response.", 2583 "schema": { 2584 "$ref": "#/definitions/listConfigResponse" 2585 } 2586 }, 2587 "default": { 2588 "description": "Generic error response.", 2589 "schema": { 2590 "$ref": "#/definitions/ApiError" 2591 } 2592 } 2593 } 2594 } 2595 }, 2596 "/configs/export": { 2597 "get": { 2598 "tags": [ 2599 "Configuration" 2600 ], 2601 "summary": "Export the current config from MinIO server", 2602 "operationId": "ExportConfig", 2603 "responses": { 2604 "200": { 2605 "description": "A successful response.", 2606 "schema": { 2607 "$ref": "#/definitions/configExportResponse" 2608 } 2609 }, 2610 "default": { 2611 "description": "Generic error response.", 2612 "schema": { 2613 "$ref": "#/definitions/ApiError" 2614 } 2615 } 2616 } 2617 } 2618 }, 2619 "/configs/import": { 2620 "post": { 2621 "consumes": [ 2622 "multipart/form-data" 2623 ], 2624 "tags": [ 2625 "Configuration" 2626 ], 2627 "summary": "Uploads a file to import MinIO server config.", 2628 "parameters": [ 2629 { 2630 "type": "file", 2631 "name": "file", 2632 "in": "formData", 2633 "required": true 2634 } 2635 ], 2636 "responses": { 2637 "200": { 2638 "description": "A successful response." 2639 }, 2640 "default": { 2641 "description": "Generic error response.", 2642 "schema": { 2643 "$ref": "#/definitions/ApiError" 2644 } 2645 } 2646 } 2647 } 2648 }, 2649 "/configs/{name}": { 2650 "get": { 2651 "tags": [ 2652 "Configuration" 2653 ], 2654 "summary": "Configuration info", 2655 "operationId": "ConfigInfo", 2656 "parameters": [ 2657 { 2658 "type": "string", 2659 "name": "name", 2660 "in": "path", 2661 "required": true 2662 } 2663 ], 2664 "responses": { 2665 "200": { 2666 "description": "A successful response.", 2667 "schema": { 2668 "type": "array", 2669 "items": { 2670 "$ref": "#/definitions/configuration" 2671 } 2672 } 2673 }, 2674 "default": { 2675 "description": "Generic error response.", 2676 "schema": { 2677 "$ref": "#/definitions/ApiError" 2678 } 2679 } 2680 } 2681 }, 2682 "put": { 2683 "tags": [ 2684 "Configuration" 2685 ], 2686 "summary": "Set Configuration", 2687 "operationId": "SetConfig", 2688 "parameters": [ 2689 { 2690 "type": "string", 2691 "name": "name", 2692 "in": "path", 2693 "required": true 2694 }, 2695 { 2696 "name": "body", 2697 "in": "body", 2698 "required": true, 2699 "schema": { 2700 "$ref": "#/definitions/setConfigRequest" 2701 } 2702 } 2703 ], 2704 "responses": { 2705 "200": { 2706 "description": "A successful response.", 2707 "schema": { 2708 "$ref": "#/definitions/setConfigResponse" 2709 } 2710 }, 2711 "default": { 2712 "description": "Generic error response.", 2713 "schema": { 2714 "$ref": "#/definitions/ApiError" 2715 } 2716 } 2717 } 2718 } 2719 }, 2720 "/configs/{name}/reset": { 2721 "post": { 2722 "tags": [ 2723 "Configuration" 2724 ], 2725 "summary": "Configuration reset", 2726 "operationId": "ResetConfig", 2727 "parameters": [ 2728 { 2729 "type": "string", 2730 "name": "name", 2731 "in": "path", 2732 "required": true 2733 } 2734 ], 2735 "responses": { 2736 "200": { 2737 "description": "A successful response.", 2738 "schema": { 2739 "$ref": "#/definitions/setConfigResponse" 2740 } 2741 }, 2742 "default": { 2743 "description": "Generic error response.", 2744 "schema": { 2745 "$ref": "#/definitions/ApiError" 2746 } 2747 } 2748 } 2749 } 2750 }, 2751 "/download-shared-object/{url}": { 2752 "get": { 2753 "security": [], 2754 "produces": [ 2755 "application/octet-stream" 2756 ], 2757 "tags": [ 2758 "Public" 2759 ], 2760 "summary": "Downloads an object from a presigned url", 2761 "operationId": "DownloadSharedObject", 2762 "parameters": [ 2763 { 2764 "type": "string", 2765 "name": "url", 2766 "in": "path", 2767 "required": true 2768 } 2769 ], 2770 "responses": { 2771 "200": { 2772 "description": "A successful response.", 2773 "schema": { 2774 "type": "file" 2775 } 2776 }, 2777 "default": { 2778 "description": "Generic error response.", 2779 "schema": { 2780 "$ref": "#/definitions/ApiError" 2781 } 2782 } 2783 } 2784 } 2785 }, 2786 "/group/{name}": { 2787 "get": { 2788 "tags": [ 2789 "Group" 2790 ], 2791 "summary": "Group info", 2792 "operationId": "GroupInfo", 2793 "parameters": [ 2794 { 2795 "type": "string", 2796 "name": "name", 2797 "in": "path", 2798 "required": true 2799 } 2800 ], 2801 "responses": { 2802 "200": { 2803 "description": "A successful response.", 2804 "schema": { 2805 "$ref": "#/definitions/group" 2806 } 2807 }, 2808 "default": { 2809 "description": "Generic error response.", 2810 "schema": { 2811 "$ref": "#/definitions/ApiError" 2812 } 2813 } 2814 } 2815 }, 2816 "put": { 2817 "tags": [ 2818 "Group" 2819 ], 2820 "summary": "Update Group Members or Status", 2821 "operationId": "UpdateGroup", 2822 "parameters": [ 2823 { 2824 "type": "string", 2825 "name": "name", 2826 "in": "path", 2827 "required": true 2828 }, 2829 { 2830 "name": "body", 2831 "in": "body", 2832 "required": true, 2833 "schema": { 2834 "$ref": "#/definitions/updateGroupRequest" 2835 } 2836 } 2837 ], 2838 "responses": { 2839 "200": { 2840 "description": "A successful response.", 2841 "schema": { 2842 "$ref": "#/definitions/group" 2843 } 2844 }, 2845 "default": { 2846 "description": "Generic error response.", 2847 "schema": { 2848 "$ref": "#/definitions/ApiError" 2849 } 2850 } 2851 } 2852 }, 2853 "delete": { 2854 "tags": [ 2855 "Group" 2856 ], 2857 "summary": "Remove group", 2858 "operationId": "RemoveGroup", 2859 "parameters": [ 2860 { 2861 "type": "string", 2862 "name": "name", 2863 "in": "path", 2864 "required": true 2865 } 2866 ], 2867 "responses": { 2868 "204": { 2869 "description": "A successful response." 2870 }, 2871 "default": { 2872 "description": "Generic error response.", 2873 "schema": { 2874 "$ref": "#/definitions/ApiError" 2875 } 2876 } 2877 } 2878 } 2879 }, 2880 "/groups": { 2881 "get": { 2882 "tags": [ 2883 "Group" 2884 ], 2885 "summary": "List Groups", 2886 "operationId": "ListGroups", 2887 "parameters": [ 2888 { 2889 "$ref": "#/parameters/offset" 2890 }, 2891 { 2892 "$ref": "#/parameters/limit" 2893 } 2894 ], 2895 "responses": { 2896 "200": { 2897 "description": "A successful response.", 2898 "schema": { 2899 "$ref": "#/definitions/listGroupsResponse" 2900 } 2901 }, 2902 "default": { 2903 "description": "Generic error response.", 2904 "schema": { 2905 "$ref": "#/definitions/ApiError" 2906 } 2907 } 2908 } 2909 }, 2910 "post": { 2911 "tags": [ 2912 "Group" 2913 ], 2914 "summary": "Add Group", 2915 "operationId": "AddGroup", 2916 "parameters": [ 2917 { 2918 "name": "body", 2919 "in": "body", 2920 "required": true, 2921 "schema": { 2922 "$ref": "#/definitions/addGroupRequest" 2923 } 2924 } 2925 ], 2926 "responses": { 2927 "201": { 2928 "description": "A successful response." 2929 }, 2930 "default": { 2931 "description": "Generic error response.", 2932 "schema": { 2933 "$ref": "#/definitions/ApiError" 2934 } 2935 } 2936 } 2937 } 2938 }, 2939 "/idp/{type}": { 2940 "get": { 2941 "tags": [ 2942 "idp" 2943 ], 2944 "summary": "List IDP Configurations", 2945 "operationId": "ListConfigurations", 2946 "parameters": [ 2947 { 2948 "type": "string", 2949 "description": "IDP Configuration Type", 2950 "name": "type", 2951 "in": "path", 2952 "required": true 2953 } 2954 ], 2955 "responses": { 2956 "200": { 2957 "description": "A successful response.", 2958 "schema": { 2959 "$ref": "#/definitions/idpListConfigurationsResponse" 2960 } 2961 }, 2962 "default": { 2963 "description": "Generic error response.", 2964 "schema": { 2965 "$ref": "#/definitions/ApiError" 2966 } 2967 } 2968 } 2969 }, 2970 "post": { 2971 "consumes": [ 2972 "application/json" 2973 ], 2974 "tags": [ 2975 "idp" 2976 ], 2977 "summary": "Create IDP Configuration", 2978 "operationId": "CreateConfiguration", 2979 "parameters": [ 2980 { 2981 "type": "string", 2982 "description": "IDP Configuration Type", 2983 "name": "type", 2984 "in": "path", 2985 "required": true 2986 }, 2987 { 2988 "name": "body", 2989 "in": "body", 2990 "required": true, 2991 "schema": { 2992 "$ref": "#/definitions/idpServerConfiguration" 2993 } 2994 } 2995 ], 2996 "responses": { 2997 "201": { 2998 "description": "A successful response.", 2999 "schema": { 3000 "$ref": "#/definitions/setIDPResponse" 3001 } 3002 }, 3003 "default": { 3004 "description": "Generic error response.", 3005 "schema": { 3006 "$ref": "#/definitions/ApiError" 3007 } 3008 } 3009 } 3010 } 3011 }, 3012 "/idp/{type}/{name}": { 3013 "get": { 3014 "tags": [ 3015 "idp" 3016 ], 3017 "summary": "Get IDP Configuration", 3018 "operationId": "GetConfiguration", 3019 "parameters": [ 3020 { 3021 "type": "string", 3022 "description": "IDP Configuration Name", 3023 "name": "name", 3024 "in": "path", 3025 "required": true 3026 }, 3027 { 3028 "type": "string", 3029 "description": "IDP Configuration Type", 3030 "name": "type", 3031 "in": "path", 3032 "required": true 3033 } 3034 ], 3035 "responses": { 3036 "200": { 3037 "description": "A successful response.", 3038 "schema": { 3039 "$ref": "#/definitions/idpServerConfiguration" 3040 } 3041 }, 3042 "default": { 3043 "description": "Generic error response.", 3044 "schema": { 3045 "$ref": "#/definitions/ApiError" 3046 } 3047 } 3048 } 3049 }, 3050 "put": { 3051 "consumes": [ 3052 "application/json" 3053 ], 3054 "tags": [ 3055 "idp" 3056 ], 3057 "summary": "Update IDP Configuration", 3058 "operationId": "UpdateConfiguration", 3059 "parameters": [ 3060 { 3061 "name": "body", 3062 "in": "body", 3063 "required": true, 3064 "schema": { 3065 "$ref": "#/definitions/idpServerConfiguration" 3066 } 3067 }, 3068 { 3069 "type": "string", 3070 "description": "IDP Configuration Name", 3071 "name": "name", 3072 "in": "path", 3073 "required": true 3074 }, 3075 { 3076 "type": "string", 3077 "description": "IDP Configuration Type", 3078 "name": "type", 3079 "in": "path", 3080 "required": true 3081 } 3082 ], 3083 "responses": { 3084 "200": { 3085 "description": "A successful response.", 3086 "schema": { 3087 "$ref": "#/definitions/setIDPResponse" 3088 } 3089 }, 3090 "default": { 3091 "description": "Generic error response.", 3092 "schema": { 3093 "$ref": "#/definitions/ApiError" 3094 } 3095 } 3096 } 3097 }, 3098 "delete": { 3099 "tags": [ 3100 "idp" 3101 ], 3102 "summary": "Delete IDP Configuration", 3103 "operationId": "DeleteConfiguration", 3104 "parameters": [ 3105 { 3106 "type": "string", 3107 "description": "IDP Configuration Name", 3108 "name": "name", 3109 "in": "path", 3110 "required": true 3111 }, 3112 { 3113 "type": "string", 3114 "description": "IDP Configuration Type", 3115 "name": "type", 3116 "in": "path", 3117 "required": true 3118 } 3119 ], 3120 "responses": { 3121 "200": { 3122 "description": "A successful response.", 3123 "schema": { 3124 "$ref": "#/definitions/setIDPResponse" 3125 } 3126 }, 3127 "default": { 3128 "description": "Generic error response.", 3129 "schema": { 3130 "$ref": "#/definitions/ApiError" 3131 } 3132 } 3133 } 3134 } 3135 }, 3136 "/kms/apis": { 3137 "get": { 3138 "tags": [ 3139 "KMS" 3140 ], 3141 "summary": "KMS apis", 3142 "operationId": "KMSAPIs", 3143 "responses": { 3144 "200": { 3145 "description": "A successful response.", 3146 "schema": { 3147 "$ref": "#/definitions/kmsAPIsResponse" 3148 } 3149 }, 3150 "default": { 3151 "description": "Generic error response.", 3152 "schema": { 3153 "$ref": "#/definitions/ApiError" 3154 } 3155 } 3156 } 3157 } 3158 }, 3159 "/kms/describe-self/identity": { 3160 "get": { 3161 "tags": [ 3162 "KMS" 3163 ], 3164 "summary": "KMS describe self identity", 3165 "operationId": "KMSDescribeSelfIdentity", 3166 "responses": { 3167 "200": { 3168 "description": "A successful response.", 3169 "schema": { 3170 "$ref": "#/definitions/kmsDescribeSelfIdentityResponse" 3171 } 3172 }, 3173 "default": { 3174 "description": "Generic error response.", 3175 "schema": { 3176 "$ref": "#/definitions/ApiError" 3177 } 3178 } 3179 } 3180 } 3181 }, 3182 "/kms/identities": { 3183 "get": { 3184 "tags": [ 3185 "KMS" 3186 ], 3187 "summary": "KMS list identities", 3188 "operationId": "KMSListIdentities", 3189 "parameters": [ 3190 { 3191 "type": "string", 3192 "description": "pattern to retrieve identities", 3193 "name": "pattern", 3194 "in": "query" 3195 } 3196 ], 3197 "responses": { 3198 "200": { 3199 "description": "A successful response.", 3200 "schema": { 3201 "$ref": "#/definitions/kmsListIdentitiesResponse" 3202 } 3203 }, 3204 "default": { 3205 "description": "Generic error response.", 3206 "schema": { 3207 "$ref": "#/definitions/ApiError" 3208 } 3209 } 3210 } 3211 } 3212 }, 3213 "/kms/identities/{name}": { 3214 "delete": { 3215 "tags": [ 3216 "KMS" 3217 ], 3218 "summary": "KMS delete identity", 3219 "operationId": "KMSDeleteIdentity", 3220 "parameters": [ 3221 { 3222 "type": "string", 3223 "description": "KMS identity name", 3224 "name": "name", 3225 "in": "path", 3226 "required": true 3227 } 3228 ], 3229 "responses": { 3230 "200": { 3231 "description": "A successful response." 3232 }, 3233 "default": { 3234 "description": "Generic error response.", 3235 "schema": { 3236 "$ref": "#/definitions/ApiError" 3237 } 3238 } 3239 } 3240 } 3241 }, 3242 "/kms/identities/{name}/describe": { 3243 "get": { 3244 "tags": [ 3245 "KMS" 3246 ], 3247 "summary": "KMS describe identity", 3248 "operationId": "KMSDescribeIdentity", 3249 "parameters": [ 3250 { 3251 "type": "string", 3252 "description": "KMS identity name", 3253 "name": "name", 3254 "in": "path", 3255 "required": true 3256 } 3257 ], 3258 "responses": { 3259 "200": { 3260 "description": "A successful response.", 3261 "schema": { 3262 "$ref": "#/definitions/kmsDescribeIdentityResponse" 3263 } 3264 }, 3265 "default": { 3266 "description": "Generic error response.", 3267 "schema": { 3268 "$ref": "#/definitions/ApiError" 3269 } 3270 } 3271 } 3272 } 3273 }, 3274 "/kms/keys": { 3275 "get": { 3276 "tags": [ 3277 "KMS" 3278 ], 3279 "summary": "KMS list keys", 3280 "operationId": "KMSListKeys", 3281 "parameters": [ 3282 { 3283 "type": "string", 3284 "description": "pattern to retrieve keys", 3285 "name": "pattern", 3286 "in": "query" 3287 } 3288 ], 3289 "responses": { 3290 "200": { 3291 "description": "A successful response.", 3292 "schema": { 3293 "$ref": "#/definitions/kmsListKeysResponse" 3294 } 3295 }, 3296 "default": { 3297 "description": "Generic error response.", 3298 "schema": { 3299 "$ref": "#/definitions/ApiError" 3300 } 3301 } 3302 } 3303 }, 3304 "post": { 3305 "tags": [ 3306 "KMS" 3307 ], 3308 "summary": "KMS create key", 3309 "operationId": "KMSCreateKey", 3310 "parameters": [ 3311 { 3312 "name": "body", 3313 "in": "body", 3314 "required": true, 3315 "schema": { 3316 "$ref": "#/definitions/kmsCreateKeyRequest" 3317 } 3318 } 3319 ], 3320 "responses": { 3321 "201": { 3322 "description": "A successful response." 3323 }, 3324 "default": { 3325 "description": "Generic error response.", 3326 "schema": { 3327 "$ref": "#/definitions/ApiError" 3328 } 3329 } 3330 } 3331 } 3332 }, 3333 "/kms/keys/{name}": { 3334 "get": { 3335 "tags": [ 3336 "KMS" 3337 ], 3338 "summary": "KMS key status", 3339 "operationId": "KMSKeyStatus", 3340 "parameters": [ 3341 { 3342 "type": "string", 3343 "description": "KMS key name", 3344 "name": "name", 3345 "in": "path", 3346 "required": true 3347 } 3348 ], 3349 "responses": { 3350 "200": { 3351 "description": "A successful response.", 3352 "schema": { 3353 "$ref": "#/definitions/kmsKeyStatusResponse" 3354 } 3355 }, 3356 "default": { 3357 "description": "Generic error response.", 3358 "schema": { 3359 "$ref": "#/definitions/ApiError" 3360 } 3361 } 3362 } 3363 }, 3364 "delete": { 3365 "tags": [ 3366 "KMS" 3367 ], 3368 "summary": "KMS delete key", 3369 "operationId": "KMSDeleteKey", 3370 "parameters": [ 3371 { 3372 "type": "string", 3373 "description": "KMS key name", 3374 "name": "name", 3375 "in": "path", 3376 "required": true 3377 } 3378 ], 3379 "responses": { 3380 "200": { 3381 "description": "A successful response." 3382 }, 3383 "default": { 3384 "description": "Generic error response.", 3385 "schema": { 3386 "$ref": "#/definitions/ApiError" 3387 } 3388 } 3389 } 3390 } 3391 }, 3392 "/kms/keys/{name}/import": { 3393 "post": { 3394 "tags": [ 3395 "KMS" 3396 ], 3397 "summary": "KMS import key", 3398 "operationId": "KMSImportKey", 3399 "parameters": [ 3400 { 3401 "name": "body", 3402 "in": "body", 3403 "required": true, 3404 "schema": { 3405 "$ref": "#/definitions/kmsImportKeyRequest" 3406 } 3407 }, 3408 { 3409 "type": "string", 3410 "description": "KMS key name", 3411 "name": "name", 3412 "in": "path", 3413 "required": true 3414 } 3415 ], 3416 "responses": { 3417 "201": { 3418 "description": "A successful response." 3419 }, 3420 "default": { 3421 "description": "Generic error response.", 3422 "schema": { 3423 "$ref": "#/definitions/ApiError" 3424 } 3425 } 3426 } 3427 } 3428 }, 3429 "/kms/metrics": { 3430 "get": { 3431 "tags": [ 3432 "KMS" 3433 ], 3434 "summary": "KMS metrics", 3435 "operationId": "KMSMetrics", 3436 "responses": { 3437 "200": { 3438 "description": "A successful response.", 3439 "schema": { 3440 "$ref": "#/definitions/kmsMetricsResponse" 3441 } 3442 }, 3443 "default": { 3444 "description": "Generic error response.", 3445 "schema": { 3446 "$ref": "#/definitions/ApiError" 3447 } 3448 } 3449 } 3450 } 3451 }, 3452 "/kms/policies": { 3453 "get": { 3454 "tags": [ 3455 "KMS" 3456 ], 3457 "summary": "KMS list policies", 3458 "operationId": "KMSListPolicies", 3459 "parameters": [ 3460 { 3461 "type": "string", 3462 "description": "pattern to retrieve policies", 3463 "name": "pattern", 3464 "in": "query" 3465 } 3466 ], 3467 "responses": { 3468 "200": { 3469 "description": "A successful response.", 3470 "schema": { 3471 "$ref": "#/definitions/kmsListPoliciesResponse" 3472 } 3473 }, 3474 "default": { 3475 "description": "Generic error response.", 3476 "schema": { 3477 "$ref": "#/definitions/ApiError" 3478 } 3479 } 3480 } 3481 }, 3482 "post": { 3483 "tags": [ 3484 "KMS" 3485 ], 3486 "summary": "KMS set policy", 3487 "operationId": "KMSSetPolicy", 3488 "parameters": [ 3489 { 3490 "name": "body", 3491 "in": "body", 3492 "required": true, 3493 "schema": { 3494 "$ref": "#/definitions/kmsSetPolicyRequest" 3495 } 3496 } 3497 ], 3498 "responses": { 3499 "200": { 3500 "description": "A successful response." 3501 }, 3502 "default": { 3503 "description": "Generic error response.", 3504 "schema": { 3505 "$ref": "#/definitions/ApiError" 3506 } 3507 } 3508 } 3509 } 3510 }, 3511 "/kms/policies/{name}": { 3512 "get": { 3513 "tags": [ 3514 "KMS" 3515 ], 3516 "summary": "KMS get policy", 3517 "operationId": "KMSGetPolicy", 3518 "parameters": [ 3519 { 3520 "type": "string", 3521 "description": "KMS policy name", 3522 "name": "name", 3523 "in": "path", 3524 "required": true 3525 } 3526 ], 3527 "responses": { 3528 "200": { 3529 "description": "A successful response.", 3530 "schema": { 3531 "$ref": "#/definitions/kmsGetPolicyResponse" 3532 } 3533 }, 3534 "default": { 3535 "description": "Generic error response.", 3536 "schema": { 3537 "$ref": "#/definitions/ApiError" 3538 } 3539 } 3540 } 3541 }, 3542 "delete": { 3543 "tags": [ 3544 "KMS" 3545 ], 3546 "summary": "KMS delete policy", 3547 "operationId": "KMSDeletePolicy", 3548 "parameters": [ 3549 { 3550 "type": "string", 3551 "description": "KMS policy name", 3552 "name": "name", 3553 "in": "path", 3554 "required": true 3555 } 3556 ], 3557 "responses": { 3558 "200": { 3559 "description": "A successful response." 3560 }, 3561 "default": { 3562 "description": "Generic error response.", 3563 "schema": { 3564 "$ref": "#/definitions/ApiError" 3565 } 3566 } 3567 } 3568 } 3569 }, 3570 "/kms/policies/{name}/assign": { 3571 "post": { 3572 "tags": [ 3573 "KMS" 3574 ], 3575 "summary": "KMS assign policy", 3576 "operationId": "KMSAssignPolicy", 3577 "parameters": [ 3578 { 3579 "name": "body", 3580 "in": "body", 3581 "required": true, 3582 "schema": { 3583 "$ref": "#/definitions/kmsAssignPolicyRequest" 3584 } 3585 }, 3586 { 3587 "type": "string", 3588 "description": "KMS policy name", 3589 "name": "name", 3590 "in": "path", 3591 "required": true 3592 } 3593 ], 3594 "responses": { 3595 "200": { 3596 "description": "A successful response." 3597 }, 3598 "default": { 3599 "description": "Generic error response.", 3600 "schema": { 3601 "$ref": "#/definitions/ApiError" 3602 } 3603 } 3604 } 3605 } 3606 }, 3607 "/kms/policies/{name}/describe": { 3608 "get": { 3609 "tags": [ 3610 "KMS" 3611 ], 3612 "summary": "KMS describe policy", 3613 "operationId": "KMSDescribePolicy", 3614 "parameters": [ 3615 { 3616 "type": "string", 3617 "description": "KMS policy name", 3618 "name": "name", 3619 "in": "path", 3620 "required": true 3621 } 3622 ], 3623 "responses": { 3624 "200": { 3625 "description": "A successful response.", 3626 "schema": { 3627 "$ref": "#/definitions/kmsDescribePolicyResponse" 3628 } 3629 }, 3630 "default": { 3631 "description": "Generic error response.", 3632 "schema": { 3633 "$ref": "#/definitions/ApiError" 3634 } 3635 } 3636 } 3637 } 3638 }, 3639 "/kms/status": { 3640 "get": { 3641 "tags": [ 3642 "KMS" 3643 ], 3644 "summary": "KMS status", 3645 "operationId": "KMSStatus", 3646 "responses": { 3647 "200": { 3648 "description": "A successful response.", 3649 "schema": { 3650 "$ref": "#/definitions/kmsStatusResponse" 3651 } 3652 }, 3653 "default": { 3654 "description": "Generic error response.", 3655 "schema": { 3656 "$ref": "#/definitions/ApiError" 3657 } 3658 } 3659 } 3660 } 3661 }, 3662 "/kms/version": { 3663 "get": { 3664 "tags": [ 3665 "KMS" 3666 ], 3667 "summary": "KMS version", 3668 "operationId": "KMSVersion", 3669 "responses": { 3670 "200": { 3671 "description": "A successful response.", 3672 "schema": { 3673 "$ref": "#/definitions/kmsVersionResponse" 3674 } 3675 }, 3676 "default": { 3677 "description": "Generic error response.", 3678 "schema": { 3679 "$ref": "#/definitions/ApiError" 3680 } 3681 } 3682 } 3683 } 3684 }, 3685 "/ldap-entities": { 3686 "post": { 3687 "tags": [ 3688 "idp" 3689 ], 3690 "summary": "Get LDAP Entities", 3691 "operationId": "GetLDAPEntities", 3692 "parameters": [ 3693 { 3694 "name": "body", 3695 "in": "body", 3696 "required": true, 3697 "schema": { 3698 "$ref": "#/definitions/ldapEntitiesRequest" 3699 } 3700 } 3701 ], 3702 "responses": { 3703 "200": { 3704 "description": "A successful response.", 3705 "schema": { 3706 "$ref": "#/definitions/ldapEntities" 3707 } 3708 }, 3709 "default": { 3710 "description": "Generic error response.", 3711 "schema": { 3712 "$ref": "#/definitions/ApiError" 3713 } 3714 } 3715 } 3716 } 3717 }, 3718 "/list-external-buckets": { 3719 "post": { 3720 "tags": [ 3721 "Bucket" 3722 ], 3723 "summary": "Lists an External list of buckets using custom credentials", 3724 "operationId": "ListExternalBuckets", 3725 "parameters": [ 3726 { 3727 "name": "body", 3728 "in": "body", 3729 "required": true, 3730 "schema": { 3731 "$ref": "#/definitions/listExternalBucketsParams" 3732 } 3733 } 3734 ], 3735 "responses": { 3736 "200": { 3737 "description": "A successful response.", 3738 "schema": { 3739 "$ref": "#/definitions/listBucketsResponse" 3740 } 3741 }, 3742 "default": { 3743 "description": "Generic error response.", 3744 "schema": { 3745 "$ref": "#/definitions/ApiError" 3746 } 3747 } 3748 } 3749 } 3750 }, 3751 "/login": { 3752 "get": { 3753 "security": [], 3754 "tags": [ 3755 "Auth" 3756 ], 3757 "summary": "Returns login strategy, form or sso.", 3758 "operationId": "LoginDetail", 3759 "responses": { 3760 "200": { 3761 "description": "A successful response.", 3762 "schema": { 3763 "$ref": "#/definitions/loginDetails" 3764 } 3765 }, 3766 "default": { 3767 "description": "Generic error response.", 3768 "schema": { 3769 "$ref": "#/definitions/ApiError" 3770 } 3771 } 3772 } 3773 }, 3774 "post": { 3775 "security": [], 3776 "tags": [ 3777 "Auth" 3778 ], 3779 "summary": "Login to Console", 3780 "operationId": "Login", 3781 "parameters": [ 3782 { 3783 "name": "body", 3784 "in": "body", 3785 "required": true, 3786 "schema": { 3787 "$ref": "#/definitions/loginRequest" 3788 } 3789 } 3790 ], 3791 "responses": { 3792 "204": { 3793 "description": "A successful login." 3794 }, 3795 "default": { 3796 "description": "Generic error response.", 3797 "schema": { 3798 "$ref": "#/definitions/ApiError" 3799 } 3800 } 3801 } 3802 } 3803 }, 3804 "/login/oauth2/auth": { 3805 "post": { 3806 "security": [], 3807 "tags": [ 3808 "Auth" 3809 ], 3810 "summary": "Identity Provider oauth2 callback endpoint.", 3811 "operationId": "LoginOauth2Auth", 3812 "parameters": [ 3813 { 3814 "name": "body", 3815 "in": "body", 3816 "required": true, 3817 "schema": { 3818 "$ref": "#/definitions/loginOauth2AuthRequest" 3819 } 3820 } 3821 ], 3822 "responses": { 3823 "204": { 3824 "description": "A successful login." 3825 }, 3826 "default": { 3827 "description": "Generic error response.", 3828 "schema": { 3829 "$ref": "#/definitions/ApiError" 3830 } 3831 } 3832 } 3833 } 3834 }, 3835 "/logout": { 3836 "post": { 3837 "tags": [ 3838 "Auth" 3839 ], 3840 "summary": "Logout from Console.", 3841 "operationId": "Logout", 3842 "parameters": [ 3843 { 3844 "name": "body", 3845 "in": "body", 3846 "required": true, 3847 "schema": { 3848 "$ref": "#/definitions/logoutRequest" 3849 } 3850 } 3851 ], 3852 "responses": { 3853 "200": { 3854 "description": "A successful response." 3855 }, 3856 "default": { 3857 "description": "Generic error response.", 3858 "schema": { 3859 "$ref": "#/definitions/ApiError" 3860 } 3861 } 3862 } 3863 } 3864 }, 3865 "/logs/search": { 3866 "get": { 3867 "tags": [ 3868 "Logging" 3869 ], 3870 "summary": "Search the logs", 3871 "operationId": "LogSearch", 3872 "parameters": [ 3873 { 3874 "type": "array", 3875 "items": { 3876 "type": "string" 3877 }, 3878 "collectionFormat": "multi", 3879 "description": "Filter Parameters", 3880 "name": "fp", 3881 "in": "query" 3882 }, 3883 { 3884 "type": "number", 3885 "format": "int32", 3886 "default": 10, 3887 "name": "pageSize", 3888 "in": "query" 3889 }, 3890 { 3891 "type": "number", 3892 "format": "int32", 3893 "default": 0, 3894 "name": "pageNo", 3895 "in": "query" 3896 }, 3897 { 3898 "enum": [ 3899 "timeDesc", 3900 "timeAsc" 3901 ], 3902 "type": "string", 3903 "default": "timeDesc", 3904 "name": "order", 3905 "in": "query" 3906 }, 3907 { 3908 "type": "string", 3909 "name": "timeStart", 3910 "in": "query" 3911 }, 3912 { 3913 "type": "string", 3914 "name": "timeEnd", 3915 "in": "query" 3916 } 3917 ], 3918 "responses": { 3919 "200": { 3920 "description": "A successful response.", 3921 "schema": { 3922 "$ref": "#/definitions/logSearchResponse" 3923 } 3924 }, 3925 "default": { 3926 "description": "Generic error response.", 3927 "schema": { 3928 "$ref": "#/definitions/ApiError" 3929 } 3930 } 3931 } 3932 } 3933 }, 3934 "/nodes": { 3935 "get": { 3936 "tags": [ 3937 "System" 3938 ], 3939 "summary": "Lists Nodes", 3940 "operationId": "ListNodes", 3941 "responses": { 3942 "200": { 3943 "description": "A successful response.", 3944 "schema": { 3945 "type": "array", 3946 "items": { 3947 "type": "string" 3948 } 3949 } 3950 }, 3951 "default": { 3952 "description": "Generic error response.", 3953 "schema": { 3954 "$ref": "#/definitions/ApiError" 3955 } 3956 } 3957 } 3958 } 3959 }, 3960 "/policies": { 3961 "get": { 3962 "tags": [ 3963 "Policy" 3964 ], 3965 "summary": "List Policies", 3966 "operationId": "ListPolicies", 3967 "parameters": [ 3968 { 3969 "$ref": "#/parameters/offset" 3970 }, 3971 { 3972 "$ref": "#/parameters/limit" 3973 } 3974 ], 3975 "responses": { 3976 "200": { 3977 "description": "A successful response.", 3978 "schema": { 3979 "$ref": "#/definitions/listPoliciesResponse" 3980 } 3981 }, 3982 "default": { 3983 "description": "Generic error response.", 3984 "schema": { 3985 "$ref": "#/definitions/ApiError" 3986 } 3987 } 3988 } 3989 }, 3990 "post": { 3991 "tags": [ 3992 "Policy" 3993 ], 3994 "summary": "Add Policy", 3995 "operationId": "AddPolicy", 3996 "parameters": [ 3997 { 3998 "name": "body", 3999 "in": "body", 4000 "required": true, 4001 "schema": { 4002 "$ref": "#/definitions/addPolicyRequest" 4003 } 4004 } 4005 ], 4006 "responses": { 4007 "201": { 4008 "description": "A successful response.", 4009 "schema": { 4010 "$ref": "#/definitions/policy" 4011 } 4012 }, 4013 "default": { 4014 "description": "Generic error response.", 4015 "schema": { 4016 "$ref": "#/definitions/ApiError" 4017 } 4018 } 4019 } 4020 } 4021 }, 4022 "/policies/{policy}/groups": { 4023 "get": { 4024 "tags": [ 4025 "Policy" 4026 ], 4027 "summary": "List Groups for a Policy", 4028 "operationId": "ListGroupsForPolicy", 4029 "parameters": [ 4030 { 4031 "type": "string", 4032 "name": "policy", 4033 "in": "path", 4034 "required": true 4035 } 4036 ], 4037 "responses": { 4038 "200": { 4039 "description": "A successful response.", 4040 "schema": { 4041 "type": "array", 4042 "items": { 4043 "type": "string" 4044 } 4045 } 4046 }, 4047 "default": { 4048 "description": "Generic error response.", 4049 "schema": { 4050 "$ref": "#/definitions/ApiError" 4051 } 4052 } 4053 } 4054 } 4055 }, 4056 "/policies/{policy}/users": { 4057 "get": { 4058 "tags": [ 4059 "Policy" 4060 ], 4061 "summary": "List Users for a Policy", 4062 "operationId": "ListUsersForPolicy", 4063 "parameters": [ 4064 { 4065 "type": "string", 4066 "name": "policy", 4067 "in": "path", 4068 "required": true 4069 } 4070 ], 4071 "responses": { 4072 "200": { 4073 "description": "A successful response.", 4074 "schema": { 4075 "type": "array", 4076 "items": { 4077 "type": "string" 4078 } 4079 } 4080 }, 4081 "default": { 4082 "description": "Generic error response.", 4083 "schema": { 4084 "$ref": "#/definitions/ApiError" 4085 } 4086 } 4087 } 4088 } 4089 }, 4090 "/policy/{name}": { 4091 "get": { 4092 "tags": [ 4093 "Policy" 4094 ], 4095 "summary": "Policy info", 4096 "operationId": "PolicyInfo", 4097 "parameters": [ 4098 { 4099 "type": "string", 4100 "name": "name", 4101 "in": "path", 4102 "required": true 4103 } 4104 ], 4105 "responses": { 4106 "200": { 4107 "description": "A successful response.", 4108 "schema": { 4109 "$ref": "#/definitions/policy" 4110 } 4111 }, 4112 "default": { 4113 "description": "Generic error response.", 4114 "schema": { 4115 "$ref": "#/definitions/ApiError" 4116 } 4117 } 4118 } 4119 }, 4120 "delete": { 4121 "tags": [ 4122 "Policy" 4123 ], 4124 "summary": "Remove policy", 4125 "operationId": "RemovePolicy", 4126 "parameters": [ 4127 { 4128 "type": "string", 4129 "name": "name", 4130 "in": "path", 4131 "required": true 4132 } 4133 ], 4134 "responses": { 4135 "204": { 4136 "description": "A successful response." 4137 }, 4138 "default": { 4139 "description": "Generic error response.", 4140 "schema": { 4141 "$ref": "#/definitions/ApiError" 4142 } 4143 } 4144 } 4145 } 4146 }, 4147 "/profiling/start": { 4148 "post": { 4149 "tags": [ 4150 "Profile" 4151 ], 4152 "summary": "Start recording profile data", 4153 "operationId": "ProfilingStart", 4154 "parameters": [ 4155 { 4156 "name": "body", 4157 "in": "body", 4158 "required": true, 4159 "schema": { 4160 "$ref": "#/definitions/profilingStartRequest" 4161 } 4162 } 4163 ], 4164 "responses": { 4165 "201": { 4166 "description": "A successful response.", 4167 "schema": { 4168 "$ref": "#/definitions/startProfilingList" 4169 } 4170 }, 4171 "default": { 4172 "description": "Generic error response.", 4173 "schema": { 4174 "$ref": "#/definitions/ApiError" 4175 } 4176 } 4177 } 4178 } 4179 }, 4180 "/profiling/stop": { 4181 "post": { 4182 "produces": [ 4183 "application/zip" 4184 ], 4185 "tags": [ 4186 "Profile" 4187 ], 4188 "summary": "Stop and download profile data", 4189 "operationId": "ProfilingStop", 4190 "responses": { 4191 "201": { 4192 "description": "A successful response.", 4193 "schema": { 4194 "type": "file" 4195 } 4196 }, 4197 "default": { 4198 "description": "Generic error response.", 4199 "schema": { 4200 "$ref": "#/definitions/ApiError" 4201 } 4202 } 4203 } 4204 } 4205 }, 4206 "/releases": { 4207 "get": { 4208 "tags": [ 4209 "release" 4210 ], 4211 "summary": "Get repo releases for a given version", 4212 "operationId": "ListReleases", 4213 "parameters": [ 4214 { 4215 "type": "string", 4216 "description": "repo name", 4217 "name": "repo", 4218 "in": "query", 4219 "required": true 4220 }, 4221 { 4222 "type": "string", 4223 "description": "Current Release", 4224 "name": "current", 4225 "in": "query" 4226 }, 4227 { 4228 "type": "string", 4229 "description": "search content", 4230 "name": "search", 4231 "in": "query" 4232 }, 4233 { 4234 "type": "string", 4235 "description": "filter releases", 4236 "name": "filter", 4237 "in": "query" 4238 } 4239 ], 4240 "responses": { 4241 "200": { 4242 "description": "A successful response.", 4243 "schema": { 4244 "$ref": "#/definitions/releaseListResponse" 4245 } 4246 }, 4247 "default": { 4248 "description": "Generic error response.", 4249 "schema": { 4250 "$ref": "#/definitions/ApiError" 4251 } 4252 } 4253 } 4254 } 4255 }, 4256 "/remote-buckets": { 4257 "get": { 4258 "tags": [ 4259 "Bucket" 4260 ], 4261 "summary": "List Remote Buckets", 4262 "operationId": "ListRemoteBuckets", 4263 "responses": { 4264 "200": { 4265 "description": "A successful response.", 4266 "schema": { 4267 "$ref": "#/definitions/listRemoteBucketsResponse" 4268 } 4269 }, 4270 "default": { 4271 "description": "Generic error response.", 4272 "schema": { 4273 "$ref": "#/definitions/ApiError" 4274 } 4275 } 4276 } 4277 }, 4278 "post": { 4279 "tags": [ 4280 "Bucket" 4281 ], 4282 "summary": "Add Remote Bucket", 4283 "operationId": "AddRemoteBucket", 4284 "parameters": [ 4285 { 4286 "name": "body", 4287 "in": "body", 4288 "required": true, 4289 "schema": { 4290 "$ref": "#/definitions/createRemoteBucket" 4291 } 4292 } 4293 ], 4294 "responses": { 4295 "201": { 4296 "description": "A successful response." 4297 }, 4298 "default": { 4299 "description": "Generic error response.", 4300 "schema": { 4301 "$ref": "#/definitions/ApiError" 4302 } 4303 } 4304 } 4305 } 4306 }, 4307 "/remote-buckets/{name}": { 4308 "get": { 4309 "tags": [ 4310 "Bucket" 4311 ], 4312 "summary": "Remote Bucket Details", 4313 "operationId": "RemoteBucketDetails", 4314 "parameters": [ 4315 { 4316 "type": "string", 4317 "name": "name", 4318 "in": "path", 4319 "required": true 4320 } 4321 ], 4322 "responses": { 4323 "200": { 4324 "description": "A successful response.", 4325 "schema": { 4326 "$ref": "#/definitions/remoteBucket" 4327 } 4328 }, 4329 "default": { 4330 "description": "Generic error response.", 4331 "schema": { 4332 "$ref": "#/definitions/ApiError" 4333 } 4334 } 4335 } 4336 } 4337 }, 4338 "/remote-buckets/{source-bucket-name}/{arn}": { 4339 "delete": { 4340 "tags": [ 4341 "Bucket" 4342 ], 4343 "summary": "Delete Remote Bucket", 4344 "operationId": "DeleteRemoteBucket", 4345 "parameters": [ 4346 { 4347 "type": "string", 4348 "name": "source-bucket-name", 4349 "in": "path", 4350 "required": true 4351 }, 4352 { 4353 "type": "string", 4354 "name": "arn", 4355 "in": "path", 4356 "required": true 4357 } 4358 ], 4359 "responses": { 4360 "204": { 4361 "description": "A successful response." 4362 }, 4363 "default": { 4364 "description": "Generic error response.", 4365 "schema": { 4366 "$ref": "#/definitions/ApiError" 4367 } 4368 } 4369 } 4370 } 4371 }, 4372 "/service-account-credentials": { 4373 "post": { 4374 "tags": [ 4375 "ServiceAccount" 4376 ], 4377 "summary": "Create Service Account With Credentials", 4378 "operationId": "CreateServiceAccountCreds", 4379 "parameters": [ 4380 { 4381 "name": "body", 4382 "in": "body", 4383 "required": true, 4384 "schema": { 4385 "$ref": "#/definitions/serviceAccountRequestCreds" 4386 } 4387 } 4388 ], 4389 "responses": { 4390 "201": { 4391 "description": "A successful response.", 4392 "schema": { 4393 "$ref": "#/definitions/serviceAccountCreds" 4394 } 4395 }, 4396 "default": { 4397 "description": "Generic error response.", 4398 "schema": { 4399 "$ref": "#/definitions/ApiError" 4400 } 4401 } 4402 } 4403 } 4404 }, 4405 "/service-accounts": { 4406 "get": { 4407 "tags": [ 4408 "ServiceAccount" 4409 ], 4410 "summary": "List User's Service Accounts", 4411 "operationId": "ListUserServiceAccounts", 4412 "parameters": [ 4413 { 4414 "$ref": "#/parameters/offset" 4415 }, 4416 { 4417 "$ref": "#/parameters/limit" 4418 } 4419 ], 4420 "responses": { 4421 "200": { 4422 "description": "A successful response.", 4423 "schema": { 4424 "$ref": "#/definitions/serviceAccounts" 4425 } 4426 }, 4427 "default": { 4428 "description": "Generic error response.", 4429 "schema": { 4430 "$ref": "#/definitions/ApiError" 4431 } 4432 } 4433 } 4434 }, 4435 "post": { 4436 "tags": [ 4437 "ServiceAccount" 4438 ], 4439 "summary": "Create Service Account", 4440 "operationId": "CreateServiceAccount", 4441 "parameters": [ 4442 { 4443 "name": "body", 4444 "in": "body", 4445 "required": true, 4446 "schema": { 4447 "$ref": "#/definitions/serviceAccountRequest" 4448 } 4449 } 4450 ], 4451 "responses": { 4452 "201": { 4453 "description": "A successful response.", 4454 "schema": { 4455 "$ref": "#/definitions/serviceAccountCreds" 4456 } 4457 }, 4458 "default": { 4459 "description": "Generic error response.", 4460 "schema": { 4461 "$ref": "#/definitions/ApiError" 4462 } 4463 } 4464 } 4465 } 4466 }, 4467 "/service-accounts/delete-multi": { 4468 "delete": { 4469 "tags": [ 4470 "ServiceAccount" 4471 ], 4472 "summary": "Delete Multiple Service Accounts", 4473 "operationId": "DeleteMultipleServiceAccounts", 4474 "parameters": [ 4475 { 4476 "name": "selectedSA", 4477 "in": "body", 4478 "required": true, 4479 "schema": { 4480 "$ref": "#/definitions/selectedSAs" 4481 } 4482 } 4483 ], 4484 "responses": { 4485 "204": { 4486 "description": "A successful response." 4487 }, 4488 "default": { 4489 "description": "Generic error response.", 4490 "schema": { 4491 "$ref": "#/definitions/ApiError" 4492 } 4493 } 4494 } 4495 } 4496 }, 4497 "/service-accounts/{access_key}": { 4498 "get": { 4499 "tags": [ 4500 "ServiceAccount" 4501 ], 4502 "summary": "Get Service Account", 4503 "operationId": "GetServiceAccount", 4504 "parameters": [ 4505 { 4506 "type": "string", 4507 "name": "access_key", 4508 "in": "path", 4509 "required": true 4510 } 4511 ], 4512 "responses": { 4513 "200": { 4514 "description": "A successful response.", 4515 "schema": { 4516 "$ref": "#/definitions/serviceAccount" 4517 } 4518 }, 4519 "default": { 4520 "description": "Generic error response.", 4521 "schema": { 4522 "$ref": "#/definitions/ApiError" 4523 } 4524 } 4525 } 4526 }, 4527 "put": { 4528 "tags": [ 4529 "ServiceAccount" 4530 ], 4531 "summary": "Set Service Account Policy", 4532 "operationId": "UpdateServiceAccount", 4533 "parameters": [ 4534 { 4535 "type": "string", 4536 "name": "access_key", 4537 "in": "path", 4538 "required": true 4539 }, 4540 { 4541 "name": "body", 4542 "in": "body", 4543 "required": true, 4544 "schema": { 4545 "$ref": "#/definitions/updateServiceAccountRequest" 4546 } 4547 } 4548 ], 4549 "responses": { 4550 "200": { 4551 "description": "A successful response." 4552 }, 4553 "default": { 4554 "description": "Generic error response.", 4555 "schema": { 4556 "$ref": "#/definitions/ApiError" 4557 } 4558 } 4559 } 4560 }, 4561 "delete": { 4562 "tags": [ 4563 "ServiceAccount" 4564 ], 4565 "summary": "Delete Service Account", 4566 "operationId": "DeleteServiceAccount", 4567 "parameters": [ 4568 { 4569 "type": "string", 4570 "name": "access_key", 4571 "in": "path", 4572 "required": true 4573 } 4574 ], 4575 "responses": { 4576 "204": { 4577 "description": "A successful response." 4578 }, 4579 "default": { 4580 "description": "Generic error response.", 4581 "schema": { 4582 "$ref": "#/definitions/ApiError" 4583 } 4584 } 4585 } 4586 } 4587 }, 4588 "/service/restart": { 4589 "post": { 4590 "tags": [ 4591 "Service" 4592 ], 4593 "summary": "Restart Service", 4594 "operationId": "RestartService", 4595 "responses": { 4596 "204": { 4597 "description": "A successful response." 4598 }, 4599 "default": { 4600 "description": "Generic error response.", 4601 "schema": { 4602 "$ref": "#/definitions/ApiError" 4603 } 4604 } 4605 } 4606 } 4607 }, 4608 "/session": { 4609 "get": { 4610 "tags": [ 4611 "Auth" 4612 ], 4613 "summary": "Endpoint to check if your session is still valid", 4614 "operationId": "SessionCheck", 4615 "responses": { 4616 "200": { 4617 "description": "A successful response.", 4618 "schema": { 4619 "$ref": "#/definitions/sessionResponse" 4620 } 4621 }, 4622 "default": { 4623 "description": "Generic error response.", 4624 "schema": { 4625 "$ref": "#/definitions/ApiError" 4626 } 4627 } 4628 } 4629 } 4630 }, 4631 "/set-policy": { 4632 "put": { 4633 "tags": [ 4634 "Policy" 4635 ], 4636 "summary": "Set policy", 4637 "operationId": "SetPolicy", 4638 "parameters": [ 4639 { 4640 "name": "body", 4641 "in": "body", 4642 "required": true, 4643 "schema": { 4644 "$ref": "#/definitions/setPolicyNameRequest" 4645 } 4646 } 4647 ], 4648 "responses": { 4649 "204": { 4650 "description": "A successful response." 4651 }, 4652 "default": { 4653 "description": "Generic error response.", 4654 "schema": { 4655 "$ref": "#/definitions/ApiError" 4656 } 4657 } 4658 } 4659 } 4660 }, 4661 "/set-policy-multi": { 4662 "put": { 4663 "tags": [ 4664 "Policy" 4665 ], 4666 "summary": "Set policy to multiple users/groups", 4667 "operationId": "SetPolicyMultiple", 4668 "parameters": [ 4669 { 4670 "name": "body", 4671 "in": "body", 4672 "required": true, 4673 "schema": { 4674 "$ref": "#/definitions/setPolicyMultipleNameRequest" 4675 } 4676 } 4677 ], 4678 "responses": { 4679 "204": { 4680 "description": "A successful response." 4681 }, 4682 "default": { 4683 "description": "Generic error response.", 4684 "schema": { 4685 "$ref": "#/definitions/ApiError" 4686 } 4687 } 4688 } 4689 } 4690 }, 4691 "/subnet/apikey": { 4692 "get": { 4693 "tags": [ 4694 "Subnet" 4695 ], 4696 "summary": "Subnet api key", 4697 "operationId": "SubnetApiKey", 4698 "parameters": [ 4699 { 4700 "type": "string", 4701 "name": "token", 4702 "in": "query", 4703 "required": true 4704 } 4705 ], 4706 "responses": { 4707 "200": { 4708 "description": "A successful response.", 4709 "schema": { 4710 "$ref": "#/definitions/apiKey" 4711 } 4712 }, 4713 "default": { 4714 "description": "Generic error response.", 4715 "schema": { 4716 "$ref": "#/definitions/ApiError" 4717 } 4718 } 4719 } 4720 } 4721 }, 4722 "/subnet/info": { 4723 "get": { 4724 "tags": [ 4725 "Subnet" 4726 ], 4727 "summary": "Subnet info", 4728 "operationId": "SubnetInfo", 4729 "responses": { 4730 "200": { 4731 "description": "A successful response.", 4732 "schema": { 4733 "$ref": "#/definitions/license" 4734 } 4735 }, 4736 "default": { 4737 "description": "Generic error response.", 4738 "schema": { 4739 "$ref": "#/definitions/ApiError" 4740 } 4741 } 4742 } 4743 } 4744 }, 4745 "/subnet/login": { 4746 "post": { 4747 "tags": [ 4748 "Subnet" 4749 ], 4750 "summary": "Login to SUBNET", 4751 "operationId": "SubnetLogin", 4752 "parameters": [ 4753 { 4754 "name": "body", 4755 "in": "body", 4756 "required": true, 4757 "schema": { 4758 "$ref": "#/definitions/subnetLoginRequest" 4759 } 4760 } 4761 ], 4762 "responses": { 4763 "200": { 4764 "description": "A successful response.", 4765 "schema": { 4766 "$ref": "#/definitions/subnetLoginResponse" 4767 } 4768 }, 4769 "default": { 4770 "description": "Generic error response.", 4771 "schema": { 4772 "$ref": "#/definitions/ApiError" 4773 } 4774 } 4775 } 4776 } 4777 }, 4778 "/subnet/login/mfa": { 4779 "post": { 4780 "tags": [ 4781 "Subnet" 4782 ], 4783 "summary": "Login to SUBNET using mfa", 4784 "operationId": "SubnetLoginMFA", 4785 "parameters": [ 4786 { 4787 "name": "body", 4788 "in": "body", 4789 "required": true, 4790 "schema": { 4791 "$ref": "#/definitions/subnetLoginMFARequest" 4792 } 4793 } 4794 ], 4795 "responses": { 4796 "200": { 4797 "description": "A successful response.", 4798 "schema": { 4799 "$ref": "#/definitions/subnetLoginResponse" 4800 } 4801 }, 4802 "default": { 4803 "description": "Generic error response.", 4804 "schema": { 4805 "$ref": "#/definitions/ApiError" 4806 } 4807 } 4808 } 4809 } 4810 }, 4811 "/subnet/register": { 4812 "post": { 4813 "tags": [ 4814 "Subnet" 4815 ], 4816 "summary": "Register cluster with Subnet", 4817 "operationId": "SubnetRegister", 4818 "parameters": [ 4819 { 4820 "name": "body", 4821 "in": "body", 4822 "required": true, 4823 "schema": { 4824 "$ref": "#/definitions/subnetRegisterRequest" 4825 } 4826 } 4827 ], 4828 "responses": { 4829 "200": { 4830 "description": "A successful response." 4831 }, 4832 "default": { 4833 "description": "Generic error response.", 4834 "schema": { 4835 "$ref": "#/definitions/ApiError" 4836 } 4837 } 4838 } 4839 } 4840 }, 4841 "/subnet/registration-token": { 4842 "get": { 4843 "tags": [ 4844 "Subnet" 4845 ], 4846 "summary": "SUBNET registraton token", 4847 "operationId": "SubnetRegToken", 4848 "responses": { 4849 "200": { 4850 "description": "A successful response.", 4851 "schema": { 4852 "$ref": "#/definitions/SubnetRegTokenResponse" 4853 } 4854 }, 4855 "default": { 4856 "description": "Generic error response.", 4857 "schema": { 4858 "$ref": "#/definitions/ApiError" 4859 } 4860 } 4861 } 4862 } 4863 }, 4864 "/support/callhome": { 4865 "get": { 4866 "tags": [ 4867 "Support" 4868 ], 4869 "summary": "Get Callhome current status", 4870 "operationId": "GetCallHomeOptionValue", 4871 "responses": { 4872 "200": { 4873 "description": "A successful response.", 4874 "schema": { 4875 "$ref": "#/definitions/callHomeGetResponse" 4876 } 4877 }, 4878 "default": { 4879 "description": "Generic error response.", 4880 "schema": { 4881 "$ref": "#/definitions/ApiError" 4882 } 4883 } 4884 } 4885 }, 4886 "put": { 4887 "tags": [ 4888 "Support" 4889 ], 4890 "summary": "Sets callhome status", 4891 "operationId": "SetCallHomeStatus", 4892 "parameters": [ 4893 { 4894 "name": "body", 4895 "in": "body", 4896 "required": true, 4897 "schema": { 4898 "$ref": "#/definitions/callHomeSetStatus" 4899 } 4900 } 4901 ], 4902 "responses": { 4903 "204": { 4904 "description": "A successful response." 4905 }, 4906 "default": { 4907 "description": "Generic error response.", 4908 "schema": { 4909 "$ref": "#/definitions/ApiError" 4910 } 4911 } 4912 } 4913 } 4914 }, 4915 "/user/policy": { 4916 "get": { 4917 "tags": [ 4918 "Policy" 4919 ], 4920 "summary": "returns policies for logged in user", 4921 "operationId": "GetUserPolicy", 4922 "responses": { 4923 "200": { 4924 "description": "A successful response.", 4925 "schema": { 4926 "type": "string" 4927 } 4928 }, 4929 "default": { 4930 "description": "Generic error response.", 4931 "schema": { 4932 "$ref": "#/definitions/ApiError" 4933 } 4934 } 4935 } 4936 } 4937 }, 4938 "/user/{name}": { 4939 "get": { 4940 "tags": [ 4941 "User" 4942 ], 4943 "summary": "Get User Info", 4944 "operationId": "GetUserInfo", 4945 "parameters": [ 4946 { 4947 "type": "string", 4948 "name": "name", 4949 "in": "path", 4950 "required": true 4951 } 4952 ], 4953 "responses": { 4954 "200": { 4955 "description": "A successful response.", 4956 "schema": { 4957 "$ref": "#/definitions/user" 4958 } 4959 }, 4960 "default": { 4961 "description": "Generic error response.", 4962 "schema": { 4963 "$ref": "#/definitions/ApiError" 4964 } 4965 } 4966 } 4967 }, 4968 "put": { 4969 "tags": [ 4970 "User" 4971 ], 4972 "summary": "Update User Info", 4973 "operationId": "UpdateUserInfo", 4974 "parameters": [ 4975 { 4976 "type": "string", 4977 "name": "name", 4978 "in": "path", 4979 "required": true 4980 }, 4981 { 4982 "name": "body", 4983 "in": "body", 4984 "required": true, 4985 "schema": { 4986 "$ref": "#/definitions/updateUser" 4987 } 4988 } 4989 ], 4990 "responses": { 4991 "200": { 4992 "description": "A successful response.", 4993 "schema": { 4994 "$ref": "#/definitions/user" 4995 } 4996 }, 4997 "default": { 4998 "description": "Generic error response.", 4999 "schema": { 5000 "$ref": "#/definitions/ApiError" 5001 } 5002 } 5003 } 5004 }, 5005 "delete": { 5006 "tags": [ 5007 "User" 5008 ], 5009 "summary": "Remove user", 5010 "operationId": "RemoveUser", 5011 "parameters": [ 5012 { 5013 "type": "string", 5014 "name": "name", 5015 "in": "path", 5016 "required": true 5017 } 5018 ], 5019 "responses": { 5020 "204": { 5021 "description": "A successful response." 5022 }, 5023 "default": { 5024 "description": "Generic error response.", 5025 "schema": { 5026 "$ref": "#/definitions/ApiError" 5027 } 5028 } 5029 } 5030 } 5031 }, 5032 "/user/{name}/groups": { 5033 "put": { 5034 "tags": [ 5035 "User" 5036 ], 5037 "summary": "Update Groups for a user", 5038 "operationId": "UpdateUserGroups", 5039 "parameters": [ 5040 { 5041 "type": "string", 5042 "name": "name", 5043 "in": "path", 5044 "required": true 5045 }, 5046 { 5047 "name": "body", 5048 "in": "body", 5049 "required": true, 5050 "schema": { 5051 "$ref": "#/definitions/updateUserGroups" 5052 } 5053 } 5054 ], 5055 "responses": { 5056 "200": { 5057 "description": "A successful response.", 5058 "schema": { 5059 "$ref": "#/definitions/user" 5060 } 5061 }, 5062 "default": { 5063 "description": "Generic error response.", 5064 "schema": { 5065 "$ref": "#/definitions/ApiError" 5066 } 5067 } 5068 } 5069 } 5070 }, 5071 "/user/{name}/policies": { 5072 "get": { 5073 "tags": [ 5074 "Policy" 5075 ], 5076 "summary": "returns policies assigned for a specified user", 5077 "operationId": "GetSAUserPolicy", 5078 "parameters": [ 5079 { 5080 "type": "string", 5081 "name": "name", 5082 "in": "path", 5083 "required": true 5084 } 5085 ], 5086 "responses": { 5087 "200": { 5088 "description": "A successful response.", 5089 "schema": { 5090 "$ref": "#/definitions/aUserPolicyResponse" 5091 } 5092 }, 5093 "default": { 5094 "description": "Generic error response.", 5095 "schema": { 5096 "$ref": "#/definitions/ApiError" 5097 } 5098 } 5099 } 5100 } 5101 }, 5102 "/user/{name}/service-account-credentials": { 5103 "post": { 5104 "tags": [ 5105 "User" 5106 ], 5107 "summary": "Create Service Account for User With Credentials", 5108 "operationId": "CreateServiceAccountCredentials", 5109 "parameters": [ 5110 { 5111 "type": "string", 5112 "name": "name", 5113 "in": "path", 5114 "required": true 5115 }, 5116 { 5117 "name": "body", 5118 "in": "body", 5119 "required": true, 5120 "schema": { 5121 "$ref": "#/definitions/serviceAccountRequestCreds" 5122 } 5123 } 5124 ], 5125 "responses": { 5126 "201": { 5127 "description": "A successful response.", 5128 "schema": { 5129 "$ref": "#/definitions/serviceAccountCreds" 5130 } 5131 }, 5132 "default": { 5133 "description": "Generic error response.", 5134 "schema": { 5135 "$ref": "#/definitions/ApiError" 5136 } 5137 } 5138 } 5139 } 5140 }, 5141 "/user/{name}/service-accounts": { 5142 "get": { 5143 "tags": [ 5144 "User" 5145 ], 5146 "summary": "returns a list of service accounts for a user", 5147 "operationId": "ListAUserServiceAccounts", 5148 "parameters": [ 5149 { 5150 "type": "string", 5151 "name": "name", 5152 "in": "path", 5153 "required": true 5154 } 5155 ], 5156 "responses": { 5157 "200": { 5158 "description": "A successful response.", 5159 "schema": { 5160 "$ref": "#/definitions/serviceAccounts" 5161 } 5162 }, 5163 "default": { 5164 "description": "Generic error response.", 5165 "schema": { 5166 "$ref": "#/definitions/ApiError" 5167 } 5168 } 5169 } 5170 }, 5171 "post": { 5172 "tags": [ 5173 "User" 5174 ], 5175 "summary": "Create Service Account for User", 5176 "operationId": "CreateAUserServiceAccount", 5177 "parameters": [ 5178 { 5179 "type": "string", 5180 "name": "name", 5181 "in": "path", 5182 "required": true 5183 }, 5184 { 5185 "name": "body", 5186 "in": "body", 5187 "required": true, 5188 "schema": { 5189 "$ref": "#/definitions/serviceAccountRequest" 5190 } 5191 } 5192 ], 5193 "responses": { 5194 "201": { 5195 "description": "A successful response.", 5196 "schema": { 5197 "$ref": "#/definitions/serviceAccountCreds" 5198 } 5199 }, 5200 "default": { 5201 "description": "Generic error response.", 5202 "schema": { 5203 "$ref": "#/definitions/ApiError" 5204 } 5205 } 5206 } 5207 } 5208 }, 5209 "/users": { 5210 "get": { 5211 "tags": [ 5212 "User" 5213 ], 5214 "summary": "List Users", 5215 "operationId": "ListUsers", 5216 "parameters": [ 5217 { 5218 "$ref": "#/parameters/offset" 5219 }, 5220 { 5221 "$ref": "#/parameters/limit" 5222 } 5223 ], 5224 "responses": { 5225 "200": { 5226 "description": "A successful response.", 5227 "schema": { 5228 "$ref": "#/definitions/listUsersResponse" 5229 } 5230 }, 5231 "default": { 5232 "description": "Generic error response.", 5233 "schema": { 5234 "$ref": "#/definitions/ApiError" 5235 } 5236 } 5237 } 5238 }, 5239 "post": { 5240 "tags": [ 5241 "User" 5242 ], 5243 "summary": "Add User", 5244 "operationId": "AddUser", 5245 "parameters": [ 5246 { 5247 "name": "body", 5248 "in": "body", 5249 "required": true, 5250 "schema": { 5251 "$ref": "#/definitions/addUserRequest" 5252 } 5253 } 5254 ], 5255 "responses": { 5256 "201": { 5257 "description": "A successful response.", 5258 "schema": { 5259 "$ref": "#/definitions/user" 5260 } 5261 }, 5262 "default": { 5263 "description": "Generic error response.", 5264 "schema": { 5265 "$ref": "#/definitions/ApiError" 5266 } 5267 } 5268 } 5269 } 5270 }, 5271 "/users-groups-bulk": { 5272 "put": { 5273 "tags": [ 5274 "User" 5275 ], 5276 "summary": "Bulk functionality to Add Users to Groups", 5277 "operationId": "BulkUpdateUsersGroups", 5278 "parameters": [ 5279 { 5280 "name": "body", 5281 "in": "body", 5282 "required": true, 5283 "schema": { 5284 "$ref": "#/definitions/bulkUserGroups" 5285 } 5286 } 5287 ], 5288 "responses": { 5289 "200": { 5290 "description": "A successful response." 5291 }, 5292 "default": { 5293 "description": "Generic error response.", 5294 "schema": { 5295 "$ref": "#/definitions/ApiError" 5296 } 5297 } 5298 } 5299 } 5300 }, 5301 "/users/service-accounts": { 5302 "post": { 5303 "tags": [ 5304 "User" 5305 ], 5306 "summary": "Check number of service accounts for each user specified", 5307 "operationId": "CheckUserServiceAccounts", 5308 "parameters": [ 5309 { 5310 "name": "selectedUsers", 5311 "in": "body", 5312 "required": true, 5313 "schema": { 5314 "$ref": "#/definitions/selectedUsers" 5315 } 5316 } 5317 ], 5318 "responses": { 5319 "200": { 5320 "description": "A successful response.", 5321 "schema": { 5322 "$ref": "#/definitions/userServiceAccountSummary" 5323 } 5324 }, 5325 "default": { 5326 "description": "Generic error response.", 5327 "schema": { 5328 "$ref": "#/definitions/ApiError" 5329 } 5330 } 5331 } 5332 } 5333 } 5334 }, 5335 "definitions": { 5336 "ApiError": { 5337 "type": "object", 5338 "properties": { 5339 "detailedMessage": { 5340 "type": "string" 5341 }, 5342 "message": { 5343 "type": "string" 5344 } 5345 } 5346 }, 5347 "BackendProperties": { 5348 "type": "object", 5349 "properties": { 5350 "backendType": { 5351 "type": "string" 5352 }, 5353 "offlineDrives": { 5354 "type": "integer" 5355 }, 5356 "onlineDrives": { 5357 "type": "integer" 5358 }, 5359 "rrSCParity": { 5360 "type": "integer" 5361 }, 5362 "standardSCParity": { 5363 "type": "integer" 5364 } 5365 } 5366 }, 5367 "SubnetRegTokenResponse": { 5368 "type": "object", 5369 "properties": { 5370 "regToken": { 5371 "type": "string" 5372 } 5373 } 5374 }, 5375 "aUserPolicyResponse": { 5376 "type": "object", 5377 "properties": { 5378 "policy": { 5379 "type": "string" 5380 } 5381 } 5382 }, 5383 "accessRule": { 5384 "type": "object", 5385 "properties": { 5386 "access": { 5387 "type": "string" 5388 }, 5389 "prefix": { 5390 "type": "string" 5391 } 5392 } 5393 }, 5394 "accountChangePasswordRequest": { 5395 "type": "object", 5396 "required": [ 5397 "current_secret_key", 5398 "new_secret_key" 5399 ], 5400 "properties": { 5401 "current_secret_key": { 5402 "type": "string" 5403 }, 5404 "new_secret_key": { 5405 "type": "string" 5406 } 5407 } 5408 }, 5409 "addBucketLifecycle": { 5410 "type": "object", 5411 "properties": { 5412 "disable": { 5413 "description": "Non required, toggle to disable or enable rule", 5414 "type": "boolean" 5415 }, 5416 "expired_object_delete_all": { 5417 "description": "Non required, toggle to disable or enable rule", 5418 "type": "boolean" 5419 }, 5420 "expired_object_delete_marker": { 5421 "description": "Non required, toggle to disable or enable rule", 5422 "type": "boolean" 5423 }, 5424 "expiry_days": { 5425 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 5426 "type": "integer", 5427 "format": "int32", 5428 "default": 0 5429 }, 5430 "newer_noncurrentversion_expiration_versions": { 5431 "description": "Non required, can be set in case of expiration is enabled", 5432 "type": "integer", 5433 "format": "int32", 5434 "default": 0 5435 }, 5436 "noncurrentversion_expiration_days": { 5437 "description": "Non required, can be set in case of expiration is enabled", 5438 "type": "integer", 5439 "format": "int32", 5440 "default": 0 5441 }, 5442 "noncurrentversion_transition_days": { 5443 "description": "Non required, can be set in case of transition is enabled", 5444 "type": "integer", 5445 "format": "int32", 5446 "default": 0 5447 }, 5448 "noncurrentversion_transition_storage_class": { 5449 "description": "Non required, can be set in case of transition is enabled", 5450 "type": "string" 5451 }, 5452 "prefix": { 5453 "description": "Non required field, it matches a prefix to perform ILM operations on it", 5454 "type": "string" 5455 }, 5456 "storage_class": { 5457 "description": "Required only in case of transition is set. it refers to a tier", 5458 "type": "string" 5459 }, 5460 "tags": { 5461 "description": "Non required field, tags to match ILM files", 5462 "type": "string" 5463 }, 5464 "transition_days": { 5465 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 5466 "type": "integer", 5467 "format": "int32", 5468 "default": 0 5469 }, 5470 "type": { 5471 "description": "ILM Rule type (Expiry or transition)", 5472 "type": "string", 5473 "enum": [ 5474 "expiry", 5475 "transition" 5476 ] 5477 } 5478 } 5479 }, 5480 "addBucketReplication": { 5481 "type": "object", 5482 "properties": { 5483 "arn": { 5484 "type": "string" 5485 }, 5486 "destination_bucket": { 5487 "type": "string" 5488 } 5489 } 5490 }, 5491 "addGroupRequest": { 5492 "type": "object", 5493 "required": [ 5494 "group", 5495 "members" 5496 ], 5497 "properties": { 5498 "group": { 5499 "type": "string" 5500 }, 5501 "members": { 5502 "type": "array", 5503 "items": { 5504 "type": "string" 5505 } 5506 } 5507 } 5508 }, 5509 "addMultiBucketLifecycle": { 5510 "type": "object", 5511 "required": [ 5512 "buckets", 5513 "type" 5514 ], 5515 "properties": { 5516 "buckets": { 5517 "type": "array", 5518 "items": { 5519 "type": "string" 5520 } 5521 }, 5522 "expired_object_delete_all": { 5523 "description": "Non required, toggle to disable or enable rule", 5524 "type": "boolean" 5525 }, 5526 "expired_object_delete_marker": { 5527 "description": "Non required, toggle to disable or enable rule", 5528 "type": "boolean" 5529 }, 5530 "expiry_days": { 5531 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 5532 "type": "integer", 5533 "format": "int32", 5534 "default": 0 5535 }, 5536 "noncurrentversion_expiration_days": { 5537 "description": "Non required, can be set in case of expiration is enabled", 5538 "type": "integer", 5539 "format": "int32", 5540 "default": 0 5541 }, 5542 "noncurrentversion_transition_days": { 5543 "description": "Non required, can be set in case of transition is enabled", 5544 "type": "integer", 5545 "format": "int32", 5546 "default": 0 5547 }, 5548 "noncurrentversion_transition_storage_class": { 5549 "description": "Non required, can be set in case of transition is enabled", 5550 "type": "string" 5551 }, 5552 "prefix": { 5553 "description": "Non required field, it matches a prefix to perform ILM operations on it", 5554 "type": "string" 5555 }, 5556 "storage_class": { 5557 "description": "Required only in case of transition is set. it refers to a tier", 5558 "type": "string" 5559 }, 5560 "tags": { 5561 "description": "Non required field, tags to match ILM files", 5562 "type": "string" 5563 }, 5564 "transition_days": { 5565 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 5566 "type": "integer", 5567 "format": "int32", 5568 "default": 0 5569 }, 5570 "type": { 5571 "description": "ILM Rule type (Expiry or transition)", 5572 "type": "string", 5573 "enum": [ 5574 "expiry", 5575 "transition" 5576 ] 5577 } 5578 } 5579 }, 5580 "addPolicyRequest": { 5581 "type": "object", 5582 "required": [ 5583 "name", 5584 "policy" 5585 ], 5586 "properties": { 5587 "name": { 5588 "type": "string" 5589 }, 5590 "policy": { 5591 "type": "string" 5592 } 5593 } 5594 }, 5595 "addUserRequest": { 5596 "type": "object", 5597 "required": [ 5598 "accessKey", 5599 "secretKey", 5600 "groups", 5601 "policies" 5602 ], 5603 "properties": { 5604 "accessKey": { 5605 "type": "string" 5606 }, 5607 "groups": { 5608 "type": "array", 5609 "items": { 5610 "type": "string" 5611 } 5612 }, 5613 "policies": { 5614 "type": "array", 5615 "items": { 5616 "type": "string" 5617 } 5618 }, 5619 "secretKey": { 5620 "type": "string" 5621 } 5622 } 5623 }, 5624 "adminInfoResponse": { 5625 "type": "object", 5626 "properties": { 5627 "advancedMetricsStatus": { 5628 "type": "string", 5629 "enum": [ 5630 "not configured", 5631 "available", 5632 "unavailable" 5633 ] 5634 }, 5635 "backend": { 5636 "$ref": "#/definitions/BackendProperties" 5637 }, 5638 "buckets": { 5639 "type": "integer" 5640 }, 5641 "objects": { 5642 "type": "integer" 5643 }, 5644 "servers": { 5645 "type": "array", 5646 "items": { 5647 "$ref": "#/definitions/serverProperties" 5648 } 5649 }, 5650 "usage": { 5651 "type": "integer" 5652 }, 5653 "widgets": { 5654 "type": "array", 5655 "items": { 5656 "$ref": "#/definitions/widget" 5657 } 5658 } 5659 } 5660 }, 5661 "apiKey": { 5662 "type": "object", 5663 "properties": { 5664 "apiKey": { 5665 "type": "string" 5666 } 5667 } 5668 }, 5669 "arnsResponse": { 5670 "type": "object", 5671 "properties": { 5672 "arns": { 5673 "type": "array", 5674 "items": { 5675 "type": "string" 5676 } 5677 } 5678 } 5679 }, 5680 "bucket": { 5681 "type": "object", 5682 "required": [ 5683 "name" 5684 ], 5685 "properties": { 5686 "access": { 5687 "$ref": "#/definitions/bucketAccess" 5688 }, 5689 "creation_date": { 5690 "type": "string" 5691 }, 5692 "definition": { 5693 "type": "string" 5694 }, 5695 "details": { 5696 "type": "object", 5697 "properties": { 5698 "locking": { 5699 "type": "boolean" 5700 }, 5701 "quota": { 5702 "type": "object", 5703 "properties": { 5704 "quota": { 5705 "type": "integer", 5706 "format": "int64" 5707 }, 5708 "type": { 5709 "type": "string", 5710 "enum": [ 5711 "hard" 5712 ] 5713 } 5714 } 5715 }, 5716 "replication": { 5717 "type": "boolean" 5718 }, 5719 "tags": { 5720 "type": "object", 5721 "additionalProperties": { 5722 "type": "string" 5723 } 5724 }, 5725 "versioning": { 5726 "type": "boolean" 5727 }, 5728 "versioningSuspended": { 5729 "type": "boolean" 5730 } 5731 } 5732 }, 5733 "name": { 5734 "type": "string", 5735 "minLength": 3 5736 }, 5737 "objects": { 5738 "type": "integer", 5739 "format": "int64" 5740 }, 5741 "rw_access": { 5742 "type": "object", 5743 "properties": { 5744 "read": { 5745 "type": "boolean" 5746 }, 5747 "write": { 5748 "type": "boolean" 5749 } 5750 } 5751 }, 5752 "size": { 5753 "type": "integer", 5754 "format": "int64" 5755 } 5756 } 5757 }, 5758 "bucketAccess": { 5759 "type": "string", 5760 "default": "PRIVATE", 5761 "enum": [ 5762 "PRIVATE", 5763 "PUBLIC", 5764 "CUSTOM" 5765 ] 5766 }, 5767 "bucketEncryptionInfo": { 5768 "type": "object", 5769 "properties": { 5770 "algorithm": { 5771 "type": "string" 5772 }, 5773 "kmsMasterKeyID": { 5774 "type": "string" 5775 } 5776 } 5777 }, 5778 "bucketEncryptionRequest": { 5779 "type": "object", 5780 "properties": { 5781 "encType": { 5782 "$ref": "#/definitions/bucketEncryptionType" 5783 }, 5784 "kmsKeyID": { 5785 "type": "string" 5786 } 5787 } 5788 }, 5789 "bucketEncryptionType": { 5790 "type": "string", 5791 "default": "sse-s3", 5792 "enum": [ 5793 "sse-s3", 5794 "sse-kms" 5795 ] 5796 }, 5797 "bucketEventRequest": { 5798 "type": "object", 5799 "required": [ 5800 "configuration" 5801 ], 5802 "properties": { 5803 "configuration": { 5804 "$ref": "#/definitions/notificationConfig" 5805 }, 5806 "ignoreExisting": { 5807 "type": "boolean" 5808 } 5809 } 5810 }, 5811 "bucketLifecycleResponse": { 5812 "type": "object", 5813 "properties": { 5814 "lifecycle": { 5815 "type": "array", 5816 "items": { 5817 "$ref": "#/definitions/objectBucketLifecycle" 5818 } 5819 } 5820 } 5821 }, 5822 "bucketObLockingResponse": { 5823 "type": "object", 5824 "properties": { 5825 "object_locking_enabled": { 5826 "type": "boolean" 5827 } 5828 } 5829 }, 5830 "bucketObject": { 5831 "type": "object", 5832 "properties": { 5833 "content_type": { 5834 "type": "string" 5835 }, 5836 "etag": { 5837 "type": "string" 5838 }, 5839 "expiration": { 5840 "type": "string" 5841 }, 5842 "expiration_rule_id": { 5843 "type": "string" 5844 }, 5845 "is_delete_marker": { 5846 "type": "boolean" 5847 }, 5848 "is_latest": { 5849 "type": "boolean" 5850 }, 5851 "last_modified": { 5852 "type": "string" 5853 }, 5854 "legal_hold_status": { 5855 "type": "string" 5856 }, 5857 "metadata": { 5858 "type": "object", 5859 "additionalProperties": { 5860 "type": "string" 5861 } 5862 }, 5863 "name": { 5864 "type": "string" 5865 }, 5866 "retention_mode": { 5867 "type": "string" 5868 }, 5869 "retention_until_date": { 5870 "type": "string" 5871 }, 5872 "size": { 5873 "type": "integer", 5874 "format": "int64" 5875 }, 5876 "tags": { 5877 "type": "object", 5878 "additionalProperties": { 5879 "type": "string" 5880 } 5881 }, 5882 "user_metadata": { 5883 "type": "object", 5884 "additionalProperties": { 5885 "type": "string" 5886 } 5887 }, 5888 "user_tags": { 5889 "type": "object", 5890 "additionalProperties": { 5891 "type": "string" 5892 } 5893 }, 5894 "version_id": { 5895 "type": "string" 5896 } 5897 } 5898 }, 5899 "bucketQuota": { 5900 "type": "object", 5901 "properties": { 5902 "quota": { 5903 "type": "integer" 5904 }, 5905 "type": { 5906 "type": "string", 5907 "enum": [ 5908 "hard" 5909 ] 5910 } 5911 } 5912 }, 5913 "bucketReplicationDestination": { 5914 "type": "object", 5915 "properties": { 5916 "bucket": { 5917 "type": "string" 5918 } 5919 } 5920 }, 5921 "bucketReplicationResponse": { 5922 "type": "object", 5923 "properties": { 5924 "rules": { 5925 "type": "array", 5926 "items": { 5927 "$ref": "#/definitions/bucketReplicationRule" 5928 } 5929 } 5930 } 5931 }, 5932 "bucketReplicationRule": { 5933 "type": "object", 5934 "properties": { 5935 "bandwidth": { 5936 "type": "string" 5937 }, 5938 "delete_marker_replication": { 5939 "type": "boolean" 5940 }, 5941 "deletes_replication": { 5942 "type": "boolean" 5943 }, 5944 "destination": { 5945 "$ref": "#/definitions/bucketReplicationDestination" 5946 }, 5947 "existingObjects": { 5948 "type": "boolean" 5949 }, 5950 "healthCheckPeriod": { 5951 "type": "integer" 5952 }, 5953 "id": { 5954 "type": "string" 5955 }, 5956 "metadata_replication": { 5957 "type": "boolean" 5958 }, 5959 "prefix": { 5960 "type": "string" 5961 }, 5962 "priority": { 5963 "type": "integer", 5964 "format": "int32" 5965 }, 5966 "status": { 5967 "type": "string", 5968 "enum": [ 5969 "Enabled", 5970 "Disabled" 5971 ] 5972 }, 5973 "storageClass": { 5974 "type": "string" 5975 }, 5976 "syncMode": { 5977 "type": "string", 5978 "default": "async", 5979 "enum": [ 5980 "async", 5981 "sync" 5982 ] 5983 }, 5984 "tags": { 5985 "type": "string" 5986 } 5987 } 5988 }, 5989 "bucketReplicationRuleList": { 5990 "type": "object", 5991 "properties": { 5992 "rules": { 5993 "type": "array", 5994 "items": { 5995 "type": "string" 5996 } 5997 } 5998 } 5999 }, 6000 "bucketVersioningResponse": { 6001 "type": "object", 6002 "properties": { 6003 "MFADelete": { 6004 "type": "string" 6005 }, 6006 "excludeFolders": { 6007 "type": "boolean" 6008 }, 6009 "excludedPrefixes": { 6010 "type": "array", 6011 "items": { 6012 "type": "object", 6013 "properties": { 6014 "prefix": { 6015 "type": "string" 6016 } 6017 } 6018 } 6019 }, 6020 "status": { 6021 "type": "string" 6022 } 6023 } 6024 }, 6025 "bulkUserGroups": { 6026 "type": "object", 6027 "required": [ 6028 "users", 6029 "groups" 6030 ], 6031 "properties": { 6032 "groups": { 6033 "type": "array", 6034 "items": { 6035 "type": "string" 6036 } 6037 }, 6038 "users": { 6039 "type": "array", 6040 "items": { 6041 "type": "string" 6042 } 6043 } 6044 } 6045 }, 6046 "callHomeGetResponse": { 6047 "type": "object", 6048 "properties": { 6049 "diagnosticsStatus": { 6050 "type": "boolean" 6051 }, 6052 "logsStatus": { 6053 "type": "boolean" 6054 } 6055 } 6056 }, 6057 "callHomeSetStatus": { 6058 "type": "object", 6059 "required": [ 6060 "diagState", 6061 "logsState" 6062 ], 6063 "properties": { 6064 "diagState": { 6065 "type": "boolean" 6066 }, 6067 "logsState": { 6068 "type": "boolean" 6069 } 6070 } 6071 }, 6072 "changeUserPasswordRequest": { 6073 "type": "object", 6074 "required": [ 6075 "selectedUser", 6076 "newSecretKey" 6077 ], 6078 "properties": { 6079 "newSecretKey": { 6080 "type": "string" 6081 }, 6082 "selectedUser": { 6083 "type": "string" 6084 } 6085 } 6086 }, 6087 "configDescription": { 6088 "type": "object", 6089 "properties": { 6090 "description": { 6091 "type": "string" 6092 }, 6093 "key": { 6094 "type": "string" 6095 } 6096 } 6097 }, 6098 "configExportResponse": { 6099 "type": "object", 6100 "properties": { 6101 "status": { 6102 "type": "string" 6103 }, 6104 "value": { 6105 "description": "Returns base64 encoded value", 6106 "type": "string" 6107 } 6108 } 6109 }, 6110 "configuration": { 6111 "type": "object", 6112 "properties": { 6113 "key_values": { 6114 "type": "array", 6115 "items": { 6116 "$ref": "#/definitions/configurationKV" 6117 } 6118 }, 6119 "name": { 6120 "type": "string" 6121 } 6122 } 6123 }, 6124 "configurationKV": { 6125 "type": "object", 6126 "properties": { 6127 "env_override": { 6128 "$ref": "#/definitions/envOverride" 6129 }, 6130 "key": { 6131 "type": "string" 6132 }, 6133 "value": { 6134 "type": "string" 6135 } 6136 } 6137 }, 6138 "createRemoteBucket": { 6139 "required": [ 6140 "accessKey", 6141 "secretKey", 6142 "targetURL", 6143 "sourceBucket", 6144 "targetBucket" 6145 ], 6146 "properties": { 6147 "accessKey": { 6148 "type": "string", 6149 "minLength": 3 6150 }, 6151 "bandwidth": { 6152 "type": "integer", 6153 "format": "int64" 6154 }, 6155 "healthCheckPeriod": { 6156 "type": "integer", 6157 "format": "int32" 6158 }, 6159 "region": { 6160 "type": "string" 6161 }, 6162 "secretKey": { 6163 "type": "string", 6164 "minLength": 8 6165 }, 6166 "sourceBucket": { 6167 "type": "string" 6168 }, 6169 "syncMode": { 6170 "type": "string", 6171 "default": "async", 6172 "enum": [ 6173 "async", 6174 "sync" 6175 ] 6176 }, 6177 "targetBucket": { 6178 "type": "string" 6179 }, 6180 "targetURL": { 6181 "type": "string" 6182 } 6183 } 6184 }, 6185 "deleteFile": { 6186 "type": "object", 6187 "properties": { 6188 "path": { 6189 "type": "string" 6190 }, 6191 "recursive": { 6192 "type": "boolean" 6193 }, 6194 "versionID": { 6195 "type": "string" 6196 } 6197 } 6198 }, 6199 "envOverride": { 6200 "type": "object", 6201 "properties": { 6202 "name": { 6203 "type": "string" 6204 }, 6205 "value": { 6206 "type": "string" 6207 } 6208 } 6209 }, 6210 "environmentConstants": { 6211 "type": "object", 6212 "properties": { 6213 "maxConcurrentDownloads": { 6214 "type": "integer" 6215 }, 6216 "maxConcurrentUploads": { 6217 "type": "integer" 6218 } 6219 } 6220 }, 6221 "expirationResponse": { 6222 "type": "object", 6223 "properties": { 6224 "date": { 6225 "type": "string" 6226 }, 6227 "days": { 6228 "type": "integer", 6229 "format": "int64" 6230 }, 6231 "delete_all": { 6232 "type": "boolean" 6233 }, 6234 "delete_marker": { 6235 "type": "boolean" 6236 }, 6237 "newer_noncurrent_expiration_versions": { 6238 "type": "integer", 6239 "format": "int64" 6240 }, 6241 "noncurrent_expiration_days": { 6242 "type": "integer", 6243 "format": "int64" 6244 } 6245 } 6246 }, 6247 "getBucketRetentionConfig": { 6248 "type": "object", 6249 "properties": { 6250 "mode": { 6251 "$ref": "#/definitions/objectRetentionMode" 6252 }, 6253 "unit": { 6254 "$ref": "#/definitions/objectRetentionUnit" 6255 }, 6256 "validity": { 6257 "type": "integer", 6258 "format": "int32" 6259 } 6260 } 6261 }, 6262 "group": { 6263 "type": "object", 6264 "properties": { 6265 "members": { 6266 "type": "array", 6267 "items": { 6268 "type": "string" 6269 } 6270 }, 6271 "name": { 6272 "type": "string" 6273 }, 6274 "policy": { 6275 "type": "string" 6276 }, 6277 "status": { 6278 "type": "string" 6279 } 6280 } 6281 }, 6282 "iamEntity": { 6283 "type": "string", 6284 "pattern": "^[\\w+=,.@-]{1,64}$" 6285 }, 6286 "iamPolicy": { 6287 "type": "object", 6288 "properties": { 6289 "statement": { 6290 "type": "array", 6291 "items": { 6292 "$ref": "#/definitions/iamPolicyStatement" 6293 } 6294 }, 6295 "version": { 6296 "type": "string" 6297 } 6298 } 6299 }, 6300 "iamPolicyStatement": { 6301 "type": "object", 6302 "properties": { 6303 "action": { 6304 "type": "array", 6305 "items": { 6306 "type": "string" 6307 } 6308 }, 6309 "condition": { 6310 "type": "object", 6311 "additionalProperties": { 6312 "type": "object" 6313 } 6314 }, 6315 "effect": { 6316 "type": "string" 6317 }, 6318 "resource": { 6319 "type": "array", 6320 "items": { 6321 "type": "string" 6322 } 6323 } 6324 } 6325 }, 6326 "idpListConfigurationsResponse": { 6327 "type": "object", 6328 "properties": { 6329 "results": { 6330 "type": "array", 6331 "items": { 6332 "$ref": "#/definitions/idpServerConfiguration" 6333 } 6334 } 6335 } 6336 }, 6337 "idpServerConfiguration": { 6338 "type": "object", 6339 "properties": { 6340 "enabled": { 6341 "type": "boolean" 6342 }, 6343 "info": { 6344 "type": "array", 6345 "items": { 6346 "$ref": "#/definitions/idpServerConfigurationInfo" 6347 } 6348 }, 6349 "input": { 6350 "type": "string" 6351 }, 6352 "name": { 6353 "type": "string" 6354 }, 6355 "type": { 6356 "type": "string" 6357 } 6358 } 6359 }, 6360 "idpServerConfigurationInfo": { 6361 "type": "object", 6362 "properties": { 6363 "isCfg": { 6364 "type": "boolean" 6365 }, 6366 "isEnv": { 6367 "type": "boolean" 6368 }, 6369 "key": { 6370 "type": "string" 6371 }, 6372 "value": { 6373 "type": "string" 6374 } 6375 } 6376 }, 6377 "kmDeleteKeyRequest": { 6378 "type": "object" 6379 }, 6380 "kmsAPI": { 6381 "type": "object", 6382 "properties": { 6383 "maxBody": { 6384 "type": "integer" 6385 }, 6386 "method": { 6387 "type": "string" 6388 }, 6389 "path": { 6390 "type": "string" 6391 }, 6392 "timeout": { 6393 "type": "integer" 6394 } 6395 } 6396 }, 6397 "kmsAPIsResponse": { 6398 "type": "object", 6399 "properties": { 6400 "results": { 6401 "type": "array", 6402 "items": { 6403 "$ref": "#/definitions/kmsAPI" 6404 } 6405 } 6406 } 6407 }, 6408 "kmsAssignPolicyRequest": { 6409 "type": "object", 6410 "properties": { 6411 "identity": { 6412 "type": "string" 6413 } 6414 } 6415 }, 6416 "kmsCreateKeyRequest": { 6417 "type": "object", 6418 "required": [ 6419 "key" 6420 ], 6421 "properties": { 6422 "key": { 6423 "type": "string" 6424 } 6425 } 6426 }, 6427 "kmsDescribeIdentityResponse": { 6428 "type": "object", 6429 "properties": { 6430 "admin": { 6431 "type": "boolean" 6432 }, 6433 "createdAt": { 6434 "type": "string" 6435 }, 6436 "createdBy": { 6437 "type": "string" 6438 }, 6439 "identity": { 6440 "type": "string" 6441 }, 6442 "policy": { 6443 "type": "string" 6444 } 6445 } 6446 }, 6447 "kmsDescribePolicyResponse": { 6448 "type": "object", 6449 "properties": { 6450 "createdAt": { 6451 "type": "string" 6452 }, 6453 "createdBy": { 6454 "type": "string" 6455 }, 6456 "name": { 6457 "type": "string" 6458 } 6459 } 6460 }, 6461 "kmsDescribeSelfIdentityResponse": { 6462 "type": "object", 6463 "properties": { 6464 "admin": { 6465 "type": "boolean" 6466 }, 6467 "createdAt": { 6468 "type": "string" 6469 }, 6470 "createdBy": { 6471 "type": "string" 6472 }, 6473 "identity": { 6474 "type": "string" 6475 }, 6476 "policy": { 6477 "$ref": "#/definitions/kmsGetPolicyResponse" 6478 }, 6479 "policyName": { 6480 "type": "string" 6481 } 6482 } 6483 }, 6484 "kmsEndpoint": { 6485 "type": "object", 6486 "properties": { 6487 "status": { 6488 "type": "string" 6489 }, 6490 "url": { 6491 "type": "string" 6492 } 6493 } 6494 }, 6495 "kmsGetPolicyResponse": { 6496 "type": "object", 6497 "properties": { 6498 "allow": { 6499 "type": "array", 6500 "items": { 6501 "type": "string" 6502 } 6503 }, 6504 "deny": { 6505 "type": "array", 6506 "items": { 6507 "type": "string" 6508 } 6509 } 6510 } 6511 }, 6512 "kmsIdentityInfo": { 6513 "type": "object", 6514 "properties": { 6515 "createdAt": { 6516 "type": "string" 6517 }, 6518 "createdBy": { 6519 "type": "string" 6520 }, 6521 "error": { 6522 "type": "string" 6523 }, 6524 "identity": { 6525 "type": "string" 6526 }, 6527 "policy": { 6528 "type": "string" 6529 } 6530 } 6531 }, 6532 "kmsImportKeyRequest": { 6533 "type": "object", 6534 "required": [ 6535 "bytes" 6536 ], 6537 "properties": { 6538 "bytes": { 6539 "type": "string" 6540 } 6541 } 6542 }, 6543 "kmsKeyInfo": { 6544 "type": "object", 6545 "properties": { 6546 "createdAt": { 6547 "type": "string" 6548 }, 6549 "createdBy": { 6550 "type": "string" 6551 }, 6552 "name": { 6553 "type": "string" 6554 } 6555 } 6556 }, 6557 "kmsKeyStatusResponse": { 6558 "type": "object", 6559 "properties": { 6560 "decryptionErr": { 6561 "type": "string" 6562 }, 6563 "encryptionErr": { 6564 "type": "string" 6565 }, 6566 "keyID": { 6567 "type": "string" 6568 } 6569 } 6570 }, 6571 "kmsLatencyHistogram": { 6572 "type": "object", 6573 "properties": { 6574 "duration": { 6575 "type": "integer" 6576 }, 6577 "total": { 6578 "type": "integer" 6579 } 6580 } 6581 }, 6582 "kmsListIdentitiesResponse": { 6583 "type": "object", 6584 "properties": { 6585 "results": { 6586 "type": "array", 6587 "items": { 6588 "$ref": "#/definitions/kmsIdentityInfo" 6589 } 6590 } 6591 } 6592 }, 6593 "kmsListKeysResponse": { 6594 "type": "object", 6595 "properties": { 6596 "results": { 6597 "type": "array", 6598 "items": { 6599 "$ref": "#/definitions/kmsKeyInfo" 6600 } 6601 } 6602 } 6603 }, 6604 "kmsListPoliciesResponse": { 6605 "type": "object", 6606 "properties": { 6607 "results": { 6608 "type": "array", 6609 "items": { 6610 "$ref": "#/definitions/kmsPolicyInfo" 6611 } 6612 } 6613 } 6614 }, 6615 "kmsMetricsResponse": { 6616 "type": "object", 6617 "required": [ 6618 "requestOK", 6619 "requestErr", 6620 "requestFail", 6621 "requestActive", 6622 "auditEvents", 6623 "errorEvents", 6624 "latencyHistogram", 6625 "uptime", 6626 "cpus", 6627 "usableCPUs", 6628 "threads", 6629 "heapAlloc", 6630 "stackAlloc" 6631 ], 6632 "properties": { 6633 "auditEvents": { 6634 "type": "integer" 6635 }, 6636 "cpus": { 6637 "type": "integer" 6638 }, 6639 "errorEvents": { 6640 "type": "integer" 6641 }, 6642 "heapAlloc": { 6643 "type": "integer" 6644 }, 6645 "heapObjects": { 6646 "type": "integer" 6647 }, 6648 "latencyHistogram": { 6649 "type": "array", 6650 "items": { 6651 "$ref": "#/definitions/kmsLatencyHistogram" 6652 } 6653 }, 6654 "requestActive": { 6655 "type": "integer" 6656 }, 6657 "requestErr": { 6658 "type": "integer" 6659 }, 6660 "requestFail": { 6661 "type": "integer" 6662 }, 6663 "requestOK": { 6664 "type": "integer" 6665 }, 6666 "stackAlloc": { 6667 "type": "integer" 6668 }, 6669 "threads": { 6670 "type": "integer" 6671 }, 6672 "uptime": { 6673 "type": "integer" 6674 }, 6675 "usableCPUs": { 6676 "type": "integer" 6677 } 6678 } 6679 }, 6680 "kmsPolicyInfo": { 6681 "type": "object", 6682 "properties": { 6683 "createdAt": { 6684 "type": "string" 6685 }, 6686 "createdBy": { 6687 "type": "string" 6688 }, 6689 "name": { 6690 "type": "string" 6691 } 6692 } 6693 }, 6694 "kmsSetPolicyRequest": { 6695 "type": "object", 6696 "required": [ 6697 "policy" 6698 ], 6699 "properties": { 6700 "allow": { 6701 "type": "array", 6702 "items": { 6703 "type": "string" 6704 } 6705 }, 6706 "deny": { 6707 "type": "array", 6708 "items": { 6709 "type": "string" 6710 } 6711 }, 6712 "policy": { 6713 "type": "string" 6714 } 6715 } 6716 }, 6717 "kmsStatusResponse": { 6718 "type": "object", 6719 "properties": { 6720 "defaultKeyID": { 6721 "type": "string" 6722 }, 6723 "endpoints": { 6724 "type": "array", 6725 "items": { 6726 "$ref": "#/definitions/kmsEndpoint" 6727 } 6728 }, 6729 "name": { 6730 "type": "string" 6731 } 6732 } 6733 }, 6734 "kmsVersionResponse": { 6735 "type": "object", 6736 "properties": { 6737 "version": { 6738 "type": "string" 6739 } 6740 } 6741 }, 6742 "ldapEntities": { 6743 "type": "object", 6744 "properties": { 6745 "groups": { 6746 "type": "array", 6747 "items": { 6748 "$ref": "#/definitions/ldapGroupPolicyEntity" 6749 } 6750 }, 6751 "policies": { 6752 "type": "array", 6753 "items": { 6754 "$ref": "#/definitions/ldapPolicyEntity" 6755 } 6756 }, 6757 "timestamp": { 6758 "type": "string" 6759 }, 6760 "users": { 6761 "type": "array", 6762 "items": { 6763 "$ref": "#/definitions/ldapUserPolicyEntity" 6764 } 6765 } 6766 } 6767 }, 6768 "ldapEntitiesRequest": { 6769 "type": "object", 6770 "properties": { 6771 "groups": { 6772 "type": "array", 6773 "items": { 6774 "type": "string" 6775 } 6776 }, 6777 "policies": { 6778 "type": "array", 6779 "items": { 6780 "type": "string" 6781 } 6782 }, 6783 "users": { 6784 "type": "array", 6785 "items": { 6786 "type": "string" 6787 } 6788 } 6789 } 6790 }, 6791 "ldapGroupPolicyEntity": { 6792 "type": "object", 6793 "properties": { 6794 "group": { 6795 "type": "string" 6796 }, 6797 "policies": { 6798 "type": "array", 6799 "items": { 6800 "type": "string" 6801 } 6802 } 6803 } 6804 }, 6805 "ldapPolicyEntity": { 6806 "type": "object", 6807 "properties": { 6808 "groups": { 6809 "type": "array", 6810 "items": { 6811 "type": "string" 6812 } 6813 }, 6814 "policy": { 6815 "type": "string" 6816 }, 6817 "users": { 6818 "type": "array", 6819 "items": { 6820 "type": "string" 6821 } 6822 } 6823 } 6824 }, 6825 "ldapUserPolicyEntity": { 6826 "type": "object", 6827 "properties": { 6828 "policies": { 6829 "type": "array", 6830 "items": { 6831 "type": "string" 6832 } 6833 }, 6834 "user": { 6835 "type": "string" 6836 } 6837 } 6838 }, 6839 "license": { 6840 "type": "object", 6841 "properties": { 6842 "account_id": { 6843 "type": "integer" 6844 }, 6845 "email": { 6846 "type": "string" 6847 }, 6848 "expires_at": { 6849 "type": "string" 6850 }, 6851 "organization": { 6852 "type": "string" 6853 }, 6854 "plan": { 6855 "type": "string" 6856 }, 6857 "storage_capacity": { 6858 "type": "integer" 6859 } 6860 } 6861 }, 6862 "lifecycleTag": { 6863 "type": "object", 6864 "properties": { 6865 "key": { 6866 "type": "string" 6867 }, 6868 "value": { 6869 "type": "string" 6870 } 6871 } 6872 }, 6873 "listAccessRulesResponse": { 6874 "type": "object", 6875 "properties": { 6876 "accessRules": { 6877 "type": "array", 6878 "title": "list of policies", 6879 "items": { 6880 "$ref": "#/definitions/accessRule" 6881 } 6882 }, 6883 "total": { 6884 "type": "integer", 6885 "format": "int64", 6886 "title": "total number of policies" 6887 } 6888 } 6889 }, 6890 "listBucketEventsResponse": { 6891 "type": "object", 6892 "properties": { 6893 "events": { 6894 "type": "array", 6895 "items": { 6896 "$ref": "#/definitions/notificationConfig" 6897 } 6898 }, 6899 "total": { 6900 "type": "integer", 6901 "format": "int64", 6902 "title": "total number of bucket events" 6903 } 6904 } 6905 }, 6906 "listBucketsResponse": { 6907 "type": "object", 6908 "properties": { 6909 "buckets": { 6910 "type": "array", 6911 "title": "list of resulting buckets", 6912 "items": { 6913 "$ref": "#/definitions/bucket" 6914 } 6915 }, 6916 "total": { 6917 "type": "integer", 6918 "format": "int64", 6919 "title": "number of buckets accessible to the user" 6920 } 6921 } 6922 }, 6923 "listConfigResponse": { 6924 "type": "object", 6925 "properties": { 6926 "configurations": { 6927 "type": "array", 6928 "items": { 6929 "$ref": "#/definitions/configDescription" 6930 } 6931 }, 6932 "total": { 6933 "type": "integer", 6934 "format": "int64", 6935 "title": "total number of configurations" 6936 } 6937 } 6938 }, 6939 "listExternalBucketsParams": { 6940 "required": [ 6941 "accessKey", 6942 "secretKey", 6943 "targetURL", 6944 "useTLS" 6945 ], 6946 "properties": { 6947 "accessKey": { 6948 "type": "string", 6949 "minLength": 3 6950 }, 6951 "region": { 6952 "type": "string" 6953 }, 6954 "secretKey": { 6955 "type": "string", 6956 "minLength": 8 6957 }, 6958 "targetURL": { 6959 "type": "string" 6960 }, 6961 "useTLS": { 6962 "type": "boolean" 6963 } 6964 } 6965 }, 6966 "listGroupsResponse": { 6967 "type": "object", 6968 "properties": { 6969 "groups": { 6970 "type": "array", 6971 "title": "list of groups", 6972 "items": { 6973 "type": "string" 6974 } 6975 }, 6976 "total": { 6977 "type": "integer", 6978 "format": "int64", 6979 "title": "total number of groups" 6980 } 6981 } 6982 }, 6983 "listObjectsResponse": { 6984 "type": "object", 6985 "properties": { 6986 "objects": { 6987 "type": "array", 6988 "title": "list of resulting objects", 6989 "items": { 6990 "$ref": "#/definitions/bucketObject" 6991 } 6992 }, 6993 "total": { 6994 "type": "integer", 6995 "format": "int64", 6996 "title": "number of objects" 6997 } 6998 } 6999 }, 7000 "listPoliciesResponse": { 7001 "type": "object", 7002 "properties": { 7003 "policies": { 7004 "type": "array", 7005 "title": "list of policies", 7006 "items": { 7007 "$ref": "#/definitions/policy" 7008 } 7009 }, 7010 "total": { 7011 "type": "integer", 7012 "format": "int64", 7013 "title": "total number of policies" 7014 } 7015 } 7016 }, 7017 "listRemoteBucketsResponse": { 7018 "type": "object", 7019 "properties": { 7020 "buckets": { 7021 "type": "array", 7022 "title": "list of remote buckets", 7023 "items": { 7024 "$ref": "#/definitions/remoteBucket" 7025 } 7026 }, 7027 "total": { 7028 "type": "integer", 7029 "format": "int64", 7030 "title": "number of remote buckets accessible to user" 7031 } 7032 } 7033 }, 7034 "listUsersResponse": { 7035 "type": "object", 7036 "properties": { 7037 "users": { 7038 "type": "array", 7039 "title": "list of resulting users", 7040 "items": { 7041 "$ref": "#/definitions/user" 7042 } 7043 } 7044 } 7045 }, 7046 "logSearchResponse": { 7047 "type": "object", 7048 "properties": { 7049 "results": { 7050 "type": "object", 7051 "title": "list of log search responses" 7052 } 7053 } 7054 }, 7055 "loginDetails": { 7056 "type": "object", 7057 "properties": { 7058 "animatedLogin": { 7059 "type": "boolean" 7060 }, 7061 "isK8S": { 7062 "type": "boolean" 7063 }, 7064 "loginStrategy": { 7065 "type": "string", 7066 "enum": [ 7067 "form", 7068 "redirect", 7069 "service-account", 7070 "redirect-service-account" 7071 ] 7072 }, 7073 "redirectRules": { 7074 "type": "array", 7075 "items": { 7076 "$ref": "#/definitions/redirectRule" 7077 } 7078 } 7079 } 7080 }, 7081 "loginOauth2AuthRequest": { 7082 "type": "object", 7083 "required": [ 7084 "state", 7085 "code" 7086 ], 7087 "properties": { 7088 "code": { 7089 "type": "string" 7090 }, 7091 "state": { 7092 "type": "string" 7093 } 7094 } 7095 }, 7096 "loginRequest": { 7097 "type": "object", 7098 "properties": { 7099 "accessKey": { 7100 "type": "string" 7101 }, 7102 "features": { 7103 "type": "object", 7104 "properties": { 7105 "hide_menu": { 7106 "type": "boolean" 7107 } 7108 } 7109 }, 7110 "secretKey": { 7111 "type": "string" 7112 }, 7113 "sts": { 7114 "type": "string" 7115 } 7116 } 7117 }, 7118 "loginResponse": { 7119 "type": "object", 7120 "properties": { 7121 "IDPRefreshToken": { 7122 "type": "string" 7123 }, 7124 "sessionId": { 7125 "type": "string" 7126 } 7127 } 7128 }, 7129 "logoutRequest": { 7130 "type": "object", 7131 "properties": { 7132 "state": { 7133 "type": "string" 7134 } 7135 } 7136 }, 7137 "makeBucketRequest": { 7138 "type": "object", 7139 "required": [ 7140 "name" 7141 ], 7142 "properties": { 7143 "locking": { 7144 "type": "boolean" 7145 }, 7146 "name": { 7147 "type": "string" 7148 }, 7149 "quota": { 7150 "$ref": "#/definitions/setBucketQuota" 7151 }, 7152 "retention": { 7153 "$ref": "#/definitions/putBucketRetentionRequest" 7154 }, 7155 "versioning": { 7156 "$ref": "#/definitions/setBucketVersioning" 7157 } 7158 } 7159 }, 7160 "makeBucketsResponse": { 7161 "type": "object", 7162 "properties": { 7163 "bucketName": { 7164 "type": "string" 7165 } 7166 } 7167 }, 7168 "maxShareLinkExpResponse": { 7169 "type": "object", 7170 "required": [ 7171 "exp" 7172 ], 7173 "properties": { 7174 "exp": { 7175 "type": "number", 7176 "format": "int64" 7177 } 7178 } 7179 }, 7180 "metadata": { 7181 "type": "object", 7182 "properties": { 7183 "objectMetadata": { 7184 "type": "object", 7185 "additionalProperties": true 7186 } 7187 } 7188 }, 7189 "multiBucketReplication": { 7190 "required": [ 7191 "accessKey", 7192 "secretKey", 7193 "targetURL", 7194 "bucketsRelation" 7195 ], 7196 "properties": { 7197 "accessKey": { 7198 "type": "string", 7199 "minLength": 3 7200 }, 7201 "bandwidth": { 7202 "type": "integer", 7203 "format": "int64" 7204 }, 7205 "bucketsRelation": { 7206 "type": "array", 7207 "minLength": 1, 7208 "items": { 7209 "$ref": "#/definitions/multiBucketsRelation" 7210 } 7211 }, 7212 "healthCheckPeriod": { 7213 "type": "integer", 7214 "format": "int32" 7215 }, 7216 "prefix": { 7217 "type": "string" 7218 }, 7219 "priority": { 7220 "type": "integer", 7221 "format": "int32", 7222 "default": 0 7223 }, 7224 "region": { 7225 "type": "string" 7226 }, 7227 "replicateDeleteMarkers": { 7228 "type": "boolean" 7229 }, 7230 "replicateDeletes": { 7231 "type": "boolean" 7232 }, 7233 "replicateExistingObjects": { 7234 "type": "boolean" 7235 }, 7236 "replicateMetadata": { 7237 "type": "boolean" 7238 }, 7239 "secretKey": { 7240 "type": "string", 7241 "minLength": 8 7242 }, 7243 "storageClass": { 7244 "type": "string", 7245 "default": "" 7246 }, 7247 "syncMode": { 7248 "type": "string", 7249 "default": "async", 7250 "enum": [ 7251 "async", 7252 "sync" 7253 ] 7254 }, 7255 "tags": { 7256 "type": "string" 7257 }, 7258 "targetURL": { 7259 "type": "string" 7260 } 7261 } 7262 }, 7263 "multiBucketReplicationEdit": { 7264 "properties": { 7265 "arn": { 7266 "type": "string" 7267 }, 7268 "prefix": { 7269 "type": "string" 7270 }, 7271 "priority": { 7272 "type": "integer", 7273 "format": "int32", 7274 "default": 0 7275 }, 7276 "replicateDeleteMarkers": { 7277 "type": "boolean" 7278 }, 7279 "replicateDeletes": { 7280 "type": "boolean" 7281 }, 7282 "replicateExistingObjects": { 7283 "type": "boolean" 7284 }, 7285 "replicateMetadata": { 7286 "type": "boolean" 7287 }, 7288 "ruleState": { 7289 "type": "boolean" 7290 }, 7291 "storageClass": { 7292 "type": "string", 7293 "default": "" 7294 }, 7295 "tags": { 7296 "type": "string", 7297 "default": "" 7298 } 7299 } 7300 }, 7301 "multiBucketResponseItem": { 7302 "type": "object", 7303 "properties": { 7304 "errorString": { 7305 "type": "string" 7306 }, 7307 "originBucket": { 7308 "type": "string" 7309 }, 7310 "targetBucket": { 7311 "type": "string" 7312 } 7313 } 7314 }, 7315 "multiBucketResponseState": { 7316 "type": "object", 7317 "properties": { 7318 "replicationState": { 7319 "type": "array", 7320 "items": { 7321 "$ref": "#/definitions/multiBucketResponseItem" 7322 } 7323 } 7324 } 7325 }, 7326 "multiBucketsRelation": { 7327 "type": "object", 7328 "properties": { 7329 "destinationBucket": { 7330 "type": "string" 7331 }, 7332 "originBucket": { 7333 "type": "string" 7334 } 7335 } 7336 }, 7337 "multiLifecycleResult": { 7338 "properties": { 7339 "results": { 7340 "type": "array", 7341 "items": { 7342 "$ref": "#/definitions/multicycleResultItem" 7343 } 7344 } 7345 } 7346 }, 7347 "multicycleResultItem": { 7348 "type": "object", 7349 "properties": { 7350 "bucketName": { 7351 "type": "string" 7352 }, 7353 "error": { 7354 "type": "string" 7355 } 7356 } 7357 }, 7358 "nofiticationService": { 7359 "type": "string", 7360 "enum": [ 7361 "webhook", 7362 "amqp", 7363 "kafka", 7364 "mqtt", 7365 "nats", 7366 "nsq", 7367 "mysql", 7368 "postgres", 7369 "elasticsearch", 7370 "redis" 7371 ] 7372 }, 7373 "notifEndpointResponse": { 7374 "type": "object", 7375 "properties": { 7376 "notification_endpoints": { 7377 "type": "array", 7378 "items": { 7379 "$ref": "#/definitions/notificationEndpointItem" 7380 } 7381 } 7382 } 7383 }, 7384 "notificationConfig": { 7385 "type": "object", 7386 "required": [ 7387 "arn" 7388 ], 7389 "properties": { 7390 "arn": { 7391 "type": "string" 7392 }, 7393 "events": { 7394 "type": "array", 7395 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 7396 "items": { 7397 "$ref": "#/definitions/notificationEventType" 7398 } 7399 }, 7400 "id": { 7401 "type": "string" 7402 }, 7403 "prefix": { 7404 "type": "string", 7405 "title": "filter event associated to the specified prefix" 7406 }, 7407 "suffix": { 7408 "type": "string", 7409 "title": "filter event associated to the specified suffix" 7410 } 7411 } 7412 }, 7413 "notificationDeleteRequest": { 7414 "type": "object", 7415 "required": [ 7416 "events", 7417 "prefix", 7418 "suffix" 7419 ], 7420 "properties": { 7421 "events": { 7422 "type": "array", 7423 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 7424 "minLength": 1, 7425 "items": { 7426 "$ref": "#/definitions/notificationEventType" 7427 } 7428 }, 7429 "prefix": { 7430 "type": "string", 7431 "title": "filter event associated to the specified prefix" 7432 }, 7433 "suffix": { 7434 "type": "string", 7435 "title": "filter event associated to the specified suffix" 7436 } 7437 } 7438 }, 7439 "notificationEndpoint": { 7440 "type": "object", 7441 "required": [ 7442 "service", 7443 "account_id", 7444 "properties" 7445 ], 7446 "properties": { 7447 "account_id": { 7448 "type": "string" 7449 }, 7450 "properties": { 7451 "type": "object", 7452 "additionalProperties": { 7453 "type": "string" 7454 } 7455 }, 7456 "service": { 7457 "$ref": "#/definitions/nofiticationService" 7458 } 7459 } 7460 }, 7461 "notificationEndpointItem": { 7462 "type": "object", 7463 "properties": { 7464 "account_id": { 7465 "type": "string" 7466 }, 7467 "service": { 7468 "$ref": "#/definitions/nofiticationService" 7469 }, 7470 "status": { 7471 "type": "string" 7472 } 7473 } 7474 }, 7475 "notificationEventType": { 7476 "type": "string", 7477 "enum": [ 7478 "put", 7479 "delete", 7480 "get", 7481 "replica", 7482 "ilm", 7483 "scanner" 7484 ] 7485 }, 7486 "objectBucketLifecycle": { 7487 "type": "object", 7488 "properties": { 7489 "expiration": { 7490 "$ref": "#/definitions/expirationResponse" 7491 }, 7492 "id": { 7493 "type": "string" 7494 }, 7495 "prefix": { 7496 "type": "string" 7497 }, 7498 "status": { 7499 "type": "string" 7500 }, 7501 "tags": { 7502 "type": "array", 7503 "items": { 7504 "$ref": "#/definitions/lifecycleTag" 7505 } 7506 }, 7507 "transition": { 7508 "$ref": "#/definitions/transitionResponse" 7509 } 7510 } 7511 }, 7512 "objectLegalHoldStatus": { 7513 "type": "string", 7514 "enum": [ 7515 "enabled", 7516 "disabled" 7517 ] 7518 }, 7519 "objectRetentionMode": { 7520 "type": "string", 7521 "enum": [ 7522 "governance", 7523 "compliance" 7524 ] 7525 }, 7526 "objectRetentionUnit": { 7527 "type": "string", 7528 "enum": [ 7529 "days", 7530 "years" 7531 ] 7532 }, 7533 "peerInfo": { 7534 "type": "object", 7535 "properties": { 7536 "deploymentID": { 7537 "type": "string" 7538 }, 7539 "endpoint": { 7540 "type": "string" 7541 }, 7542 "name": { 7543 "type": "string" 7544 } 7545 } 7546 }, 7547 "peerInfoRemove": { 7548 "type": "object", 7549 "required": [ 7550 "sites" 7551 ], 7552 "properties": { 7553 "all": { 7554 "type": "boolean" 7555 }, 7556 "sites": { 7557 "type": "array", 7558 "items": { 7559 "type": "string" 7560 } 7561 } 7562 } 7563 }, 7564 "peerSite": { 7565 "type": "object", 7566 "properties": { 7567 "accessKey": { 7568 "type": "string" 7569 }, 7570 "endpoint": { 7571 "type": "string" 7572 }, 7573 "name": { 7574 "type": "string" 7575 }, 7576 "secretKey": { 7577 "type": "string" 7578 } 7579 } 7580 }, 7581 "peerSiteEditResponse": { 7582 "type": "object", 7583 "properties": { 7584 "errorDetail": { 7585 "type": "string" 7586 }, 7587 "status": { 7588 "type": "string" 7589 }, 7590 "success": { 7591 "type": "boolean" 7592 } 7593 } 7594 }, 7595 "peerSiteRemoveResponse": { 7596 "type": "object", 7597 "properties": { 7598 "errorDetail": { 7599 "type": "string" 7600 }, 7601 "status": { 7602 "type": "string" 7603 } 7604 } 7605 }, 7606 "permissionResource": { 7607 "type": "object", 7608 "properties": { 7609 "conditionOperator": { 7610 "type": "string" 7611 }, 7612 "prefixes": { 7613 "type": "array", 7614 "items": { 7615 "type": "string" 7616 } 7617 }, 7618 "resource": { 7619 "type": "string" 7620 } 7621 } 7622 }, 7623 "policy": { 7624 "type": "object", 7625 "properties": { 7626 "name": { 7627 "type": "string" 7628 }, 7629 "policy": { 7630 "type": "string" 7631 } 7632 } 7633 }, 7634 "policyArgs": { 7635 "type": "object", 7636 "properties": { 7637 "action": { 7638 "type": "string" 7639 }, 7640 "bucket_name": { 7641 "type": "string" 7642 }, 7643 "id": { 7644 "type": "string" 7645 } 7646 } 7647 }, 7648 "policyEntity": { 7649 "type": "string", 7650 "default": "user", 7651 "enum": [ 7652 "user", 7653 "group" 7654 ] 7655 }, 7656 "prefixAccessPair": { 7657 "type": "object", 7658 "properties": { 7659 "access": { 7660 "type": "string" 7661 }, 7662 "prefix": { 7663 "type": "string" 7664 } 7665 } 7666 }, 7667 "prefixWrapper": { 7668 "type": "object", 7669 "properties": { 7670 "prefix": { 7671 "type": "string" 7672 } 7673 } 7674 }, 7675 "principal": { 7676 "type": "object", 7677 "properties": { 7678 "STSAccessKeyID": { 7679 "type": "string" 7680 }, 7681 "STSSecretAccessKey": { 7682 "type": "string" 7683 }, 7684 "STSSessionToken": { 7685 "type": "string" 7686 }, 7687 "accountAccessKey": { 7688 "type": "string" 7689 }, 7690 "customStyleOb": { 7691 "type": "string" 7692 }, 7693 "hm": { 7694 "type": "boolean" 7695 }, 7696 "ob": { 7697 "type": "boolean" 7698 } 7699 } 7700 }, 7701 "profilingStartRequest": { 7702 "type": "object", 7703 "required": [ 7704 "type" 7705 ], 7706 "properties": { 7707 "type": { 7708 "type": "string" 7709 } 7710 } 7711 }, 7712 "putBucketRetentionRequest": { 7713 "type": "object", 7714 "required": [ 7715 "mode", 7716 "unit", 7717 "validity" 7718 ], 7719 "properties": { 7720 "mode": { 7721 "$ref": "#/definitions/objectRetentionMode" 7722 }, 7723 "unit": { 7724 "$ref": "#/definitions/objectRetentionUnit" 7725 }, 7726 "validity": { 7727 "type": "integer", 7728 "format": "int32" 7729 } 7730 } 7731 }, 7732 "putBucketTagsRequest": { 7733 "type": "object", 7734 "properties": { 7735 "tags": { 7736 "additionalProperties": { 7737 "type": "string" 7738 } 7739 } 7740 } 7741 }, 7742 "putObjectLegalHoldRequest": { 7743 "type": "object", 7744 "required": [ 7745 "status" 7746 ], 7747 "properties": { 7748 "status": { 7749 "$ref": "#/definitions/objectLegalHoldStatus" 7750 } 7751 } 7752 }, 7753 "putObjectRetentionRequest": { 7754 "type": "object", 7755 "required": [ 7756 "mode", 7757 "expires" 7758 ], 7759 "properties": { 7760 "expires": { 7761 "type": "string" 7762 }, 7763 "governance_bypass": { 7764 "type": "boolean" 7765 }, 7766 "mode": { 7767 "$ref": "#/definitions/objectRetentionMode" 7768 } 7769 } 7770 }, 7771 "putObjectTagsRequest": { 7772 "type": "object", 7773 "properties": { 7774 "tags": { 7775 "additionalProperties": { 7776 "type": "string" 7777 } 7778 } 7779 } 7780 }, 7781 "redirectRule": { 7782 "type": "object", 7783 "properties": { 7784 "displayName": { 7785 "type": "string" 7786 }, 7787 "redirect": { 7788 "type": "string" 7789 }, 7790 "serviceType": { 7791 "type": "string" 7792 } 7793 } 7794 }, 7795 "releaseAuthor": { 7796 "type": "object", 7797 "properties": { 7798 "avatar_url": { 7799 "type": "string" 7800 }, 7801 "events_url": { 7802 "type": "string" 7803 }, 7804 "followers_url": { 7805 "type": "string" 7806 }, 7807 "following_url": { 7808 "type": "string" 7809 }, 7810 "gists_url": { 7811 "type": "string" 7812 }, 7813 "gravatar_id": { 7814 "type": "string" 7815 }, 7816 "html_url": { 7817 "type": "string" 7818 }, 7819 "id": { 7820 "type": "integer" 7821 }, 7822 "login": { 7823 "type": "string" 7824 }, 7825 "node_id": { 7826 "type": "string" 7827 }, 7828 "organizations_url": { 7829 "type": "string" 7830 }, 7831 "receivedEvents_url": { 7832 "type": "string" 7833 }, 7834 "repos_url": { 7835 "type": "string" 7836 }, 7837 "site_admin": { 7838 "type": "boolean" 7839 }, 7840 "starred_url": { 7841 "type": "string" 7842 }, 7843 "subscriptions_url": { 7844 "type": "string" 7845 }, 7846 "type": { 7847 "type": "string" 7848 }, 7849 "url": { 7850 "type": "string" 7851 } 7852 } 7853 }, 7854 "releaseInfo": { 7855 "type": "object", 7856 "properties": { 7857 "breakingChangesContent": { 7858 "type": "string" 7859 }, 7860 "contextContent": { 7861 "type": "string" 7862 }, 7863 "metadata": { 7864 "$ref": "#/definitions/releaseMetadata" 7865 }, 7866 "newFeaturesContent": { 7867 "type": "string" 7868 }, 7869 "notesContent": { 7870 "type": "string" 7871 }, 7872 "securityContent": { 7873 "type": "string" 7874 } 7875 } 7876 }, 7877 "releaseListResponse": { 7878 "type": "object", 7879 "properties": { 7880 "results": { 7881 "type": "array", 7882 "items": { 7883 "$ref": "#/definitions/releaseInfo" 7884 } 7885 } 7886 } 7887 }, 7888 "releaseMetadata": { 7889 "type": "object", 7890 "properties": { 7891 "assets_url": { 7892 "type": "string" 7893 }, 7894 "author": { 7895 "$ref": "#/definitions/releaseAuthor" 7896 }, 7897 "created_at": { 7898 "type": "string" 7899 }, 7900 "draft": { 7901 "type": "boolean" 7902 }, 7903 "html_url": { 7904 "type": "string" 7905 }, 7906 "id": { 7907 "type": "integer" 7908 }, 7909 "name": { 7910 "type": "string" 7911 }, 7912 "node_id": { 7913 "type": "string" 7914 }, 7915 "prerelease": { 7916 "type": "boolean" 7917 }, 7918 "published_at": { 7919 "type": "string" 7920 }, 7921 "tag_name": { 7922 "type": "string" 7923 }, 7924 "tarball_url": { 7925 "type": "string" 7926 }, 7927 "target_commitish": { 7928 "type": "string" 7929 }, 7930 "upload_url": { 7931 "type": "string" 7932 }, 7933 "url": { 7934 "type": "string" 7935 }, 7936 "zipball_url": { 7937 "type": "string" 7938 } 7939 } 7940 }, 7941 "remoteBucket": { 7942 "type": "object", 7943 "required": [ 7944 "accessKey", 7945 "sourceBucket", 7946 "remoteARN" 7947 ], 7948 "properties": { 7949 "accessKey": { 7950 "type": "string", 7951 "minLength": 3 7952 }, 7953 "bandwidth": { 7954 "type": "integer", 7955 "format": "int64" 7956 }, 7957 "healthCheckPeriod": { 7958 "type": "integer" 7959 }, 7960 "remoteARN": { 7961 "type": "string" 7962 }, 7963 "secretKey": { 7964 "type": "string", 7965 "minLength": 8 7966 }, 7967 "service": { 7968 "type": "string", 7969 "enum": [ 7970 "replication" 7971 ] 7972 }, 7973 "sourceBucket": { 7974 "type": "string" 7975 }, 7976 "status": { 7977 "type": "string" 7978 }, 7979 "syncMode": { 7980 "type": "string" 7981 }, 7982 "targetBucket": { 7983 "type": "string" 7984 }, 7985 "targetURL": { 7986 "type": "string" 7987 } 7988 } 7989 }, 7990 "resultTarget": { 7991 "type": "object", 7992 "properties": { 7993 "legendFormat": { 7994 "type": "string" 7995 }, 7996 "result": { 7997 "type": "array", 7998 "items": { 7999 "$ref": "#/definitions/widgetResult" 8000 } 8001 }, 8002 "resultType": { 8003 "type": "string" 8004 } 8005 } 8006 }, 8007 "rewindItem": { 8008 "type": "object", 8009 "properties": { 8010 "action": { 8011 "type": "string" 8012 }, 8013 "delete_flag": { 8014 "type": "boolean" 8015 }, 8016 "is_latest": { 8017 "type": "boolean" 8018 }, 8019 "last_modified": { 8020 "type": "string" 8021 }, 8022 "name": { 8023 "type": "string" 8024 }, 8025 "size": { 8026 "type": "integer", 8027 "format": "int64" 8028 }, 8029 "version_id": { 8030 "type": "string" 8031 } 8032 } 8033 }, 8034 "rewindResponse": { 8035 "type": "object", 8036 "properties": { 8037 "objects": { 8038 "type": "array", 8039 "items": { 8040 "$ref": "#/definitions/rewindItem" 8041 } 8042 } 8043 } 8044 }, 8045 "selectedSAs": { 8046 "type": "array", 8047 "items": { 8048 "type": "string" 8049 } 8050 }, 8051 "selectedUsers": { 8052 "type": "array", 8053 "items": { 8054 "type": "string" 8055 } 8056 }, 8057 "serverDrives": { 8058 "type": "object", 8059 "properties": { 8060 "availableSpace": { 8061 "type": "integer" 8062 }, 8063 "drivePath": { 8064 "type": "string" 8065 }, 8066 "endpoint": { 8067 "type": "string" 8068 }, 8069 "healing": { 8070 "type": "boolean" 8071 }, 8072 "model": { 8073 "type": "string" 8074 }, 8075 "rootDisk": { 8076 "type": "boolean" 8077 }, 8078 "state": { 8079 "type": "string" 8080 }, 8081 "totalSpace": { 8082 "type": "integer" 8083 }, 8084 "usedSpace": { 8085 "type": "integer" 8086 }, 8087 "uuid": { 8088 "type": "string" 8089 } 8090 } 8091 }, 8092 "serverProperties": { 8093 "type": "object", 8094 "properties": { 8095 "commitID": { 8096 "type": "string" 8097 }, 8098 "drives": { 8099 "type": "array", 8100 "items": { 8101 "$ref": "#/definitions/serverDrives" 8102 } 8103 }, 8104 "endpoint": { 8105 "type": "string" 8106 }, 8107 "network": { 8108 "type": "object", 8109 "additionalProperties": { 8110 "type": "string" 8111 } 8112 }, 8113 "poolNumber": { 8114 "type": "integer" 8115 }, 8116 "state": { 8117 "type": "string" 8118 }, 8119 "uptime": { 8120 "type": "integer" 8121 }, 8122 "version": { 8123 "type": "string" 8124 } 8125 } 8126 }, 8127 "serviceAccount": { 8128 "type": "object", 8129 "properties": { 8130 "accountStatus": { 8131 "type": "string" 8132 }, 8133 "description": { 8134 "type": "string" 8135 }, 8136 "expiration": { 8137 "type": "string" 8138 }, 8139 "impliedPolicy": { 8140 "type": "boolean" 8141 }, 8142 "name": { 8143 "type": "string" 8144 }, 8145 "parentUser": { 8146 "type": "string" 8147 }, 8148 "policy": { 8149 "type": "string" 8150 } 8151 } 8152 }, 8153 "serviceAccountCreds": { 8154 "type": "object", 8155 "properties": { 8156 "accessKey": { 8157 "type": "string" 8158 }, 8159 "secretKey": { 8160 "type": "string" 8161 }, 8162 "url": { 8163 "type": "string" 8164 } 8165 } 8166 }, 8167 "serviceAccountRequest": { 8168 "type": "object", 8169 "properties": { 8170 "comment": { 8171 "type": "string" 8172 }, 8173 "description": { 8174 "type": "string" 8175 }, 8176 "expiry": { 8177 "type": "string" 8178 }, 8179 "name": { 8180 "type": "string" 8181 }, 8182 "policy": { 8183 "type": "string", 8184 "title": "policy to be applied to the Service Account if any" 8185 } 8186 } 8187 }, 8188 "serviceAccountRequestCreds": { 8189 "type": "object", 8190 "properties": { 8191 "accessKey": { 8192 "type": "string" 8193 }, 8194 "comment": { 8195 "type": "string" 8196 }, 8197 "description": { 8198 "type": "string" 8199 }, 8200 "expiry": { 8201 "type": "string" 8202 }, 8203 "name": { 8204 "type": "string" 8205 }, 8206 "policy": { 8207 "type": "string", 8208 "title": "policy to be applied to the Service Account if any" 8209 }, 8210 "secretKey": { 8211 "type": "string" 8212 } 8213 } 8214 }, 8215 "serviceAccounts": { 8216 "type": "array", 8217 "items": { 8218 "type": "object", 8219 "properties": { 8220 "accessKey": { 8221 "type": "string" 8222 }, 8223 "accountStatus": { 8224 "type": "string" 8225 }, 8226 "description": { 8227 "type": "string" 8228 }, 8229 "expiration": { 8230 "type": "string" 8231 }, 8232 "name": { 8233 "type": "string" 8234 } 8235 } 8236 } 8237 }, 8238 "sessionResponse": { 8239 "type": "object", 8240 "properties": { 8241 "allowResources": { 8242 "type": "array", 8243 "items": { 8244 "$ref": "#/definitions/permissionResource" 8245 } 8246 }, 8247 "customStyles": { 8248 "type": "string" 8249 }, 8250 "distributedMode": { 8251 "type": "boolean" 8252 }, 8253 "envConstants": { 8254 "$ref": "#/definitions/environmentConstants" 8255 }, 8256 "features": { 8257 "type": "array", 8258 "items": { 8259 "type": "string" 8260 } 8261 }, 8262 "operator": { 8263 "type": "boolean" 8264 }, 8265 "permissions": { 8266 "type": "object", 8267 "additionalProperties": { 8268 "type": "array", 8269 "items": { 8270 "type": "string" 8271 } 8272 } 8273 }, 8274 "serverEndPoint": { 8275 "type": "string" 8276 }, 8277 "status": { 8278 "type": "string", 8279 "enum": [ 8280 "ok" 8281 ] 8282 } 8283 } 8284 }, 8285 "setBucketPolicyRequest": { 8286 "type": "object", 8287 "required": [ 8288 "access" 8289 ], 8290 "properties": { 8291 "access": { 8292 "$ref": "#/definitions/bucketAccess" 8293 }, 8294 "definition": { 8295 "type": "string" 8296 } 8297 } 8298 }, 8299 "setBucketQuota": { 8300 "type": "object", 8301 "required": [ 8302 "enabled" 8303 ], 8304 "properties": { 8305 "amount": { 8306 "type": "integer" 8307 }, 8308 "enabled": { 8309 "type": "boolean" 8310 }, 8311 "quota_type": { 8312 "type": "string", 8313 "enum": [ 8314 "hard" 8315 ] 8316 } 8317 } 8318 }, 8319 "setBucketVersioning": { 8320 "type": "object", 8321 "properties": { 8322 "enabled": { 8323 "type": "boolean" 8324 }, 8325 "excludeFolders": { 8326 "type": "boolean" 8327 }, 8328 "excludePrefixes": { 8329 "type": "array", 8330 "maxLength": 10, 8331 "items": { 8332 "type": "string" 8333 } 8334 } 8335 } 8336 }, 8337 "setConfigRequest": { 8338 "type": "object", 8339 "required": [ 8340 "key_values" 8341 ], 8342 "properties": { 8343 "arn_resource_id": { 8344 "type": "string", 8345 "title": "Used if configuration is an event notification's target" 8346 }, 8347 "key_values": { 8348 "type": "array", 8349 "minItems": 1, 8350 "items": { 8351 "$ref": "#/definitions/configurationKV" 8352 } 8353 } 8354 } 8355 }, 8356 "setConfigResponse": { 8357 "type": "object", 8358 "properties": { 8359 "restart": { 8360 "description": "Returns wheter server needs to restart to apply changes or not", 8361 "type": "boolean" 8362 } 8363 } 8364 }, 8365 "setIDPResponse": { 8366 "type": "object", 8367 "properties": { 8368 "restart": { 8369 "type": "boolean" 8370 } 8371 } 8372 }, 8373 "setNotificationEndpointResponse": { 8374 "type": "object", 8375 "required": [ 8376 "service", 8377 "account_id", 8378 "properties" 8379 ], 8380 "properties": { 8381 "account_id": { 8382 "type": "string" 8383 }, 8384 "properties": { 8385 "type": "object", 8386 "additionalProperties": { 8387 "type": "string" 8388 } 8389 }, 8390 "restart": { 8391 "type": "boolean" 8392 }, 8393 "service": { 8394 "$ref": "#/definitions/nofiticationService" 8395 } 8396 } 8397 }, 8398 "setPolicyMultipleNameRequest": { 8399 "type": "object", 8400 "properties": { 8401 "groups": { 8402 "type": "array", 8403 "items": { 8404 "$ref": "#/definitions/iamEntity" 8405 } 8406 }, 8407 "name": { 8408 "type": "array", 8409 "items": { 8410 "type": "string" 8411 } 8412 }, 8413 "users": { 8414 "type": "array", 8415 "items": { 8416 "$ref": "#/definitions/iamEntity" 8417 } 8418 } 8419 } 8420 }, 8421 "setPolicyNameRequest": { 8422 "type": "object", 8423 "required": [ 8424 "name", 8425 "entityType", 8426 "entityName" 8427 ], 8428 "properties": { 8429 "entityName": { 8430 "type": "string" 8431 }, 8432 "entityType": { 8433 "$ref": "#/definitions/policyEntity" 8434 }, 8435 "name": { 8436 "type": "array", 8437 "items": { 8438 "type": "string" 8439 } 8440 } 8441 } 8442 }, 8443 "setPolicyRequest": { 8444 "type": "object", 8445 "required": [ 8446 "entityType", 8447 "entityName" 8448 ], 8449 "properties": { 8450 "entityName": { 8451 "type": "string" 8452 }, 8453 "entityType": { 8454 "$ref": "#/definitions/policyEntity" 8455 } 8456 } 8457 }, 8458 "siteReplicationAddRequest": { 8459 "type": "array", 8460 "items": { 8461 "$ref": "#/definitions/peerSite" 8462 } 8463 }, 8464 "siteReplicationAddResponse": { 8465 "type": "object", 8466 "properties": { 8467 "errorDetail": { 8468 "type": "string" 8469 }, 8470 "initialSyncErrorMessage": { 8471 "type": "string" 8472 }, 8473 "status": { 8474 "type": "string" 8475 }, 8476 "success": { 8477 "type": "boolean" 8478 } 8479 } 8480 }, 8481 "siteReplicationInfoResponse": { 8482 "type": "object", 8483 "properties": { 8484 "enabled": { 8485 "type": "boolean" 8486 }, 8487 "name": { 8488 "type": "string" 8489 }, 8490 "serviceAccountAccessKey": { 8491 "type": "string" 8492 }, 8493 "sites": { 8494 "type": "array", 8495 "items": { 8496 "$ref": "#/definitions/peerInfo" 8497 } 8498 } 8499 } 8500 }, 8501 "siteReplicationStatusResponse": { 8502 "type": "object", 8503 "properties": { 8504 "bucketStats": { 8505 "type": "object" 8506 }, 8507 "enabled": { 8508 "type": "boolean" 8509 }, 8510 "groupStats": { 8511 "type": "object" 8512 }, 8513 "maxBuckets": { 8514 "type": "integer" 8515 }, 8516 "maxGroups": { 8517 "type": "integer" 8518 }, 8519 "maxPolicies": { 8520 "type": "integer" 8521 }, 8522 "maxUsers": { 8523 "type": "integer" 8524 }, 8525 "policyStats": { 8526 "type": "object" 8527 }, 8528 "sites": { 8529 "type": "object" 8530 }, 8531 "statsSummary": { 8532 "type": "object" 8533 }, 8534 "userStats": { 8535 "type": "object" 8536 } 8537 } 8538 }, 8539 "startProfilingItem": { 8540 "type": "object", 8541 "properties": { 8542 "error": { 8543 "type": "string" 8544 }, 8545 "nodeName": { 8546 "type": "string" 8547 }, 8548 "success": { 8549 "type": "boolean" 8550 } 8551 } 8552 }, 8553 "startProfilingList": { 8554 "type": "object", 8555 "properties": { 8556 "startResults": { 8557 "type": "array", 8558 "items": { 8559 "$ref": "#/definitions/startProfilingItem" 8560 } 8561 }, 8562 "total": { 8563 "type": "integer", 8564 "format": "int64", 8565 "title": "number of start results" 8566 } 8567 } 8568 }, 8569 "subnetLoginMFARequest": { 8570 "type": "object", 8571 "required": [ 8572 "username", 8573 "otp", 8574 "mfa_token" 8575 ], 8576 "properties": { 8577 "mfa_token": { 8578 "type": "string" 8579 }, 8580 "otp": { 8581 "type": "string" 8582 }, 8583 "username": { 8584 "type": "string" 8585 } 8586 } 8587 }, 8588 "subnetLoginRequest": { 8589 "type": "object", 8590 "properties": { 8591 "apiKey": { 8592 "type": "string" 8593 }, 8594 "password": { 8595 "type": "string" 8596 }, 8597 "username": { 8598 "type": "string" 8599 } 8600 } 8601 }, 8602 "subnetLoginResponse": { 8603 "type": "object", 8604 "properties": { 8605 "access_token": { 8606 "type": "string" 8607 }, 8608 "mfa_token": { 8609 "type": "string" 8610 }, 8611 "organizations": { 8612 "type": "array", 8613 "items": { 8614 "$ref": "#/definitions/subnetOrganization" 8615 } 8616 }, 8617 "registered": { 8618 "type": "boolean" 8619 } 8620 } 8621 }, 8622 "subnetOrganization": { 8623 "type": "object", 8624 "properties": { 8625 "accountId": { 8626 "type": "integer" 8627 }, 8628 "company": { 8629 "type": "string" 8630 }, 8631 "isAccountOwner": { 8632 "type": "boolean" 8633 }, 8634 "shortName": { 8635 "type": "string" 8636 }, 8637 "subscriptionStatus": { 8638 "type": "string" 8639 }, 8640 "userId": { 8641 "type": "integer" 8642 } 8643 } 8644 }, 8645 "subnetRegisterRequest": { 8646 "type": "object", 8647 "required": [ 8648 "token", 8649 "account_id" 8650 ], 8651 "properties": { 8652 "account_id": { 8653 "type": "string" 8654 }, 8655 "token": { 8656 "type": "string" 8657 } 8658 } 8659 }, 8660 "tier": { 8661 "type": "object", 8662 "properties": { 8663 "azure": { 8664 "type": "object", 8665 "$ref": "#/definitions/tier_azure" 8666 }, 8667 "gcs": { 8668 "type": "object", 8669 "$ref": "#/definitions/tier_gcs" 8670 }, 8671 "minio": { 8672 "type": "object", 8673 "$ref": "#/definitions/tier_minio" 8674 }, 8675 "s3": { 8676 "type": "object", 8677 "$ref": "#/definitions/tier_s3" 8678 }, 8679 "status": { 8680 "type": "boolean" 8681 }, 8682 "type": { 8683 "type": "string", 8684 "enum": [ 8685 "s3", 8686 "gcs", 8687 "azure", 8688 "minio", 8689 "unsupported" 8690 ] 8691 } 8692 } 8693 }, 8694 "tierCredentialsRequest": { 8695 "type": "object", 8696 "properties": { 8697 "access_key": { 8698 "type": "string" 8699 }, 8700 "creds": { 8701 "description": "a base64 encoded value", 8702 "type": "string" 8703 }, 8704 "secret_key": { 8705 "type": "string" 8706 } 8707 } 8708 }, 8709 "tierListResponse": { 8710 "type": "object", 8711 "properties": { 8712 "items": { 8713 "type": "array", 8714 "items": { 8715 "$ref": "#/definitions/tier" 8716 } 8717 } 8718 } 8719 }, 8720 "tier_azure": { 8721 "type": "object", 8722 "properties": { 8723 "accountkey": { 8724 "type": "string" 8725 }, 8726 "accountname": { 8727 "type": "string" 8728 }, 8729 "bucket": { 8730 "type": "string" 8731 }, 8732 "endpoint": { 8733 "type": "string" 8734 }, 8735 "name": { 8736 "type": "string" 8737 }, 8738 "objects": { 8739 "type": "string" 8740 }, 8741 "prefix": { 8742 "type": "string" 8743 }, 8744 "region": { 8745 "type": "string" 8746 }, 8747 "usage": { 8748 "type": "string" 8749 }, 8750 "versions": { 8751 "type": "string" 8752 } 8753 } 8754 }, 8755 "tier_gcs": { 8756 "type": "object", 8757 "properties": { 8758 "bucket": { 8759 "type": "string" 8760 }, 8761 "creds": { 8762 "type": "string" 8763 }, 8764 "endpoint": { 8765 "type": "string" 8766 }, 8767 "name": { 8768 "type": "string" 8769 }, 8770 "objects": { 8771 "type": "string" 8772 }, 8773 "prefix": { 8774 "type": "string" 8775 }, 8776 "region": { 8777 "type": "string" 8778 }, 8779 "usage": { 8780 "type": "string" 8781 }, 8782 "versions": { 8783 "type": "string" 8784 } 8785 } 8786 }, 8787 "tier_minio": { 8788 "type": "object", 8789 "properties": { 8790 "accesskey": { 8791 "type": "string" 8792 }, 8793 "bucket": { 8794 "type": "string" 8795 }, 8796 "endpoint": { 8797 "type": "string" 8798 }, 8799 "name": { 8800 "type": "string" 8801 }, 8802 "objects": { 8803 "type": "string" 8804 }, 8805 "prefix": { 8806 "type": "string" 8807 }, 8808 "region": { 8809 "type": "string" 8810 }, 8811 "secretkey": { 8812 "type": "string" 8813 }, 8814 "storageclass": { 8815 "type": "string" 8816 }, 8817 "usage": { 8818 "type": "string" 8819 }, 8820 "versions": { 8821 "type": "string" 8822 } 8823 } 8824 }, 8825 "tier_s3": { 8826 "type": "object", 8827 "properties": { 8828 "accesskey": { 8829 "type": "string" 8830 }, 8831 "bucket": { 8832 "type": "string" 8833 }, 8834 "endpoint": { 8835 "type": "string" 8836 }, 8837 "name": { 8838 "type": "string" 8839 }, 8840 "objects": { 8841 "type": "string" 8842 }, 8843 "prefix": { 8844 "type": "string" 8845 }, 8846 "region": { 8847 "type": "string" 8848 }, 8849 "secretkey": { 8850 "type": "string" 8851 }, 8852 "storageclass": { 8853 "type": "string" 8854 }, 8855 "usage": { 8856 "type": "string" 8857 }, 8858 "versions": { 8859 "type": "string" 8860 } 8861 } 8862 }, 8863 "transitionResponse": { 8864 "type": "object", 8865 "properties": { 8866 "date": { 8867 "type": "string" 8868 }, 8869 "days": { 8870 "type": "integer", 8871 "format": "int64" 8872 }, 8873 "noncurrent_storage_class": { 8874 "type": "string" 8875 }, 8876 "noncurrent_transition_days": { 8877 "type": "integer", 8878 "format": "int64" 8879 }, 8880 "storage_class": { 8881 "type": "string" 8882 } 8883 } 8884 }, 8885 "updateBucketLifecycle": { 8886 "type": "object", 8887 "required": [ 8888 "type" 8889 ], 8890 "properties": { 8891 "disable": { 8892 "description": "Non required, toggle to disable or enable rule", 8893 "type": "boolean" 8894 }, 8895 "expired_object_delete_all": { 8896 "description": "Non required, toggle to disable or enable rule", 8897 "type": "boolean" 8898 }, 8899 "expired_object_delete_marker": { 8900 "description": "Non required, toggle to disable or enable rule", 8901 "type": "boolean" 8902 }, 8903 "expiry_days": { 8904 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 8905 "type": "integer", 8906 "format": "int32", 8907 "default": 0 8908 }, 8909 "noncurrentversion_expiration_days": { 8910 "description": "Non required, can be set in case of expiration is enabled", 8911 "type": "integer", 8912 "format": "int32", 8913 "default": 0 8914 }, 8915 "noncurrentversion_transition_days": { 8916 "description": "Non required, can be set in case of transition is enabled", 8917 "type": "integer", 8918 "format": "int32", 8919 "default": 0 8920 }, 8921 "noncurrentversion_transition_storage_class": { 8922 "description": "Non required, can be set in case of transition is enabled", 8923 "type": "string" 8924 }, 8925 "prefix": { 8926 "description": "Non required field, it matches a prefix to perform ILM operations on it", 8927 "type": "string" 8928 }, 8929 "storage_class": { 8930 "description": "Required only in case of transition is set. it refers to a tier", 8931 "type": "string" 8932 }, 8933 "tags": { 8934 "description": "Non required field, tags to match ILM files", 8935 "type": "string" 8936 }, 8937 "transition_days": { 8938 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 8939 "type": "integer", 8940 "format": "int32", 8941 "default": 0 8942 }, 8943 "type": { 8944 "description": "ILM Rule type (Expiry or transition)", 8945 "type": "string", 8946 "enum": [ 8947 "expiry", 8948 "transition" 8949 ] 8950 } 8951 } 8952 }, 8953 "updateGroupRequest": { 8954 "type": "object", 8955 "required": [ 8956 "members", 8957 "status" 8958 ], 8959 "properties": { 8960 "members": { 8961 "type": "array", 8962 "items": { 8963 "type": "string" 8964 } 8965 }, 8966 "status": { 8967 "type": "string" 8968 } 8969 } 8970 }, 8971 "updateServiceAccountRequest": { 8972 "type": "object", 8973 "required": [ 8974 "policy" 8975 ], 8976 "properties": { 8977 "description": { 8978 "type": "string" 8979 }, 8980 "expiry": { 8981 "type": "string" 8982 }, 8983 "name": { 8984 "type": "string" 8985 }, 8986 "policy": { 8987 "type": "string" 8988 }, 8989 "secretKey": { 8990 "type": "string" 8991 }, 8992 "status": { 8993 "type": "string" 8994 } 8995 } 8996 }, 8997 "updateUser": { 8998 "type": "object", 8999 "required": [ 9000 "status", 9001 "groups" 9002 ], 9003 "properties": { 9004 "groups": { 9005 "type": "array", 9006 "items": { 9007 "type": "string" 9008 } 9009 }, 9010 "status": { 9011 "type": "string" 9012 } 9013 } 9014 }, 9015 "updateUserGroups": { 9016 "type": "object", 9017 "required": [ 9018 "groups" 9019 ], 9020 "properties": { 9021 "groups": { 9022 "type": "array", 9023 "items": { 9024 "type": "string" 9025 } 9026 } 9027 } 9028 }, 9029 "user": { 9030 "type": "object", 9031 "properties": { 9032 "accessKey": { 9033 "type": "string" 9034 }, 9035 "hasPolicy": { 9036 "type": "boolean" 9037 }, 9038 "memberOf": { 9039 "type": "array", 9040 "items": { 9041 "type": "string" 9042 } 9043 }, 9044 "policy": { 9045 "type": "array", 9046 "items": { 9047 "type": "string" 9048 } 9049 }, 9050 "status": { 9051 "type": "string" 9052 } 9053 } 9054 }, 9055 "userSAs": { 9056 "type": "object", 9057 "properties": { 9058 "path": { 9059 "type": "string" 9060 }, 9061 "recursive": { 9062 "type": "boolean" 9063 }, 9064 "versionID": { 9065 "type": "string" 9066 } 9067 } 9068 }, 9069 "userServiceAccountItem": { 9070 "type": "object", 9071 "properties": { 9072 "numSAs": { 9073 "type": "integer", 9074 "format": "int64" 9075 }, 9076 "userName": { 9077 "type": "string" 9078 } 9079 } 9080 }, 9081 "userServiceAccountSummary": { 9082 "type": "object", 9083 "properties": { 9084 "hasSA": { 9085 "type": "boolean" 9086 }, 9087 "userServiceAccountList": { 9088 "type": "array", 9089 "title": "list of users with number of service accounts", 9090 "items": { 9091 "$ref": "#/definitions/userServiceAccountItem" 9092 } 9093 } 9094 } 9095 }, 9096 "widget": { 9097 "type": "object", 9098 "properties": { 9099 "id": { 9100 "type": "integer", 9101 "format": "int32" 9102 }, 9103 "options": { 9104 "type": "object", 9105 "properties": { 9106 "reduceOptions": { 9107 "type": "object", 9108 "properties": { 9109 "calcs": { 9110 "type": "array", 9111 "items": { 9112 "type": "string" 9113 } 9114 } 9115 } 9116 } 9117 } 9118 }, 9119 "targets": { 9120 "type": "array", 9121 "items": { 9122 "$ref": "#/definitions/resultTarget" 9123 } 9124 }, 9125 "title": { 9126 "type": "string" 9127 }, 9128 "type": { 9129 "type": "string" 9130 } 9131 } 9132 }, 9133 "widgetDetails": { 9134 "type": "object", 9135 "properties": { 9136 "id": { 9137 "type": "integer", 9138 "format": "int32" 9139 }, 9140 "options": { 9141 "type": "object", 9142 "properties": { 9143 "reduceOptions": { 9144 "type": "object", 9145 "properties": { 9146 "calcs": { 9147 "type": "array", 9148 "items": { 9149 "type": "string" 9150 } 9151 } 9152 } 9153 } 9154 } 9155 }, 9156 "targets": { 9157 "type": "array", 9158 "items": { 9159 "$ref": "#/definitions/resultTarget" 9160 } 9161 }, 9162 "title": { 9163 "type": "string" 9164 }, 9165 "type": { 9166 "type": "string" 9167 } 9168 } 9169 }, 9170 "widgetResult": { 9171 "type": "object", 9172 "properties": { 9173 "metric": { 9174 "type": "object", 9175 "additionalProperties": { 9176 "type": "string" 9177 } 9178 }, 9179 "values": { 9180 "type": "array", 9181 "items": {} 9182 } 9183 } 9184 } 9185 }, 9186 "parameters": { 9187 "limit": { 9188 "type": "number", 9189 "format": "int32", 9190 "default": 20, 9191 "name": "limit", 9192 "in": "query" 9193 }, 9194 "offset": { 9195 "type": "number", 9196 "format": "int32", 9197 "default": 0, 9198 "name": "offset", 9199 "in": "query" 9200 } 9201 }, 9202 "securityDefinitions": { 9203 "anonymous": { 9204 "type": "apiKey", 9205 "name": "X-Anonymous", 9206 "in": "header" 9207 }, 9208 "key": { 9209 "type": "oauth2", 9210 "flow": "accessCode", 9211 "authorizationUrl": "http://min.io", 9212 "tokenUrl": "http://min.io" 9213 } 9214 }, 9215 "security": [ 9216 { 9217 "key": [] 9218 } 9219 ] 9220 }`)) 9221 FlatSwaggerJSON = json.RawMessage([]byte(`{ 9222 "consumes": [ 9223 "application/json" 9224 ], 9225 "produces": [ 9226 "application/json" 9227 ], 9228 "schemes": [ 9229 "http", 9230 "ws" 9231 ], 9232 "swagger": "2.0", 9233 "info": { 9234 "title": "MinIO Console Server", 9235 "version": "0.1.0" 9236 }, 9237 "basePath": "/api/v1", 9238 "paths": { 9239 "/account/change-password": { 9240 "post": { 9241 "tags": [ 9242 "Account" 9243 ], 9244 "summary": "Change password of currently logged in user.", 9245 "operationId": "AccountChangePassword", 9246 "parameters": [ 9247 { 9248 "name": "body", 9249 "in": "body", 9250 "required": true, 9251 "schema": { 9252 "$ref": "#/definitions/accountChangePasswordRequest" 9253 } 9254 } 9255 ], 9256 "responses": { 9257 "204": { 9258 "description": "A successful login." 9259 }, 9260 "default": { 9261 "description": "Generic error response.", 9262 "schema": { 9263 "$ref": "#/definitions/ApiError" 9264 } 9265 } 9266 } 9267 } 9268 }, 9269 "/account/change-user-password": { 9270 "post": { 9271 "tags": [ 9272 "Account" 9273 ], 9274 "summary": "Change password of currently logged in user.", 9275 "operationId": "ChangeUserPassword", 9276 "parameters": [ 9277 { 9278 "name": "body", 9279 "in": "body", 9280 "required": true, 9281 "schema": { 9282 "$ref": "#/definitions/changeUserPasswordRequest" 9283 } 9284 } 9285 ], 9286 "responses": { 9287 "201": { 9288 "description": "Password successfully changed." 9289 }, 9290 "default": { 9291 "description": "Generic error response.", 9292 "schema": { 9293 "$ref": "#/definitions/ApiError" 9294 } 9295 } 9296 } 9297 } 9298 }, 9299 "/admin/arns": { 9300 "get": { 9301 "tags": [ 9302 "System" 9303 ], 9304 "summary": "Returns a list of active ARNs in the instance", 9305 "operationId": "ArnList", 9306 "responses": { 9307 "200": { 9308 "description": "A successful response.", 9309 "schema": { 9310 "$ref": "#/definitions/arnsResponse" 9311 } 9312 }, 9313 "default": { 9314 "description": "Generic error response.", 9315 "schema": { 9316 "$ref": "#/definitions/ApiError" 9317 } 9318 } 9319 } 9320 } 9321 }, 9322 "/admin/info": { 9323 "get": { 9324 "tags": [ 9325 "System" 9326 ], 9327 "summary": "Returns information about the deployment", 9328 "operationId": "AdminInfo", 9329 "parameters": [ 9330 { 9331 "type": "boolean", 9332 "default": false, 9333 "name": "defaultOnly", 9334 "in": "query" 9335 } 9336 ], 9337 "responses": { 9338 "200": { 9339 "description": "A successful response.", 9340 "schema": { 9341 "$ref": "#/definitions/adminInfoResponse" 9342 } 9343 }, 9344 "default": { 9345 "description": "Generic error response.", 9346 "schema": { 9347 "$ref": "#/definitions/ApiError" 9348 } 9349 } 9350 } 9351 } 9352 }, 9353 "/admin/info/widgets/{widgetId}": { 9354 "get": { 9355 "tags": [ 9356 "System" 9357 ], 9358 "summary": "Returns information about the deployment", 9359 "operationId": "DashboardWidgetDetails", 9360 "parameters": [ 9361 { 9362 "type": "integer", 9363 "format": "int32", 9364 "name": "widgetId", 9365 "in": "path", 9366 "required": true 9367 }, 9368 { 9369 "type": "integer", 9370 "name": "start", 9371 "in": "query" 9372 }, 9373 { 9374 "type": "integer", 9375 "name": "end", 9376 "in": "query" 9377 }, 9378 { 9379 "type": "integer", 9380 "format": "int32", 9381 "name": "step", 9382 "in": "query" 9383 } 9384 ], 9385 "responses": { 9386 "200": { 9387 "description": "A successful response.", 9388 "schema": { 9389 "$ref": "#/definitions/widgetDetails" 9390 } 9391 }, 9392 "default": { 9393 "description": "Generic error response.", 9394 "schema": { 9395 "$ref": "#/definitions/ApiError" 9396 } 9397 } 9398 } 9399 } 9400 }, 9401 "/admin/inspect": { 9402 "get": { 9403 "produces": [ 9404 "application/octet-stream" 9405 ], 9406 "tags": [ 9407 "Inspect" 9408 ], 9409 "summary": "Inspect Files on Drive", 9410 "operationId": "Inspect", 9411 "parameters": [ 9412 { 9413 "type": "string", 9414 "name": "file", 9415 "in": "query", 9416 "required": true 9417 }, 9418 { 9419 "type": "string", 9420 "name": "volume", 9421 "in": "query", 9422 "required": true 9423 }, 9424 { 9425 "type": "boolean", 9426 "name": "encrypt", 9427 "in": "query" 9428 } 9429 ], 9430 "responses": { 9431 "200": { 9432 "description": "A successful response.", 9433 "schema": { 9434 "type": "file" 9435 } 9436 }, 9437 "default": { 9438 "description": "Generic error response.", 9439 "schema": { 9440 "$ref": "#/definitions/ApiError" 9441 } 9442 } 9443 } 9444 } 9445 }, 9446 "/admin/notification_endpoints": { 9447 "get": { 9448 "tags": [ 9449 "Configuration" 9450 ], 9451 "summary": "Returns a list of active notification endpoints", 9452 "operationId": "NotificationEndpointList", 9453 "responses": { 9454 "200": { 9455 "description": "A successful response.", 9456 "schema": { 9457 "$ref": "#/definitions/notifEndpointResponse" 9458 } 9459 }, 9460 "default": { 9461 "description": "Generic error response.", 9462 "schema": { 9463 "$ref": "#/definitions/ApiError" 9464 } 9465 } 9466 } 9467 }, 9468 "post": { 9469 "tags": [ 9470 "Configuration" 9471 ], 9472 "summary": "Allows to configure a new notification endpoint", 9473 "operationId": "AddNotificationEndpoint", 9474 "parameters": [ 9475 { 9476 "name": "body", 9477 "in": "body", 9478 "required": true, 9479 "schema": { 9480 "$ref": "#/definitions/notificationEndpoint" 9481 } 9482 } 9483 ], 9484 "responses": { 9485 "201": { 9486 "description": "A successful response.", 9487 "schema": { 9488 "$ref": "#/definitions/setNotificationEndpointResponse" 9489 } 9490 }, 9491 "default": { 9492 "description": "Generic error response.", 9493 "schema": { 9494 "$ref": "#/definitions/ApiError" 9495 } 9496 } 9497 } 9498 } 9499 }, 9500 "/admin/site-replication": { 9501 "get": { 9502 "tags": [ 9503 "SiteReplication" 9504 ], 9505 "summary": "Get list of Replication Sites", 9506 "operationId": "GetSiteReplicationInfo", 9507 "responses": { 9508 "200": { 9509 "description": "A successful response.", 9510 "schema": { 9511 "$ref": "#/definitions/siteReplicationInfoResponse" 9512 } 9513 }, 9514 "default": { 9515 "description": "Generic error response.", 9516 "schema": { 9517 "$ref": "#/definitions/ApiError" 9518 } 9519 } 9520 } 9521 }, 9522 "put": { 9523 "tags": [ 9524 "SiteReplication" 9525 ], 9526 "summary": "Edit a Replication Site", 9527 "operationId": "SiteReplicationEdit", 9528 "parameters": [ 9529 { 9530 "name": "body", 9531 "in": "body", 9532 "required": true, 9533 "schema": { 9534 "$ref": "#/definitions/peerInfo" 9535 } 9536 } 9537 ], 9538 "responses": { 9539 "200": { 9540 "description": "A successful response.", 9541 "schema": { 9542 "$ref": "#/definitions/peerSiteEditResponse" 9543 } 9544 }, 9545 "default": { 9546 "description": "Generic error response.", 9547 "schema": { 9548 "$ref": "#/definitions/ApiError" 9549 } 9550 } 9551 } 9552 }, 9553 "post": { 9554 "tags": [ 9555 "SiteReplication" 9556 ], 9557 "summary": "Add a Replication Site", 9558 "operationId": "SiteReplicationInfoAdd", 9559 "parameters": [ 9560 { 9561 "name": "body", 9562 "in": "body", 9563 "required": true, 9564 "schema": { 9565 "$ref": "#/definitions/siteReplicationAddRequest" 9566 } 9567 } 9568 ], 9569 "responses": { 9570 "200": { 9571 "description": "A successful response.", 9572 "schema": { 9573 "$ref": "#/definitions/siteReplicationAddResponse" 9574 } 9575 }, 9576 "default": { 9577 "description": "Generic error response.", 9578 "schema": { 9579 "$ref": "#/definitions/ApiError" 9580 } 9581 } 9582 } 9583 }, 9584 "delete": { 9585 "tags": [ 9586 "SiteReplication" 9587 ], 9588 "summary": "Remove a Replication Site", 9589 "operationId": "SiteReplicationRemove", 9590 "parameters": [ 9591 { 9592 "name": "body", 9593 "in": "body", 9594 "required": true, 9595 "schema": { 9596 "$ref": "#/definitions/peerInfoRemove" 9597 } 9598 } 9599 ], 9600 "responses": { 9601 "204": { 9602 "description": "A successful response.", 9603 "schema": { 9604 "$ref": "#/definitions/peerSiteRemoveResponse" 9605 } 9606 }, 9607 "default": { 9608 "description": "Generic error response.", 9609 "schema": { 9610 "$ref": "#/definitions/ApiError" 9611 } 9612 } 9613 } 9614 } 9615 }, 9616 "/admin/site-replication/status": { 9617 "get": { 9618 "tags": [ 9619 "SiteReplication" 9620 ], 9621 "summary": "Display overall site replication status", 9622 "operationId": "GetSiteReplicationStatus", 9623 "parameters": [ 9624 { 9625 "type": "boolean", 9626 "default": true, 9627 "description": "Include Bucket stats", 9628 "name": "buckets", 9629 "in": "query" 9630 }, 9631 { 9632 "type": "boolean", 9633 "default": true, 9634 "description": "Include Group stats", 9635 "name": "groups", 9636 "in": "query" 9637 }, 9638 { 9639 "type": "boolean", 9640 "default": true, 9641 "description": "Include Policies stats", 9642 "name": "policies", 9643 "in": "query" 9644 }, 9645 { 9646 "type": "boolean", 9647 "default": true, 9648 "description": "Include Policies stats", 9649 "name": "users", 9650 "in": "query" 9651 }, 9652 { 9653 "type": "string", 9654 "description": "Entity Type to lookup", 9655 "name": "entityType", 9656 "in": "query" 9657 }, 9658 { 9659 "type": "string", 9660 "description": "Entity Value to lookup", 9661 "name": "entityValue", 9662 "in": "query" 9663 } 9664 ], 9665 "responses": { 9666 "200": { 9667 "description": "A successful response.", 9668 "schema": { 9669 "$ref": "#/definitions/siteReplicationStatusResponse" 9670 } 9671 }, 9672 "default": { 9673 "description": "Generic error response.", 9674 "schema": { 9675 "$ref": "#/definitions/ApiError" 9676 } 9677 } 9678 } 9679 } 9680 }, 9681 "/admin/tiers": { 9682 "get": { 9683 "tags": [ 9684 "Tiering" 9685 ], 9686 "summary": "Returns a list of tiers for ilm", 9687 "operationId": "TiersList", 9688 "responses": { 9689 "200": { 9690 "description": "A successful response.", 9691 "schema": { 9692 "$ref": "#/definitions/tierListResponse" 9693 } 9694 }, 9695 "default": { 9696 "description": "Generic error response.", 9697 "schema": { 9698 "$ref": "#/definitions/ApiError" 9699 } 9700 } 9701 } 9702 }, 9703 "post": { 9704 "tags": [ 9705 "Tiering" 9706 ], 9707 "summary": "Allows to configure a new tier", 9708 "operationId": "AddTier", 9709 "parameters": [ 9710 { 9711 "name": "body", 9712 "in": "body", 9713 "required": true, 9714 "schema": { 9715 "$ref": "#/definitions/tier" 9716 } 9717 } 9718 ], 9719 "responses": { 9720 "201": { 9721 "description": "A successful response." 9722 }, 9723 "default": { 9724 "description": "Generic error response.", 9725 "schema": { 9726 "$ref": "#/definitions/ApiError" 9727 } 9728 } 9729 } 9730 } 9731 }, 9732 "/admin/tiers/{type}/{name}": { 9733 "get": { 9734 "tags": [ 9735 "Tiering" 9736 ], 9737 "summary": "Get Tier", 9738 "operationId": "GetTier", 9739 "parameters": [ 9740 { 9741 "enum": [ 9742 "s3", 9743 "gcs", 9744 "azure", 9745 "minio" 9746 ], 9747 "type": "string", 9748 "name": "type", 9749 "in": "path", 9750 "required": true 9751 }, 9752 { 9753 "type": "string", 9754 "name": "name", 9755 "in": "path", 9756 "required": true 9757 } 9758 ], 9759 "responses": { 9760 "200": { 9761 "description": "A successful response.", 9762 "schema": { 9763 "$ref": "#/definitions/tier" 9764 } 9765 }, 9766 "default": { 9767 "description": "Generic error response.", 9768 "schema": { 9769 "$ref": "#/definitions/ApiError" 9770 } 9771 } 9772 } 9773 } 9774 }, 9775 "/admin/tiers/{type}/{name}/credentials": { 9776 "put": { 9777 "tags": [ 9778 "Tiering" 9779 ], 9780 "summary": "Edit Tier Credentials", 9781 "operationId": "EditTierCredentials", 9782 "parameters": [ 9783 { 9784 "enum": [ 9785 "s3", 9786 "gcs", 9787 "azure", 9788 "minio" 9789 ], 9790 "type": "string", 9791 "name": "type", 9792 "in": "path", 9793 "required": true 9794 }, 9795 { 9796 "type": "string", 9797 "name": "name", 9798 "in": "path", 9799 "required": true 9800 }, 9801 { 9802 "name": "body", 9803 "in": "body", 9804 "required": true, 9805 "schema": { 9806 "$ref": "#/definitions/tierCredentialsRequest" 9807 } 9808 } 9809 ], 9810 "responses": { 9811 "200": { 9812 "description": "A successful response." 9813 }, 9814 "default": { 9815 "description": "Generic error response.", 9816 "schema": { 9817 "$ref": "#/definitions/ApiError" 9818 } 9819 } 9820 } 9821 } 9822 }, 9823 "/bucket-policy/{bucket}": { 9824 "get": { 9825 "tags": [ 9826 "Bucket" 9827 ], 9828 "summary": "List Policies With Given Bucket", 9829 "operationId": "ListPoliciesWithBucket", 9830 "parameters": [ 9831 { 9832 "type": "string", 9833 "name": "bucket", 9834 "in": "path", 9835 "required": true 9836 }, 9837 { 9838 "type": "number", 9839 "format": "int32", 9840 "default": 0, 9841 "name": "offset", 9842 "in": "query" 9843 }, 9844 { 9845 "type": "number", 9846 "format": "int32", 9847 "default": 20, 9848 "name": "limit", 9849 "in": "query" 9850 } 9851 ], 9852 "responses": { 9853 "200": { 9854 "description": "A successful response.", 9855 "schema": { 9856 "$ref": "#/definitions/listPoliciesResponse" 9857 } 9858 }, 9859 "default": { 9860 "description": "Generic error response.", 9861 "schema": { 9862 "$ref": "#/definitions/ApiError" 9863 } 9864 } 9865 } 9866 } 9867 }, 9868 "/bucket-users/{bucket}": { 9869 "get": { 9870 "tags": [ 9871 "Bucket" 9872 ], 9873 "summary": "List Users With Access to a Given Bucket", 9874 "operationId": "ListUsersWithAccessToBucket", 9875 "parameters": [ 9876 { 9877 "type": "string", 9878 "name": "bucket", 9879 "in": "path", 9880 "required": true 9881 }, 9882 { 9883 "type": "number", 9884 "format": "int32", 9885 "default": 0, 9886 "name": "offset", 9887 "in": "query" 9888 }, 9889 { 9890 "type": "number", 9891 "format": "int32", 9892 "default": 20, 9893 "name": "limit", 9894 "in": "query" 9895 } 9896 ], 9897 "responses": { 9898 "200": { 9899 "description": "A successful response.", 9900 "schema": { 9901 "type": "array", 9902 "items": { 9903 "type": "string" 9904 } 9905 } 9906 }, 9907 "default": { 9908 "description": "Generic error response.", 9909 "schema": { 9910 "$ref": "#/definitions/ApiError" 9911 } 9912 } 9913 } 9914 } 9915 }, 9916 "/bucket/{bucket}/access-rules": { 9917 "get": { 9918 "tags": [ 9919 "Bucket" 9920 ], 9921 "summary": "List Access Rules With Given Bucket", 9922 "operationId": "ListAccessRulesWithBucket", 9923 "parameters": [ 9924 { 9925 "type": "string", 9926 "name": "bucket", 9927 "in": "path", 9928 "required": true 9929 }, 9930 { 9931 "type": "number", 9932 "format": "int32", 9933 "default": 0, 9934 "name": "offset", 9935 "in": "query" 9936 }, 9937 { 9938 "type": "number", 9939 "format": "int32", 9940 "default": 20, 9941 "name": "limit", 9942 "in": "query" 9943 } 9944 ], 9945 "responses": { 9946 "200": { 9947 "description": "A successful response.", 9948 "schema": { 9949 "$ref": "#/definitions/listAccessRulesResponse" 9950 } 9951 }, 9952 "default": { 9953 "description": "Generic error response.", 9954 "schema": { 9955 "$ref": "#/definitions/ApiError" 9956 } 9957 } 9958 } 9959 }, 9960 "put": { 9961 "tags": [ 9962 "Bucket" 9963 ], 9964 "summary": "Add Access Rule To Given Bucket", 9965 "operationId": "SetAccessRuleWithBucket", 9966 "parameters": [ 9967 { 9968 "type": "string", 9969 "name": "bucket", 9970 "in": "path", 9971 "required": true 9972 }, 9973 { 9974 "name": "prefixaccess", 9975 "in": "body", 9976 "required": true, 9977 "schema": { 9978 "$ref": "#/definitions/prefixAccessPair" 9979 } 9980 } 9981 ], 9982 "responses": { 9983 "200": { 9984 "description": "A successful response.", 9985 "schema": { 9986 "type": "boolean" 9987 } 9988 }, 9989 "default": { 9990 "description": "Generic error response.", 9991 "schema": { 9992 "$ref": "#/definitions/ApiError" 9993 } 9994 } 9995 } 9996 }, 9997 "delete": { 9998 "tags": [ 9999 "Bucket" 10000 ], 10001 "summary": "Delete Access Rule From Given Bucket", 10002 "operationId": "DeleteAccessRuleWithBucket", 10003 "parameters": [ 10004 { 10005 "type": "string", 10006 "name": "bucket", 10007 "in": "path", 10008 "required": true 10009 }, 10010 { 10011 "name": "prefix", 10012 "in": "body", 10013 "required": true, 10014 "schema": { 10015 "$ref": "#/definitions/prefixWrapper" 10016 } 10017 } 10018 ], 10019 "responses": { 10020 "200": { 10021 "description": "A successful response.", 10022 "schema": { 10023 "type": "boolean" 10024 } 10025 }, 10026 "default": { 10027 "description": "Generic error response.", 10028 "schema": { 10029 "$ref": "#/definitions/ApiError" 10030 } 10031 } 10032 } 10033 } 10034 }, 10035 "/buckets": { 10036 "get": { 10037 "tags": [ 10038 "Bucket" 10039 ], 10040 "summary": "List Buckets", 10041 "operationId": "ListBuckets", 10042 "responses": { 10043 "200": { 10044 "description": "A successful response.", 10045 "schema": { 10046 "$ref": "#/definitions/listBucketsResponse" 10047 } 10048 }, 10049 "default": { 10050 "description": "Generic error response.", 10051 "schema": { 10052 "$ref": "#/definitions/ApiError" 10053 } 10054 } 10055 } 10056 }, 10057 "post": { 10058 "tags": [ 10059 "Bucket" 10060 ], 10061 "summary": "Make bucket", 10062 "operationId": "MakeBucket", 10063 "parameters": [ 10064 { 10065 "name": "body", 10066 "in": "body", 10067 "required": true, 10068 "schema": { 10069 "$ref": "#/definitions/makeBucketRequest" 10070 } 10071 } 10072 ], 10073 "responses": { 10074 "200": { 10075 "description": "A successful response.", 10076 "schema": { 10077 "$ref": "#/definitions/makeBucketsResponse" 10078 } 10079 }, 10080 "default": { 10081 "description": "Generic error response.", 10082 "schema": { 10083 "$ref": "#/definitions/ApiError" 10084 } 10085 } 10086 } 10087 } 10088 }, 10089 "/buckets-replication": { 10090 "post": { 10091 "tags": [ 10092 "Bucket" 10093 ], 10094 "summary": "Sets Multi Bucket Replication in multiple Buckets", 10095 "operationId": "SetMultiBucketReplication", 10096 "parameters": [ 10097 { 10098 "name": "body", 10099 "in": "body", 10100 "required": true, 10101 "schema": { 10102 "$ref": "#/definitions/multiBucketReplication" 10103 } 10104 } 10105 ], 10106 "responses": { 10107 "200": { 10108 "description": "A successful response.", 10109 "schema": { 10110 "$ref": "#/definitions/multiBucketResponseState" 10111 } 10112 }, 10113 "default": { 10114 "description": "Generic error response.", 10115 "schema": { 10116 "$ref": "#/definitions/ApiError" 10117 } 10118 } 10119 } 10120 } 10121 }, 10122 "/buckets/max-share-exp": { 10123 "get": { 10124 "tags": [ 10125 "Bucket" 10126 ], 10127 "summary": "Get max expiration time for share link in seconds", 10128 "operationId": "GetMaxShareLinkExp", 10129 "responses": { 10130 "200": { 10131 "description": "A successful response.", 10132 "schema": { 10133 "$ref": "#/definitions/maxShareLinkExpResponse" 10134 } 10135 }, 10136 "default": { 10137 "description": "Generic error response.", 10138 "schema": { 10139 "$ref": "#/definitions/ApiError" 10140 } 10141 } 10142 } 10143 } 10144 }, 10145 "/buckets/multi-lifecycle": { 10146 "post": { 10147 "tags": [ 10148 "Bucket" 10149 ], 10150 "summary": "Add Multi Bucket Lifecycle", 10151 "operationId": "AddMultiBucketLifecycle", 10152 "parameters": [ 10153 { 10154 "name": "body", 10155 "in": "body", 10156 "required": true, 10157 "schema": { 10158 "$ref": "#/definitions/addMultiBucketLifecycle" 10159 } 10160 } 10161 ], 10162 "responses": { 10163 "200": { 10164 "description": "A successful response.", 10165 "schema": { 10166 "$ref": "#/definitions/multiLifecycleResult" 10167 } 10168 }, 10169 "default": { 10170 "description": "Generic error response.", 10171 "schema": { 10172 "$ref": "#/definitions/ApiError" 10173 } 10174 } 10175 } 10176 } 10177 }, 10178 "/buckets/{bucket_name}/delete-all-replication-rules": { 10179 "delete": { 10180 "tags": [ 10181 "Bucket" 10182 ], 10183 "summary": "Deletes all replication rules from a bucket", 10184 "operationId": "DeleteAllReplicationRules", 10185 "parameters": [ 10186 { 10187 "type": "string", 10188 "name": "bucket_name", 10189 "in": "path", 10190 "required": true 10191 } 10192 ], 10193 "responses": { 10194 "204": { 10195 "description": "A successful response." 10196 }, 10197 "default": { 10198 "description": "Generic error response.", 10199 "schema": { 10200 "$ref": "#/definitions/ApiError" 10201 } 10202 } 10203 } 10204 } 10205 }, 10206 "/buckets/{bucket_name}/delete-objects": { 10207 "post": { 10208 "tags": [ 10209 "Object" 10210 ], 10211 "summary": "Delete Multiple Objects", 10212 "operationId": "DeleteMultipleObjects", 10213 "parameters": [ 10214 { 10215 "type": "string", 10216 "name": "bucket_name", 10217 "in": "path", 10218 "required": true 10219 }, 10220 { 10221 "type": "boolean", 10222 "name": "all_versions", 10223 "in": "query" 10224 }, 10225 { 10226 "type": "boolean", 10227 "name": "bypass", 10228 "in": "query" 10229 }, 10230 { 10231 "name": "files", 10232 "in": "body", 10233 "required": true, 10234 "schema": { 10235 "type": "array", 10236 "items": { 10237 "$ref": "#/definitions/deleteFile" 10238 } 10239 } 10240 } 10241 ], 10242 "responses": { 10243 "200": { 10244 "description": "A successful response." 10245 }, 10246 "default": { 10247 "description": "Generic error response.", 10248 "schema": { 10249 "$ref": "#/definitions/ApiError" 10250 } 10251 } 10252 } 10253 } 10254 }, 10255 "/buckets/{bucket_name}/delete-selected-replication-rules": { 10256 "delete": { 10257 "tags": [ 10258 "Bucket" 10259 ], 10260 "summary": "Deletes selected replication rules from a bucket", 10261 "operationId": "DeleteSelectedReplicationRules", 10262 "parameters": [ 10263 { 10264 "type": "string", 10265 "name": "bucket_name", 10266 "in": "path", 10267 "required": true 10268 }, 10269 { 10270 "name": "rules", 10271 "in": "body", 10272 "required": true, 10273 "schema": { 10274 "$ref": "#/definitions/bucketReplicationRuleList" 10275 } 10276 } 10277 ], 10278 "responses": { 10279 "204": { 10280 "description": "A successful response." 10281 }, 10282 "default": { 10283 "description": "Generic error response.", 10284 "schema": { 10285 "$ref": "#/definitions/ApiError" 10286 } 10287 } 10288 } 10289 } 10290 }, 10291 "/buckets/{bucket_name}/encryption/disable": { 10292 "post": { 10293 "tags": [ 10294 "Bucket" 10295 ], 10296 "summary": "Disable bucket encryption.", 10297 "operationId": "DisableBucketEncryption", 10298 "parameters": [ 10299 { 10300 "type": "string", 10301 "name": "bucket_name", 10302 "in": "path", 10303 "required": true 10304 } 10305 ], 10306 "responses": { 10307 "200": { 10308 "description": "A successful response." 10309 }, 10310 "default": { 10311 "description": "Generic error response.", 10312 "schema": { 10313 "$ref": "#/definitions/ApiError" 10314 } 10315 } 10316 } 10317 } 10318 }, 10319 "/buckets/{bucket_name}/encryption/enable": { 10320 "post": { 10321 "tags": [ 10322 "Bucket" 10323 ], 10324 "summary": "Enable bucket encryption.", 10325 "operationId": "EnableBucketEncryption", 10326 "parameters": [ 10327 { 10328 "type": "string", 10329 "name": "bucket_name", 10330 "in": "path", 10331 "required": true 10332 }, 10333 { 10334 "name": "body", 10335 "in": "body", 10336 "required": true, 10337 "schema": { 10338 "$ref": "#/definitions/bucketEncryptionRequest" 10339 } 10340 } 10341 ], 10342 "responses": { 10343 "200": { 10344 "description": "A successful response." 10345 }, 10346 "default": { 10347 "description": "Generic error response.", 10348 "schema": { 10349 "$ref": "#/definitions/ApiError" 10350 } 10351 } 10352 } 10353 } 10354 }, 10355 "/buckets/{bucket_name}/encryption/info": { 10356 "get": { 10357 "tags": [ 10358 "Bucket" 10359 ], 10360 "summary": "Get bucket encryption information.", 10361 "operationId": "GetBucketEncryptionInfo", 10362 "parameters": [ 10363 { 10364 "type": "string", 10365 "name": "bucket_name", 10366 "in": "path", 10367 "required": true 10368 } 10369 ], 10370 "responses": { 10371 "200": { 10372 "description": "A successful response.", 10373 "schema": { 10374 "$ref": "#/definitions/bucketEncryptionInfo" 10375 } 10376 }, 10377 "default": { 10378 "description": "Generic error response.", 10379 "schema": { 10380 "$ref": "#/definitions/ApiError" 10381 } 10382 } 10383 } 10384 } 10385 }, 10386 "/buckets/{bucket_name}/events": { 10387 "get": { 10388 "tags": [ 10389 "Bucket" 10390 ], 10391 "summary": "List Bucket Events", 10392 "operationId": "ListBucketEvents", 10393 "parameters": [ 10394 { 10395 "type": "string", 10396 "name": "bucket_name", 10397 "in": "path", 10398 "required": true 10399 }, 10400 { 10401 "type": "number", 10402 "format": "int32", 10403 "default": 0, 10404 "name": "offset", 10405 "in": "query" 10406 }, 10407 { 10408 "type": "number", 10409 "format": "int32", 10410 "default": 20, 10411 "name": "limit", 10412 "in": "query" 10413 } 10414 ], 10415 "responses": { 10416 "200": { 10417 "description": "A successful response.", 10418 "schema": { 10419 "$ref": "#/definitions/listBucketEventsResponse" 10420 } 10421 }, 10422 "default": { 10423 "description": "Generic error response.", 10424 "schema": { 10425 "$ref": "#/definitions/ApiError" 10426 } 10427 } 10428 } 10429 }, 10430 "post": { 10431 "tags": [ 10432 "Bucket" 10433 ], 10434 "summary": "Create Bucket Event", 10435 "operationId": "CreateBucketEvent", 10436 "parameters": [ 10437 { 10438 "type": "string", 10439 "name": "bucket_name", 10440 "in": "path", 10441 "required": true 10442 }, 10443 { 10444 "name": "body", 10445 "in": "body", 10446 "required": true, 10447 "schema": { 10448 "$ref": "#/definitions/bucketEventRequest" 10449 } 10450 } 10451 ], 10452 "responses": { 10453 "201": { 10454 "description": "A successful response." 10455 }, 10456 "default": { 10457 "description": "Generic error response.", 10458 "schema": { 10459 "$ref": "#/definitions/ApiError" 10460 } 10461 } 10462 } 10463 } 10464 }, 10465 "/buckets/{bucket_name}/events/{arn}": { 10466 "delete": { 10467 "tags": [ 10468 "Bucket" 10469 ], 10470 "summary": "Delete Bucket Event", 10471 "operationId": "DeleteBucketEvent", 10472 "parameters": [ 10473 { 10474 "type": "string", 10475 "name": "bucket_name", 10476 "in": "path", 10477 "required": true 10478 }, 10479 { 10480 "type": "string", 10481 "name": "arn", 10482 "in": "path", 10483 "required": true 10484 }, 10485 { 10486 "name": "body", 10487 "in": "body", 10488 "required": true, 10489 "schema": { 10490 "$ref": "#/definitions/notificationDeleteRequest" 10491 } 10492 } 10493 ], 10494 "responses": { 10495 "204": { 10496 "description": "A successful response." 10497 }, 10498 "default": { 10499 "description": "Generic error response.", 10500 "schema": { 10501 "$ref": "#/definitions/ApiError" 10502 } 10503 } 10504 } 10505 } 10506 }, 10507 "/buckets/{bucket_name}/lifecycle": { 10508 "get": { 10509 "tags": [ 10510 "Bucket" 10511 ], 10512 "summary": "Bucket Lifecycle", 10513 "operationId": "GetBucketLifecycle", 10514 "parameters": [ 10515 { 10516 "type": "string", 10517 "name": "bucket_name", 10518 "in": "path", 10519 "required": true 10520 } 10521 ], 10522 "responses": { 10523 "200": { 10524 "description": "A successful response.", 10525 "schema": { 10526 "$ref": "#/definitions/bucketLifecycleResponse" 10527 } 10528 }, 10529 "default": { 10530 "description": "Generic error response.", 10531 "schema": { 10532 "$ref": "#/definitions/ApiError" 10533 } 10534 } 10535 } 10536 }, 10537 "post": { 10538 "tags": [ 10539 "Bucket" 10540 ], 10541 "summary": "Add Bucket Lifecycle", 10542 "operationId": "AddBucketLifecycle", 10543 "parameters": [ 10544 { 10545 "type": "string", 10546 "name": "bucket_name", 10547 "in": "path", 10548 "required": true 10549 }, 10550 { 10551 "name": "body", 10552 "in": "body", 10553 "required": true, 10554 "schema": { 10555 "$ref": "#/definitions/addBucketLifecycle" 10556 } 10557 } 10558 ], 10559 "responses": { 10560 "201": { 10561 "description": "A successful response." 10562 }, 10563 "default": { 10564 "description": "Generic error response.", 10565 "schema": { 10566 "$ref": "#/definitions/ApiError" 10567 } 10568 } 10569 } 10570 } 10571 }, 10572 "/buckets/{bucket_name}/lifecycle/{lifecycle_id}": { 10573 "put": { 10574 "tags": [ 10575 "Bucket" 10576 ], 10577 "summary": "Update Lifecycle rule", 10578 "operationId": "UpdateBucketLifecycle", 10579 "parameters": [ 10580 { 10581 "type": "string", 10582 "name": "bucket_name", 10583 "in": "path", 10584 "required": true 10585 }, 10586 { 10587 "type": "string", 10588 "name": "lifecycle_id", 10589 "in": "path", 10590 "required": true 10591 }, 10592 { 10593 "name": "body", 10594 "in": "body", 10595 "required": true, 10596 "schema": { 10597 "$ref": "#/definitions/updateBucketLifecycle" 10598 } 10599 } 10600 ], 10601 "responses": { 10602 "200": { 10603 "description": "A successful response." 10604 }, 10605 "default": { 10606 "description": "Generic error response.", 10607 "schema": { 10608 "$ref": "#/definitions/ApiError" 10609 } 10610 } 10611 } 10612 }, 10613 "delete": { 10614 "tags": [ 10615 "Bucket" 10616 ], 10617 "summary": "Delete Lifecycle rule", 10618 "operationId": "DeleteBucketLifecycleRule", 10619 "parameters": [ 10620 { 10621 "type": "string", 10622 "name": "bucket_name", 10623 "in": "path", 10624 "required": true 10625 }, 10626 { 10627 "type": "string", 10628 "name": "lifecycle_id", 10629 "in": "path", 10630 "required": true 10631 } 10632 ], 10633 "responses": { 10634 "204": { 10635 "description": "A successful response." 10636 }, 10637 "default": { 10638 "description": "Generic error response.", 10639 "schema": { 10640 "$ref": "#/definitions/ApiError" 10641 } 10642 } 10643 } 10644 } 10645 }, 10646 "/buckets/{bucket_name}/object-locking": { 10647 "get": { 10648 "tags": [ 10649 "Bucket" 10650 ], 10651 "summary": "Returns the status of object locking support on the bucket", 10652 "operationId": "GetBucketObjectLockingStatus", 10653 "parameters": [ 10654 { 10655 "type": "string", 10656 "name": "bucket_name", 10657 "in": "path", 10658 "required": true 10659 } 10660 ], 10661 "responses": { 10662 "200": { 10663 "description": "A successful response.", 10664 "schema": { 10665 "$ref": "#/definitions/bucketObLockingResponse" 10666 } 10667 }, 10668 "default": { 10669 "description": "Generic error response.", 10670 "schema": { 10671 "$ref": "#/definitions/ApiError" 10672 } 10673 } 10674 } 10675 } 10676 }, 10677 "/buckets/{bucket_name}/objects": { 10678 "get": { 10679 "security": [ 10680 { 10681 "key": [] 10682 }, 10683 { 10684 "anonymous": [] 10685 } 10686 ], 10687 "tags": [ 10688 "Object" 10689 ], 10690 "summary": "List Objects", 10691 "operationId": "ListObjects", 10692 "parameters": [ 10693 { 10694 "type": "string", 10695 "name": "bucket_name", 10696 "in": "path", 10697 "required": true 10698 }, 10699 { 10700 "type": "string", 10701 "name": "prefix", 10702 "in": "query" 10703 }, 10704 { 10705 "type": "boolean", 10706 "name": "recursive", 10707 "in": "query" 10708 }, 10709 { 10710 "type": "boolean", 10711 "name": "with_versions", 10712 "in": "query" 10713 }, 10714 { 10715 "type": "boolean", 10716 "name": "with_metadata", 10717 "in": "query" 10718 }, 10719 { 10720 "type": "number", 10721 "format": "int32", 10722 "default": 20, 10723 "name": "limit", 10724 "in": "query" 10725 } 10726 ], 10727 "responses": { 10728 "200": { 10729 "description": "A successful response.", 10730 "schema": { 10731 "$ref": "#/definitions/listObjectsResponse" 10732 } 10733 }, 10734 "default": { 10735 "description": "Generic error response.", 10736 "schema": { 10737 "$ref": "#/definitions/ApiError" 10738 } 10739 } 10740 } 10741 }, 10742 "delete": { 10743 "tags": [ 10744 "Object" 10745 ], 10746 "summary": "Delete Object", 10747 "operationId": "DeleteObject", 10748 "parameters": [ 10749 { 10750 "type": "string", 10751 "name": "bucket_name", 10752 "in": "path", 10753 "required": true 10754 }, 10755 { 10756 "type": "string", 10757 "name": "prefix", 10758 "in": "query", 10759 "required": true 10760 }, 10761 { 10762 "type": "string", 10763 "name": "version_id", 10764 "in": "query" 10765 }, 10766 { 10767 "type": "boolean", 10768 "name": "recursive", 10769 "in": "query" 10770 }, 10771 { 10772 "type": "boolean", 10773 "name": "all_versions", 10774 "in": "query" 10775 }, 10776 { 10777 "type": "boolean", 10778 "name": "non_current_versions", 10779 "in": "query" 10780 }, 10781 { 10782 "type": "boolean", 10783 "name": "bypass", 10784 "in": "query" 10785 } 10786 ], 10787 "responses": { 10788 "200": { 10789 "description": "A successful response." 10790 }, 10791 "default": { 10792 "description": "Generic error response.", 10793 "schema": { 10794 "$ref": "#/definitions/ApiError" 10795 } 10796 } 10797 } 10798 } 10799 }, 10800 "/buckets/{bucket_name}/objects/download": { 10801 "get": { 10802 "security": [ 10803 { 10804 "key": [] 10805 }, 10806 { 10807 "anonymous": [] 10808 } 10809 ], 10810 "produces": [ 10811 "application/octet-stream" 10812 ], 10813 "tags": [ 10814 "Object" 10815 ], 10816 "summary": "Download Object", 10817 "operationId": "Download Object", 10818 "parameters": [ 10819 { 10820 "type": "string", 10821 "name": "bucket_name", 10822 "in": "path", 10823 "required": true 10824 }, 10825 { 10826 "type": "string", 10827 "name": "prefix", 10828 "in": "query", 10829 "required": true 10830 }, 10831 { 10832 "type": "string", 10833 "name": "version_id", 10834 "in": "query" 10835 }, 10836 { 10837 "type": "boolean", 10838 "default": false, 10839 "name": "preview", 10840 "in": "query" 10841 }, 10842 { 10843 "type": "string", 10844 "default": "", 10845 "name": "override_file_name", 10846 "in": "query" 10847 } 10848 ], 10849 "responses": { 10850 "200": { 10851 "description": "A successful response.", 10852 "schema": { 10853 "type": "file" 10854 } 10855 }, 10856 "default": { 10857 "description": "Generic error response.", 10858 "schema": { 10859 "$ref": "#/definitions/ApiError" 10860 } 10861 } 10862 } 10863 } 10864 }, 10865 "/buckets/{bucket_name}/objects/download-multiple": { 10866 "post": { 10867 "security": [ 10868 { 10869 "key": [] 10870 }, 10871 { 10872 "anonymous": [] 10873 } 10874 ], 10875 "produces": [ 10876 "application/octet-stream" 10877 ], 10878 "tags": [ 10879 "Object" 10880 ], 10881 "summary": "Download Multiple Objects", 10882 "operationId": "DownloadMultipleObjects", 10883 "parameters": [ 10884 { 10885 "type": "string", 10886 "name": "bucket_name", 10887 "in": "path", 10888 "required": true 10889 }, 10890 { 10891 "name": "objectList", 10892 "in": "body", 10893 "required": true, 10894 "schema": { 10895 "type": "array", 10896 "items": { 10897 "type": "string" 10898 } 10899 } 10900 } 10901 ], 10902 "responses": { 10903 "200": { 10904 "description": "A successful response.", 10905 "schema": { 10906 "type": "file" 10907 } 10908 }, 10909 "default": { 10910 "description": "Generic error response.", 10911 "schema": { 10912 "$ref": "#/definitions/ApiError" 10913 } 10914 } 10915 } 10916 } 10917 }, 10918 "/buckets/{bucket_name}/objects/legalhold": { 10919 "put": { 10920 "tags": [ 10921 "Object" 10922 ], 10923 "summary": "Put Object's legalhold status", 10924 "operationId": "PutObjectLegalHold", 10925 "parameters": [ 10926 { 10927 "type": "string", 10928 "name": "bucket_name", 10929 "in": "path", 10930 "required": true 10931 }, 10932 { 10933 "type": "string", 10934 "name": "prefix", 10935 "in": "query", 10936 "required": true 10937 }, 10938 { 10939 "type": "string", 10940 "name": "version_id", 10941 "in": "query", 10942 "required": true 10943 }, 10944 { 10945 "name": "body", 10946 "in": "body", 10947 "required": true, 10948 "schema": { 10949 "$ref": "#/definitions/putObjectLegalHoldRequest" 10950 } 10951 } 10952 ], 10953 "responses": { 10954 "200": { 10955 "description": "A successful response." 10956 }, 10957 "default": { 10958 "description": "Generic error response.", 10959 "schema": { 10960 "$ref": "#/definitions/ApiError" 10961 } 10962 } 10963 } 10964 } 10965 }, 10966 "/buckets/{bucket_name}/objects/metadata": { 10967 "get": { 10968 "tags": [ 10969 "Object" 10970 ], 10971 "summary": "Gets the metadata of an object", 10972 "operationId": "GetObjectMetadata", 10973 "parameters": [ 10974 { 10975 "type": "string", 10976 "name": "bucket_name", 10977 "in": "path", 10978 "required": true 10979 }, 10980 { 10981 "type": "string", 10982 "name": "prefix", 10983 "in": "query", 10984 "required": true 10985 }, 10986 { 10987 "type": "string", 10988 "name": "versionID", 10989 "in": "query" 10990 } 10991 ], 10992 "responses": { 10993 "200": { 10994 "description": "A successful response.", 10995 "schema": { 10996 "$ref": "#/definitions/metadata" 10997 } 10998 }, 10999 "default": { 11000 "description": "Generic error response.", 11001 "schema": { 11002 "$ref": "#/definitions/ApiError" 11003 } 11004 } 11005 } 11006 } 11007 }, 11008 "/buckets/{bucket_name}/objects/restore": { 11009 "put": { 11010 "tags": [ 11011 "Object" 11012 ], 11013 "summary": "Restore Object to a selected version", 11014 "operationId": "PutObjectRestore", 11015 "parameters": [ 11016 { 11017 "type": "string", 11018 "name": "bucket_name", 11019 "in": "path", 11020 "required": true 11021 }, 11022 { 11023 "type": "string", 11024 "name": "prefix", 11025 "in": "query", 11026 "required": true 11027 }, 11028 { 11029 "type": "string", 11030 "name": "version_id", 11031 "in": "query", 11032 "required": true 11033 } 11034 ], 11035 "responses": { 11036 "200": { 11037 "description": "A successful response." 11038 }, 11039 "default": { 11040 "description": "Generic error response.", 11041 "schema": { 11042 "$ref": "#/definitions/ApiError" 11043 } 11044 } 11045 } 11046 } 11047 }, 11048 "/buckets/{bucket_name}/objects/retention": { 11049 "put": { 11050 "tags": [ 11051 "Object" 11052 ], 11053 "summary": "Put Object's retention status", 11054 "operationId": "PutObjectRetention", 11055 "parameters": [ 11056 { 11057 "type": "string", 11058 "name": "bucket_name", 11059 "in": "path", 11060 "required": true 11061 }, 11062 { 11063 "type": "string", 11064 "name": "prefix", 11065 "in": "query", 11066 "required": true 11067 }, 11068 { 11069 "type": "string", 11070 "name": "version_id", 11071 "in": "query", 11072 "required": true 11073 }, 11074 { 11075 "name": "body", 11076 "in": "body", 11077 "required": true, 11078 "schema": { 11079 "$ref": "#/definitions/putObjectRetentionRequest" 11080 } 11081 } 11082 ], 11083 "responses": { 11084 "200": { 11085 "description": "A successful response." 11086 }, 11087 "default": { 11088 "description": "Generic error response.", 11089 "schema": { 11090 "$ref": "#/definitions/ApiError" 11091 } 11092 } 11093 } 11094 }, 11095 "delete": { 11096 "tags": [ 11097 "Object" 11098 ], 11099 "summary": "Delete Object retention from an object", 11100 "operationId": "DeleteObjectRetention", 11101 "parameters": [ 11102 { 11103 "type": "string", 11104 "name": "bucket_name", 11105 "in": "path", 11106 "required": true 11107 }, 11108 { 11109 "type": "string", 11110 "name": "prefix", 11111 "in": "query", 11112 "required": true 11113 }, 11114 { 11115 "type": "string", 11116 "name": "version_id", 11117 "in": "query", 11118 "required": true 11119 } 11120 ], 11121 "responses": { 11122 "200": { 11123 "description": "A successful response." 11124 }, 11125 "default": { 11126 "description": "Generic error response.", 11127 "schema": { 11128 "$ref": "#/definitions/ApiError" 11129 } 11130 } 11131 } 11132 } 11133 }, 11134 "/buckets/{bucket_name}/objects/share": { 11135 "get": { 11136 "tags": [ 11137 "Object" 11138 ], 11139 "summary": "Shares an Object on a url", 11140 "operationId": "ShareObject", 11141 "parameters": [ 11142 { 11143 "type": "string", 11144 "name": "bucket_name", 11145 "in": "path", 11146 "required": true 11147 }, 11148 { 11149 "type": "string", 11150 "name": "prefix", 11151 "in": "query", 11152 "required": true 11153 }, 11154 { 11155 "type": "string", 11156 "name": "version_id", 11157 "in": "query", 11158 "required": true 11159 }, 11160 { 11161 "type": "string", 11162 "name": "expires", 11163 "in": "query" 11164 } 11165 ], 11166 "responses": { 11167 "200": { 11168 "description": "A successful response.", 11169 "schema": { 11170 "type": "string" 11171 } 11172 }, 11173 "default": { 11174 "description": "Generic error response.", 11175 "schema": { 11176 "$ref": "#/definitions/ApiError" 11177 } 11178 } 11179 } 11180 } 11181 }, 11182 "/buckets/{bucket_name}/objects/tags": { 11183 "put": { 11184 "tags": [ 11185 "Object" 11186 ], 11187 "summary": "Put Object's tags", 11188 "operationId": "PutObjectTags", 11189 "parameters": [ 11190 { 11191 "type": "string", 11192 "name": "bucket_name", 11193 "in": "path", 11194 "required": true 11195 }, 11196 { 11197 "type": "string", 11198 "name": "prefix", 11199 "in": "query", 11200 "required": true 11201 }, 11202 { 11203 "type": "string", 11204 "name": "version_id", 11205 "in": "query", 11206 "required": true 11207 }, 11208 { 11209 "name": "body", 11210 "in": "body", 11211 "required": true, 11212 "schema": { 11213 "$ref": "#/definitions/putObjectTagsRequest" 11214 } 11215 } 11216 ], 11217 "responses": { 11218 "200": { 11219 "description": "A successful response." 11220 }, 11221 "default": { 11222 "description": "Generic error response.", 11223 "schema": { 11224 "$ref": "#/definitions/ApiError" 11225 } 11226 } 11227 } 11228 } 11229 }, 11230 "/buckets/{bucket_name}/objects/upload": { 11231 "post": { 11232 "security": [ 11233 { 11234 "key": [] 11235 }, 11236 { 11237 "anonymous": [] 11238 } 11239 ], 11240 "consumes": [ 11241 "multipart/form-data" 11242 ], 11243 "tags": [ 11244 "Object" 11245 ], 11246 "summary": "Uploads an Object.", 11247 "parameters": [ 11248 { 11249 "type": "string", 11250 "name": "bucket_name", 11251 "in": "path", 11252 "required": true 11253 }, 11254 { 11255 "type": "string", 11256 "name": "prefix", 11257 "in": "query" 11258 } 11259 ], 11260 "responses": { 11261 "200": { 11262 "description": "A successful response." 11263 }, 11264 "default": { 11265 "description": "Generic error response.", 11266 "schema": { 11267 "$ref": "#/definitions/ApiError" 11268 } 11269 } 11270 } 11271 } 11272 }, 11273 "/buckets/{bucket_name}/replication": { 11274 "get": { 11275 "tags": [ 11276 "Bucket" 11277 ], 11278 "summary": "Bucket Replication", 11279 "operationId": "GetBucketReplication", 11280 "parameters": [ 11281 { 11282 "type": "string", 11283 "name": "bucket_name", 11284 "in": "path", 11285 "required": true 11286 } 11287 ], 11288 "responses": { 11289 "200": { 11290 "description": "A successful response.", 11291 "schema": { 11292 "$ref": "#/definitions/bucketReplicationResponse" 11293 } 11294 }, 11295 "default": { 11296 "description": "Generic error response.", 11297 "schema": { 11298 "$ref": "#/definitions/ApiError" 11299 } 11300 } 11301 } 11302 } 11303 }, 11304 "/buckets/{bucket_name}/replication/{rule_id}": { 11305 "get": { 11306 "tags": [ 11307 "Bucket" 11308 ], 11309 "summary": "Bucket Replication", 11310 "operationId": "GetBucketReplicationRule", 11311 "parameters": [ 11312 { 11313 "type": "string", 11314 "name": "bucket_name", 11315 "in": "path", 11316 "required": true 11317 }, 11318 { 11319 "type": "string", 11320 "name": "rule_id", 11321 "in": "path", 11322 "required": true 11323 } 11324 ], 11325 "responses": { 11326 "200": { 11327 "description": "A successful response.", 11328 "schema": { 11329 "$ref": "#/definitions/bucketReplicationRule" 11330 } 11331 }, 11332 "default": { 11333 "description": "Generic error response.", 11334 "schema": { 11335 "$ref": "#/definitions/ApiError" 11336 } 11337 } 11338 } 11339 }, 11340 "put": { 11341 "tags": [ 11342 "Bucket" 11343 ], 11344 "summary": "Update Replication rule", 11345 "operationId": "UpdateMultiBucketReplication", 11346 "parameters": [ 11347 { 11348 "type": "string", 11349 "name": "bucket_name", 11350 "in": "path", 11351 "required": true 11352 }, 11353 { 11354 "type": "string", 11355 "name": "rule_id", 11356 "in": "path", 11357 "required": true 11358 }, 11359 { 11360 "name": "body", 11361 "in": "body", 11362 "required": true, 11363 "schema": { 11364 "$ref": "#/definitions/multiBucketReplicationEdit" 11365 } 11366 } 11367 ], 11368 "responses": { 11369 "201": { 11370 "description": "A successful response." 11371 }, 11372 "default": { 11373 "description": "Generic error response.", 11374 "schema": { 11375 "$ref": "#/definitions/ApiError" 11376 } 11377 } 11378 } 11379 }, 11380 "delete": { 11381 "tags": [ 11382 "Bucket" 11383 ], 11384 "summary": "Bucket Replication Rule Delete", 11385 "operationId": "DeleteBucketReplicationRule", 11386 "parameters": [ 11387 { 11388 "type": "string", 11389 "name": "bucket_name", 11390 "in": "path", 11391 "required": true 11392 }, 11393 { 11394 "type": "string", 11395 "name": "rule_id", 11396 "in": "path", 11397 "required": true 11398 } 11399 ], 11400 "responses": { 11401 "204": { 11402 "description": "A successful response." 11403 }, 11404 "default": { 11405 "description": "Generic error response.", 11406 "schema": { 11407 "$ref": "#/definitions/ApiError" 11408 } 11409 } 11410 } 11411 } 11412 }, 11413 "/buckets/{bucket_name}/retention": { 11414 "get": { 11415 "tags": [ 11416 "Bucket" 11417 ], 11418 "summary": "Get Bucket's retention config", 11419 "operationId": "GetBucketRetentionConfig", 11420 "parameters": [ 11421 { 11422 "type": "string", 11423 "name": "bucket_name", 11424 "in": "path", 11425 "required": true 11426 } 11427 ], 11428 "responses": { 11429 "200": { 11430 "description": "A successful response.", 11431 "schema": { 11432 "$ref": "#/definitions/getBucketRetentionConfig" 11433 } 11434 }, 11435 "default": { 11436 "description": "Generic error response.", 11437 "schema": { 11438 "$ref": "#/definitions/ApiError" 11439 } 11440 } 11441 } 11442 }, 11443 "put": { 11444 "tags": [ 11445 "Bucket" 11446 ], 11447 "summary": "Set Bucket's retention config", 11448 "operationId": "SetBucketRetentionConfig", 11449 "parameters": [ 11450 { 11451 "type": "string", 11452 "name": "bucket_name", 11453 "in": "path", 11454 "required": true 11455 }, 11456 { 11457 "name": "body", 11458 "in": "body", 11459 "required": true, 11460 "schema": { 11461 "$ref": "#/definitions/putBucketRetentionRequest" 11462 } 11463 } 11464 ], 11465 "responses": { 11466 "200": { 11467 "description": "A successful response." 11468 }, 11469 "default": { 11470 "description": "Generic error response.", 11471 "schema": { 11472 "$ref": "#/definitions/ApiError" 11473 } 11474 } 11475 } 11476 } 11477 }, 11478 "/buckets/{bucket_name}/rewind/{date}": { 11479 "get": { 11480 "tags": [ 11481 "Bucket" 11482 ], 11483 "summary": "Get objects in a bucket for a rewind date", 11484 "operationId": "GetBucketRewind", 11485 "parameters": [ 11486 { 11487 "type": "string", 11488 "name": "bucket_name", 11489 "in": "path", 11490 "required": true 11491 }, 11492 { 11493 "type": "string", 11494 "name": "date", 11495 "in": "path", 11496 "required": true 11497 }, 11498 { 11499 "type": "string", 11500 "name": "prefix", 11501 "in": "query" 11502 } 11503 ], 11504 "responses": { 11505 "200": { 11506 "description": "A successful response.", 11507 "schema": { 11508 "$ref": "#/definitions/rewindResponse" 11509 } 11510 }, 11511 "default": { 11512 "description": "Generic error response.", 11513 "schema": { 11514 "$ref": "#/definitions/ApiError" 11515 } 11516 } 11517 } 11518 } 11519 }, 11520 "/buckets/{bucket_name}/tags": { 11521 "put": { 11522 "tags": [ 11523 "Bucket" 11524 ], 11525 "summary": "Put Bucket's tags", 11526 "operationId": "PutBucketTags", 11527 "parameters": [ 11528 { 11529 "type": "string", 11530 "name": "bucket_name", 11531 "in": "path", 11532 "required": true 11533 }, 11534 { 11535 "name": "body", 11536 "in": "body", 11537 "required": true, 11538 "schema": { 11539 "$ref": "#/definitions/putBucketTagsRequest" 11540 } 11541 } 11542 ], 11543 "responses": { 11544 "200": { 11545 "description": "A successful response." 11546 }, 11547 "default": { 11548 "description": "Generic error response.", 11549 "schema": { 11550 "$ref": "#/definitions/ApiError" 11551 } 11552 } 11553 } 11554 } 11555 }, 11556 "/buckets/{bucket_name}/versioning": { 11557 "get": { 11558 "tags": [ 11559 "Bucket" 11560 ], 11561 "summary": "Bucket Versioning", 11562 "operationId": "GetBucketVersioning", 11563 "parameters": [ 11564 { 11565 "type": "string", 11566 "name": "bucket_name", 11567 "in": "path", 11568 "required": true 11569 } 11570 ], 11571 "responses": { 11572 "200": { 11573 "description": "A successful response.", 11574 "schema": { 11575 "$ref": "#/definitions/bucketVersioningResponse" 11576 } 11577 }, 11578 "default": { 11579 "description": "Generic error response.", 11580 "schema": { 11581 "$ref": "#/definitions/ApiError" 11582 } 11583 } 11584 } 11585 }, 11586 "put": { 11587 "tags": [ 11588 "Bucket" 11589 ], 11590 "summary": "Set Bucket Versioning", 11591 "operationId": "SetBucketVersioning", 11592 "parameters": [ 11593 { 11594 "type": "string", 11595 "name": "bucket_name", 11596 "in": "path", 11597 "required": true 11598 }, 11599 { 11600 "name": "body", 11601 "in": "body", 11602 "required": true, 11603 "schema": { 11604 "$ref": "#/definitions/setBucketVersioning" 11605 } 11606 } 11607 ], 11608 "responses": { 11609 "201": { 11610 "description": "A successful response." 11611 }, 11612 "default": { 11613 "description": "Generic error response.", 11614 "schema": { 11615 "$ref": "#/definitions/ApiError" 11616 } 11617 } 11618 } 11619 } 11620 }, 11621 "/buckets/{name}": { 11622 "get": { 11623 "tags": [ 11624 "Bucket" 11625 ], 11626 "summary": "Bucket Info", 11627 "operationId": "BucketInfo", 11628 "parameters": [ 11629 { 11630 "type": "string", 11631 "name": "name", 11632 "in": "path", 11633 "required": true 11634 } 11635 ], 11636 "responses": { 11637 "200": { 11638 "description": "A successful response.", 11639 "schema": { 11640 "$ref": "#/definitions/bucket" 11641 } 11642 }, 11643 "default": { 11644 "description": "Generic error response.", 11645 "schema": { 11646 "$ref": "#/definitions/ApiError" 11647 } 11648 } 11649 } 11650 }, 11651 "delete": { 11652 "tags": [ 11653 "Bucket" 11654 ], 11655 "summary": "Delete Bucket", 11656 "operationId": "DeleteBucket", 11657 "parameters": [ 11658 { 11659 "type": "string", 11660 "name": "name", 11661 "in": "path", 11662 "required": true 11663 } 11664 ], 11665 "responses": { 11666 "204": { 11667 "description": "A successful response." 11668 }, 11669 "default": { 11670 "description": "Generic error response.", 11671 "schema": { 11672 "$ref": "#/definitions/ApiError" 11673 } 11674 } 11675 } 11676 } 11677 }, 11678 "/buckets/{name}/quota": { 11679 "get": { 11680 "tags": [ 11681 "Bucket" 11682 ], 11683 "summary": "Get Bucket Quota", 11684 "operationId": "GetBucketQuota", 11685 "parameters": [ 11686 { 11687 "type": "string", 11688 "name": "name", 11689 "in": "path", 11690 "required": true 11691 } 11692 ], 11693 "responses": { 11694 "200": { 11695 "description": "A successful response.", 11696 "schema": { 11697 "$ref": "#/definitions/bucketQuota" 11698 } 11699 }, 11700 "default": { 11701 "description": "Generic error response.", 11702 "schema": { 11703 "$ref": "#/definitions/ApiError" 11704 } 11705 } 11706 } 11707 }, 11708 "put": { 11709 "tags": [ 11710 "Bucket" 11711 ], 11712 "summary": "Bucket Quota", 11713 "operationId": "SetBucketQuota", 11714 "parameters": [ 11715 { 11716 "type": "string", 11717 "name": "name", 11718 "in": "path", 11719 "required": true 11720 }, 11721 { 11722 "name": "body", 11723 "in": "body", 11724 "required": true, 11725 "schema": { 11726 "$ref": "#/definitions/setBucketQuota" 11727 } 11728 } 11729 ], 11730 "responses": { 11731 "200": { 11732 "description": "A successful response.", 11733 "schema": { 11734 "$ref": "#/definitions/bucket" 11735 } 11736 }, 11737 "default": { 11738 "description": "Generic error response.", 11739 "schema": { 11740 "$ref": "#/definitions/ApiError" 11741 } 11742 } 11743 } 11744 } 11745 }, 11746 "/buckets/{name}/set-policy": { 11747 "put": { 11748 "tags": [ 11749 "Bucket" 11750 ], 11751 "summary": "Bucket Set Policy", 11752 "operationId": "BucketSetPolicy", 11753 "parameters": [ 11754 { 11755 "type": "string", 11756 "name": "name", 11757 "in": "path", 11758 "required": true 11759 }, 11760 { 11761 "name": "body", 11762 "in": "body", 11763 "required": true, 11764 "schema": { 11765 "$ref": "#/definitions/setBucketPolicyRequest" 11766 } 11767 } 11768 ], 11769 "responses": { 11770 "200": { 11771 "description": "A successful response.", 11772 "schema": { 11773 "$ref": "#/definitions/bucket" 11774 } 11775 }, 11776 "default": { 11777 "description": "Generic error response.", 11778 "schema": { 11779 "$ref": "#/definitions/ApiError" 11780 } 11781 } 11782 } 11783 } 11784 }, 11785 "/configs": { 11786 "get": { 11787 "tags": [ 11788 "Configuration" 11789 ], 11790 "summary": "List Configurations", 11791 "operationId": "ListConfig", 11792 "parameters": [ 11793 { 11794 "type": "number", 11795 "format": "int32", 11796 "default": 0, 11797 "name": "offset", 11798 "in": "query" 11799 }, 11800 { 11801 "type": "number", 11802 "format": "int32", 11803 "default": 20, 11804 "name": "limit", 11805 "in": "query" 11806 } 11807 ], 11808 "responses": { 11809 "200": { 11810 "description": "A successful response.", 11811 "schema": { 11812 "$ref": "#/definitions/listConfigResponse" 11813 } 11814 }, 11815 "default": { 11816 "description": "Generic error response.", 11817 "schema": { 11818 "$ref": "#/definitions/ApiError" 11819 } 11820 } 11821 } 11822 } 11823 }, 11824 "/configs/export": { 11825 "get": { 11826 "tags": [ 11827 "Configuration" 11828 ], 11829 "summary": "Export the current config from MinIO server", 11830 "operationId": "ExportConfig", 11831 "responses": { 11832 "200": { 11833 "description": "A successful response.", 11834 "schema": { 11835 "$ref": "#/definitions/configExportResponse" 11836 } 11837 }, 11838 "default": { 11839 "description": "Generic error response.", 11840 "schema": { 11841 "$ref": "#/definitions/ApiError" 11842 } 11843 } 11844 } 11845 } 11846 }, 11847 "/configs/import": { 11848 "post": { 11849 "consumes": [ 11850 "multipart/form-data" 11851 ], 11852 "tags": [ 11853 "Configuration" 11854 ], 11855 "summary": "Uploads a file to import MinIO server config.", 11856 "parameters": [ 11857 { 11858 "type": "file", 11859 "name": "file", 11860 "in": "formData", 11861 "required": true 11862 } 11863 ], 11864 "responses": { 11865 "200": { 11866 "description": "A successful response." 11867 }, 11868 "default": { 11869 "description": "Generic error response.", 11870 "schema": { 11871 "$ref": "#/definitions/ApiError" 11872 } 11873 } 11874 } 11875 } 11876 }, 11877 "/configs/{name}": { 11878 "get": { 11879 "tags": [ 11880 "Configuration" 11881 ], 11882 "summary": "Configuration info", 11883 "operationId": "ConfigInfo", 11884 "parameters": [ 11885 { 11886 "type": "string", 11887 "name": "name", 11888 "in": "path", 11889 "required": true 11890 } 11891 ], 11892 "responses": { 11893 "200": { 11894 "description": "A successful response.", 11895 "schema": { 11896 "type": "array", 11897 "items": { 11898 "$ref": "#/definitions/configuration" 11899 } 11900 } 11901 }, 11902 "default": { 11903 "description": "Generic error response.", 11904 "schema": { 11905 "$ref": "#/definitions/ApiError" 11906 } 11907 } 11908 } 11909 }, 11910 "put": { 11911 "tags": [ 11912 "Configuration" 11913 ], 11914 "summary": "Set Configuration", 11915 "operationId": "SetConfig", 11916 "parameters": [ 11917 { 11918 "type": "string", 11919 "name": "name", 11920 "in": "path", 11921 "required": true 11922 }, 11923 { 11924 "name": "body", 11925 "in": "body", 11926 "required": true, 11927 "schema": { 11928 "$ref": "#/definitions/setConfigRequest" 11929 } 11930 } 11931 ], 11932 "responses": { 11933 "200": { 11934 "description": "A successful response.", 11935 "schema": { 11936 "$ref": "#/definitions/setConfigResponse" 11937 } 11938 }, 11939 "default": { 11940 "description": "Generic error response.", 11941 "schema": { 11942 "$ref": "#/definitions/ApiError" 11943 } 11944 } 11945 } 11946 } 11947 }, 11948 "/configs/{name}/reset": { 11949 "post": { 11950 "tags": [ 11951 "Configuration" 11952 ], 11953 "summary": "Configuration reset", 11954 "operationId": "ResetConfig", 11955 "parameters": [ 11956 { 11957 "type": "string", 11958 "name": "name", 11959 "in": "path", 11960 "required": true 11961 } 11962 ], 11963 "responses": { 11964 "200": { 11965 "description": "A successful response.", 11966 "schema": { 11967 "$ref": "#/definitions/setConfigResponse" 11968 } 11969 }, 11970 "default": { 11971 "description": "Generic error response.", 11972 "schema": { 11973 "$ref": "#/definitions/ApiError" 11974 } 11975 } 11976 } 11977 } 11978 }, 11979 "/download-shared-object/{url}": { 11980 "get": { 11981 "security": [], 11982 "produces": [ 11983 "application/octet-stream" 11984 ], 11985 "tags": [ 11986 "Public" 11987 ], 11988 "summary": "Downloads an object from a presigned url", 11989 "operationId": "DownloadSharedObject", 11990 "parameters": [ 11991 { 11992 "type": "string", 11993 "name": "url", 11994 "in": "path", 11995 "required": true 11996 } 11997 ], 11998 "responses": { 11999 "200": { 12000 "description": "A successful response.", 12001 "schema": { 12002 "type": "file" 12003 } 12004 }, 12005 "default": { 12006 "description": "Generic error response.", 12007 "schema": { 12008 "$ref": "#/definitions/ApiError" 12009 } 12010 } 12011 } 12012 } 12013 }, 12014 "/group/{name}": { 12015 "get": { 12016 "tags": [ 12017 "Group" 12018 ], 12019 "summary": "Group info", 12020 "operationId": "GroupInfo", 12021 "parameters": [ 12022 { 12023 "type": "string", 12024 "name": "name", 12025 "in": "path", 12026 "required": true 12027 } 12028 ], 12029 "responses": { 12030 "200": { 12031 "description": "A successful response.", 12032 "schema": { 12033 "$ref": "#/definitions/group" 12034 } 12035 }, 12036 "default": { 12037 "description": "Generic error response.", 12038 "schema": { 12039 "$ref": "#/definitions/ApiError" 12040 } 12041 } 12042 } 12043 }, 12044 "put": { 12045 "tags": [ 12046 "Group" 12047 ], 12048 "summary": "Update Group Members or Status", 12049 "operationId": "UpdateGroup", 12050 "parameters": [ 12051 { 12052 "type": "string", 12053 "name": "name", 12054 "in": "path", 12055 "required": true 12056 }, 12057 { 12058 "name": "body", 12059 "in": "body", 12060 "required": true, 12061 "schema": { 12062 "$ref": "#/definitions/updateGroupRequest" 12063 } 12064 } 12065 ], 12066 "responses": { 12067 "200": { 12068 "description": "A successful response.", 12069 "schema": { 12070 "$ref": "#/definitions/group" 12071 } 12072 }, 12073 "default": { 12074 "description": "Generic error response.", 12075 "schema": { 12076 "$ref": "#/definitions/ApiError" 12077 } 12078 } 12079 } 12080 }, 12081 "delete": { 12082 "tags": [ 12083 "Group" 12084 ], 12085 "summary": "Remove group", 12086 "operationId": "RemoveGroup", 12087 "parameters": [ 12088 { 12089 "type": "string", 12090 "name": "name", 12091 "in": "path", 12092 "required": true 12093 } 12094 ], 12095 "responses": { 12096 "204": { 12097 "description": "A successful response." 12098 }, 12099 "default": { 12100 "description": "Generic error response.", 12101 "schema": { 12102 "$ref": "#/definitions/ApiError" 12103 } 12104 } 12105 } 12106 } 12107 }, 12108 "/groups": { 12109 "get": { 12110 "tags": [ 12111 "Group" 12112 ], 12113 "summary": "List Groups", 12114 "operationId": "ListGroups", 12115 "parameters": [ 12116 { 12117 "type": "number", 12118 "format": "int32", 12119 "default": 0, 12120 "name": "offset", 12121 "in": "query" 12122 }, 12123 { 12124 "type": "number", 12125 "format": "int32", 12126 "default": 20, 12127 "name": "limit", 12128 "in": "query" 12129 } 12130 ], 12131 "responses": { 12132 "200": { 12133 "description": "A successful response.", 12134 "schema": { 12135 "$ref": "#/definitions/listGroupsResponse" 12136 } 12137 }, 12138 "default": { 12139 "description": "Generic error response.", 12140 "schema": { 12141 "$ref": "#/definitions/ApiError" 12142 } 12143 } 12144 } 12145 }, 12146 "post": { 12147 "tags": [ 12148 "Group" 12149 ], 12150 "summary": "Add Group", 12151 "operationId": "AddGroup", 12152 "parameters": [ 12153 { 12154 "name": "body", 12155 "in": "body", 12156 "required": true, 12157 "schema": { 12158 "$ref": "#/definitions/addGroupRequest" 12159 } 12160 } 12161 ], 12162 "responses": { 12163 "201": { 12164 "description": "A successful response." 12165 }, 12166 "default": { 12167 "description": "Generic error response.", 12168 "schema": { 12169 "$ref": "#/definitions/ApiError" 12170 } 12171 } 12172 } 12173 } 12174 }, 12175 "/idp/{type}": { 12176 "get": { 12177 "tags": [ 12178 "idp" 12179 ], 12180 "summary": "List IDP Configurations", 12181 "operationId": "ListConfigurations", 12182 "parameters": [ 12183 { 12184 "type": "string", 12185 "description": "IDP Configuration Type", 12186 "name": "type", 12187 "in": "path", 12188 "required": true 12189 } 12190 ], 12191 "responses": { 12192 "200": { 12193 "description": "A successful response.", 12194 "schema": { 12195 "$ref": "#/definitions/idpListConfigurationsResponse" 12196 } 12197 }, 12198 "default": { 12199 "description": "Generic error response.", 12200 "schema": { 12201 "$ref": "#/definitions/ApiError" 12202 } 12203 } 12204 } 12205 }, 12206 "post": { 12207 "consumes": [ 12208 "application/json" 12209 ], 12210 "tags": [ 12211 "idp" 12212 ], 12213 "summary": "Create IDP Configuration", 12214 "operationId": "CreateConfiguration", 12215 "parameters": [ 12216 { 12217 "type": "string", 12218 "description": "IDP Configuration Type", 12219 "name": "type", 12220 "in": "path", 12221 "required": true 12222 }, 12223 { 12224 "name": "body", 12225 "in": "body", 12226 "required": true, 12227 "schema": { 12228 "$ref": "#/definitions/idpServerConfiguration" 12229 } 12230 } 12231 ], 12232 "responses": { 12233 "201": { 12234 "description": "A successful response.", 12235 "schema": { 12236 "$ref": "#/definitions/setIDPResponse" 12237 } 12238 }, 12239 "default": { 12240 "description": "Generic error response.", 12241 "schema": { 12242 "$ref": "#/definitions/ApiError" 12243 } 12244 } 12245 } 12246 } 12247 }, 12248 "/idp/{type}/{name}": { 12249 "get": { 12250 "tags": [ 12251 "idp" 12252 ], 12253 "summary": "Get IDP Configuration", 12254 "operationId": "GetConfiguration", 12255 "parameters": [ 12256 { 12257 "type": "string", 12258 "description": "IDP Configuration Name", 12259 "name": "name", 12260 "in": "path", 12261 "required": true 12262 }, 12263 { 12264 "type": "string", 12265 "description": "IDP Configuration Type", 12266 "name": "type", 12267 "in": "path", 12268 "required": true 12269 } 12270 ], 12271 "responses": { 12272 "200": { 12273 "description": "A successful response.", 12274 "schema": { 12275 "$ref": "#/definitions/idpServerConfiguration" 12276 } 12277 }, 12278 "default": { 12279 "description": "Generic error response.", 12280 "schema": { 12281 "$ref": "#/definitions/ApiError" 12282 } 12283 } 12284 } 12285 }, 12286 "put": { 12287 "consumes": [ 12288 "application/json" 12289 ], 12290 "tags": [ 12291 "idp" 12292 ], 12293 "summary": "Update IDP Configuration", 12294 "operationId": "UpdateConfiguration", 12295 "parameters": [ 12296 { 12297 "name": "body", 12298 "in": "body", 12299 "required": true, 12300 "schema": { 12301 "$ref": "#/definitions/idpServerConfiguration" 12302 } 12303 }, 12304 { 12305 "type": "string", 12306 "description": "IDP Configuration Name", 12307 "name": "name", 12308 "in": "path", 12309 "required": true 12310 }, 12311 { 12312 "type": "string", 12313 "description": "IDP Configuration Type", 12314 "name": "type", 12315 "in": "path", 12316 "required": true 12317 } 12318 ], 12319 "responses": { 12320 "200": { 12321 "description": "A successful response.", 12322 "schema": { 12323 "$ref": "#/definitions/setIDPResponse" 12324 } 12325 }, 12326 "default": { 12327 "description": "Generic error response.", 12328 "schema": { 12329 "$ref": "#/definitions/ApiError" 12330 } 12331 } 12332 } 12333 }, 12334 "delete": { 12335 "tags": [ 12336 "idp" 12337 ], 12338 "summary": "Delete IDP Configuration", 12339 "operationId": "DeleteConfiguration", 12340 "parameters": [ 12341 { 12342 "type": "string", 12343 "description": "IDP Configuration Name", 12344 "name": "name", 12345 "in": "path", 12346 "required": true 12347 }, 12348 { 12349 "type": "string", 12350 "description": "IDP Configuration Type", 12351 "name": "type", 12352 "in": "path", 12353 "required": true 12354 } 12355 ], 12356 "responses": { 12357 "200": { 12358 "description": "A successful response.", 12359 "schema": { 12360 "$ref": "#/definitions/setIDPResponse" 12361 } 12362 }, 12363 "default": { 12364 "description": "Generic error response.", 12365 "schema": { 12366 "$ref": "#/definitions/ApiError" 12367 } 12368 } 12369 } 12370 } 12371 }, 12372 "/kms/apis": { 12373 "get": { 12374 "tags": [ 12375 "KMS" 12376 ], 12377 "summary": "KMS apis", 12378 "operationId": "KMSAPIs", 12379 "responses": { 12380 "200": { 12381 "description": "A successful response.", 12382 "schema": { 12383 "$ref": "#/definitions/kmsAPIsResponse" 12384 } 12385 }, 12386 "default": { 12387 "description": "Generic error response.", 12388 "schema": { 12389 "$ref": "#/definitions/ApiError" 12390 } 12391 } 12392 } 12393 } 12394 }, 12395 "/kms/describe-self/identity": { 12396 "get": { 12397 "tags": [ 12398 "KMS" 12399 ], 12400 "summary": "KMS describe self identity", 12401 "operationId": "KMSDescribeSelfIdentity", 12402 "responses": { 12403 "200": { 12404 "description": "A successful response.", 12405 "schema": { 12406 "$ref": "#/definitions/kmsDescribeSelfIdentityResponse" 12407 } 12408 }, 12409 "default": { 12410 "description": "Generic error response.", 12411 "schema": { 12412 "$ref": "#/definitions/ApiError" 12413 } 12414 } 12415 } 12416 } 12417 }, 12418 "/kms/identities": { 12419 "get": { 12420 "tags": [ 12421 "KMS" 12422 ], 12423 "summary": "KMS list identities", 12424 "operationId": "KMSListIdentities", 12425 "parameters": [ 12426 { 12427 "type": "string", 12428 "description": "pattern to retrieve identities", 12429 "name": "pattern", 12430 "in": "query" 12431 } 12432 ], 12433 "responses": { 12434 "200": { 12435 "description": "A successful response.", 12436 "schema": { 12437 "$ref": "#/definitions/kmsListIdentitiesResponse" 12438 } 12439 }, 12440 "default": { 12441 "description": "Generic error response.", 12442 "schema": { 12443 "$ref": "#/definitions/ApiError" 12444 } 12445 } 12446 } 12447 } 12448 }, 12449 "/kms/identities/{name}": { 12450 "delete": { 12451 "tags": [ 12452 "KMS" 12453 ], 12454 "summary": "KMS delete identity", 12455 "operationId": "KMSDeleteIdentity", 12456 "parameters": [ 12457 { 12458 "type": "string", 12459 "description": "KMS identity name", 12460 "name": "name", 12461 "in": "path", 12462 "required": true 12463 } 12464 ], 12465 "responses": { 12466 "200": { 12467 "description": "A successful response." 12468 }, 12469 "default": { 12470 "description": "Generic error response.", 12471 "schema": { 12472 "$ref": "#/definitions/ApiError" 12473 } 12474 } 12475 } 12476 } 12477 }, 12478 "/kms/identities/{name}/describe": { 12479 "get": { 12480 "tags": [ 12481 "KMS" 12482 ], 12483 "summary": "KMS describe identity", 12484 "operationId": "KMSDescribeIdentity", 12485 "parameters": [ 12486 { 12487 "type": "string", 12488 "description": "KMS identity name", 12489 "name": "name", 12490 "in": "path", 12491 "required": true 12492 } 12493 ], 12494 "responses": { 12495 "200": { 12496 "description": "A successful response.", 12497 "schema": { 12498 "$ref": "#/definitions/kmsDescribeIdentityResponse" 12499 } 12500 }, 12501 "default": { 12502 "description": "Generic error response.", 12503 "schema": { 12504 "$ref": "#/definitions/ApiError" 12505 } 12506 } 12507 } 12508 } 12509 }, 12510 "/kms/keys": { 12511 "get": { 12512 "tags": [ 12513 "KMS" 12514 ], 12515 "summary": "KMS list keys", 12516 "operationId": "KMSListKeys", 12517 "parameters": [ 12518 { 12519 "type": "string", 12520 "description": "pattern to retrieve keys", 12521 "name": "pattern", 12522 "in": "query" 12523 } 12524 ], 12525 "responses": { 12526 "200": { 12527 "description": "A successful response.", 12528 "schema": { 12529 "$ref": "#/definitions/kmsListKeysResponse" 12530 } 12531 }, 12532 "default": { 12533 "description": "Generic error response.", 12534 "schema": { 12535 "$ref": "#/definitions/ApiError" 12536 } 12537 } 12538 } 12539 }, 12540 "post": { 12541 "tags": [ 12542 "KMS" 12543 ], 12544 "summary": "KMS create key", 12545 "operationId": "KMSCreateKey", 12546 "parameters": [ 12547 { 12548 "name": "body", 12549 "in": "body", 12550 "required": true, 12551 "schema": { 12552 "$ref": "#/definitions/kmsCreateKeyRequest" 12553 } 12554 } 12555 ], 12556 "responses": { 12557 "201": { 12558 "description": "A successful response." 12559 }, 12560 "default": { 12561 "description": "Generic error response.", 12562 "schema": { 12563 "$ref": "#/definitions/ApiError" 12564 } 12565 } 12566 } 12567 } 12568 }, 12569 "/kms/keys/{name}": { 12570 "get": { 12571 "tags": [ 12572 "KMS" 12573 ], 12574 "summary": "KMS key status", 12575 "operationId": "KMSKeyStatus", 12576 "parameters": [ 12577 { 12578 "type": "string", 12579 "description": "KMS key name", 12580 "name": "name", 12581 "in": "path", 12582 "required": true 12583 } 12584 ], 12585 "responses": { 12586 "200": { 12587 "description": "A successful response.", 12588 "schema": { 12589 "$ref": "#/definitions/kmsKeyStatusResponse" 12590 } 12591 }, 12592 "default": { 12593 "description": "Generic error response.", 12594 "schema": { 12595 "$ref": "#/definitions/ApiError" 12596 } 12597 } 12598 } 12599 }, 12600 "delete": { 12601 "tags": [ 12602 "KMS" 12603 ], 12604 "summary": "KMS delete key", 12605 "operationId": "KMSDeleteKey", 12606 "parameters": [ 12607 { 12608 "type": "string", 12609 "description": "KMS key name", 12610 "name": "name", 12611 "in": "path", 12612 "required": true 12613 } 12614 ], 12615 "responses": { 12616 "200": { 12617 "description": "A successful response." 12618 }, 12619 "default": { 12620 "description": "Generic error response.", 12621 "schema": { 12622 "$ref": "#/definitions/ApiError" 12623 } 12624 } 12625 } 12626 } 12627 }, 12628 "/kms/keys/{name}/import": { 12629 "post": { 12630 "tags": [ 12631 "KMS" 12632 ], 12633 "summary": "KMS import key", 12634 "operationId": "KMSImportKey", 12635 "parameters": [ 12636 { 12637 "name": "body", 12638 "in": "body", 12639 "required": true, 12640 "schema": { 12641 "$ref": "#/definitions/kmsImportKeyRequest" 12642 } 12643 }, 12644 { 12645 "type": "string", 12646 "description": "KMS key name", 12647 "name": "name", 12648 "in": "path", 12649 "required": true 12650 } 12651 ], 12652 "responses": { 12653 "201": { 12654 "description": "A successful response." 12655 }, 12656 "default": { 12657 "description": "Generic error response.", 12658 "schema": { 12659 "$ref": "#/definitions/ApiError" 12660 } 12661 } 12662 } 12663 } 12664 }, 12665 "/kms/metrics": { 12666 "get": { 12667 "tags": [ 12668 "KMS" 12669 ], 12670 "summary": "KMS metrics", 12671 "operationId": "KMSMetrics", 12672 "responses": { 12673 "200": { 12674 "description": "A successful response.", 12675 "schema": { 12676 "$ref": "#/definitions/kmsMetricsResponse" 12677 } 12678 }, 12679 "default": { 12680 "description": "Generic error response.", 12681 "schema": { 12682 "$ref": "#/definitions/ApiError" 12683 } 12684 } 12685 } 12686 } 12687 }, 12688 "/kms/policies": { 12689 "get": { 12690 "tags": [ 12691 "KMS" 12692 ], 12693 "summary": "KMS list policies", 12694 "operationId": "KMSListPolicies", 12695 "parameters": [ 12696 { 12697 "type": "string", 12698 "description": "pattern to retrieve policies", 12699 "name": "pattern", 12700 "in": "query" 12701 } 12702 ], 12703 "responses": { 12704 "200": { 12705 "description": "A successful response.", 12706 "schema": { 12707 "$ref": "#/definitions/kmsListPoliciesResponse" 12708 } 12709 }, 12710 "default": { 12711 "description": "Generic error response.", 12712 "schema": { 12713 "$ref": "#/definitions/ApiError" 12714 } 12715 } 12716 } 12717 }, 12718 "post": { 12719 "tags": [ 12720 "KMS" 12721 ], 12722 "summary": "KMS set policy", 12723 "operationId": "KMSSetPolicy", 12724 "parameters": [ 12725 { 12726 "name": "body", 12727 "in": "body", 12728 "required": true, 12729 "schema": { 12730 "$ref": "#/definitions/kmsSetPolicyRequest" 12731 } 12732 } 12733 ], 12734 "responses": { 12735 "200": { 12736 "description": "A successful response." 12737 }, 12738 "default": { 12739 "description": "Generic error response.", 12740 "schema": { 12741 "$ref": "#/definitions/ApiError" 12742 } 12743 } 12744 } 12745 } 12746 }, 12747 "/kms/policies/{name}": { 12748 "get": { 12749 "tags": [ 12750 "KMS" 12751 ], 12752 "summary": "KMS get policy", 12753 "operationId": "KMSGetPolicy", 12754 "parameters": [ 12755 { 12756 "type": "string", 12757 "description": "KMS policy name", 12758 "name": "name", 12759 "in": "path", 12760 "required": true 12761 } 12762 ], 12763 "responses": { 12764 "200": { 12765 "description": "A successful response.", 12766 "schema": { 12767 "$ref": "#/definitions/kmsGetPolicyResponse" 12768 } 12769 }, 12770 "default": { 12771 "description": "Generic error response.", 12772 "schema": { 12773 "$ref": "#/definitions/ApiError" 12774 } 12775 } 12776 } 12777 }, 12778 "delete": { 12779 "tags": [ 12780 "KMS" 12781 ], 12782 "summary": "KMS delete policy", 12783 "operationId": "KMSDeletePolicy", 12784 "parameters": [ 12785 { 12786 "type": "string", 12787 "description": "KMS policy name", 12788 "name": "name", 12789 "in": "path", 12790 "required": true 12791 } 12792 ], 12793 "responses": { 12794 "200": { 12795 "description": "A successful response." 12796 }, 12797 "default": { 12798 "description": "Generic error response.", 12799 "schema": { 12800 "$ref": "#/definitions/ApiError" 12801 } 12802 } 12803 } 12804 } 12805 }, 12806 "/kms/policies/{name}/assign": { 12807 "post": { 12808 "tags": [ 12809 "KMS" 12810 ], 12811 "summary": "KMS assign policy", 12812 "operationId": "KMSAssignPolicy", 12813 "parameters": [ 12814 { 12815 "name": "body", 12816 "in": "body", 12817 "required": true, 12818 "schema": { 12819 "$ref": "#/definitions/kmsAssignPolicyRequest" 12820 } 12821 }, 12822 { 12823 "type": "string", 12824 "description": "KMS policy name", 12825 "name": "name", 12826 "in": "path", 12827 "required": true 12828 } 12829 ], 12830 "responses": { 12831 "200": { 12832 "description": "A successful response." 12833 }, 12834 "default": { 12835 "description": "Generic error response.", 12836 "schema": { 12837 "$ref": "#/definitions/ApiError" 12838 } 12839 } 12840 } 12841 } 12842 }, 12843 "/kms/policies/{name}/describe": { 12844 "get": { 12845 "tags": [ 12846 "KMS" 12847 ], 12848 "summary": "KMS describe policy", 12849 "operationId": "KMSDescribePolicy", 12850 "parameters": [ 12851 { 12852 "type": "string", 12853 "description": "KMS policy name", 12854 "name": "name", 12855 "in": "path", 12856 "required": true 12857 } 12858 ], 12859 "responses": { 12860 "200": { 12861 "description": "A successful response.", 12862 "schema": { 12863 "$ref": "#/definitions/kmsDescribePolicyResponse" 12864 } 12865 }, 12866 "default": { 12867 "description": "Generic error response.", 12868 "schema": { 12869 "$ref": "#/definitions/ApiError" 12870 } 12871 } 12872 } 12873 } 12874 }, 12875 "/kms/status": { 12876 "get": { 12877 "tags": [ 12878 "KMS" 12879 ], 12880 "summary": "KMS status", 12881 "operationId": "KMSStatus", 12882 "responses": { 12883 "200": { 12884 "description": "A successful response.", 12885 "schema": { 12886 "$ref": "#/definitions/kmsStatusResponse" 12887 } 12888 }, 12889 "default": { 12890 "description": "Generic error response.", 12891 "schema": { 12892 "$ref": "#/definitions/ApiError" 12893 } 12894 } 12895 } 12896 } 12897 }, 12898 "/kms/version": { 12899 "get": { 12900 "tags": [ 12901 "KMS" 12902 ], 12903 "summary": "KMS version", 12904 "operationId": "KMSVersion", 12905 "responses": { 12906 "200": { 12907 "description": "A successful response.", 12908 "schema": { 12909 "$ref": "#/definitions/kmsVersionResponse" 12910 } 12911 }, 12912 "default": { 12913 "description": "Generic error response.", 12914 "schema": { 12915 "$ref": "#/definitions/ApiError" 12916 } 12917 } 12918 } 12919 } 12920 }, 12921 "/ldap-entities": { 12922 "post": { 12923 "tags": [ 12924 "idp" 12925 ], 12926 "summary": "Get LDAP Entities", 12927 "operationId": "GetLDAPEntities", 12928 "parameters": [ 12929 { 12930 "name": "body", 12931 "in": "body", 12932 "required": true, 12933 "schema": { 12934 "$ref": "#/definitions/ldapEntitiesRequest" 12935 } 12936 } 12937 ], 12938 "responses": { 12939 "200": { 12940 "description": "A successful response.", 12941 "schema": { 12942 "$ref": "#/definitions/ldapEntities" 12943 } 12944 }, 12945 "default": { 12946 "description": "Generic error response.", 12947 "schema": { 12948 "$ref": "#/definitions/ApiError" 12949 } 12950 } 12951 } 12952 } 12953 }, 12954 "/list-external-buckets": { 12955 "post": { 12956 "tags": [ 12957 "Bucket" 12958 ], 12959 "summary": "Lists an External list of buckets using custom credentials", 12960 "operationId": "ListExternalBuckets", 12961 "parameters": [ 12962 { 12963 "name": "body", 12964 "in": "body", 12965 "required": true, 12966 "schema": { 12967 "$ref": "#/definitions/listExternalBucketsParams" 12968 } 12969 } 12970 ], 12971 "responses": { 12972 "200": { 12973 "description": "A successful response.", 12974 "schema": { 12975 "$ref": "#/definitions/listBucketsResponse" 12976 } 12977 }, 12978 "default": { 12979 "description": "Generic error response.", 12980 "schema": { 12981 "$ref": "#/definitions/ApiError" 12982 } 12983 } 12984 } 12985 } 12986 }, 12987 "/login": { 12988 "get": { 12989 "security": [], 12990 "tags": [ 12991 "Auth" 12992 ], 12993 "summary": "Returns login strategy, form or sso.", 12994 "operationId": "LoginDetail", 12995 "responses": { 12996 "200": { 12997 "description": "A successful response.", 12998 "schema": { 12999 "$ref": "#/definitions/loginDetails" 13000 } 13001 }, 13002 "default": { 13003 "description": "Generic error response.", 13004 "schema": { 13005 "$ref": "#/definitions/ApiError" 13006 } 13007 } 13008 } 13009 }, 13010 "post": { 13011 "security": [], 13012 "tags": [ 13013 "Auth" 13014 ], 13015 "summary": "Login to Console", 13016 "operationId": "Login", 13017 "parameters": [ 13018 { 13019 "name": "body", 13020 "in": "body", 13021 "required": true, 13022 "schema": { 13023 "$ref": "#/definitions/loginRequest" 13024 } 13025 } 13026 ], 13027 "responses": { 13028 "204": { 13029 "description": "A successful login." 13030 }, 13031 "default": { 13032 "description": "Generic error response.", 13033 "schema": { 13034 "$ref": "#/definitions/ApiError" 13035 } 13036 } 13037 } 13038 } 13039 }, 13040 "/login/oauth2/auth": { 13041 "post": { 13042 "security": [], 13043 "tags": [ 13044 "Auth" 13045 ], 13046 "summary": "Identity Provider oauth2 callback endpoint.", 13047 "operationId": "LoginOauth2Auth", 13048 "parameters": [ 13049 { 13050 "name": "body", 13051 "in": "body", 13052 "required": true, 13053 "schema": { 13054 "$ref": "#/definitions/loginOauth2AuthRequest" 13055 } 13056 } 13057 ], 13058 "responses": { 13059 "204": { 13060 "description": "A successful login." 13061 }, 13062 "default": { 13063 "description": "Generic error response.", 13064 "schema": { 13065 "$ref": "#/definitions/ApiError" 13066 } 13067 } 13068 } 13069 } 13070 }, 13071 "/logout": { 13072 "post": { 13073 "tags": [ 13074 "Auth" 13075 ], 13076 "summary": "Logout from Console.", 13077 "operationId": "Logout", 13078 "parameters": [ 13079 { 13080 "name": "body", 13081 "in": "body", 13082 "required": true, 13083 "schema": { 13084 "$ref": "#/definitions/logoutRequest" 13085 } 13086 } 13087 ], 13088 "responses": { 13089 "200": { 13090 "description": "A successful response." 13091 }, 13092 "default": { 13093 "description": "Generic error response.", 13094 "schema": { 13095 "$ref": "#/definitions/ApiError" 13096 } 13097 } 13098 } 13099 } 13100 }, 13101 "/logs/search": { 13102 "get": { 13103 "tags": [ 13104 "Logging" 13105 ], 13106 "summary": "Search the logs", 13107 "operationId": "LogSearch", 13108 "parameters": [ 13109 { 13110 "type": "array", 13111 "items": { 13112 "type": "string" 13113 }, 13114 "collectionFormat": "multi", 13115 "description": "Filter Parameters", 13116 "name": "fp", 13117 "in": "query" 13118 }, 13119 { 13120 "type": "number", 13121 "format": "int32", 13122 "default": 10, 13123 "name": "pageSize", 13124 "in": "query" 13125 }, 13126 { 13127 "type": "number", 13128 "format": "int32", 13129 "default": 0, 13130 "name": "pageNo", 13131 "in": "query" 13132 }, 13133 { 13134 "enum": [ 13135 "timeDesc", 13136 "timeAsc" 13137 ], 13138 "type": "string", 13139 "default": "timeDesc", 13140 "name": "order", 13141 "in": "query" 13142 }, 13143 { 13144 "type": "string", 13145 "name": "timeStart", 13146 "in": "query" 13147 }, 13148 { 13149 "type": "string", 13150 "name": "timeEnd", 13151 "in": "query" 13152 } 13153 ], 13154 "responses": { 13155 "200": { 13156 "description": "A successful response.", 13157 "schema": { 13158 "$ref": "#/definitions/logSearchResponse" 13159 } 13160 }, 13161 "default": { 13162 "description": "Generic error response.", 13163 "schema": { 13164 "$ref": "#/definitions/ApiError" 13165 } 13166 } 13167 } 13168 } 13169 }, 13170 "/nodes": { 13171 "get": { 13172 "tags": [ 13173 "System" 13174 ], 13175 "summary": "Lists Nodes", 13176 "operationId": "ListNodes", 13177 "responses": { 13178 "200": { 13179 "description": "A successful response.", 13180 "schema": { 13181 "type": "array", 13182 "items": { 13183 "type": "string" 13184 } 13185 } 13186 }, 13187 "default": { 13188 "description": "Generic error response.", 13189 "schema": { 13190 "$ref": "#/definitions/ApiError" 13191 } 13192 } 13193 } 13194 } 13195 }, 13196 "/policies": { 13197 "get": { 13198 "tags": [ 13199 "Policy" 13200 ], 13201 "summary": "List Policies", 13202 "operationId": "ListPolicies", 13203 "parameters": [ 13204 { 13205 "type": "number", 13206 "format": "int32", 13207 "default": 0, 13208 "name": "offset", 13209 "in": "query" 13210 }, 13211 { 13212 "type": "number", 13213 "format": "int32", 13214 "default": 20, 13215 "name": "limit", 13216 "in": "query" 13217 } 13218 ], 13219 "responses": { 13220 "200": { 13221 "description": "A successful response.", 13222 "schema": { 13223 "$ref": "#/definitions/listPoliciesResponse" 13224 } 13225 }, 13226 "default": { 13227 "description": "Generic error response.", 13228 "schema": { 13229 "$ref": "#/definitions/ApiError" 13230 } 13231 } 13232 } 13233 }, 13234 "post": { 13235 "tags": [ 13236 "Policy" 13237 ], 13238 "summary": "Add Policy", 13239 "operationId": "AddPolicy", 13240 "parameters": [ 13241 { 13242 "name": "body", 13243 "in": "body", 13244 "required": true, 13245 "schema": { 13246 "$ref": "#/definitions/addPolicyRequest" 13247 } 13248 } 13249 ], 13250 "responses": { 13251 "201": { 13252 "description": "A successful response.", 13253 "schema": { 13254 "$ref": "#/definitions/policy" 13255 } 13256 }, 13257 "default": { 13258 "description": "Generic error response.", 13259 "schema": { 13260 "$ref": "#/definitions/ApiError" 13261 } 13262 } 13263 } 13264 } 13265 }, 13266 "/policies/{policy}/groups": { 13267 "get": { 13268 "tags": [ 13269 "Policy" 13270 ], 13271 "summary": "List Groups for a Policy", 13272 "operationId": "ListGroupsForPolicy", 13273 "parameters": [ 13274 { 13275 "type": "string", 13276 "name": "policy", 13277 "in": "path", 13278 "required": true 13279 } 13280 ], 13281 "responses": { 13282 "200": { 13283 "description": "A successful response.", 13284 "schema": { 13285 "type": "array", 13286 "items": { 13287 "type": "string" 13288 } 13289 } 13290 }, 13291 "default": { 13292 "description": "Generic error response.", 13293 "schema": { 13294 "$ref": "#/definitions/ApiError" 13295 } 13296 } 13297 } 13298 } 13299 }, 13300 "/policies/{policy}/users": { 13301 "get": { 13302 "tags": [ 13303 "Policy" 13304 ], 13305 "summary": "List Users for a Policy", 13306 "operationId": "ListUsersForPolicy", 13307 "parameters": [ 13308 { 13309 "type": "string", 13310 "name": "policy", 13311 "in": "path", 13312 "required": true 13313 } 13314 ], 13315 "responses": { 13316 "200": { 13317 "description": "A successful response.", 13318 "schema": { 13319 "type": "array", 13320 "items": { 13321 "type": "string" 13322 } 13323 } 13324 }, 13325 "default": { 13326 "description": "Generic error response.", 13327 "schema": { 13328 "$ref": "#/definitions/ApiError" 13329 } 13330 } 13331 } 13332 } 13333 }, 13334 "/policy/{name}": { 13335 "get": { 13336 "tags": [ 13337 "Policy" 13338 ], 13339 "summary": "Policy info", 13340 "operationId": "PolicyInfo", 13341 "parameters": [ 13342 { 13343 "type": "string", 13344 "name": "name", 13345 "in": "path", 13346 "required": true 13347 } 13348 ], 13349 "responses": { 13350 "200": { 13351 "description": "A successful response.", 13352 "schema": { 13353 "$ref": "#/definitions/policy" 13354 } 13355 }, 13356 "default": { 13357 "description": "Generic error response.", 13358 "schema": { 13359 "$ref": "#/definitions/ApiError" 13360 } 13361 } 13362 } 13363 }, 13364 "delete": { 13365 "tags": [ 13366 "Policy" 13367 ], 13368 "summary": "Remove policy", 13369 "operationId": "RemovePolicy", 13370 "parameters": [ 13371 { 13372 "type": "string", 13373 "name": "name", 13374 "in": "path", 13375 "required": true 13376 } 13377 ], 13378 "responses": { 13379 "204": { 13380 "description": "A successful response." 13381 }, 13382 "default": { 13383 "description": "Generic error response.", 13384 "schema": { 13385 "$ref": "#/definitions/ApiError" 13386 } 13387 } 13388 } 13389 } 13390 }, 13391 "/profiling/start": { 13392 "post": { 13393 "tags": [ 13394 "Profile" 13395 ], 13396 "summary": "Start recording profile data", 13397 "operationId": "ProfilingStart", 13398 "parameters": [ 13399 { 13400 "name": "body", 13401 "in": "body", 13402 "required": true, 13403 "schema": { 13404 "$ref": "#/definitions/profilingStartRequest" 13405 } 13406 } 13407 ], 13408 "responses": { 13409 "201": { 13410 "description": "A successful response.", 13411 "schema": { 13412 "$ref": "#/definitions/startProfilingList" 13413 } 13414 }, 13415 "default": { 13416 "description": "Generic error response.", 13417 "schema": { 13418 "$ref": "#/definitions/ApiError" 13419 } 13420 } 13421 } 13422 } 13423 }, 13424 "/profiling/stop": { 13425 "post": { 13426 "produces": [ 13427 "application/zip" 13428 ], 13429 "tags": [ 13430 "Profile" 13431 ], 13432 "summary": "Stop and download profile data", 13433 "operationId": "ProfilingStop", 13434 "responses": { 13435 "201": { 13436 "description": "A successful response.", 13437 "schema": { 13438 "type": "file" 13439 } 13440 }, 13441 "default": { 13442 "description": "Generic error response.", 13443 "schema": { 13444 "$ref": "#/definitions/ApiError" 13445 } 13446 } 13447 } 13448 } 13449 }, 13450 "/releases": { 13451 "get": { 13452 "tags": [ 13453 "release" 13454 ], 13455 "summary": "Get repo releases for a given version", 13456 "operationId": "ListReleases", 13457 "parameters": [ 13458 { 13459 "type": "string", 13460 "description": "repo name", 13461 "name": "repo", 13462 "in": "query", 13463 "required": true 13464 }, 13465 { 13466 "type": "string", 13467 "description": "Current Release", 13468 "name": "current", 13469 "in": "query" 13470 }, 13471 { 13472 "type": "string", 13473 "description": "search content", 13474 "name": "search", 13475 "in": "query" 13476 }, 13477 { 13478 "type": "string", 13479 "description": "filter releases", 13480 "name": "filter", 13481 "in": "query" 13482 } 13483 ], 13484 "responses": { 13485 "200": { 13486 "description": "A successful response.", 13487 "schema": { 13488 "$ref": "#/definitions/releaseListResponse" 13489 } 13490 }, 13491 "default": { 13492 "description": "Generic error response.", 13493 "schema": { 13494 "$ref": "#/definitions/ApiError" 13495 } 13496 } 13497 } 13498 } 13499 }, 13500 "/remote-buckets": { 13501 "get": { 13502 "tags": [ 13503 "Bucket" 13504 ], 13505 "summary": "List Remote Buckets", 13506 "operationId": "ListRemoteBuckets", 13507 "responses": { 13508 "200": { 13509 "description": "A successful response.", 13510 "schema": { 13511 "$ref": "#/definitions/listRemoteBucketsResponse" 13512 } 13513 }, 13514 "default": { 13515 "description": "Generic error response.", 13516 "schema": { 13517 "$ref": "#/definitions/ApiError" 13518 } 13519 } 13520 } 13521 }, 13522 "post": { 13523 "tags": [ 13524 "Bucket" 13525 ], 13526 "summary": "Add Remote Bucket", 13527 "operationId": "AddRemoteBucket", 13528 "parameters": [ 13529 { 13530 "name": "body", 13531 "in": "body", 13532 "required": true, 13533 "schema": { 13534 "$ref": "#/definitions/createRemoteBucket" 13535 } 13536 } 13537 ], 13538 "responses": { 13539 "201": { 13540 "description": "A successful response." 13541 }, 13542 "default": { 13543 "description": "Generic error response.", 13544 "schema": { 13545 "$ref": "#/definitions/ApiError" 13546 } 13547 } 13548 } 13549 } 13550 }, 13551 "/remote-buckets/{name}": { 13552 "get": { 13553 "tags": [ 13554 "Bucket" 13555 ], 13556 "summary": "Remote Bucket Details", 13557 "operationId": "RemoteBucketDetails", 13558 "parameters": [ 13559 { 13560 "type": "string", 13561 "name": "name", 13562 "in": "path", 13563 "required": true 13564 } 13565 ], 13566 "responses": { 13567 "200": { 13568 "description": "A successful response.", 13569 "schema": { 13570 "$ref": "#/definitions/remoteBucket" 13571 } 13572 }, 13573 "default": { 13574 "description": "Generic error response.", 13575 "schema": { 13576 "$ref": "#/definitions/ApiError" 13577 } 13578 } 13579 } 13580 } 13581 }, 13582 "/remote-buckets/{source-bucket-name}/{arn}": { 13583 "delete": { 13584 "tags": [ 13585 "Bucket" 13586 ], 13587 "summary": "Delete Remote Bucket", 13588 "operationId": "DeleteRemoteBucket", 13589 "parameters": [ 13590 { 13591 "type": "string", 13592 "name": "source-bucket-name", 13593 "in": "path", 13594 "required": true 13595 }, 13596 { 13597 "type": "string", 13598 "name": "arn", 13599 "in": "path", 13600 "required": true 13601 } 13602 ], 13603 "responses": { 13604 "204": { 13605 "description": "A successful response." 13606 }, 13607 "default": { 13608 "description": "Generic error response.", 13609 "schema": { 13610 "$ref": "#/definitions/ApiError" 13611 } 13612 } 13613 } 13614 } 13615 }, 13616 "/service-account-credentials": { 13617 "post": { 13618 "tags": [ 13619 "ServiceAccount" 13620 ], 13621 "summary": "Create Service Account With Credentials", 13622 "operationId": "CreateServiceAccountCreds", 13623 "parameters": [ 13624 { 13625 "name": "body", 13626 "in": "body", 13627 "required": true, 13628 "schema": { 13629 "$ref": "#/definitions/serviceAccountRequestCreds" 13630 } 13631 } 13632 ], 13633 "responses": { 13634 "201": { 13635 "description": "A successful response.", 13636 "schema": { 13637 "$ref": "#/definitions/serviceAccountCreds" 13638 } 13639 }, 13640 "default": { 13641 "description": "Generic error response.", 13642 "schema": { 13643 "$ref": "#/definitions/ApiError" 13644 } 13645 } 13646 } 13647 } 13648 }, 13649 "/service-accounts": { 13650 "get": { 13651 "tags": [ 13652 "ServiceAccount" 13653 ], 13654 "summary": "List User's Service Accounts", 13655 "operationId": "ListUserServiceAccounts", 13656 "parameters": [ 13657 { 13658 "type": "number", 13659 "format": "int32", 13660 "default": 0, 13661 "name": "offset", 13662 "in": "query" 13663 }, 13664 { 13665 "type": "number", 13666 "format": "int32", 13667 "default": 20, 13668 "name": "limit", 13669 "in": "query" 13670 } 13671 ], 13672 "responses": { 13673 "200": { 13674 "description": "A successful response.", 13675 "schema": { 13676 "$ref": "#/definitions/serviceAccounts" 13677 } 13678 }, 13679 "default": { 13680 "description": "Generic error response.", 13681 "schema": { 13682 "$ref": "#/definitions/ApiError" 13683 } 13684 } 13685 } 13686 }, 13687 "post": { 13688 "tags": [ 13689 "ServiceAccount" 13690 ], 13691 "summary": "Create Service Account", 13692 "operationId": "CreateServiceAccount", 13693 "parameters": [ 13694 { 13695 "name": "body", 13696 "in": "body", 13697 "required": true, 13698 "schema": { 13699 "$ref": "#/definitions/serviceAccountRequest" 13700 } 13701 } 13702 ], 13703 "responses": { 13704 "201": { 13705 "description": "A successful response.", 13706 "schema": { 13707 "$ref": "#/definitions/serviceAccountCreds" 13708 } 13709 }, 13710 "default": { 13711 "description": "Generic error response.", 13712 "schema": { 13713 "$ref": "#/definitions/ApiError" 13714 } 13715 } 13716 } 13717 } 13718 }, 13719 "/service-accounts/delete-multi": { 13720 "delete": { 13721 "tags": [ 13722 "ServiceAccount" 13723 ], 13724 "summary": "Delete Multiple Service Accounts", 13725 "operationId": "DeleteMultipleServiceAccounts", 13726 "parameters": [ 13727 { 13728 "name": "selectedSA", 13729 "in": "body", 13730 "required": true, 13731 "schema": { 13732 "$ref": "#/definitions/selectedSAs" 13733 } 13734 } 13735 ], 13736 "responses": { 13737 "204": { 13738 "description": "A successful response." 13739 }, 13740 "default": { 13741 "description": "Generic error response.", 13742 "schema": { 13743 "$ref": "#/definitions/ApiError" 13744 } 13745 } 13746 } 13747 } 13748 }, 13749 "/service-accounts/{access_key}": { 13750 "get": { 13751 "tags": [ 13752 "ServiceAccount" 13753 ], 13754 "summary": "Get Service Account", 13755 "operationId": "GetServiceAccount", 13756 "parameters": [ 13757 { 13758 "type": "string", 13759 "name": "access_key", 13760 "in": "path", 13761 "required": true 13762 } 13763 ], 13764 "responses": { 13765 "200": { 13766 "description": "A successful response.", 13767 "schema": { 13768 "$ref": "#/definitions/serviceAccount" 13769 } 13770 }, 13771 "default": { 13772 "description": "Generic error response.", 13773 "schema": { 13774 "$ref": "#/definitions/ApiError" 13775 } 13776 } 13777 } 13778 }, 13779 "put": { 13780 "tags": [ 13781 "ServiceAccount" 13782 ], 13783 "summary": "Set Service Account Policy", 13784 "operationId": "UpdateServiceAccount", 13785 "parameters": [ 13786 { 13787 "type": "string", 13788 "name": "access_key", 13789 "in": "path", 13790 "required": true 13791 }, 13792 { 13793 "name": "body", 13794 "in": "body", 13795 "required": true, 13796 "schema": { 13797 "$ref": "#/definitions/updateServiceAccountRequest" 13798 } 13799 } 13800 ], 13801 "responses": { 13802 "200": { 13803 "description": "A successful response." 13804 }, 13805 "default": { 13806 "description": "Generic error response.", 13807 "schema": { 13808 "$ref": "#/definitions/ApiError" 13809 } 13810 } 13811 } 13812 }, 13813 "delete": { 13814 "tags": [ 13815 "ServiceAccount" 13816 ], 13817 "summary": "Delete Service Account", 13818 "operationId": "DeleteServiceAccount", 13819 "parameters": [ 13820 { 13821 "type": "string", 13822 "name": "access_key", 13823 "in": "path", 13824 "required": true 13825 } 13826 ], 13827 "responses": { 13828 "204": { 13829 "description": "A successful response." 13830 }, 13831 "default": { 13832 "description": "Generic error response.", 13833 "schema": { 13834 "$ref": "#/definitions/ApiError" 13835 } 13836 } 13837 } 13838 } 13839 }, 13840 "/service/restart": { 13841 "post": { 13842 "tags": [ 13843 "Service" 13844 ], 13845 "summary": "Restart Service", 13846 "operationId": "RestartService", 13847 "responses": { 13848 "204": { 13849 "description": "A successful response." 13850 }, 13851 "default": { 13852 "description": "Generic error response.", 13853 "schema": { 13854 "$ref": "#/definitions/ApiError" 13855 } 13856 } 13857 } 13858 } 13859 }, 13860 "/session": { 13861 "get": { 13862 "tags": [ 13863 "Auth" 13864 ], 13865 "summary": "Endpoint to check if your session is still valid", 13866 "operationId": "SessionCheck", 13867 "responses": { 13868 "200": { 13869 "description": "A successful response.", 13870 "schema": { 13871 "$ref": "#/definitions/sessionResponse" 13872 } 13873 }, 13874 "default": { 13875 "description": "Generic error response.", 13876 "schema": { 13877 "$ref": "#/definitions/ApiError" 13878 } 13879 } 13880 } 13881 } 13882 }, 13883 "/set-policy": { 13884 "put": { 13885 "tags": [ 13886 "Policy" 13887 ], 13888 "summary": "Set policy", 13889 "operationId": "SetPolicy", 13890 "parameters": [ 13891 { 13892 "name": "body", 13893 "in": "body", 13894 "required": true, 13895 "schema": { 13896 "$ref": "#/definitions/setPolicyNameRequest" 13897 } 13898 } 13899 ], 13900 "responses": { 13901 "204": { 13902 "description": "A successful response." 13903 }, 13904 "default": { 13905 "description": "Generic error response.", 13906 "schema": { 13907 "$ref": "#/definitions/ApiError" 13908 } 13909 } 13910 } 13911 } 13912 }, 13913 "/set-policy-multi": { 13914 "put": { 13915 "tags": [ 13916 "Policy" 13917 ], 13918 "summary": "Set policy to multiple users/groups", 13919 "operationId": "SetPolicyMultiple", 13920 "parameters": [ 13921 { 13922 "name": "body", 13923 "in": "body", 13924 "required": true, 13925 "schema": { 13926 "$ref": "#/definitions/setPolicyMultipleNameRequest" 13927 } 13928 } 13929 ], 13930 "responses": { 13931 "204": { 13932 "description": "A successful response." 13933 }, 13934 "default": { 13935 "description": "Generic error response.", 13936 "schema": { 13937 "$ref": "#/definitions/ApiError" 13938 } 13939 } 13940 } 13941 } 13942 }, 13943 "/subnet/apikey": { 13944 "get": { 13945 "tags": [ 13946 "Subnet" 13947 ], 13948 "summary": "Subnet api key", 13949 "operationId": "SubnetApiKey", 13950 "parameters": [ 13951 { 13952 "type": "string", 13953 "name": "token", 13954 "in": "query", 13955 "required": true 13956 } 13957 ], 13958 "responses": { 13959 "200": { 13960 "description": "A successful response.", 13961 "schema": { 13962 "$ref": "#/definitions/apiKey" 13963 } 13964 }, 13965 "default": { 13966 "description": "Generic error response.", 13967 "schema": { 13968 "$ref": "#/definitions/ApiError" 13969 } 13970 } 13971 } 13972 } 13973 }, 13974 "/subnet/info": { 13975 "get": { 13976 "tags": [ 13977 "Subnet" 13978 ], 13979 "summary": "Subnet info", 13980 "operationId": "SubnetInfo", 13981 "responses": { 13982 "200": { 13983 "description": "A successful response.", 13984 "schema": { 13985 "$ref": "#/definitions/license" 13986 } 13987 }, 13988 "default": { 13989 "description": "Generic error response.", 13990 "schema": { 13991 "$ref": "#/definitions/ApiError" 13992 } 13993 } 13994 } 13995 } 13996 }, 13997 "/subnet/login": { 13998 "post": { 13999 "tags": [ 14000 "Subnet" 14001 ], 14002 "summary": "Login to SUBNET", 14003 "operationId": "SubnetLogin", 14004 "parameters": [ 14005 { 14006 "name": "body", 14007 "in": "body", 14008 "required": true, 14009 "schema": { 14010 "$ref": "#/definitions/subnetLoginRequest" 14011 } 14012 } 14013 ], 14014 "responses": { 14015 "200": { 14016 "description": "A successful response.", 14017 "schema": { 14018 "$ref": "#/definitions/subnetLoginResponse" 14019 } 14020 }, 14021 "default": { 14022 "description": "Generic error response.", 14023 "schema": { 14024 "$ref": "#/definitions/ApiError" 14025 } 14026 } 14027 } 14028 } 14029 }, 14030 "/subnet/login/mfa": { 14031 "post": { 14032 "tags": [ 14033 "Subnet" 14034 ], 14035 "summary": "Login to SUBNET using mfa", 14036 "operationId": "SubnetLoginMFA", 14037 "parameters": [ 14038 { 14039 "name": "body", 14040 "in": "body", 14041 "required": true, 14042 "schema": { 14043 "$ref": "#/definitions/subnetLoginMFARequest" 14044 } 14045 } 14046 ], 14047 "responses": { 14048 "200": { 14049 "description": "A successful response.", 14050 "schema": { 14051 "$ref": "#/definitions/subnetLoginResponse" 14052 } 14053 }, 14054 "default": { 14055 "description": "Generic error response.", 14056 "schema": { 14057 "$ref": "#/definitions/ApiError" 14058 } 14059 } 14060 } 14061 } 14062 }, 14063 "/subnet/register": { 14064 "post": { 14065 "tags": [ 14066 "Subnet" 14067 ], 14068 "summary": "Register cluster with Subnet", 14069 "operationId": "SubnetRegister", 14070 "parameters": [ 14071 { 14072 "name": "body", 14073 "in": "body", 14074 "required": true, 14075 "schema": { 14076 "$ref": "#/definitions/subnetRegisterRequest" 14077 } 14078 } 14079 ], 14080 "responses": { 14081 "200": { 14082 "description": "A successful response." 14083 }, 14084 "default": { 14085 "description": "Generic error response.", 14086 "schema": { 14087 "$ref": "#/definitions/ApiError" 14088 } 14089 } 14090 } 14091 } 14092 }, 14093 "/subnet/registration-token": { 14094 "get": { 14095 "tags": [ 14096 "Subnet" 14097 ], 14098 "summary": "SUBNET registraton token", 14099 "operationId": "SubnetRegToken", 14100 "responses": { 14101 "200": { 14102 "description": "A successful response.", 14103 "schema": { 14104 "$ref": "#/definitions/SubnetRegTokenResponse" 14105 } 14106 }, 14107 "default": { 14108 "description": "Generic error response.", 14109 "schema": { 14110 "$ref": "#/definitions/ApiError" 14111 } 14112 } 14113 } 14114 } 14115 }, 14116 "/support/callhome": { 14117 "get": { 14118 "tags": [ 14119 "Support" 14120 ], 14121 "summary": "Get Callhome current status", 14122 "operationId": "GetCallHomeOptionValue", 14123 "responses": { 14124 "200": { 14125 "description": "A successful response.", 14126 "schema": { 14127 "$ref": "#/definitions/callHomeGetResponse" 14128 } 14129 }, 14130 "default": { 14131 "description": "Generic error response.", 14132 "schema": { 14133 "$ref": "#/definitions/ApiError" 14134 } 14135 } 14136 } 14137 }, 14138 "put": { 14139 "tags": [ 14140 "Support" 14141 ], 14142 "summary": "Sets callhome status", 14143 "operationId": "SetCallHomeStatus", 14144 "parameters": [ 14145 { 14146 "name": "body", 14147 "in": "body", 14148 "required": true, 14149 "schema": { 14150 "$ref": "#/definitions/callHomeSetStatus" 14151 } 14152 } 14153 ], 14154 "responses": { 14155 "204": { 14156 "description": "A successful response." 14157 }, 14158 "default": { 14159 "description": "Generic error response.", 14160 "schema": { 14161 "$ref": "#/definitions/ApiError" 14162 } 14163 } 14164 } 14165 } 14166 }, 14167 "/user/policy": { 14168 "get": { 14169 "tags": [ 14170 "Policy" 14171 ], 14172 "summary": "returns policies for logged in user", 14173 "operationId": "GetUserPolicy", 14174 "responses": { 14175 "200": { 14176 "description": "A successful response.", 14177 "schema": { 14178 "type": "string" 14179 } 14180 }, 14181 "default": { 14182 "description": "Generic error response.", 14183 "schema": { 14184 "$ref": "#/definitions/ApiError" 14185 } 14186 } 14187 } 14188 } 14189 }, 14190 "/user/{name}": { 14191 "get": { 14192 "tags": [ 14193 "User" 14194 ], 14195 "summary": "Get User Info", 14196 "operationId": "GetUserInfo", 14197 "parameters": [ 14198 { 14199 "type": "string", 14200 "name": "name", 14201 "in": "path", 14202 "required": true 14203 } 14204 ], 14205 "responses": { 14206 "200": { 14207 "description": "A successful response.", 14208 "schema": { 14209 "$ref": "#/definitions/user" 14210 } 14211 }, 14212 "default": { 14213 "description": "Generic error response.", 14214 "schema": { 14215 "$ref": "#/definitions/ApiError" 14216 } 14217 } 14218 } 14219 }, 14220 "put": { 14221 "tags": [ 14222 "User" 14223 ], 14224 "summary": "Update User Info", 14225 "operationId": "UpdateUserInfo", 14226 "parameters": [ 14227 { 14228 "type": "string", 14229 "name": "name", 14230 "in": "path", 14231 "required": true 14232 }, 14233 { 14234 "name": "body", 14235 "in": "body", 14236 "required": true, 14237 "schema": { 14238 "$ref": "#/definitions/updateUser" 14239 } 14240 } 14241 ], 14242 "responses": { 14243 "200": { 14244 "description": "A successful response.", 14245 "schema": { 14246 "$ref": "#/definitions/user" 14247 } 14248 }, 14249 "default": { 14250 "description": "Generic error response.", 14251 "schema": { 14252 "$ref": "#/definitions/ApiError" 14253 } 14254 } 14255 } 14256 }, 14257 "delete": { 14258 "tags": [ 14259 "User" 14260 ], 14261 "summary": "Remove user", 14262 "operationId": "RemoveUser", 14263 "parameters": [ 14264 { 14265 "type": "string", 14266 "name": "name", 14267 "in": "path", 14268 "required": true 14269 } 14270 ], 14271 "responses": { 14272 "204": { 14273 "description": "A successful response." 14274 }, 14275 "default": { 14276 "description": "Generic error response.", 14277 "schema": { 14278 "$ref": "#/definitions/ApiError" 14279 } 14280 } 14281 } 14282 } 14283 }, 14284 "/user/{name}/groups": { 14285 "put": { 14286 "tags": [ 14287 "User" 14288 ], 14289 "summary": "Update Groups for a user", 14290 "operationId": "UpdateUserGroups", 14291 "parameters": [ 14292 { 14293 "type": "string", 14294 "name": "name", 14295 "in": "path", 14296 "required": true 14297 }, 14298 { 14299 "name": "body", 14300 "in": "body", 14301 "required": true, 14302 "schema": { 14303 "$ref": "#/definitions/updateUserGroups" 14304 } 14305 } 14306 ], 14307 "responses": { 14308 "200": { 14309 "description": "A successful response.", 14310 "schema": { 14311 "$ref": "#/definitions/user" 14312 } 14313 }, 14314 "default": { 14315 "description": "Generic error response.", 14316 "schema": { 14317 "$ref": "#/definitions/ApiError" 14318 } 14319 } 14320 } 14321 } 14322 }, 14323 "/user/{name}/policies": { 14324 "get": { 14325 "tags": [ 14326 "Policy" 14327 ], 14328 "summary": "returns policies assigned for a specified user", 14329 "operationId": "GetSAUserPolicy", 14330 "parameters": [ 14331 { 14332 "type": "string", 14333 "name": "name", 14334 "in": "path", 14335 "required": true 14336 } 14337 ], 14338 "responses": { 14339 "200": { 14340 "description": "A successful response.", 14341 "schema": { 14342 "$ref": "#/definitions/aUserPolicyResponse" 14343 } 14344 }, 14345 "default": { 14346 "description": "Generic error response.", 14347 "schema": { 14348 "$ref": "#/definitions/ApiError" 14349 } 14350 } 14351 } 14352 } 14353 }, 14354 "/user/{name}/service-account-credentials": { 14355 "post": { 14356 "tags": [ 14357 "User" 14358 ], 14359 "summary": "Create Service Account for User With Credentials", 14360 "operationId": "CreateServiceAccountCredentials", 14361 "parameters": [ 14362 { 14363 "type": "string", 14364 "name": "name", 14365 "in": "path", 14366 "required": true 14367 }, 14368 { 14369 "name": "body", 14370 "in": "body", 14371 "required": true, 14372 "schema": { 14373 "$ref": "#/definitions/serviceAccountRequestCreds" 14374 } 14375 } 14376 ], 14377 "responses": { 14378 "201": { 14379 "description": "A successful response.", 14380 "schema": { 14381 "$ref": "#/definitions/serviceAccountCreds" 14382 } 14383 }, 14384 "default": { 14385 "description": "Generic error response.", 14386 "schema": { 14387 "$ref": "#/definitions/ApiError" 14388 } 14389 } 14390 } 14391 } 14392 }, 14393 "/user/{name}/service-accounts": { 14394 "get": { 14395 "tags": [ 14396 "User" 14397 ], 14398 "summary": "returns a list of service accounts for a user", 14399 "operationId": "ListAUserServiceAccounts", 14400 "parameters": [ 14401 { 14402 "type": "string", 14403 "name": "name", 14404 "in": "path", 14405 "required": true 14406 } 14407 ], 14408 "responses": { 14409 "200": { 14410 "description": "A successful response.", 14411 "schema": { 14412 "$ref": "#/definitions/serviceAccounts" 14413 } 14414 }, 14415 "default": { 14416 "description": "Generic error response.", 14417 "schema": { 14418 "$ref": "#/definitions/ApiError" 14419 } 14420 } 14421 } 14422 }, 14423 "post": { 14424 "tags": [ 14425 "User" 14426 ], 14427 "summary": "Create Service Account for User", 14428 "operationId": "CreateAUserServiceAccount", 14429 "parameters": [ 14430 { 14431 "type": "string", 14432 "name": "name", 14433 "in": "path", 14434 "required": true 14435 }, 14436 { 14437 "name": "body", 14438 "in": "body", 14439 "required": true, 14440 "schema": { 14441 "$ref": "#/definitions/serviceAccountRequest" 14442 } 14443 } 14444 ], 14445 "responses": { 14446 "201": { 14447 "description": "A successful response.", 14448 "schema": { 14449 "$ref": "#/definitions/serviceAccountCreds" 14450 } 14451 }, 14452 "default": { 14453 "description": "Generic error response.", 14454 "schema": { 14455 "$ref": "#/definitions/ApiError" 14456 } 14457 } 14458 } 14459 } 14460 }, 14461 "/users": { 14462 "get": { 14463 "tags": [ 14464 "User" 14465 ], 14466 "summary": "List Users", 14467 "operationId": "ListUsers", 14468 "parameters": [ 14469 { 14470 "type": "number", 14471 "format": "int32", 14472 "default": 0, 14473 "name": "offset", 14474 "in": "query" 14475 }, 14476 { 14477 "type": "number", 14478 "format": "int32", 14479 "default": 20, 14480 "name": "limit", 14481 "in": "query" 14482 } 14483 ], 14484 "responses": { 14485 "200": { 14486 "description": "A successful response.", 14487 "schema": { 14488 "$ref": "#/definitions/listUsersResponse" 14489 } 14490 }, 14491 "default": { 14492 "description": "Generic error response.", 14493 "schema": { 14494 "$ref": "#/definitions/ApiError" 14495 } 14496 } 14497 } 14498 }, 14499 "post": { 14500 "tags": [ 14501 "User" 14502 ], 14503 "summary": "Add User", 14504 "operationId": "AddUser", 14505 "parameters": [ 14506 { 14507 "name": "body", 14508 "in": "body", 14509 "required": true, 14510 "schema": { 14511 "$ref": "#/definitions/addUserRequest" 14512 } 14513 } 14514 ], 14515 "responses": { 14516 "201": { 14517 "description": "A successful response.", 14518 "schema": { 14519 "$ref": "#/definitions/user" 14520 } 14521 }, 14522 "default": { 14523 "description": "Generic error response.", 14524 "schema": { 14525 "$ref": "#/definitions/ApiError" 14526 } 14527 } 14528 } 14529 } 14530 }, 14531 "/users-groups-bulk": { 14532 "put": { 14533 "tags": [ 14534 "User" 14535 ], 14536 "summary": "Bulk functionality to Add Users to Groups", 14537 "operationId": "BulkUpdateUsersGroups", 14538 "parameters": [ 14539 { 14540 "name": "body", 14541 "in": "body", 14542 "required": true, 14543 "schema": { 14544 "$ref": "#/definitions/bulkUserGroups" 14545 } 14546 } 14547 ], 14548 "responses": { 14549 "200": { 14550 "description": "A successful response." 14551 }, 14552 "default": { 14553 "description": "Generic error response.", 14554 "schema": { 14555 "$ref": "#/definitions/ApiError" 14556 } 14557 } 14558 } 14559 } 14560 }, 14561 "/users/service-accounts": { 14562 "post": { 14563 "tags": [ 14564 "User" 14565 ], 14566 "summary": "Check number of service accounts for each user specified", 14567 "operationId": "CheckUserServiceAccounts", 14568 "parameters": [ 14569 { 14570 "name": "selectedUsers", 14571 "in": "body", 14572 "required": true, 14573 "schema": { 14574 "$ref": "#/definitions/selectedUsers" 14575 } 14576 } 14577 ], 14578 "responses": { 14579 "200": { 14580 "description": "A successful response.", 14581 "schema": { 14582 "$ref": "#/definitions/userServiceAccountSummary" 14583 } 14584 }, 14585 "default": { 14586 "description": "Generic error response.", 14587 "schema": { 14588 "$ref": "#/definitions/ApiError" 14589 } 14590 } 14591 } 14592 } 14593 } 14594 }, 14595 "definitions": { 14596 "ApiError": { 14597 "type": "object", 14598 "properties": { 14599 "detailedMessage": { 14600 "type": "string" 14601 }, 14602 "message": { 14603 "type": "string" 14604 } 14605 } 14606 }, 14607 "BackendProperties": { 14608 "type": "object", 14609 "properties": { 14610 "backendType": { 14611 "type": "string" 14612 }, 14613 "offlineDrives": { 14614 "type": "integer" 14615 }, 14616 "onlineDrives": { 14617 "type": "integer" 14618 }, 14619 "rrSCParity": { 14620 "type": "integer" 14621 }, 14622 "standardSCParity": { 14623 "type": "integer" 14624 } 14625 } 14626 }, 14627 "BucketDetails": { 14628 "type": "object", 14629 "properties": { 14630 "locking": { 14631 "type": "boolean" 14632 }, 14633 "quota": { 14634 "type": "object", 14635 "properties": { 14636 "quota": { 14637 "type": "integer", 14638 "format": "int64" 14639 }, 14640 "type": { 14641 "type": "string", 14642 "enum": [ 14643 "hard" 14644 ] 14645 } 14646 } 14647 }, 14648 "replication": { 14649 "type": "boolean" 14650 }, 14651 "tags": { 14652 "type": "object", 14653 "additionalProperties": { 14654 "type": "string" 14655 } 14656 }, 14657 "versioning": { 14658 "type": "boolean" 14659 }, 14660 "versioningSuspended": { 14661 "type": "boolean" 14662 } 14663 } 14664 }, 14665 "BucketDetailsQuota": { 14666 "type": "object", 14667 "properties": { 14668 "quota": { 14669 "type": "integer", 14670 "format": "int64" 14671 }, 14672 "type": { 14673 "type": "string", 14674 "enum": [ 14675 "hard" 14676 ] 14677 } 14678 } 14679 }, 14680 "BucketRwAccess": { 14681 "type": "object", 14682 "properties": { 14683 "read": { 14684 "type": "boolean" 14685 }, 14686 "write": { 14687 "type": "boolean" 14688 } 14689 } 14690 }, 14691 "BucketVersioningResponseExcludedPrefixesItems0": { 14692 "type": "object", 14693 "properties": { 14694 "prefix": { 14695 "type": "string" 14696 } 14697 } 14698 }, 14699 "LoginRequestFeatures": { 14700 "type": "object", 14701 "properties": { 14702 "hide_menu": { 14703 "type": "boolean" 14704 } 14705 } 14706 }, 14707 "ServiceAccountsItems0": { 14708 "type": "object", 14709 "properties": { 14710 "accessKey": { 14711 "type": "string" 14712 }, 14713 "accountStatus": { 14714 "type": "string" 14715 }, 14716 "description": { 14717 "type": "string" 14718 }, 14719 "expiration": { 14720 "type": "string" 14721 }, 14722 "name": { 14723 "type": "string" 14724 } 14725 } 14726 }, 14727 "SubnetRegTokenResponse": { 14728 "type": "object", 14729 "properties": { 14730 "regToken": { 14731 "type": "string" 14732 } 14733 } 14734 }, 14735 "WidgetDetailsOptions": { 14736 "type": "object", 14737 "properties": { 14738 "reduceOptions": { 14739 "type": "object", 14740 "properties": { 14741 "calcs": { 14742 "type": "array", 14743 "items": { 14744 "type": "string" 14745 } 14746 } 14747 } 14748 } 14749 } 14750 }, 14751 "WidgetDetailsOptionsReduceOptions": { 14752 "type": "object", 14753 "properties": { 14754 "calcs": { 14755 "type": "array", 14756 "items": { 14757 "type": "string" 14758 } 14759 } 14760 } 14761 }, 14762 "WidgetOptions": { 14763 "type": "object", 14764 "properties": { 14765 "reduceOptions": { 14766 "type": "object", 14767 "properties": { 14768 "calcs": { 14769 "type": "array", 14770 "items": { 14771 "type": "string" 14772 } 14773 } 14774 } 14775 } 14776 } 14777 }, 14778 "WidgetOptionsReduceOptions": { 14779 "type": "object", 14780 "properties": { 14781 "calcs": { 14782 "type": "array", 14783 "items": { 14784 "type": "string" 14785 } 14786 } 14787 } 14788 }, 14789 "aUserPolicyResponse": { 14790 "type": "object", 14791 "properties": { 14792 "policy": { 14793 "type": "string" 14794 } 14795 } 14796 }, 14797 "accessRule": { 14798 "type": "object", 14799 "properties": { 14800 "access": { 14801 "type": "string" 14802 }, 14803 "prefix": { 14804 "type": "string" 14805 } 14806 } 14807 }, 14808 "accountChangePasswordRequest": { 14809 "type": "object", 14810 "required": [ 14811 "current_secret_key", 14812 "new_secret_key" 14813 ], 14814 "properties": { 14815 "current_secret_key": { 14816 "type": "string" 14817 }, 14818 "new_secret_key": { 14819 "type": "string" 14820 } 14821 } 14822 }, 14823 "addBucketLifecycle": { 14824 "type": "object", 14825 "properties": { 14826 "disable": { 14827 "description": "Non required, toggle to disable or enable rule", 14828 "type": "boolean" 14829 }, 14830 "expired_object_delete_all": { 14831 "description": "Non required, toggle to disable or enable rule", 14832 "type": "boolean" 14833 }, 14834 "expired_object_delete_marker": { 14835 "description": "Non required, toggle to disable or enable rule", 14836 "type": "boolean" 14837 }, 14838 "expiry_days": { 14839 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 14840 "type": "integer", 14841 "format": "int32", 14842 "default": 0 14843 }, 14844 "newer_noncurrentversion_expiration_versions": { 14845 "description": "Non required, can be set in case of expiration is enabled", 14846 "type": "integer", 14847 "format": "int32", 14848 "default": 0 14849 }, 14850 "noncurrentversion_expiration_days": { 14851 "description": "Non required, can be set in case of expiration is enabled", 14852 "type": "integer", 14853 "format": "int32", 14854 "default": 0 14855 }, 14856 "noncurrentversion_transition_days": { 14857 "description": "Non required, can be set in case of transition is enabled", 14858 "type": "integer", 14859 "format": "int32", 14860 "default": 0 14861 }, 14862 "noncurrentversion_transition_storage_class": { 14863 "description": "Non required, can be set in case of transition is enabled", 14864 "type": "string" 14865 }, 14866 "prefix": { 14867 "description": "Non required field, it matches a prefix to perform ILM operations on it", 14868 "type": "string" 14869 }, 14870 "storage_class": { 14871 "description": "Required only in case of transition is set. it refers to a tier", 14872 "type": "string" 14873 }, 14874 "tags": { 14875 "description": "Non required field, tags to match ILM files", 14876 "type": "string" 14877 }, 14878 "transition_days": { 14879 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 14880 "type": "integer", 14881 "format": "int32", 14882 "default": 0 14883 }, 14884 "type": { 14885 "description": "ILM Rule type (Expiry or transition)", 14886 "type": "string", 14887 "enum": [ 14888 "expiry", 14889 "transition" 14890 ] 14891 } 14892 } 14893 }, 14894 "addBucketReplication": { 14895 "type": "object", 14896 "properties": { 14897 "arn": { 14898 "type": "string" 14899 }, 14900 "destination_bucket": { 14901 "type": "string" 14902 } 14903 } 14904 }, 14905 "addGroupRequest": { 14906 "type": "object", 14907 "required": [ 14908 "group", 14909 "members" 14910 ], 14911 "properties": { 14912 "group": { 14913 "type": "string" 14914 }, 14915 "members": { 14916 "type": "array", 14917 "items": { 14918 "type": "string" 14919 } 14920 } 14921 } 14922 }, 14923 "addMultiBucketLifecycle": { 14924 "type": "object", 14925 "required": [ 14926 "buckets", 14927 "type" 14928 ], 14929 "properties": { 14930 "buckets": { 14931 "type": "array", 14932 "items": { 14933 "type": "string" 14934 } 14935 }, 14936 "expired_object_delete_all": { 14937 "description": "Non required, toggle to disable or enable rule", 14938 "type": "boolean" 14939 }, 14940 "expired_object_delete_marker": { 14941 "description": "Non required, toggle to disable or enable rule", 14942 "type": "boolean" 14943 }, 14944 "expiry_days": { 14945 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 14946 "type": "integer", 14947 "format": "int32", 14948 "default": 0 14949 }, 14950 "noncurrentversion_expiration_days": { 14951 "description": "Non required, can be set in case of expiration is enabled", 14952 "type": "integer", 14953 "format": "int32", 14954 "default": 0 14955 }, 14956 "noncurrentversion_transition_days": { 14957 "description": "Non required, can be set in case of transition is enabled", 14958 "type": "integer", 14959 "format": "int32", 14960 "default": 0 14961 }, 14962 "noncurrentversion_transition_storage_class": { 14963 "description": "Non required, can be set in case of transition is enabled", 14964 "type": "string" 14965 }, 14966 "prefix": { 14967 "description": "Non required field, it matches a prefix to perform ILM operations on it", 14968 "type": "string" 14969 }, 14970 "storage_class": { 14971 "description": "Required only in case of transition is set. it refers to a tier", 14972 "type": "string" 14973 }, 14974 "tags": { 14975 "description": "Non required field, tags to match ILM files", 14976 "type": "string" 14977 }, 14978 "transition_days": { 14979 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 14980 "type": "integer", 14981 "format": "int32", 14982 "default": 0 14983 }, 14984 "type": { 14985 "description": "ILM Rule type (Expiry or transition)", 14986 "type": "string", 14987 "enum": [ 14988 "expiry", 14989 "transition" 14990 ] 14991 } 14992 } 14993 }, 14994 "addPolicyRequest": { 14995 "type": "object", 14996 "required": [ 14997 "name", 14998 "policy" 14999 ], 15000 "properties": { 15001 "name": { 15002 "type": "string" 15003 }, 15004 "policy": { 15005 "type": "string" 15006 } 15007 } 15008 }, 15009 "addUserRequest": { 15010 "type": "object", 15011 "required": [ 15012 "accessKey", 15013 "secretKey", 15014 "groups", 15015 "policies" 15016 ], 15017 "properties": { 15018 "accessKey": { 15019 "type": "string" 15020 }, 15021 "groups": { 15022 "type": "array", 15023 "items": { 15024 "type": "string" 15025 } 15026 }, 15027 "policies": { 15028 "type": "array", 15029 "items": { 15030 "type": "string" 15031 } 15032 }, 15033 "secretKey": { 15034 "type": "string" 15035 } 15036 } 15037 }, 15038 "adminInfoResponse": { 15039 "type": "object", 15040 "properties": { 15041 "advancedMetricsStatus": { 15042 "type": "string", 15043 "enum": [ 15044 "not configured", 15045 "available", 15046 "unavailable" 15047 ] 15048 }, 15049 "backend": { 15050 "$ref": "#/definitions/BackendProperties" 15051 }, 15052 "buckets": { 15053 "type": "integer" 15054 }, 15055 "objects": { 15056 "type": "integer" 15057 }, 15058 "servers": { 15059 "type": "array", 15060 "items": { 15061 "$ref": "#/definitions/serverProperties" 15062 } 15063 }, 15064 "usage": { 15065 "type": "integer" 15066 }, 15067 "widgets": { 15068 "type": "array", 15069 "items": { 15070 "$ref": "#/definitions/widget" 15071 } 15072 } 15073 } 15074 }, 15075 "apiKey": { 15076 "type": "object", 15077 "properties": { 15078 "apiKey": { 15079 "type": "string" 15080 } 15081 } 15082 }, 15083 "arnsResponse": { 15084 "type": "object", 15085 "properties": { 15086 "arns": { 15087 "type": "array", 15088 "items": { 15089 "type": "string" 15090 } 15091 } 15092 } 15093 }, 15094 "bucket": { 15095 "type": "object", 15096 "required": [ 15097 "name" 15098 ], 15099 "properties": { 15100 "access": { 15101 "$ref": "#/definitions/bucketAccess" 15102 }, 15103 "creation_date": { 15104 "type": "string" 15105 }, 15106 "definition": { 15107 "type": "string" 15108 }, 15109 "details": { 15110 "type": "object", 15111 "properties": { 15112 "locking": { 15113 "type": "boolean" 15114 }, 15115 "quota": { 15116 "type": "object", 15117 "properties": { 15118 "quota": { 15119 "type": "integer", 15120 "format": "int64" 15121 }, 15122 "type": { 15123 "type": "string", 15124 "enum": [ 15125 "hard" 15126 ] 15127 } 15128 } 15129 }, 15130 "replication": { 15131 "type": "boolean" 15132 }, 15133 "tags": { 15134 "type": "object", 15135 "additionalProperties": { 15136 "type": "string" 15137 } 15138 }, 15139 "versioning": { 15140 "type": "boolean" 15141 }, 15142 "versioningSuspended": { 15143 "type": "boolean" 15144 } 15145 } 15146 }, 15147 "name": { 15148 "type": "string", 15149 "minLength": 3 15150 }, 15151 "objects": { 15152 "type": "integer", 15153 "format": "int64" 15154 }, 15155 "rw_access": { 15156 "type": "object", 15157 "properties": { 15158 "read": { 15159 "type": "boolean" 15160 }, 15161 "write": { 15162 "type": "boolean" 15163 } 15164 } 15165 }, 15166 "size": { 15167 "type": "integer", 15168 "format": "int64" 15169 } 15170 } 15171 }, 15172 "bucketAccess": { 15173 "type": "string", 15174 "default": "PRIVATE", 15175 "enum": [ 15176 "PRIVATE", 15177 "PUBLIC", 15178 "CUSTOM" 15179 ] 15180 }, 15181 "bucketEncryptionInfo": { 15182 "type": "object", 15183 "properties": { 15184 "algorithm": { 15185 "type": "string" 15186 }, 15187 "kmsMasterKeyID": { 15188 "type": "string" 15189 } 15190 } 15191 }, 15192 "bucketEncryptionRequest": { 15193 "type": "object", 15194 "properties": { 15195 "encType": { 15196 "$ref": "#/definitions/bucketEncryptionType" 15197 }, 15198 "kmsKeyID": { 15199 "type": "string" 15200 } 15201 } 15202 }, 15203 "bucketEncryptionType": { 15204 "type": "string", 15205 "default": "sse-s3", 15206 "enum": [ 15207 "sse-s3", 15208 "sse-kms" 15209 ] 15210 }, 15211 "bucketEventRequest": { 15212 "type": "object", 15213 "required": [ 15214 "configuration" 15215 ], 15216 "properties": { 15217 "configuration": { 15218 "$ref": "#/definitions/notificationConfig" 15219 }, 15220 "ignoreExisting": { 15221 "type": "boolean" 15222 } 15223 } 15224 }, 15225 "bucketLifecycleResponse": { 15226 "type": "object", 15227 "properties": { 15228 "lifecycle": { 15229 "type": "array", 15230 "items": { 15231 "$ref": "#/definitions/objectBucketLifecycle" 15232 } 15233 } 15234 } 15235 }, 15236 "bucketObLockingResponse": { 15237 "type": "object", 15238 "properties": { 15239 "object_locking_enabled": { 15240 "type": "boolean" 15241 } 15242 } 15243 }, 15244 "bucketObject": { 15245 "type": "object", 15246 "properties": { 15247 "content_type": { 15248 "type": "string" 15249 }, 15250 "etag": { 15251 "type": "string" 15252 }, 15253 "expiration": { 15254 "type": "string" 15255 }, 15256 "expiration_rule_id": { 15257 "type": "string" 15258 }, 15259 "is_delete_marker": { 15260 "type": "boolean" 15261 }, 15262 "is_latest": { 15263 "type": "boolean" 15264 }, 15265 "last_modified": { 15266 "type": "string" 15267 }, 15268 "legal_hold_status": { 15269 "type": "string" 15270 }, 15271 "metadata": { 15272 "type": "object", 15273 "additionalProperties": { 15274 "type": "string" 15275 } 15276 }, 15277 "name": { 15278 "type": "string" 15279 }, 15280 "retention_mode": { 15281 "type": "string" 15282 }, 15283 "retention_until_date": { 15284 "type": "string" 15285 }, 15286 "size": { 15287 "type": "integer", 15288 "format": "int64" 15289 }, 15290 "tags": { 15291 "type": "object", 15292 "additionalProperties": { 15293 "type": "string" 15294 } 15295 }, 15296 "user_metadata": { 15297 "type": "object", 15298 "additionalProperties": { 15299 "type": "string" 15300 } 15301 }, 15302 "user_tags": { 15303 "type": "object", 15304 "additionalProperties": { 15305 "type": "string" 15306 } 15307 }, 15308 "version_id": { 15309 "type": "string" 15310 } 15311 } 15312 }, 15313 "bucketQuota": { 15314 "type": "object", 15315 "properties": { 15316 "quota": { 15317 "type": "integer" 15318 }, 15319 "type": { 15320 "type": "string", 15321 "enum": [ 15322 "hard" 15323 ] 15324 } 15325 } 15326 }, 15327 "bucketReplicationDestination": { 15328 "type": "object", 15329 "properties": { 15330 "bucket": { 15331 "type": "string" 15332 } 15333 } 15334 }, 15335 "bucketReplicationResponse": { 15336 "type": "object", 15337 "properties": { 15338 "rules": { 15339 "type": "array", 15340 "items": { 15341 "$ref": "#/definitions/bucketReplicationRule" 15342 } 15343 } 15344 } 15345 }, 15346 "bucketReplicationRule": { 15347 "type": "object", 15348 "properties": { 15349 "bandwidth": { 15350 "type": "string" 15351 }, 15352 "delete_marker_replication": { 15353 "type": "boolean" 15354 }, 15355 "deletes_replication": { 15356 "type": "boolean" 15357 }, 15358 "destination": { 15359 "$ref": "#/definitions/bucketReplicationDestination" 15360 }, 15361 "existingObjects": { 15362 "type": "boolean" 15363 }, 15364 "healthCheckPeriod": { 15365 "type": "integer" 15366 }, 15367 "id": { 15368 "type": "string" 15369 }, 15370 "metadata_replication": { 15371 "type": "boolean" 15372 }, 15373 "prefix": { 15374 "type": "string" 15375 }, 15376 "priority": { 15377 "type": "integer", 15378 "format": "int32" 15379 }, 15380 "status": { 15381 "type": "string", 15382 "enum": [ 15383 "Enabled", 15384 "Disabled" 15385 ] 15386 }, 15387 "storageClass": { 15388 "type": "string" 15389 }, 15390 "syncMode": { 15391 "type": "string", 15392 "default": "async", 15393 "enum": [ 15394 "async", 15395 "sync" 15396 ] 15397 }, 15398 "tags": { 15399 "type": "string" 15400 } 15401 } 15402 }, 15403 "bucketReplicationRuleList": { 15404 "type": "object", 15405 "properties": { 15406 "rules": { 15407 "type": "array", 15408 "items": { 15409 "type": "string" 15410 } 15411 } 15412 } 15413 }, 15414 "bucketVersioningResponse": { 15415 "type": "object", 15416 "properties": { 15417 "MFADelete": { 15418 "type": "string" 15419 }, 15420 "excludeFolders": { 15421 "type": "boolean" 15422 }, 15423 "excludedPrefixes": { 15424 "type": "array", 15425 "items": { 15426 "$ref": "#/definitions/BucketVersioningResponseExcludedPrefixesItems0" 15427 } 15428 }, 15429 "status": { 15430 "type": "string" 15431 } 15432 } 15433 }, 15434 "bulkUserGroups": { 15435 "type": "object", 15436 "required": [ 15437 "users", 15438 "groups" 15439 ], 15440 "properties": { 15441 "groups": { 15442 "type": "array", 15443 "items": { 15444 "type": "string" 15445 } 15446 }, 15447 "users": { 15448 "type": "array", 15449 "items": { 15450 "type": "string" 15451 } 15452 } 15453 } 15454 }, 15455 "callHomeGetResponse": { 15456 "type": "object", 15457 "properties": { 15458 "diagnosticsStatus": { 15459 "type": "boolean" 15460 }, 15461 "logsStatus": { 15462 "type": "boolean" 15463 } 15464 } 15465 }, 15466 "callHomeSetStatus": { 15467 "type": "object", 15468 "required": [ 15469 "diagState", 15470 "logsState" 15471 ], 15472 "properties": { 15473 "diagState": { 15474 "type": "boolean" 15475 }, 15476 "logsState": { 15477 "type": "boolean" 15478 } 15479 } 15480 }, 15481 "changeUserPasswordRequest": { 15482 "type": "object", 15483 "required": [ 15484 "selectedUser", 15485 "newSecretKey" 15486 ], 15487 "properties": { 15488 "newSecretKey": { 15489 "type": "string" 15490 }, 15491 "selectedUser": { 15492 "type": "string" 15493 } 15494 } 15495 }, 15496 "configDescription": { 15497 "type": "object", 15498 "properties": { 15499 "description": { 15500 "type": "string" 15501 }, 15502 "key": { 15503 "type": "string" 15504 } 15505 } 15506 }, 15507 "configExportResponse": { 15508 "type": "object", 15509 "properties": { 15510 "status": { 15511 "type": "string" 15512 }, 15513 "value": { 15514 "description": "Returns base64 encoded value", 15515 "type": "string" 15516 } 15517 } 15518 }, 15519 "configuration": { 15520 "type": "object", 15521 "properties": { 15522 "key_values": { 15523 "type": "array", 15524 "items": { 15525 "$ref": "#/definitions/configurationKV" 15526 } 15527 }, 15528 "name": { 15529 "type": "string" 15530 } 15531 } 15532 }, 15533 "configurationKV": { 15534 "type": "object", 15535 "properties": { 15536 "env_override": { 15537 "$ref": "#/definitions/envOverride" 15538 }, 15539 "key": { 15540 "type": "string" 15541 }, 15542 "value": { 15543 "type": "string" 15544 } 15545 } 15546 }, 15547 "createRemoteBucket": { 15548 "required": [ 15549 "accessKey", 15550 "secretKey", 15551 "targetURL", 15552 "sourceBucket", 15553 "targetBucket" 15554 ], 15555 "properties": { 15556 "accessKey": { 15557 "type": "string", 15558 "minLength": 3 15559 }, 15560 "bandwidth": { 15561 "type": "integer", 15562 "format": "int64" 15563 }, 15564 "healthCheckPeriod": { 15565 "type": "integer", 15566 "format": "int32" 15567 }, 15568 "region": { 15569 "type": "string" 15570 }, 15571 "secretKey": { 15572 "type": "string", 15573 "minLength": 8 15574 }, 15575 "sourceBucket": { 15576 "type": "string" 15577 }, 15578 "syncMode": { 15579 "type": "string", 15580 "default": "async", 15581 "enum": [ 15582 "async", 15583 "sync" 15584 ] 15585 }, 15586 "targetBucket": { 15587 "type": "string" 15588 }, 15589 "targetURL": { 15590 "type": "string" 15591 } 15592 } 15593 }, 15594 "deleteFile": { 15595 "type": "object", 15596 "properties": { 15597 "path": { 15598 "type": "string" 15599 }, 15600 "recursive": { 15601 "type": "boolean" 15602 }, 15603 "versionID": { 15604 "type": "string" 15605 } 15606 } 15607 }, 15608 "envOverride": { 15609 "type": "object", 15610 "properties": { 15611 "name": { 15612 "type": "string" 15613 }, 15614 "value": { 15615 "type": "string" 15616 } 15617 } 15618 }, 15619 "environmentConstants": { 15620 "type": "object", 15621 "properties": { 15622 "maxConcurrentDownloads": { 15623 "type": "integer" 15624 }, 15625 "maxConcurrentUploads": { 15626 "type": "integer" 15627 } 15628 } 15629 }, 15630 "expirationResponse": { 15631 "type": "object", 15632 "properties": { 15633 "date": { 15634 "type": "string" 15635 }, 15636 "days": { 15637 "type": "integer", 15638 "format": "int64" 15639 }, 15640 "delete_all": { 15641 "type": "boolean" 15642 }, 15643 "delete_marker": { 15644 "type": "boolean" 15645 }, 15646 "newer_noncurrent_expiration_versions": { 15647 "type": "integer", 15648 "format": "int64" 15649 }, 15650 "noncurrent_expiration_days": { 15651 "type": "integer", 15652 "format": "int64" 15653 } 15654 } 15655 }, 15656 "getBucketRetentionConfig": { 15657 "type": "object", 15658 "properties": { 15659 "mode": { 15660 "$ref": "#/definitions/objectRetentionMode" 15661 }, 15662 "unit": { 15663 "$ref": "#/definitions/objectRetentionUnit" 15664 }, 15665 "validity": { 15666 "type": "integer", 15667 "format": "int32" 15668 } 15669 } 15670 }, 15671 "group": { 15672 "type": "object", 15673 "properties": { 15674 "members": { 15675 "type": "array", 15676 "items": { 15677 "type": "string" 15678 } 15679 }, 15680 "name": { 15681 "type": "string" 15682 }, 15683 "policy": { 15684 "type": "string" 15685 }, 15686 "status": { 15687 "type": "string" 15688 } 15689 } 15690 }, 15691 "iamEntity": { 15692 "type": "string", 15693 "pattern": "^[\\w+=,.@-]{1,64}$" 15694 }, 15695 "iamPolicy": { 15696 "type": "object", 15697 "properties": { 15698 "statement": { 15699 "type": "array", 15700 "items": { 15701 "$ref": "#/definitions/iamPolicyStatement" 15702 } 15703 }, 15704 "version": { 15705 "type": "string" 15706 } 15707 } 15708 }, 15709 "iamPolicyStatement": { 15710 "type": "object", 15711 "properties": { 15712 "action": { 15713 "type": "array", 15714 "items": { 15715 "type": "string" 15716 } 15717 }, 15718 "condition": { 15719 "type": "object", 15720 "additionalProperties": { 15721 "type": "object" 15722 } 15723 }, 15724 "effect": { 15725 "type": "string" 15726 }, 15727 "resource": { 15728 "type": "array", 15729 "items": { 15730 "type": "string" 15731 } 15732 } 15733 } 15734 }, 15735 "idpListConfigurationsResponse": { 15736 "type": "object", 15737 "properties": { 15738 "results": { 15739 "type": "array", 15740 "items": { 15741 "$ref": "#/definitions/idpServerConfiguration" 15742 } 15743 } 15744 } 15745 }, 15746 "idpServerConfiguration": { 15747 "type": "object", 15748 "properties": { 15749 "enabled": { 15750 "type": "boolean" 15751 }, 15752 "info": { 15753 "type": "array", 15754 "items": { 15755 "$ref": "#/definitions/idpServerConfigurationInfo" 15756 } 15757 }, 15758 "input": { 15759 "type": "string" 15760 }, 15761 "name": { 15762 "type": "string" 15763 }, 15764 "type": { 15765 "type": "string" 15766 } 15767 } 15768 }, 15769 "idpServerConfigurationInfo": { 15770 "type": "object", 15771 "properties": { 15772 "isCfg": { 15773 "type": "boolean" 15774 }, 15775 "isEnv": { 15776 "type": "boolean" 15777 }, 15778 "key": { 15779 "type": "string" 15780 }, 15781 "value": { 15782 "type": "string" 15783 } 15784 } 15785 }, 15786 "kmDeleteKeyRequest": { 15787 "type": "object" 15788 }, 15789 "kmsAPI": { 15790 "type": "object", 15791 "properties": { 15792 "maxBody": { 15793 "type": "integer" 15794 }, 15795 "method": { 15796 "type": "string" 15797 }, 15798 "path": { 15799 "type": "string" 15800 }, 15801 "timeout": { 15802 "type": "integer" 15803 } 15804 } 15805 }, 15806 "kmsAPIsResponse": { 15807 "type": "object", 15808 "properties": { 15809 "results": { 15810 "type": "array", 15811 "items": { 15812 "$ref": "#/definitions/kmsAPI" 15813 } 15814 } 15815 } 15816 }, 15817 "kmsAssignPolicyRequest": { 15818 "type": "object", 15819 "properties": { 15820 "identity": { 15821 "type": "string" 15822 } 15823 } 15824 }, 15825 "kmsCreateKeyRequest": { 15826 "type": "object", 15827 "required": [ 15828 "key" 15829 ], 15830 "properties": { 15831 "key": { 15832 "type": "string" 15833 } 15834 } 15835 }, 15836 "kmsDescribeIdentityResponse": { 15837 "type": "object", 15838 "properties": { 15839 "admin": { 15840 "type": "boolean" 15841 }, 15842 "createdAt": { 15843 "type": "string" 15844 }, 15845 "createdBy": { 15846 "type": "string" 15847 }, 15848 "identity": { 15849 "type": "string" 15850 }, 15851 "policy": { 15852 "type": "string" 15853 } 15854 } 15855 }, 15856 "kmsDescribePolicyResponse": { 15857 "type": "object", 15858 "properties": { 15859 "createdAt": { 15860 "type": "string" 15861 }, 15862 "createdBy": { 15863 "type": "string" 15864 }, 15865 "name": { 15866 "type": "string" 15867 } 15868 } 15869 }, 15870 "kmsDescribeSelfIdentityResponse": { 15871 "type": "object", 15872 "properties": { 15873 "admin": { 15874 "type": "boolean" 15875 }, 15876 "createdAt": { 15877 "type": "string" 15878 }, 15879 "createdBy": { 15880 "type": "string" 15881 }, 15882 "identity": { 15883 "type": "string" 15884 }, 15885 "policy": { 15886 "$ref": "#/definitions/kmsGetPolicyResponse" 15887 }, 15888 "policyName": { 15889 "type": "string" 15890 } 15891 } 15892 }, 15893 "kmsEndpoint": { 15894 "type": "object", 15895 "properties": { 15896 "status": { 15897 "type": "string" 15898 }, 15899 "url": { 15900 "type": "string" 15901 } 15902 } 15903 }, 15904 "kmsGetPolicyResponse": { 15905 "type": "object", 15906 "properties": { 15907 "allow": { 15908 "type": "array", 15909 "items": { 15910 "type": "string" 15911 } 15912 }, 15913 "deny": { 15914 "type": "array", 15915 "items": { 15916 "type": "string" 15917 } 15918 } 15919 } 15920 }, 15921 "kmsIdentityInfo": { 15922 "type": "object", 15923 "properties": { 15924 "createdAt": { 15925 "type": "string" 15926 }, 15927 "createdBy": { 15928 "type": "string" 15929 }, 15930 "error": { 15931 "type": "string" 15932 }, 15933 "identity": { 15934 "type": "string" 15935 }, 15936 "policy": { 15937 "type": "string" 15938 } 15939 } 15940 }, 15941 "kmsImportKeyRequest": { 15942 "type": "object", 15943 "required": [ 15944 "bytes" 15945 ], 15946 "properties": { 15947 "bytes": { 15948 "type": "string" 15949 } 15950 } 15951 }, 15952 "kmsKeyInfo": { 15953 "type": "object", 15954 "properties": { 15955 "createdAt": { 15956 "type": "string" 15957 }, 15958 "createdBy": { 15959 "type": "string" 15960 }, 15961 "name": { 15962 "type": "string" 15963 } 15964 } 15965 }, 15966 "kmsKeyStatusResponse": { 15967 "type": "object", 15968 "properties": { 15969 "decryptionErr": { 15970 "type": "string" 15971 }, 15972 "encryptionErr": { 15973 "type": "string" 15974 }, 15975 "keyID": { 15976 "type": "string" 15977 } 15978 } 15979 }, 15980 "kmsLatencyHistogram": { 15981 "type": "object", 15982 "properties": { 15983 "duration": { 15984 "type": "integer" 15985 }, 15986 "total": { 15987 "type": "integer" 15988 } 15989 } 15990 }, 15991 "kmsListIdentitiesResponse": { 15992 "type": "object", 15993 "properties": { 15994 "results": { 15995 "type": "array", 15996 "items": { 15997 "$ref": "#/definitions/kmsIdentityInfo" 15998 } 15999 } 16000 } 16001 }, 16002 "kmsListKeysResponse": { 16003 "type": "object", 16004 "properties": { 16005 "results": { 16006 "type": "array", 16007 "items": { 16008 "$ref": "#/definitions/kmsKeyInfo" 16009 } 16010 } 16011 } 16012 }, 16013 "kmsListPoliciesResponse": { 16014 "type": "object", 16015 "properties": { 16016 "results": { 16017 "type": "array", 16018 "items": { 16019 "$ref": "#/definitions/kmsPolicyInfo" 16020 } 16021 } 16022 } 16023 }, 16024 "kmsMetricsResponse": { 16025 "type": "object", 16026 "required": [ 16027 "requestOK", 16028 "requestErr", 16029 "requestFail", 16030 "requestActive", 16031 "auditEvents", 16032 "errorEvents", 16033 "latencyHistogram", 16034 "uptime", 16035 "cpus", 16036 "usableCPUs", 16037 "threads", 16038 "heapAlloc", 16039 "stackAlloc" 16040 ], 16041 "properties": { 16042 "auditEvents": { 16043 "type": "integer" 16044 }, 16045 "cpus": { 16046 "type": "integer" 16047 }, 16048 "errorEvents": { 16049 "type": "integer" 16050 }, 16051 "heapAlloc": { 16052 "type": "integer" 16053 }, 16054 "heapObjects": { 16055 "type": "integer" 16056 }, 16057 "latencyHistogram": { 16058 "type": "array", 16059 "items": { 16060 "$ref": "#/definitions/kmsLatencyHistogram" 16061 } 16062 }, 16063 "requestActive": { 16064 "type": "integer" 16065 }, 16066 "requestErr": { 16067 "type": "integer" 16068 }, 16069 "requestFail": { 16070 "type": "integer" 16071 }, 16072 "requestOK": { 16073 "type": "integer" 16074 }, 16075 "stackAlloc": { 16076 "type": "integer" 16077 }, 16078 "threads": { 16079 "type": "integer" 16080 }, 16081 "uptime": { 16082 "type": "integer" 16083 }, 16084 "usableCPUs": { 16085 "type": "integer" 16086 } 16087 } 16088 }, 16089 "kmsPolicyInfo": { 16090 "type": "object", 16091 "properties": { 16092 "createdAt": { 16093 "type": "string" 16094 }, 16095 "createdBy": { 16096 "type": "string" 16097 }, 16098 "name": { 16099 "type": "string" 16100 } 16101 } 16102 }, 16103 "kmsSetPolicyRequest": { 16104 "type": "object", 16105 "required": [ 16106 "policy" 16107 ], 16108 "properties": { 16109 "allow": { 16110 "type": "array", 16111 "items": { 16112 "type": "string" 16113 } 16114 }, 16115 "deny": { 16116 "type": "array", 16117 "items": { 16118 "type": "string" 16119 } 16120 }, 16121 "policy": { 16122 "type": "string" 16123 } 16124 } 16125 }, 16126 "kmsStatusResponse": { 16127 "type": "object", 16128 "properties": { 16129 "defaultKeyID": { 16130 "type": "string" 16131 }, 16132 "endpoints": { 16133 "type": "array", 16134 "items": { 16135 "$ref": "#/definitions/kmsEndpoint" 16136 } 16137 }, 16138 "name": { 16139 "type": "string" 16140 } 16141 } 16142 }, 16143 "kmsVersionResponse": { 16144 "type": "object", 16145 "properties": { 16146 "version": { 16147 "type": "string" 16148 } 16149 } 16150 }, 16151 "ldapEntities": { 16152 "type": "object", 16153 "properties": { 16154 "groups": { 16155 "type": "array", 16156 "items": { 16157 "$ref": "#/definitions/ldapGroupPolicyEntity" 16158 } 16159 }, 16160 "policies": { 16161 "type": "array", 16162 "items": { 16163 "$ref": "#/definitions/ldapPolicyEntity" 16164 } 16165 }, 16166 "timestamp": { 16167 "type": "string" 16168 }, 16169 "users": { 16170 "type": "array", 16171 "items": { 16172 "$ref": "#/definitions/ldapUserPolicyEntity" 16173 } 16174 } 16175 } 16176 }, 16177 "ldapEntitiesRequest": { 16178 "type": "object", 16179 "properties": { 16180 "groups": { 16181 "type": "array", 16182 "items": { 16183 "type": "string" 16184 } 16185 }, 16186 "policies": { 16187 "type": "array", 16188 "items": { 16189 "type": "string" 16190 } 16191 }, 16192 "users": { 16193 "type": "array", 16194 "items": { 16195 "type": "string" 16196 } 16197 } 16198 } 16199 }, 16200 "ldapGroupPolicyEntity": { 16201 "type": "object", 16202 "properties": { 16203 "group": { 16204 "type": "string" 16205 }, 16206 "policies": { 16207 "type": "array", 16208 "items": { 16209 "type": "string" 16210 } 16211 } 16212 } 16213 }, 16214 "ldapPolicyEntity": { 16215 "type": "object", 16216 "properties": { 16217 "groups": { 16218 "type": "array", 16219 "items": { 16220 "type": "string" 16221 } 16222 }, 16223 "policy": { 16224 "type": "string" 16225 }, 16226 "users": { 16227 "type": "array", 16228 "items": { 16229 "type": "string" 16230 } 16231 } 16232 } 16233 }, 16234 "ldapUserPolicyEntity": { 16235 "type": "object", 16236 "properties": { 16237 "policies": { 16238 "type": "array", 16239 "items": { 16240 "type": "string" 16241 } 16242 }, 16243 "user": { 16244 "type": "string" 16245 } 16246 } 16247 }, 16248 "license": { 16249 "type": "object", 16250 "properties": { 16251 "account_id": { 16252 "type": "integer" 16253 }, 16254 "email": { 16255 "type": "string" 16256 }, 16257 "expires_at": { 16258 "type": "string" 16259 }, 16260 "organization": { 16261 "type": "string" 16262 }, 16263 "plan": { 16264 "type": "string" 16265 }, 16266 "storage_capacity": { 16267 "type": "integer" 16268 } 16269 } 16270 }, 16271 "lifecycleTag": { 16272 "type": "object", 16273 "properties": { 16274 "key": { 16275 "type": "string" 16276 }, 16277 "value": { 16278 "type": "string" 16279 } 16280 } 16281 }, 16282 "listAccessRulesResponse": { 16283 "type": "object", 16284 "properties": { 16285 "accessRules": { 16286 "type": "array", 16287 "title": "list of policies", 16288 "items": { 16289 "$ref": "#/definitions/accessRule" 16290 } 16291 }, 16292 "total": { 16293 "type": "integer", 16294 "format": "int64", 16295 "title": "total number of policies" 16296 } 16297 } 16298 }, 16299 "listBucketEventsResponse": { 16300 "type": "object", 16301 "properties": { 16302 "events": { 16303 "type": "array", 16304 "items": { 16305 "$ref": "#/definitions/notificationConfig" 16306 } 16307 }, 16308 "total": { 16309 "type": "integer", 16310 "format": "int64", 16311 "title": "total number of bucket events" 16312 } 16313 } 16314 }, 16315 "listBucketsResponse": { 16316 "type": "object", 16317 "properties": { 16318 "buckets": { 16319 "type": "array", 16320 "title": "list of resulting buckets", 16321 "items": { 16322 "$ref": "#/definitions/bucket" 16323 } 16324 }, 16325 "total": { 16326 "type": "integer", 16327 "format": "int64", 16328 "title": "number of buckets accessible to the user" 16329 } 16330 } 16331 }, 16332 "listConfigResponse": { 16333 "type": "object", 16334 "properties": { 16335 "configurations": { 16336 "type": "array", 16337 "items": { 16338 "$ref": "#/definitions/configDescription" 16339 } 16340 }, 16341 "total": { 16342 "type": "integer", 16343 "format": "int64", 16344 "title": "total number of configurations" 16345 } 16346 } 16347 }, 16348 "listExternalBucketsParams": { 16349 "required": [ 16350 "accessKey", 16351 "secretKey", 16352 "targetURL", 16353 "useTLS" 16354 ], 16355 "properties": { 16356 "accessKey": { 16357 "type": "string", 16358 "minLength": 3 16359 }, 16360 "region": { 16361 "type": "string" 16362 }, 16363 "secretKey": { 16364 "type": "string", 16365 "minLength": 8 16366 }, 16367 "targetURL": { 16368 "type": "string" 16369 }, 16370 "useTLS": { 16371 "type": "boolean" 16372 } 16373 } 16374 }, 16375 "listGroupsResponse": { 16376 "type": "object", 16377 "properties": { 16378 "groups": { 16379 "type": "array", 16380 "title": "list of groups", 16381 "items": { 16382 "type": "string" 16383 } 16384 }, 16385 "total": { 16386 "type": "integer", 16387 "format": "int64", 16388 "title": "total number of groups" 16389 } 16390 } 16391 }, 16392 "listObjectsResponse": { 16393 "type": "object", 16394 "properties": { 16395 "objects": { 16396 "type": "array", 16397 "title": "list of resulting objects", 16398 "items": { 16399 "$ref": "#/definitions/bucketObject" 16400 } 16401 }, 16402 "total": { 16403 "type": "integer", 16404 "format": "int64", 16405 "title": "number of objects" 16406 } 16407 } 16408 }, 16409 "listPoliciesResponse": { 16410 "type": "object", 16411 "properties": { 16412 "policies": { 16413 "type": "array", 16414 "title": "list of policies", 16415 "items": { 16416 "$ref": "#/definitions/policy" 16417 } 16418 }, 16419 "total": { 16420 "type": "integer", 16421 "format": "int64", 16422 "title": "total number of policies" 16423 } 16424 } 16425 }, 16426 "listRemoteBucketsResponse": { 16427 "type": "object", 16428 "properties": { 16429 "buckets": { 16430 "type": "array", 16431 "title": "list of remote buckets", 16432 "items": { 16433 "$ref": "#/definitions/remoteBucket" 16434 } 16435 }, 16436 "total": { 16437 "type": "integer", 16438 "format": "int64", 16439 "title": "number of remote buckets accessible to user" 16440 } 16441 } 16442 }, 16443 "listUsersResponse": { 16444 "type": "object", 16445 "properties": { 16446 "users": { 16447 "type": "array", 16448 "title": "list of resulting users", 16449 "items": { 16450 "$ref": "#/definitions/user" 16451 } 16452 } 16453 } 16454 }, 16455 "logSearchResponse": { 16456 "type": "object", 16457 "properties": { 16458 "results": { 16459 "type": "object", 16460 "title": "list of log search responses" 16461 } 16462 } 16463 }, 16464 "loginDetails": { 16465 "type": "object", 16466 "properties": { 16467 "animatedLogin": { 16468 "type": "boolean" 16469 }, 16470 "isK8S": { 16471 "type": "boolean" 16472 }, 16473 "loginStrategy": { 16474 "type": "string", 16475 "enum": [ 16476 "form", 16477 "redirect", 16478 "service-account", 16479 "redirect-service-account" 16480 ] 16481 }, 16482 "redirectRules": { 16483 "type": "array", 16484 "items": { 16485 "$ref": "#/definitions/redirectRule" 16486 } 16487 } 16488 } 16489 }, 16490 "loginOauth2AuthRequest": { 16491 "type": "object", 16492 "required": [ 16493 "state", 16494 "code" 16495 ], 16496 "properties": { 16497 "code": { 16498 "type": "string" 16499 }, 16500 "state": { 16501 "type": "string" 16502 } 16503 } 16504 }, 16505 "loginRequest": { 16506 "type": "object", 16507 "properties": { 16508 "accessKey": { 16509 "type": "string" 16510 }, 16511 "features": { 16512 "type": "object", 16513 "properties": { 16514 "hide_menu": { 16515 "type": "boolean" 16516 } 16517 } 16518 }, 16519 "secretKey": { 16520 "type": "string" 16521 }, 16522 "sts": { 16523 "type": "string" 16524 } 16525 } 16526 }, 16527 "loginResponse": { 16528 "type": "object", 16529 "properties": { 16530 "IDPRefreshToken": { 16531 "type": "string" 16532 }, 16533 "sessionId": { 16534 "type": "string" 16535 } 16536 } 16537 }, 16538 "logoutRequest": { 16539 "type": "object", 16540 "properties": { 16541 "state": { 16542 "type": "string" 16543 } 16544 } 16545 }, 16546 "makeBucketRequest": { 16547 "type": "object", 16548 "required": [ 16549 "name" 16550 ], 16551 "properties": { 16552 "locking": { 16553 "type": "boolean" 16554 }, 16555 "name": { 16556 "type": "string" 16557 }, 16558 "quota": { 16559 "$ref": "#/definitions/setBucketQuota" 16560 }, 16561 "retention": { 16562 "$ref": "#/definitions/putBucketRetentionRequest" 16563 }, 16564 "versioning": { 16565 "$ref": "#/definitions/setBucketVersioning" 16566 } 16567 } 16568 }, 16569 "makeBucketsResponse": { 16570 "type": "object", 16571 "properties": { 16572 "bucketName": { 16573 "type": "string" 16574 } 16575 } 16576 }, 16577 "maxShareLinkExpResponse": { 16578 "type": "object", 16579 "required": [ 16580 "exp" 16581 ], 16582 "properties": { 16583 "exp": { 16584 "type": "number", 16585 "format": "int64" 16586 } 16587 } 16588 }, 16589 "metadata": { 16590 "type": "object", 16591 "properties": { 16592 "objectMetadata": { 16593 "type": "object", 16594 "additionalProperties": true 16595 } 16596 } 16597 }, 16598 "multiBucketReplication": { 16599 "required": [ 16600 "accessKey", 16601 "secretKey", 16602 "targetURL", 16603 "bucketsRelation" 16604 ], 16605 "properties": { 16606 "accessKey": { 16607 "type": "string", 16608 "minLength": 3 16609 }, 16610 "bandwidth": { 16611 "type": "integer", 16612 "format": "int64" 16613 }, 16614 "bucketsRelation": { 16615 "type": "array", 16616 "minLength": 1, 16617 "items": { 16618 "$ref": "#/definitions/multiBucketsRelation" 16619 } 16620 }, 16621 "healthCheckPeriod": { 16622 "type": "integer", 16623 "format": "int32" 16624 }, 16625 "prefix": { 16626 "type": "string" 16627 }, 16628 "priority": { 16629 "type": "integer", 16630 "format": "int32", 16631 "default": 0 16632 }, 16633 "region": { 16634 "type": "string" 16635 }, 16636 "replicateDeleteMarkers": { 16637 "type": "boolean" 16638 }, 16639 "replicateDeletes": { 16640 "type": "boolean" 16641 }, 16642 "replicateExistingObjects": { 16643 "type": "boolean" 16644 }, 16645 "replicateMetadata": { 16646 "type": "boolean" 16647 }, 16648 "secretKey": { 16649 "type": "string", 16650 "minLength": 8 16651 }, 16652 "storageClass": { 16653 "type": "string", 16654 "default": "" 16655 }, 16656 "syncMode": { 16657 "type": "string", 16658 "default": "async", 16659 "enum": [ 16660 "async", 16661 "sync" 16662 ] 16663 }, 16664 "tags": { 16665 "type": "string" 16666 }, 16667 "targetURL": { 16668 "type": "string" 16669 } 16670 } 16671 }, 16672 "multiBucketReplicationEdit": { 16673 "properties": { 16674 "arn": { 16675 "type": "string" 16676 }, 16677 "prefix": { 16678 "type": "string" 16679 }, 16680 "priority": { 16681 "type": "integer", 16682 "format": "int32", 16683 "default": 0 16684 }, 16685 "replicateDeleteMarkers": { 16686 "type": "boolean" 16687 }, 16688 "replicateDeletes": { 16689 "type": "boolean" 16690 }, 16691 "replicateExistingObjects": { 16692 "type": "boolean" 16693 }, 16694 "replicateMetadata": { 16695 "type": "boolean" 16696 }, 16697 "ruleState": { 16698 "type": "boolean" 16699 }, 16700 "storageClass": { 16701 "type": "string", 16702 "default": "" 16703 }, 16704 "tags": { 16705 "type": "string", 16706 "default": "" 16707 } 16708 } 16709 }, 16710 "multiBucketResponseItem": { 16711 "type": "object", 16712 "properties": { 16713 "errorString": { 16714 "type": "string" 16715 }, 16716 "originBucket": { 16717 "type": "string" 16718 }, 16719 "targetBucket": { 16720 "type": "string" 16721 } 16722 } 16723 }, 16724 "multiBucketResponseState": { 16725 "type": "object", 16726 "properties": { 16727 "replicationState": { 16728 "type": "array", 16729 "items": { 16730 "$ref": "#/definitions/multiBucketResponseItem" 16731 } 16732 } 16733 } 16734 }, 16735 "multiBucketsRelation": { 16736 "type": "object", 16737 "properties": { 16738 "destinationBucket": { 16739 "type": "string" 16740 }, 16741 "originBucket": { 16742 "type": "string" 16743 } 16744 } 16745 }, 16746 "multiLifecycleResult": { 16747 "properties": { 16748 "results": { 16749 "type": "array", 16750 "items": { 16751 "$ref": "#/definitions/multicycleResultItem" 16752 } 16753 } 16754 } 16755 }, 16756 "multicycleResultItem": { 16757 "type": "object", 16758 "properties": { 16759 "bucketName": { 16760 "type": "string" 16761 }, 16762 "error": { 16763 "type": "string" 16764 } 16765 } 16766 }, 16767 "nofiticationService": { 16768 "type": "string", 16769 "enum": [ 16770 "webhook", 16771 "amqp", 16772 "kafka", 16773 "mqtt", 16774 "nats", 16775 "nsq", 16776 "mysql", 16777 "postgres", 16778 "elasticsearch", 16779 "redis" 16780 ] 16781 }, 16782 "notifEndpointResponse": { 16783 "type": "object", 16784 "properties": { 16785 "notification_endpoints": { 16786 "type": "array", 16787 "items": { 16788 "$ref": "#/definitions/notificationEndpointItem" 16789 } 16790 } 16791 } 16792 }, 16793 "notificationConfig": { 16794 "type": "object", 16795 "required": [ 16796 "arn" 16797 ], 16798 "properties": { 16799 "arn": { 16800 "type": "string" 16801 }, 16802 "events": { 16803 "type": "array", 16804 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 16805 "items": { 16806 "$ref": "#/definitions/notificationEventType" 16807 } 16808 }, 16809 "id": { 16810 "type": "string" 16811 }, 16812 "prefix": { 16813 "type": "string", 16814 "title": "filter event associated to the specified prefix" 16815 }, 16816 "suffix": { 16817 "type": "string", 16818 "title": "filter event associated to the specified suffix" 16819 } 16820 } 16821 }, 16822 "notificationDeleteRequest": { 16823 "type": "object", 16824 "required": [ 16825 "events", 16826 "prefix", 16827 "suffix" 16828 ], 16829 "properties": { 16830 "events": { 16831 "type": "array", 16832 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 16833 "minLength": 1, 16834 "items": { 16835 "$ref": "#/definitions/notificationEventType" 16836 } 16837 }, 16838 "prefix": { 16839 "type": "string", 16840 "title": "filter event associated to the specified prefix" 16841 }, 16842 "suffix": { 16843 "type": "string", 16844 "title": "filter event associated to the specified suffix" 16845 } 16846 } 16847 }, 16848 "notificationEndpoint": { 16849 "type": "object", 16850 "required": [ 16851 "service", 16852 "account_id", 16853 "properties" 16854 ], 16855 "properties": { 16856 "account_id": { 16857 "type": "string" 16858 }, 16859 "properties": { 16860 "type": "object", 16861 "additionalProperties": { 16862 "type": "string" 16863 } 16864 }, 16865 "service": { 16866 "$ref": "#/definitions/nofiticationService" 16867 } 16868 } 16869 }, 16870 "notificationEndpointItem": { 16871 "type": "object", 16872 "properties": { 16873 "account_id": { 16874 "type": "string" 16875 }, 16876 "service": { 16877 "$ref": "#/definitions/nofiticationService" 16878 }, 16879 "status": { 16880 "type": "string" 16881 } 16882 } 16883 }, 16884 "notificationEventType": { 16885 "type": "string", 16886 "enum": [ 16887 "put", 16888 "delete", 16889 "get", 16890 "replica", 16891 "ilm", 16892 "scanner" 16893 ] 16894 }, 16895 "objectBucketLifecycle": { 16896 "type": "object", 16897 "properties": { 16898 "expiration": { 16899 "$ref": "#/definitions/expirationResponse" 16900 }, 16901 "id": { 16902 "type": "string" 16903 }, 16904 "prefix": { 16905 "type": "string" 16906 }, 16907 "status": { 16908 "type": "string" 16909 }, 16910 "tags": { 16911 "type": "array", 16912 "items": { 16913 "$ref": "#/definitions/lifecycleTag" 16914 } 16915 }, 16916 "transition": { 16917 "$ref": "#/definitions/transitionResponse" 16918 } 16919 } 16920 }, 16921 "objectLegalHoldStatus": { 16922 "type": "string", 16923 "enum": [ 16924 "enabled", 16925 "disabled" 16926 ] 16927 }, 16928 "objectRetentionMode": { 16929 "type": "string", 16930 "enum": [ 16931 "governance", 16932 "compliance" 16933 ] 16934 }, 16935 "objectRetentionUnit": { 16936 "type": "string", 16937 "enum": [ 16938 "days", 16939 "years" 16940 ] 16941 }, 16942 "peerInfo": { 16943 "type": "object", 16944 "properties": { 16945 "deploymentID": { 16946 "type": "string" 16947 }, 16948 "endpoint": { 16949 "type": "string" 16950 }, 16951 "name": { 16952 "type": "string" 16953 } 16954 } 16955 }, 16956 "peerInfoRemove": { 16957 "type": "object", 16958 "required": [ 16959 "sites" 16960 ], 16961 "properties": { 16962 "all": { 16963 "type": "boolean" 16964 }, 16965 "sites": { 16966 "type": "array", 16967 "items": { 16968 "type": "string" 16969 } 16970 } 16971 } 16972 }, 16973 "peerSite": { 16974 "type": "object", 16975 "properties": { 16976 "accessKey": { 16977 "type": "string" 16978 }, 16979 "endpoint": { 16980 "type": "string" 16981 }, 16982 "name": { 16983 "type": "string" 16984 }, 16985 "secretKey": { 16986 "type": "string" 16987 } 16988 } 16989 }, 16990 "peerSiteEditResponse": { 16991 "type": "object", 16992 "properties": { 16993 "errorDetail": { 16994 "type": "string" 16995 }, 16996 "status": { 16997 "type": "string" 16998 }, 16999 "success": { 17000 "type": "boolean" 17001 } 17002 } 17003 }, 17004 "peerSiteRemoveResponse": { 17005 "type": "object", 17006 "properties": { 17007 "errorDetail": { 17008 "type": "string" 17009 }, 17010 "status": { 17011 "type": "string" 17012 } 17013 } 17014 }, 17015 "permissionResource": { 17016 "type": "object", 17017 "properties": { 17018 "conditionOperator": { 17019 "type": "string" 17020 }, 17021 "prefixes": { 17022 "type": "array", 17023 "items": { 17024 "type": "string" 17025 } 17026 }, 17027 "resource": { 17028 "type": "string" 17029 } 17030 } 17031 }, 17032 "policy": { 17033 "type": "object", 17034 "properties": { 17035 "name": { 17036 "type": "string" 17037 }, 17038 "policy": { 17039 "type": "string" 17040 } 17041 } 17042 }, 17043 "policyArgs": { 17044 "type": "object", 17045 "properties": { 17046 "action": { 17047 "type": "string" 17048 }, 17049 "bucket_name": { 17050 "type": "string" 17051 }, 17052 "id": { 17053 "type": "string" 17054 } 17055 } 17056 }, 17057 "policyEntity": { 17058 "type": "string", 17059 "default": "user", 17060 "enum": [ 17061 "user", 17062 "group" 17063 ] 17064 }, 17065 "prefixAccessPair": { 17066 "type": "object", 17067 "properties": { 17068 "access": { 17069 "type": "string" 17070 }, 17071 "prefix": { 17072 "type": "string" 17073 } 17074 } 17075 }, 17076 "prefixWrapper": { 17077 "type": "object", 17078 "properties": { 17079 "prefix": { 17080 "type": "string" 17081 } 17082 } 17083 }, 17084 "principal": { 17085 "type": "object", 17086 "properties": { 17087 "STSAccessKeyID": { 17088 "type": "string" 17089 }, 17090 "STSSecretAccessKey": { 17091 "type": "string" 17092 }, 17093 "STSSessionToken": { 17094 "type": "string" 17095 }, 17096 "accountAccessKey": { 17097 "type": "string" 17098 }, 17099 "customStyleOb": { 17100 "type": "string" 17101 }, 17102 "hm": { 17103 "type": "boolean" 17104 }, 17105 "ob": { 17106 "type": "boolean" 17107 } 17108 } 17109 }, 17110 "profilingStartRequest": { 17111 "type": "object", 17112 "required": [ 17113 "type" 17114 ], 17115 "properties": { 17116 "type": { 17117 "type": "string" 17118 } 17119 } 17120 }, 17121 "putBucketRetentionRequest": { 17122 "type": "object", 17123 "required": [ 17124 "mode", 17125 "unit", 17126 "validity" 17127 ], 17128 "properties": { 17129 "mode": { 17130 "$ref": "#/definitions/objectRetentionMode" 17131 }, 17132 "unit": { 17133 "$ref": "#/definitions/objectRetentionUnit" 17134 }, 17135 "validity": { 17136 "type": "integer", 17137 "format": "int32" 17138 } 17139 } 17140 }, 17141 "putBucketTagsRequest": { 17142 "type": "object", 17143 "properties": { 17144 "tags": { 17145 "additionalProperties": { 17146 "type": "string" 17147 } 17148 } 17149 } 17150 }, 17151 "putObjectLegalHoldRequest": { 17152 "type": "object", 17153 "required": [ 17154 "status" 17155 ], 17156 "properties": { 17157 "status": { 17158 "$ref": "#/definitions/objectLegalHoldStatus" 17159 } 17160 } 17161 }, 17162 "putObjectRetentionRequest": { 17163 "type": "object", 17164 "required": [ 17165 "mode", 17166 "expires" 17167 ], 17168 "properties": { 17169 "expires": { 17170 "type": "string" 17171 }, 17172 "governance_bypass": { 17173 "type": "boolean" 17174 }, 17175 "mode": { 17176 "$ref": "#/definitions/objectRetentionMode" 17177 } 17178 } 17179 }, 17180 "putObjectTagsRequest": { 17181 "type": "object", 17182 "properties": { 17183 "tags": { 17184 "additionalProperties": { 17185 "type": "string" 17186 } 17187 } 17188 } 17189 }, 17190 "redirectRule": { 17191 "type": "object", 17192 "properties": { 17193 "displayName": { 17194 "type": "string" 17195 }, 17196 "redirect": { 17197 "type": "string" 17198 }, 17199 "serviceType": { 17200 "type": "string" 17201 } 17202 } 17203 }, 17204 "releaseAuthor": { 17205 "type": "object", 17206 "properties": { 17207 "avatar_url": { 17208 "type": "string" 17209 }, 17210 "events_url": { 17211 "type": "string" 17212 }, 17213 "followers_url": { 17214 "type": "string" 17215 }, 17216 "following_url": { 17217 "type": "string" 17218 }, 17219 "gists_url": { 17220 "type": "string" 17221 }, 17222 "gravatar_id": { 17223 "type": "string" 17224 }, 17225 "html_url": { 17226 "type": "string" 17227 }, 17228 "id": { 17229 "type": "integer" 17230 }, 17231 "login": { 17232 "type": "string" 17233 }, 17234 "node_id": { 17235 "type": "string" 17236 }, 17237 "organizations_url": { 17238 "type": "string" 17239 }, 17240 "receivedEvents_url": { 17241 "type": "string" 17242 }, 17243 "repos_url": { 17244 "type": "string" 17245 }, 17246 "site_admin": { 17247 "type": "boolean" 17248 }, 17249 "starred_url": { 17250 "type": "string" 17251 }, 17252 "subscriptions_url": { 17253 "type": "string" 17254 }, 17255 "type": { 17256 "type": "string" 17257 }, 17258 "url": { 17259 "type": "string" 17260 } 17261 } 17262 }, 17263 "releaseInfo": { 17264 "type": "object", 17265 "properties": { 17266 "breakingChangesContent": { 17267 "type": "string" 17268 }, 17269 "contextContent": { 17270 "type": "string" 17271 }, 17272 "metadata": { 17273 "$ref": "#/definitions/releaseMetadata" 17274 }, 17275 "newFeaturesContent": { 17276 "type": "string" 17277 }, 17278 "notesContent": { 17279 "type": "string" 17280 }, 17281 "securityContent": { 17282 "type": "string" 17283 } 17284 } 17285 }, 17286 "releaseListResponse": { 17287 "type": "object", 17288 "properties": { 17289 "results": { 17290 "type": "array", 17291 "items": { 17292 "$ref": "#/definitions/releaseInfo" 17293 } 17294 } 17295 } 17296 }, 17297 "releaseMetadata": { 17298 "type": "object", 17299 "properties": { 17300 "assets_url": { 17301 "type": "string" 17302 }, 17303 "author": { 17304 "$ref": "#/definitions/releaseAuthor" 17305 }, 17306 "created_at": { 17307 "type": "string" 17308 }, 17309 "draft": { 17310 "type": "boolean" 17311 }, 17312 "html_url": { 17313 "type": "string" 17314 }, 17315 "id": { 17316 "type": "integer" 17317 }, 17318 "name": { 17319 "type": "string" 17320 }, 17321 "node_id": { 17322 "type": "string" 17323 }, 17324 "prerelease": { 17325 "type": "boolean" 17326 }, 17327 "published_at": { 17328 "type": "string" 17329 }, 17330 "tag_name": { 17331 "type": "string" 17332 }, 17333 "tarball_url": { 17334 "type": "string" 17335 }, 17336 "target_commitish": { 17337 "type": "string" 17338 }, 17339 "upload_url": { 17340 "type": "string" 17341 }, 17342 "url": { 17343 "type": "string" 17344 }, 17345 "zipball_url": { 17346 "type": "string" 17347 } 17348 } 17349 }, 17350 "remoteBucket": { 17351 "type": "object", 17352 "required": [ 17353 "accessKey", 17354 "sourceBucket", 17355 "remoteARN" 17356 ], 17357 "properties": { 17358 "accessKey": { 17359 "type": "string", 17360 "minLength": 3 17361 }, 17362 "bandwidth": { 17363 "type": "integer", 17364 "format": "int64" 17365 }, 17366 "healthCheckPeriod": { 17367 "type": "integer" 17368 }, 17369 "remoteARN": { 17370 "type": "string" 17371 }, 17372 "secretKey": { 17373 "type": "string", 17374 "minLength": 8 17375 }, 17376 "service": { 17377 "type": "string", 17378 "enum": [ 17379 "replication" 17380 ] 17381 }, 17382 "sourceBucket": { 17383 "type": "string" 17384 }, 17385 "status": { 17386 "type": "string" 17387 }, 17388 "syncMode": { 17389 "type": "string" 17390 }, 17391 "targetBucket": { 17392 "type": "string" 17393 }, 17394 "targetURL": { 17395 "type": "string" 17396 } 17397 } 17398 }, 17399 "resultTarget": { 17400 "type": "object", 17401 "properties": { 17402 "legendFormat": { 17403 "type": "string" 17404 }, 17405 "result": { 17406 "type": "array", 17407 "items": { 17408 "$ref": "#/definitions/widgetResult" 17409 } 17410 }, 17411 "resultType": { 17412 "type": "string" 17413 } 17414 } 17415 }, 17416 "rewindItem": { 17417 "type": "object", 17418 "properties": { 17419 "action": { 17420 "type": "string" 17421 }, 17422 "delete_flag": { 17423 "type": "boolean" 17424 }, 17425 "is_latest": { 17426 "type": "boolean" 17427 }, 17428 "last_modified": { 17429 "type": "string" 17430 }, 17431 "name": { 17432 "type": "string" 17433 }, 17434 "size": { 17435 "type": "integer", 17436 "format": "int64" 17437 }, 17438 "version_id": { 17439 "type": "string" 17440 } 17441 } 17442 }, 17443 "rewindResponse": { 17444 "type": "object", 17445 "properties": { 17446 "objects": { 17447 "type": "array", 17448 "items": { 17449 "$ref": "#/definitions/rewindItem" 17450 } 17451 } 17452 } 17453 }, 17454 "selectedSAs": { 17455 "type": "array", 17456 "items": { 17457 "type": "string" 17458 } 17459 }, 17460 "selectedUsers": { 17461 "type": "array", 17462 "items": { 17463 "type": "string" 17464 } 17465 }, 17466 "serverDrives": { 17467 "type": "object", 17468 "properties": { 17469 "availableSpace": { 17470 "type": "integer" 17471 }, 17472 "drivePath": { 17473 "type": "string" 17474 }, 17475 "endpoint": { 17476 "type": "string" 17477 }, 17478 "healing": { 17479 "type": "boolean" 17480 }, 17481 "model": { 17482 "type": "string" 17483 }, 17484 "rootDisk": { 17485 "type": "boolean" 17486 }, 17487 "state": { 17488 "type": "string" 17489 }, 17490 "totalSpace": { 17491 "type": "integer" 17492 }, 17493 "usedSpace": { 17494 "type": "integer" 17495 }, 17496 "uuid": { 17497 "type": "string" 17498 } 17499 } 17500 }, 17501 "serverProperties": { 17502 "type": "object", 17503 "properties": { 17504 "commitID": { 17505 "type": "string" 17506 }, 17507 "drives": { 17508 "type": "array", 17509 "items": { 17510 "$ref": "#/definitions/serverDrives" 17511 } 17512 }, 17513 "endpoint": { 17514 "type": "string" 17515 }, 17516 "network": { 17517 "type": "object", 17518 "additionalProperties": { 17519 "type": "string" 17520 } 17521 }, 17522 "poolNumber": { 17523 "type": "integer" 17524 }, 17525 "state": { 17526 "type": "string" 17527 }, 17528 "uptime": { 17529 "type": "integer" 17530 }, 17531 "version": { 17532 "type": "string" 17533 } 17534 } 17535 }, 17536 "serviceAccount": { 17537 "type": "object", 17538 "properties": { 17539 "accountStatus": { 17540 "type": "string" 17541 }, 17542 "description": { 17543 "type": "string" 17544 }, 17545 "expiration": { 17546 "type": "string" 17547 }, 17548 "impliedPolicy": { 17549 "type": "boolean" 17550 }, 17551 "name": { 17552 "type": "string" 17553 }, 17554 "parentUser": { 17555 "type": "string" 17556 }, 17557 "policy": { 17558 "type": "string" 17559 } 17560 } 17561 }, 17562 "serviceAccountCreds": { 17563 "type": "object", 17564 "properties": { 17565 "accessKey": { 17566 "type": "string" 17567 }, 17568 "secretKey": { 17569 "type": "string" 17570 }, 17571 "url": { 17572 "type": "string" 17573 } 17574 } 17575 }, 17576 "serviceAccountRequest": { 17577 "type": "object", 17578 "properties": { 17579 "comment": { 17580 "type": "string" 17581 }, 17582 "description": { 17583 "type": "string" 17584 }, 17585 "expiry": { 17586 "type": "string" 17587 }, 17588 "name": { 17589 "type": "string" 17590 }, 17591 "policy": { 17592 "type": "string", 17593 "title": "policy to be applied to the Service Account if any" 17594 } 17595 } 17596 }, 17597 "serviceAccountRequestCreds": { 17598 "type": "object", 17599 "properties": { 17600 "accessKey": { 17601 "type": "string" 17602 }, 17603 "comment": { 17604 "type": "string" 17605 }, 17606 "description": { 17607 "type": "string" 17608 }, 17609 "expiry": { 17610 "type": "string" 17611 }, 17612 "name": { 17613 "type": "string" 17614 }, 17615 "policy": { 17616 "type": "string", 17617 "title": "policy to be applied to the Service Account if any" 17618 }, 17619 "secretKey": { 17620 "type": "string" 17621 } 17622 } 17623 }, 17624 "serviceAccounts": { 17625 "type": "array", 17626 "items": { 17627 "$ref": "#/definitions/ServiceAccountsItems0" 17628 } 17629 }, 17630 "sessionResponse": { 17631 "type": "object", 17632 "properties": { 17633 "allowResources": { 17634 "type": "array", 17635 "items": { 17636 "$ref": "#/definitions/permissionResource" 17637 } 17638 }, 17639 "customStyles": { 17640 "type": "string" 17641 }, 17642 "distributedMode": { 17643 "type": "boolean" 17644 }, 17645 "envConstants": { 17646 "$ref": "#/definitions/environmentConstants" 17647 }, 17648 "features": { 17649 "type": "array", 17650 "items": { 17651 "type": "string" 17652 } 17653 }, 17654 "operator": { 17655 "type": "boolean" 17656 }, 17657 "permissions": { 17658 "type": "object", 17659 "additionalProperties": { 17660 "type": "array", 17661 "items": { 17662 "type": "string" 17663 } 17664 } 17665 }, 17666 "serverEndPoint": { 17667 "type": "string" 17668 }, 17669 "status": { 17670 "type": "string", 17671 "enum": [ 17672 "ok" 17673 ] 17674 } 17675 } 17676 }, 17677 "setBucketPolicyRequest": { 17678 "type": "object", 17679 "required": [ 17680 "access" 17681 ], 17682 "properties": { 17683 "access": { 17684 "$ref": "#/definitions/bucketAccess" 17685 }, 17686 "definition": { 17687 "type": "string" 17688 } 17689 } 17690 }, 17691 "setBucketQuota": { 17692 "type": "object", 17693 "required": [ 17694 "enabled" 17695 ], 17696 "properties": { 17697 "amount": { 17698 "type": "integer" 17699 }, 17700 "enabled": { 17701 "type": "boolean" 17702 }, 17703 "quota_type": { 17704 "type": "string", 17705 "enum": [ 17706 "hard" 17707 ] 17708 } 17709 } 17710 }, 17711 "setBucketVersioning": { 17712 "type": "object", 17713 "properties": { 17714 "enabled": { 17715 "type": "boolean" 17716 }, 17717 "excludeFolders": { 17718 "type": "boolean" 17719 }, 17720 "excludePrefixes": { 17721 "type": "array", 17722 "maxLength": 10, 17723 "items": { 17724 "type": "string" 17725 } 17726 } 17727 } 17728 }, 17729 "setConfigRequest": { 17730 "type": "object", 17731 "required": [ 17732 "key_values" 17733 ], 17734 "properties": { 17735 "arn_resource_id": { 17736 "type": "string", 17737 "title": "Used if configuration is an event notification's target" 17738 }, 17739 "key_values": { 17740 "type": "array", 17741 "minItems": 1, 17742 "items": { 17743 "$ref": "#/definitions/configurationKV" 17744 } 17745 } 17746 } 17747 }, 17748 "setConfigResponse": { 17749 "type": "object", 17750 "properties": { 17751 "restart": { 17752 "description": "Returns wheter server needs to restart to apply changes or not", 17753 "type": "boolean" 17754 } 17755 } 17756 }, 17757 "setIDPResponse": { 17758 "type": "object", 17759 "properties": { 17760 "restart": { 17761 "type": "boolean" 17762 } 17763 } 17764 }, 17765 "setNotificationEndpointResponse": { 17766 "type": "object", 17767 "required": [ 17768 "service", 17769 "account_id", 17770 "properties" 17771 ], 17772 "properties": { 17773 "account_id": { 17774 "type": "string" 17775 }, 17776 "properties": { 17777 "type": "object", 17778 "additionalProperties": { 17779 "type": "string" 17780 } 17781 }, 17782 "restart": { 17783 "type": "boolean" 17784 }, 17785 "service": { 17786 "$ref": "#/definitions/nofiticationService" 17787 } 17788 } 17789 }, 17790 "setPolicyMultipleNameRequest": { 17791 "type": "object", 17792 "properties": { 17793 "groups": { 17794 "type": "array", 17795 "items": { 17796 "$ref": "#/definitions/iamEntity" 17797 } 17798 }, 17799 "name": { 17800 "type": "array", 17801 "items": { 17802 "type": "string" 17803 } 17804 }, 17805 "users": { 17806 "type": "array", 17807 "items": { 17808 "$ref": "#/definitions/iamEntity" 17809 } 17810 } 17811 } 17812 }, 17813 "setPolicyNameRequest": { 17814 "type": "object", 17815 "required": [ 17816 "name", 17817 "entityType", 17818 "entityName" 17819 ], 17820 "properties": { 17821 "entityName": { 17822 "type": "string" 17823 }, 17824 "entityType": { 17825 "$ref": "#/definitions/policyEntity" 17826 }, 17827 "name": { 17828 "type": "array", 17829 "items": { 17830 "type": "string" 17831 } 17832 } 17833 } 17834 }, 17835 "setPolicyRequest": { 17836 "type": "object", 17837 "required": [ 17838 "entityType", 17839 "entityName" 17840 ], 17841 "properties": { 17842 "entityName": { 17843 "type": "string" 17844 }, 17845 "entityType": { 17846 "$ref": "#/definitions/policyEntity" 17847 } 17848 } 17849 }, 17850 "siteReplicationAddRequest": { 17851 "type": "array", 17852 "items": { 17853 "$ref": "#/definitions/peerSite" 17854 } 17855 }, 17856 "siteReplicationAddResponse": { 17857 "type": "object", 17858 "properties": { 17859 "errorDetail": { 17860 "type": "string" 17861 }, 17862 "initialSyncErrorMessage": { 17863 "type": "string" 17864 }, 17865 "status": { 17866 "type": "string" 17867 }, 17868 "success": { 17869 "type": "boolean" 17870 } 17871 } 17872 }, 17873 "siteReplicationInfoResponse": { 17874 "type": "object", 17875 "properties": { 17876 "enabled": { 17877 "type": "boolean" 17878 }, 17879 "name": { 17880 "type": "string" 17881 }, 17882 "serviceAccountAccessKey": { 17883 "type": "string" 17884 }, 17885 "sites": { 17886 "type": "array", 17887 "items": { 17888 "$ref": "#/definitions/peerInfo" 17889 } 17890 } 17891 } 17892 }, 17893 "siteReplicationStatusResponse": { 17894 "type": "object", 17895 "properties": { 17896 "bucketStats": { 17897 "type": "object" 17898 }, 17899 "enabled": { 17900 "type": "boolean" 17901 }, 17902 "groupStats": { 17903 "type": "object" 17904 }, 17905 "maxBuckets": { 17906 "type": "integer" 17907 }, 17908 "maxGroups": { 17909 "type": "integer" 17910 }, 17911 "maxPolicies": { 17912 "type": "integer" 17913 }, 17914 "maxUsers": { 17915 "type": "integer" 17916 }, 17917 "policyStats": { 17918 "type": "object" 17919 }, 17920 "sites": { 17921 "type": "object" 17922 }, 17923 "statsSummary": { 17924 "type": "object" 17925 }, 17926 "userStats": { 17927 "type": "object" 17928 } 17929 } 17930 }, 17931 "startProfilingItem": { 17932 "type": "object", 17933 "properties": { 17934 "error": { 17935 "type": "string" 17936 }, 17937 "nodeName": { 17938 "type": "string" 17939 }, 17940 "success": { 17941 "type": "boolean" 17942 } 17943 } 17944 }, 17945 "startProfilingList": { 17946 "type": "object", 17947 "properties": { 17948 "startResults": { 17949 "type": "array", 17950 "items": { 17951 "$ref": "#/definitions/startProfilingItem" 17952 } 17953 }, 17954 "total": { 17955 "type": "integer", 17956 "format": "int64", 17957 "title": "number of start results" 17958 } 17959 } 17960 }, 17961 "subnetLoginMFARequest": { 17962 "type": "object", 17963 "required": [ 17964 "username", 17965 "otp", 17966 "mfa_token" 17967 ], 17968 "properties": { 17969 "mfa_token": { 17970 "type": "string" 17971 }, 17972 "otp": { 17973 "type": "string" 17974 }, 17975 "username": { 17976 "type": "string" 17977 } 17978 } 17979 }, 17980 "subnetLoginRequest": { 17981 "type": "object", 17982 "properties": { 17983 "apiKey": { 17984 "type": "string" 17985 }, 17986 "password": { 17987 "type": "string" 17988 }, 17989 "username": { 17990 "type": "string" 17991 } 17992 } 17993 }, 17994 "subnetLoginResponse": { 17995 "type": "object", 17996 "properties": { 17997 "access_token": { 17998 "type": "string" 17999 }, 18000 "mfa_token": { 18001 "type": "string" 18002 }, 18003 "organizations": { 18004 "type": "array", 18005 "items": { 18006 "$ref": "#/definitions/subnetOrganization" 18007 } 18008 }, 18009 "registered": { 18010 "type": "boolean" 18011 } 18012 } 18013 }, 18014 "subnetOrganization": { 18015 "type": "object", 18016 "properties": { 18017 "accountId": { 18018 "type": "integer" 18019 }, 18020 "company": { 18021 "type": "string" 18022 }, 18023 "isAccountOwner": { 18024 "type": "boolean" 18025 }, 18026 "shortName": { 18027 "type": "string" 18028 }, 18029 "subscriptionStatus": { 18030 "type": "string" 18031 }, 18032 "userId": { 18033 "type": "integer" 18034 } 18035 } 18036 }, 18037 "subnetRegisterRequest": { 18038 "type": "object", 18039 "required": [ 18040 "token", 18041 "account_id" 18042 ], 18043 "properties": { 18044 "account_id": { 18045 "type": "string" 18046 }, 18047 "token": { 18048 "type": "string" 18049 } 18050 } 18051 }, 18052 "tier": { 18053 "type": "object", 18054 "properties": { 18055 "azure": { 18056 "type": "object", 18057 "$ref": "#/definitions/tier_azure" 18058 }, 18059 "gcs": { 18060 "type": "object", 18061 "$ref": "#/definitions/tier_gcs" 18062 }, 18063 "minio": { 18064 "type": "object", 18065 "$ref": "#/definitions/tier_minio" 18066 }, 18067 "s3": { 18068 "type": "object", 18069 "$ref": "#/definitions/tier_s3" 18070 }, 18071 "status": { 18072 "type": "boolean" 18073 }, 18074 "type": { 18075 "type": "string", 18076 "enum": [ 18077 "s3", 18078 "gcs", 18079 "azure", 18080 "minio", 18081 "unsupported" 18082 ] 18083 } 18084 } 18085 }, 18086 "tierCredentialsRequest": { 18087 "type": "object", 18088 "properties": { 18089 "access_key": { 18090 "type": "string" 18091 }, 18092 "creds": { 18093 "description": "a base64 encoded value", 18094 "type": "string" 18095 }, 18096 "secret_key": { 18097 "type": "string" 18098 } 18099 } 18100 }, 18101 "tierListResponse": { 18102 "type": "object", 18103 "properties": { 18104 "items": { 18105 "type": "array", 18106 "items": { 18107 "$ref": "#/definitions/tier" 18108 } 18109 } 18110 } 18111 }, 18112 "tier_azure": { 18113 "type": "object", 18114 "properties": { 18115 "accountkey": { 18116 "type": "string" 18117 }, 18118 "accountname": { 18119 "type": "string" 18120 }, 18121 "bucket": { 18122 "type": "string" 18123 }, 18124 "endpoint": { 18125 "type": "string" 18126 }, 18127 "name": { 18128 "type": "string" 18129 }, 18130 "objects": { 18131 "type": "string" 18132 }, 18133 "prefix": { 18134 "type": "string" 18135 }, 18136 "region": { 18137 "type": "string" 18138 }, 18139 "usage": { 18140 "type": "string" 18141 }, 18142 "versions": { 18143 "type": "string" 18144 } 18145 } 18146 }, 18147 "tier_gcs": { 18148 "type": "object", 18149 "properties": { 18150 "bucket": { 18151 "type": "string" 18152 }, 18153 "creds": { 18154 "type": "string" 18155 }, 18156 "endpoint": { 18157 "type": "string" 18158 }, 18159 "name": { 18160 "type": "string" 18161 }, 18162 "objects": { 18163 "type": "string" 18164 }, 18165 "prefix": { 18166 "type": "string" 18167 }, 18168 "region": { 18169 "type": "string" 18170 }, 18171 "usage": { 18172 "type": "string" 18173 }, 18174 "versions": { 18175 "type": "string" 18176 } 18177 } 18178 }, 18179 "tier_minio": { 18180 "type": "object", 18181 "properties": { 18182 "accesskey": { 18183 "type": "string" 18184 }, 18185 "bucket": { 18186 "type": "string" 18187 }, 18188 "endpoint": { 18189 "type": "string" 18190 }, 18191 "name": { 18192 "type": "string" 18193 }, 18194 "objects": { 18195 "type": "string" 18196 }, 18197 "prefix": { 18198 "type": "string" 18199 }, 18200 "region": { 18201 "type": "string" 18202 }, 18203 "secretkey": { 18204 "type": "string" 18205 }, 18206 "storageclass": { 18207 "type": "string" 18208 }, 18209 "usage": { 18210 "type": "string" 18211 }, 18212 "versions": { 18213 "type": "string" 18214 } 18215 } 18216 }, 18217 "tier_s3": { 18218 "type": "object", 18219 "properties": { 18220 "accesskey": { 18221 "type": "string" 18222 }, 18223 "bucket": { 18224 "type": "string" 18225 }, 18226 "endpoint": { 18227 "type": "string" 18228 }, 18229 "name": { 18230 "type": "string" 18231 }, 18232 "objects": { 18233 "type": "string" 18234 }, 18235 "prefix": { 18236 "type": "string" 18237 }, 18238 "region": { 18239 "type": "string" 18240 }, 18241 "secretkey": { 18242 "type": "string" 18243 }, 18244 "storageclass": { 18245 "type": "string" 18246 }, 18247 "usage": { 18248 "type": "string" 18249 }, 18250 "versions": { 18251 "type": "string" 18252 } 18253 } 18254 }, 18255 "transitionResponse": { 18256 "type": "object", 18257 "properties": { 18258 "date": { 18259 "type": "string" 18260 }, 18261 "days": { 18262 "type": "integer", 18263 "format": "int64" 18264 }, 18265 "noncurrent_storage_class": { 18266 "type": "string" 18267 }, 18268 "noncurrent_transition_days": { 18269 "type": "integer", 18270 "format": "int64" 18271 }, 18272 "storage_class": { 18273 "type": "string" 18274 } 18275 } 18276 }, 18277 "updateBucketLifecycle": { 18278 "type": "object", 18279 "required": [ 18280 "type" 18281 ], 18282 "properties": { 18283 "disable": { 18284 "description": "Non required, toggle to disable or enable rule", 18285 "type": "boolean" 18286 }, 18287 "expired_object_delete_all": { 18288 "description": "Non required, toggle to disable or enable rule", 18289 "type": "boolean" 18290 }, 18291 "expired_object_delete_marker": { 18292 "description": "Non required, toggle to disable or enable rule", 18293 "type": "boolean" 18294 }, 18295 "expiry_days": { 18296 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 18297 "type": "integer", 18298 "format": "int32", 18299 "default": 0 18300 }, 18301 "noncurrentversion_expiration_days": { 18302 "description": "Non required, can be set in case of expiration is enabled", 18303 "type": "integer", 18304 "format": "int32", 18305 "default": 0 18306 }, 18307 "noncurrentversion_transition_days": { 18308 "description": "Non required, can be set in case of transition is enabled", 18309 "type": "integer", 18310 "format": "int32", 18311 "default": 0 18312 }, 18313 "noncurrentversion_transition_storage_class": { 18314 "description": "Non required, can be set in case of transition is enabled", 18315 "type": "string" 18316 }, 18317 "prefix": { 18318 "description": "Non required field, it matches a prefix to perform ILM operations on it", 18319 "type": "string" 18320 }, 18321 "storage_class": { 18322 "description": "Required only in case of transition is set. it refers to a tier", 18323 "type": "string" 18324 }, 18325 "tags": { 18326 "description": "Non required field, tags to match ILM files", 18327 "type": "string" 18328 }, 18329 "transition_days": { 18330 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 18331 "type": "integer", 18332 "format": "int32", 18333 "default": 0 18334 }, 18335 "type": { 18336 "description": "ILM Rule type (Expiry or transition)", 18337 "type": "string", 18338 "enum": [ 18339 "expiry", 18340 "transition" 18341 ] 18342 } 18343 } 18344 }, 18345 "updateGroupRequest": { 18346 "type": "object", 18347 "required": [ 18348 "members", 18349 "status" 18350 ], 18351 "properties": { 18352 "members": { 18353 "type": "array", 18354 "items": { 18355 "type": "string" 18356 } 18357 }, 18358 "status": { 18359 "type": "string" 18360 } 18361 } 18362 }, 18363 "updateServiceAccountRequest": { 18364 "type": "object", 18365 "required": [ 18366 "policy" 18367 ], 18368 "properties": { 18369 "description": { 18370 "type": "string" 18371 }, 18372 "expiry": { 18373 "type": "string" 18374 }, 18375 "name": { 18376 "type": "string" 18377 }, 18378 "policy": { 18379 "type": "string" 18380 }, 18381 "secretKey": { 18382 "type": "string" 18383 }, 18384 "status": { 18385 "type": "string" 18386 } 18387 } 18388 }, 18389 "updateUser": { 18390 "type": "object", 18391 "required": [ 18392 "status", 18393 "groups" 18394 ], 18395 "properties": { 18396 "groups": { 18397 "type": "array", 18398 "items": { 18399 "type": "string" 18400 } 18401 }, 18402 "status": { 18403 "type": "string" 18404 } 18405 } 18406 }, 18407 "updateUserGroups": { 18408 "type": "object", 18409 "required": [ 18410 "groups" 18411 ], 18412 "properties": { 18413 "groups": { 18414 "type": "array", 18415 "items": { 18416 "type": "string" 18417 } 18418 } 18419 } 18420 }, 18421 "user": { 18422 "type": "object", 18423 "properties": { 18424 "accessKey": { 18425 "type": "string" 18426 }, 18427 "hasPolicy": { 18428 "type": "boolean" 18429 }, 18430 "memberOf": { 18431 "type": "array", 18432 "items": { 18433 "type": "string" 18434 } 18435 }, 18436 "policy": { 18437 "type": "array", 18438 "items": { 18439 "type": "string" 18440 } 18441 }, 18442 "status": { 18443 "type": "string" 18444 } 18445 } 18446 }, 18447 "userSAs": { 18448 "type": "object", 18449 "properties": { 18450 "path": { 18451 "type": "string" 18452 }, 18453 "recursive": { 18454 "type": "boolean" 18455 }, 18456 "versionID": { 18457 "type": "string" 18458 } 18459 } 18460 }, 18461 "userServiceAccountItem": { 18462 "type": "object", 18463 "properties": { 18464 "numSAs": { 18465 "type": "integer", 18466 "format": "int64" 18467 }, 18468 "userName": { 18469 "type": "string" 18470 } 18471 } 18472 }, 18473 "userServiceAccountSummary": { 18474 "type": "object", 18475 "properties": { 18476 "hasSA": { 18477 "type": "boolean" 18478 }, 18479 "userServiceAccountList": { 18480 "type": "array", 18481 "title": "list of users with number of service accounts", 18482 "items": { 18483 "$ref": "#/definitions/userServiceAccountItem" 18484 } 18485 } 18486 } 18487 }, 18488 "widget": { 18489 "type": "object", 18490 "properties": { 18491 "id": { 18492 "type": "integer", 18493 "format": "int32" 18494 }, 18495 "options": { 18496 "type": "object", 18497 "properties": { 18498 "reduceOptions": { 18499 "type": "object", 18500 "properties": { 18501 "calcs": { 18502 "type": "array", 18503 "items": { 18504 "type": "string" 18505 } 18506 } 18507 } 18508 } 18509 } 18510 }, 18511 "targets": { 18512 "type": "array", 18513 "items": { 18514 "$ref": "#/definitions/resultTarget" 18515 } 18516 }, 18517 "title": { 18518 "type": "string" 18519 }, 18520 "type": { 18521 "type": "string" 18522 } 18523 } 18524 }, 18525 "widgetDetails": { 18526 "type": "object", 18527 "properties": { 18528 "id": { 18529 "type": "integer", 18530 "format": "int32" 18531 }, 18532 "options": { 18533 "type": "object", 18534 "properties": { 18535 "reduceOptions": { 18536 "type": "object", 18537 "properties": { 18538 "calcs": { 18539 "type": "array", 18540 "items": { 18541 "type": "string" 18542 } 18543 } 18544 } 18545 } 18546 } 18547 }, 18548 "targets": { 18549 "type": "array", 18550 "items": { 18551 "$ref": "#/definitions/resultTarget" 18552 } 18553 }, 18554 "title": { 18555 "type": "string" 18556 }, 18557 "type": { 18558 "type": "string" 18559 } 18560 } 18561 }, 18562 "widgetResult": { 18563 "type": "object", 18564 "properties": { 18565 "metric": { 18566 "type": "object", 18567 "additionalProperties": { 18568 "type": "string" 18569 } 18570 }, 18571 "values": { 18572 "type": "array", 18573 "items": {} 18574 } 18575 } 18576 } 18577 }, 18578 "parameters": { 18579 "limit": { 18580 "type": "number", 18581 "format": "int32", 18582 "default": 20, 18583 "name": "limit", 18584 "in": "query" 18585 }, 18586 "offset": { 18587 "type": "number", 18588 "format": "int32", 18589 "default": 0, 18590 "name": "offset", 18591 "in": "query" 18592 } 18593 }, 18594 "securityDefinitions": { 18595 "anonymous": { 18596 "type": "apiKey", 18597 "name": "X-Anonymous", 18598 "in": "header" 18599 }, 18600 "key": { 18601 "type": "oauth2", 18602 "flow": "accessCode", 18603 "authorizationUrl": "http://min.io", 18604 "tokenUrl": "http://min.io" 18605 } 18606 }, 18607 "security": [ 18608 { 18609 "key": [] 18610 } 18611 ] 18612 }`)) 18613 }