github.com/minio/console@v1.3.0/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 "responses": { 1768 "200": { 1769 "description": "A successful response.", 1770 "schema": { 1771 "$ref": "#/definitions/metadata" 1772 } 1773 }, 1774 "default": { 1775 "description": "Generic error response.", 1776 "schema": { 1777 "$ref": "#/definitions/ApiError" 1778 } 1779 } 1780 } 1781 } 1782 }, 1783 "/buckets/{bucket_name}/objects/restore": { 1784 "put": { 1785 "tags": [ 1786 "Object" 1787 ], 1788 "summary": "Restore Object to a selected version", 1789 "operationId": "PutObjectRestore", 1790 "parameters": [ 1791 { 1792 "type": "string", 1793 "name": "bucket_name", 1794 "in": "path", 1795 "required": true 1796 }, 1797 { 1798 "type": "string", 1799 "name": "prefix", 1800 "in": "query", 1801 "required": true 1802 }, 1803 { 1804 "type": "string", 1805 "name": "version_id", 1806 "in": "query", 1807 "required": true 1808 } 1809 ], 1810 "responses": { 1811 "200": { 1812 "description": "A successful response." 1813 }, 1814 "default": { 1815 "description": "Generic error response.", 1816 "schema": { 1817 "$ref": "#/definitions/ApiError" 1818 } 1819 } 1820 } 1821 } 1822 }, 1823 "/buckets/{bucket_name}/objects/retention": { 1824 "put": { 1825 "tags": [ 1826 "Object" 1827 ], 1828 "summary": "Put Object's retention status", 1829 "operationId": "PutObjectRetention", 1830 "parameters": [ 1831 { 1832 "type": "string", 1833 "name": "bucket_name", 1834 "in": "path", 1835 "required": true 1836 }, 1837 { 1838 "type": "string", 1839 "name": "prefix", 1840 "in": "query", 1841 "required": true 1842 }, 1843 { 1844 "type": "string", 1845 "name": "version_id", 1846 "in": "query", 1847 "required": true 1848 }, 1849 { 1850 "name": "body", 1851 "in": "body", 1852 "required": true, 1853 "schema": { 1854 "$ref": "#/definitions/putObjectRetentionRequest" 1855 } 1856 } 1857 ], 1858 "responses": { 1859 "200": { 1860 "description": "A successful response." 1861 }, 1862 "default": { 1863 "description": "Generic error response.", 1864 "schema": { 1865 "$ref": "#/definitions/ApiError" 1866 } 1867 } 1868 } 1869 }, 1870 "delete": { 1871 "tags": [ 1872 "Object" 1873 ], 1874 "summary": "Delete Object retention from an object", 1875 "operationId": "DeleteObjectRetention", 1876 "parameters": [ 1877 { 1878 "type": "string", 1879 "name": "bucket_name", 1880 "in": "path", 1881 "required": true 1882 }, 1883 { 1884 "type": "string", 1885 "name": "prefix", 1886 "in": "query", 1887 "required": true 1888 }, 1889 { 1890 "type": "string", 1891 "name": "version_id", 1892 "in": "query", 1893 "required": true 1894 } 1895 ], 1896 "responses": { 1897 "200": { 1898 "description": "A successful response." 1899 }, 1900 "default": { 1901 "description": "Generic error response.", 1902 "schema": { 1903 "$ref": "#/definitions/ApiError" 1904 } 1905 } 1906 } 1907 } 1908 }, 1909 "/buckets/{bucket_name}/objects/share": { 1910 "get": { 1911 "tags": [ 1912 "Object" 1913 ], 1914 "summary": "Shares an Object on a url", 1915 "operationId": "ShareObject", 1916 "parameters": [ 1917 { 1918 "type": "string", 1919 "name": "bucket_name", 1920 "in": "path", 1921 "required": true 1922 }, 1923 { 1924 "type": "string", 1925 "name": "prefix", 1926 "in": "query", 1927 "required": true 1928 }, 1929 { 1930 "type": "string", 1931 "name": "version_id", 1932 "in": "query", 1933 "required": true 1934 }, 1935 { 1936 "type": "string", 1937 "name": "expires", 1938 "in": "query" 1939 } 1940 ], 1941 "responses": { 1942 "200": { 1943 "description": "A successful response.", 1944 "schema": { 1945 "type": "string" 1946 } 1947 }, 1948 "default": { 1949 "description": "Generic error response.", 1950 "schema": { 1951 "$ref": "#/definitions/ApiError" 1952 } 1953 } 1954 } 1955 } 1956 }, 1957 "/buckets/{bucket_name}/objects/tags": { 1958 "put": { 1959 "tags": [ 1960 "Object" 1961 ], 1962 "summary": "Put Object's tags", 1963 "operationId": "PutObjectTags", 1964 "parameters": [ 1965 { 1966 "type": "string", 1967 "name": "bucket_name", 1968 "in": "path", 1969 "required": true 1970 }, 1971 { 1972 "type": "string", 1973 "name": "prefix", 1974 "in": "query", 1975 "required": true 1976 }, 1977 { 1978 "type": "string", 1979 "name": "version_id", 1980 "in": "query", 1981 "required": true 1982 }, 1983 { 1984 "name": "body", 1985 "in": "body", 1986 "required": true, 1987 "schema": { 1988 "$ref": "#/definitions/putObjectTagsRequest" 1989 } 1990 } 1991 ], 1992 "responses": { 1993 "200": { 1994 "description": "A successful response." 1995 }, 1996 "default": { 1997 "description": "Generic error response.", 1998 "schema": { 1999 "$ref": "#/definitions/ApiError" 2000 } 2001 } 2002 } 2003 } 2004 }, 2005 "/buckets/{bucket_name}/objects/upload": { 2006 "post": { 2007 "security": [ 2008 { 2009 "key": [] 2010 }, 2011 { 2012 "anonymous": [] 2013 } 2014 ], 2015 "consumes": [ 2016 "multipart/form-data" 2017 ], 2018 "tags": [ 2019 "Object" 2020 ], 2021 "summary": "Uploads an Object.", 2022 "parameters": [ 2023 { 2024 "type": "string", 2025 "name": "bucket_name", 2026 "in": "path", 2027 "required": true 2028 }, 2029 { 2030 "type": "string", 2031 "name": "prefix", 2032 "in": "query" 2033 } 2034 ], 2035 "responses": { 2036 "200": { 2037 "description": "A successful response." 2038 }, 2039 "default": { 2040 "description": "Generic error response.", 2041 "schema": { 2042 "$ref": "#/definitions/ApiError" 2043 } 2044 } 2045 } 2046 } 2047 }, 2048 "/buckets/{bucket_name}/replication": { 2049 "get": { 2050 "tags": [ 2051 "Bucket" 2052 ], 2053 "summary": "Bucket Replication", 2054 "operationId": "GetBucketReplication", 2055 "parameters": [ 2056 { 2057 "type": "string", 2058 "name": "bucket_name", 2059 "in": "path", 2060 "required": true 2061 } 2062 ], 2063 "responses": { 2064 "200": { 2065 "description": "A successful response.", 2066 "schema": { 2067 "$ref": "#/definitions/bucketReplicationResponse" 2068 } 2069 }, 2070 "default": { 2071 "description": "Generic error response.", 2072 "schema": { 2073 "$ref": "#/definitions/ApiError" 2074 } 2075 } 2076 } 2077 } 2078 }, 2079 "/buckets/{bucket_name}/replication/{rule_id}": { 2080 "get": { 2081 "tags": [ 2082 "Bucket" 2083 ], 2084 "summary": "Bucket Replication", 2085 "operationId": "GetBucketReplicationRule", 2086 "parameters": [ 2087 { 2088 "type": "string", 2089 "name": "bucket_name", 2090 "in": "path", 2091 "required": true 2092 }, 2093 { 2094 "type": "string", 2095 "name": "rule_id", 2096 "in": "path", 2097 "required": true 2098 } 2099 ], 2100 "responses": { 2101 "200": { 2102 "description": "A successful response.", 2103 "schema": { 2104 "$ref": "#/definitions/bucketReplicationRule" 2105 } 2106 }, 2107 "default": { 2108 "description": "Generic error response.", 2109 "schema": { 2110 "$ref": "#/definitions/ApiError" 2111 } 2112 } 2113 } 2114 }, 2115 "put": { 2116 "tags": [ 2117 "Bucket" 2118 ], 2119 "summary": "Update Replication rule", 2120 "operationId": "UpdateMultiBucketReplication", 2121 "parameters": [ 2122 { 2123 "type": "string", 2124 "name": "bucket_name", 2125 "in": "path", 2126 "required": true 2127 }, 2128 { 2129 "type": "string", 2130 "name": "rule_id", 2131 "in": "path", 2132 "required": true 2133 }, 2134 { 2135 "name": "body", 2136 "in": "body", 2137 "required": true, 2138 "schema": { 2139 "$ref": "#/definitions/multiBucketReplicationEdit" 2140 } 2141 } 2142 ], 2143 "responses": { 2144 "201": { 2145 "description": "A successful response." 2146 }, 2147 "default": { 2148 "description": "Generic error response.", 2149 "schema": { 2150 "$ref": "#/definitions/ApiError" 2151 } 2152 } 2153 } 2154 }, 2155 "delete": { 2156 "tags": [ 2157 "Bucket" 2158 ], 2159 "summary": "Bucket Replication Rule Delete", 2160 "operationId": "DeleteBucketReplicationRule", 2161 "parameters": [ 2162 { 2163 "type": "string", 2164 "name": "bucket_name", 2165 "in": "path", 2166 "required": true 2167 }, 2168 { 2169 "type": "string", 2170 "name": "rule_id", 2171 "in": "path", 2172 "required": true 2173 } 2174 ], 2175 "responses": { 2176 "204": { 2177 "description": "A successful response." 2178 }, 2179 "default": { 2180 "description": "Generic error response.", 2181 "schema": { 2182 "$ref": "#/definitions/ApiError" 2183 } 2184 } 2185 } 2186 } 2187 }, 2188 "/buckets/{bucket_name}/retention": { 2189 "get": { 2190 "tags": [ 2191 "Bucket" 2192 ], 2193 "summary": "Get Bucket's retention config", 2194 "operationId": "GetBucketRetentionConfig", 2195 "parameters": [ 2196 { 2197 "type": "string", 2198 "name": "bucket_name", 2199 "in": "path", 2200 "required": true 2201 } 2202 ], 2203 "responses": { 2204 "200": { 2205 "description": "A successful response.", 2206 "schema": { 2207 "$ref": "#/definitions/getBucketRetentionConfig" 2208 } 2209 }, 2210 "default": { 2211 "description": "Generic error response.", 2212 "schema": { 2213 "$ref": "#/definitions/ApiError" 2214 } 2215 } 2216 } 2217 }, 2218 "put": { 2219 "tags": [ 2220 "Bucket" 2221 ], 2222 "summary": "Set Bucket's retention config", 2223 "operationId": "SetBucketRetentionConfig", 2224 "parameters": [ 2225 { 2226 "type": "string", 2227 "name": "bucket_name", 2228 "in": "path", 2229 "required": true 2230 }, 2231 { 2232 "name": "body", 2233 "in": "body", 2234 "required": true, 2235 "schema": { 2236 "$ref": "#/definitions/putBucketRetentionRequest" 2237 } 2238 } 2239 ], 2240 "responses": { 2241 "200": { 2242 "description": "A successful response." 2243 }, 2244 "default": { 2245 "description": "Generic error response.", 2246 "schema": { 2247 "$ref": "#/definitions/ApiError" 2248 } 2249 } 2250 } 2251 } 2252 }, 2253 "/buckets/{bucket_name}/rewind/{date}": { 2254 "get": { 2255 "tags": [ 2256 "Bucket" 2257 ], 2258 "summary": "Get objects in a bucket for a rewind date", 2259 "operationId": "GetBucketRewind", 2260 "parameters": [ 2261 { 2262 "type": "string", 2263 "name": "bucket_name", 2264 "in": "path", 2265 "required": true 2266 }, 2267 { 2268 "type": "string", 2269 "name": "date", 2270 "in": "path", 2271 "required": true 2272 }, 2273 { 2274 "type": "string", 2275 "name": "prefix", 2276 "in": "query" 2277 } 2278 ], 2279 "responses": { 2280 "200": { 2281 "description": "A successful response.", 2282 "schema": { 2283 "$ref": "#/definitions/rewindResponse" 2284 } 2285 }, 2286 "default": { 2287 "description": "Generic error response.", 2288 "schema": { 2289 "$ref": "#/definitions/ApiError" 2290 } 2291 } 2292 } 2293 } 2294 }, 2295 "/buckets/{bucket_name}/tags": { 2296 "put": { 2297 "tags": [ 2298 "Bucket" 2299 ], 2300 "summary": "Put Bucket's tags", 2301 "operationId": "PutBucketTags", 2302 "parameters": [ 2303 { 2304 "type": "string", 2305 "name": "bucket_name", 2306 "in": "path", 2307 "required": true 2308 }, 2309 { 2310 "name": "body", 2311 "in": "body", 2312 "required": true, 2313 "schema": { 2314 "$ref": "#/definitions/putBucketTagsRequest" 2315 } 2316 } 2317 ], 2318 "responses": { 2319 "200": { 2320 "description": "A successful response." 2321 }, 2322 "default": { 2323 "description": "Generic error response.", 2324 "schema": { 2325 "$ref": "#/definitions/ApiError" 2326 } 2327 } 2328 } 2329 } 2330 }, 2331 "/buckets/{bucket_name}/versioning": { 2332 "get": { 2333 "tags": [ 2334 "Bucket" 2335 ], 2336 "summary": "Bucket Versioning", 2337 "operationId": "GetBucketVersioning", 2338 "parameters": [ 2339 { 2340 "type": "string", 2341 "name": "bucket_name", 2342 "in": "path", 2343 "required": true 2344 } 2345 ], 2346 "responses": { 2347 "200": { 2348 "description": "A successful response.", 2349 "schema": { 2350 "$ref": "#/definitions/bucketVersioningResponse" 2351 } 2352 }, 2353 "default": { 2354 "description": "Generic error response.", 2355 "schema": { 2356 "$ref": "#/definitions/ApiError" 2357 } 2358 } 2359 } 2360 }, 2361 "put": { 2362 "tags": [ 2363 "Bucket" 2364 ], 2365 "summary": "Set Bucket Versioning", 2366 "operationId": "SetBucketVersioning", 2367 "parameters": [ 2368 { 2369 "type": "string", 2370 "name": "bucket_name", 2371 "in": "path", 2372 "required": true 2373 }, 2374 { 2375 "name": "body", 2376 "in": "body", 2377 "required": true, 2378 "schema": { 2379 "$ref": "#/definitions/setBucketVersioning" 2380 } 2381 } 2382 ], 2383 "responses": { 2384 "201": { 2385 "description": "A successful response." 2386 }, 2387 "default": { 2388 "description": "Generic error response.", 2389 "schema": { 2390 "$ref": "#/definitions/ApiError" 2391 } 2392 } 2393 } 2394 } 2395 }, 2396 "/buckets/{name}": { 2397 "get": { 2398 "tags": [ 2399 "Bucket" 2400 ], 2401 "summary": "Bucket Info", 2402 "operationId": "BucketInfo", 2403 "parameters": [ 2404 { 2405 "type": "string", 2406 "name": "name", 2407 "in": "path", 2408 "required": true 2409 } 2410 ], 2411 "responses": { 2412 "200": { 2413 "description": "A successful response.", 2414 "schema": { 2415 "$ref": "#/definitions/bucket" 2416 } 2417 }, 2418 "default": { 2419 "description": "Generic error response.", 2420 "schema": { 2421 "$ref": "#/definitions/ApiError" 2422 } 2423 } 2424 } 2425 }, 2426 "delete": { 2427 "tags": [ 2428 "Bucket" 2429 ], 2430 "summary": "Delete Bucket", 2431 "operationId": "DeleteBucket", 2432 "parameters": [ 2433 { 2434 "type": "string", 2435 "name": "name", 2436 "in": "path", 2437 "required": true 2438 } 2439 ], 2440 "responses": { 2441 "204": { 2442 "description": "A successful response." 2443 }, 2444 "default": { 2445 "description": "Generic error response.", 2446 "schema": { 2447 "$ref": "#/definitions/ApiError" 2448 } 2449 } 2450 } 2451 } 2452 }, 2453 "/buckets/{name}/quota": { 2454 "get": { 2455 "tags": [ 2456 "Bucket" 2457 ], 2458 "summary": "Get Bucket Quota", 2459 "operationId": "GetBucketQuota", 2460 "parameters": [ 2461 { 2462 "type": "string", 2463 "name": "name", 2464 "in": "path", 2465 "required": true 2466 } 2467 ], 2468 "responses": { 2469 "200": { 2470 "description": "A successful response.", 2471 "schema": { 2472 "$ref": "#/definitions/bucketQuota" 2473 } 2474 }, 2475 "default": { 2476 "description": "Generic error response.", 2477 "schema": { 2478 "$ref": "#/definitions/ApiError" 2479 } 2480 } 2481 } 2482 }, 2483 "put": { 2484 "tags": [ 2485 "Bucket" 2486 ], 2487 "summary": "Bucket Quota", 2488 "operationId": "SetBucketQuota", 2489 "parameters": [ 2490 { 2491 "type": "string", 2492 "name": "name", 2493 "in": "path", 2494 "required": true 2495 }, 2496 { 2497 "name": "body", 2498 "in": "body", 2499 "required": true, 2500 "schema": { 2501 "$ref": "#/definitions/setBucketQuota" 2502 } 2503 } 2504 ], 2505 "responses": { 2506 "200": { 2507 "description": "A successful response.", 2508 "schema": { 2509 "$ref": "#/definitions/bucket" 2510 } 2511 }, 2512 "default": { 2513 "description": "Generic error response.", 2514 "schema": { 2515 "$ref": "#/definitions/ApiError" 2516 } 2517 } 2518 } 2519 } 2520 }, 2521 "/buckets/{name}/set-policy": { 2522 "put": { 2523 "tags": [ 2524 "Bucket" 2525 ], 2526 "summary": "Bucket Set Policy", 2527 "operationId": "BucketSetPolicy", 2528 "parameters": [ 2529 { 2530 "type": "string", 2531 "name": "name", 2532 "in": "path", 2533 "required": true 2534 }, 2535 { 2536 "name": "body", 2537 "in": "body", 2538 "required": true, 2539 "schema": { 2540 "$ref": "#/definitions/setBucketPolicyRequest" 2541 } 2542 } 2543 ], 2544 "responses": { 2545 "200": { 2546 "description": "A successful response.", 2547 "schema": { 2548 "$ref": "#/definitions/bucket" 2549 } 2550 }, 2551 "default": { 2552 "description": "Generic error response.", 2553 "schema": { 2554 "$ref": "#/definitions/ApiError" 2555 } 2556 } 2557 } 2558 } 2559 }, 2560 "/configs": { 2561 "get": { 2562 "tags": [ 2563 "Configuration" 2564 ], 2565 "summary": "List Configurations", 2566 "operationId": "ListConfig", 2567 "parameters": [ 2568 { 2569 "$ref": "#/parameters/offset" 2570 }, 2571 { 2572 "$ref": "#/parameters/limit" 2573 } 2574 ], 2575 "responses": { 2576 "200": { 2577 "description": "A successful response.", 2578 "schema": { 2579 "$ref": "#/definitions/listConfigResponse" 2580 } 2581 }, 2582 "default": { 2583 "description": "Generic error response.", 2584 "schema": { 2585 "$ref": "#/definitions/ApiError" 2586 } 2587 } 2588 } 2589 } 2590 }, 2591 "/configs/export": { 2592 "get": { 2593 "tags": [ 2594 "Configuration" 2595 ], 2596 "summary": "Export the current config from MinIO server", 2597 "operationId": "ExportConfig", 2598 "responses": { 2599 "200": { 2600 "description": "A successful response.", 2601 "schema": { 2602 "$ref": "#/definitions/configExportResponse" 2603 } 2604 }, 2605 "default": { 2606 "description": "Generic error response.", 2607 "schema": { 2608 "$ref": "#/definitions/ApiError" 2609 } 2610 } 2611 } 2612 } 2613 }, 2614 "/configs/import": { 2615 "post": { 2616 "consumes": [ 2617 "multipart/form-data" 2618 ], 2619 "tags": [ 2620 "Configuration" 2621 ], 2622 "summary": "Uploads a file to import MinIO server config.", 2623 "parameters": [ 2624 { 2625 "type": "file", 2626 "name": "file", 2627 "in": "formData", 2628 "required": true 2629 } 2630 ], 2631 "responses": { 2632 "200": { 2633 "description": "A successful response." 2634 }, 2635 "default": { 2636 "description": "Generic error response.", 2637 "schema": { 2638 "$ref": "#/definitions/ApiError" 2639 } 2640 } 2641 } 2642 } 2643 }, 2644 "/configs/{name}": { 2645 "get": { 2646 "tags": [ 2647 "Configuration" 2648 ], 2649 "summary": "Configuration info", 2650 "operationId": "ConfigInfo", 2651 "parameters": [ 2652 { 2653 "type": "string", 2654 "name": "name", 2655 "in": "path", 2656 "required": true 2657 } 2658 ], 2659 "responses": { 2660 "200": { 2661 "description": "A successful response.", 2662 "schema": { 2663 "type": "array", 2664 "items": { 2665 "$ref": "#/definitions/configuration" 2666 } 2667 } 2668 }, 2669 "default": { 2670 "description": "Generic error response.", 2671 "schema": { 2672 "$ref": "#/definitions/ApiError" 2673 } 2674 } 2675 } 2676 }, 2677 "put": { 2678 "tags": [ 2679 "Configuration" 2680 ], 2681 "summary": "Set Configuration", 2682 "operationId": "SetConfig", 2683 "parameters": [ 2684 { 2685 "type": "string", 2686 "name": "name", 2687 "in": "path", 2688 "required": true 2689 }, 2690 { 2691 "name": "body", 2692 "in": "body", 2693 "required": true, 2694 "schema": { 2695 "$ref": "#/definitions/setConfigRequest" 2696 } 2697 } 2698 ], 2699 "responses": { 2700 "200": { 2701 "description": "A successful response.", 2702 "schema": { 2703 "$ref": "#/definitions/setConfigResponse" 2704 } 2705 }, 2706 "default": { 2707 "description": "Generic error response.", 2708 "schema": { 2709 "$ref": "#/definitions/ApiError" 2710 } 2711 } 2712 } 2713 } 2714 }, 2715 "/configs/{name}/reset": { 2716 "post": { 2717 "tags": [ 2718 "Configuration" 2719 ], 2720 "summary": "Configuration reset", 2721 "operationId": "ResetConfig", 2722 "parameters": [ 2723 { 2724 "type": "string", 2725 "name": "name", 2726 "in": "path", 2727 "required": true 2728 } 2729 ], 2730 "responses": { 2731 "200": { 2732 "description": "A successful response.", 2733 "schema": { 2734 "$ref": "#/definitions/setConfigResponse" 2735 } 2736 }, 2737 "default": { 2738 "description": "Generic error response.", 2739 "schema": { 2740 "$ref": "#/definitions/ApiError" 2741 } 2742 } 2743 } 2744 } 2745 }, 2746 "/download-shared-object/{url}": { 2747 "get": { 2748 "security": [], 2749 "produces": [ 2750 "application/octet-stream" 2751 ], 2752 "tags": [ 2753 "Public" 2754 ], 2755 "summary": "Downloads an object from a presigned url", 2756 "operationId": "DownloadSharedObject", 2757 "parameters": [ 2758 { 2759 "type": "string", 2760 "name": "url", 2761 "in": "path", 2762 "required": true 2763 } 2764 ], 2765 "responses": { 2766 "200": { 2767 "description": "A successful response.", 2768 "schema": { 2769 "type": "file" 2770 } 2771 }, 2772 "default": { 2773 "description": "Generic error response.", 2774 "schema": { 2775 "$ref": "#/definitions/ApiError" 2776 } 2777 } 2778 } 2779 } 2780 }, 2781 "/group/{name}": { 2782 "get": { 2783 "tags": [ 2784 "Group" 2785 ], 2786 "summary": "Group info", 2787 "operationId": "GroupInfo", 2788 "parameters": [ 2789 { 2790 "type": "string", 2791 "name": "name", 2792 "in": "path", 2793 "required": true 2794 } 2795 ], 2796 "responses": { 2797 "200": { 2798 "description": "A successful response.", 2799 "schema": { 2800 "$ref": "#/definitions/group" 2801 } 2802 }, 2803 "default": { 2804 "description": "Generic error response.", 2805 "schema": { 2806 "$ref": "#/definitions/ApiError" 2807 } 2808 } 2809 } 2810 }, 2811 "put": { 2812 "tags": [ 2813 "Group" 2814 ], 2815 "summary": "Update Group Members or Status", 2816 "operationId": "UpdateGroup", 2817 "parameters": [ 2818 { 2819 "type": "string", 2820 "name": "name", 2821 "in": "path", 2822 "required": true 2823 }, 2824 { 2825 "name": "body", 2826 "in": "body", 2827 "required": true, 2828 "schema": { 2829 "$ref": "#/definitions/updateGroupRequest" 2830 } 2831 } 2832 ], 2833 "responses": { 2834 "200": { 2835 "description": "A successful response.", 2836 "schema": { 2837 "$ref": "#/definitions/group" 2838 } 2839 }, 2840 "default": { 2841 "description": "Generic error response.", 2842 "schema": { 2843 "$ref": "#/definitions/ApiError" 2844 } 2845 } 2846 } 2847 }, 2848 "delete": { 2849 "tags": [ 2850 "Group" 2851 ], 2852 "summary": "Remove group", 2853 "operationId": "RemoveGroup", 2854 "parameters": [ 2855 { 2856 "type": "string", 2857 "name": "name", 2858 "in": "path", 2859 "required": true 2860 } 2861 ], 2862 "responses": { 2863 "204": { 2864 "description": "A successful response." 2865 }, 2866 "default": { 2867 "description": "Generic error response.", 2868 "schema": { 2869 "$ref": "#/definitions/ApiError" 2870 } 2871 } 2872 } 2873 } 2874 }, 2875 "/groups": { 2876 "get": { 2877 "tags": [ 2878 "Group" 2879 ], 2880 "summary": "List Groups", 2881 "operationId": "ListGroups", 2882 "parameters": [ 2883 { 2884 "$ref": "#/parameters/offset" 2885 }, 2886 { 2887 "$ref": "#/parameters/limit" 2888 } 2889 ], 2890 "responses": { 2891 "200": { 2892 "description": "A successful response.", 2893 "schema": { 2894 "$ref": "#/definitions/listGroupsResponse" 2895 } 2896 }, 2897 "default": { 2898 "description": "Generic error response.", 2899 "schema": { 2900 "$ref": "#/definitions/ApiError" 2901 } 2902 } 2903 } 2904 }, 2905 "post": { 2906 "tags": [ 2907 "Group" 2908 ], 2909 "summary": "Add Group", 2910 "operationId": "AddGroup", 2911 "parameters": [ 2912 { 2913 "name": "body", 2914 "in": "body", 2915 "required": true, 2916 "schema": { 2917 "$ref": "#/definitions/addGroupRequest" 2918 } 2919 } 2920 ], 2921 "responses": { 2922 "201": { 2923 "description": "A successful response." 2924 }, 2925 "default": { 2926 "description": "Generic error response.", 2927 "schema": { 2928 "$ref": "#/definitions/ApiError" 2929 } 2930 } 2931 } 2932 } 2933 }, 2934 "/idp/{type}": { 2935 "get": { 2936 "tags": [ 2937 "idp" 2938 ], 2939 "summary": "List IDP Configurations", 2940 "operationId": "ListConfigurations", 2941 "parameters": [ 2942 { 2943 "type": "string", 2944 "description": "IDP Configuration Type", 2945 "name": "type", 2946 "in": "path", 2947 "required": true 2948 } 2949 ], 2950 "responses": { 2951 "200": { 2952 "description": "A successful response.", 2953 "schema": { 2954 "$ref": "#/definitions/idpListConfigurationsResponse" 2955 } 2956 }, 2957 "default": { 2958 "description": "Generic error response.", 2959 "schema": { 2960 "$ref": "#/definitions/ApiError" 2961 } 2962 } 2963 } 2964 }, 2965 "post": { 2966 "consumes": [ 2967 "application/json" 2968 ], 2969 "tags": [ 2970 "idp" 2971 ], 2972 "summary": "Create IDP Configuration", 2973 "operationId": "CreateConfiguration", 2974 "parameters": [ 2975 { 2976 "type": "string", 2977 "description": "IDP Configuration Type", 2978 "name": "type", 2979 "in": "path", 2980 "required": true 2981 }, 2982 { 2983 "name": "body", 2984 "in": "body", 2985 "required": true, 2986 "schema": { 2987 "$ref": "#/definitions/idpServerConfiguration" 2988 } 2989 } 2990 ], 2991 "responses": { 2992 "201": { 2993 "description": "A successful response.", 2994 "schema": { 2995 "$ref": "#/definitions/setIDPResponse" 2996 } 2997 }, 2998 "default": { 2999 "description": "Generic error response.", 3000 "schema": { 3001 "$ref": "#/definitions/ApiError" 3002 } 3003 } 3004 } 3005 } 3006 }, 3007 "/idp/{type}/{name}": { 3008 "get": { 3009 "tags": [ 3010 "idp" 3011 ], 3012 "summary": "Get IDP Configuration", 3013 "operationId": "GetConfiguration", 3014 "parameters": [ 3015 { 3016 "type": "string", 3017 "description": "IDP Configuration Name", 3018 "name": "name", 3019 "in": "path", 3020 "required": true 3021 }, 3022 { 3023 "type": "string", 3024 "description": "IDP Configuration Type", 3025 "name": "type", 3026 "in": "path", 3027 "required": true 3028 } 3029 ], 3030 "responses": { 3031 "200": { 3032 "description": "A successful response.", 3033 "schema": { 3034 "$ref": "#/definitions/idpServerConfiguration" 3035 } 3036 }, 3037 "default": { 3038 "description": "Generic error response.", 3039 "schema": { 3040 "$ref": "#/definitions/ApiError" 3041 } 3042 } 3043 } 3044 }, 3045 "put": { 3046 "consumes": [ 3047 "application/json" 3048 ], 3049 "tags": [ 3050 "idp" 3051 ], 3052 "summary": "Update IDP Configuration", 3053 "operationId": "UpdateConfiguration", 3054 "parameters": [ 3055 { 3056 "name": "body", 3057 "in": "body", 3058 "required": true, 3059 "schema": { 3060 "$ref": "#/definitions/idpServerConfiguration" 3061 } 3062 }, 3063 { 3064 "type": "string", 3065 "description": "IDP Configuration Name", 3066 "name": "name", 3067 "in": "path", 3068 "required": true 3069 }, 3070 { 3071 "type": "string", 3072 "description": "IDP Configuration Type", 3073 "name": "type", 3074 "in": "path", 3075 "required": true 3076 } 3077 ], 3078 "responses": { 3079 "200": { 3080 "description": "A successful response.", 3081 "schema": { 3082 "$ref": "#/definitions/setIDPResponse" 3083 } 3084 }, 3085 "default": { 3086 "description": "Generic error response.", 3087 "schema": { 3088 "$ref": "#/definitions/ApiError" 3089 } 3090 } 3091 } 3092 }, 3093 "delete": { 3094 "tags": [ 3095 "idp" 3096 ], 3097 "summary": "Delete IDP Configuration", 3098 "operationId": "DeleteConfiguration", 3099 "parameters": [ 3100 { 3101 "type": "string", 3102 "description": "IDP Configuration Name", 3103 "name": "name", 3104 "in": "path", 3105 "required": true 3106 }, 3107 { 3108 "type": "string", 3109 "description": "IDP Configuration Type", 3110 "name": "type", 3111 "in": "path", 3112 "required": true 3113 } 3114 ], 3115 "responses": { 3116 "200": { 3117 "description": "A successful response.", 3118 "schema": { 3119 "$ref": "#/definitions/setIDPResponse" 3120 } 3121 }, 3122 "default": { 3123 "description": "Generic error response.", 3124 "schema": { 3125 "$ref": "#/definitions/ApiError" 3126 } 3127 } 3128 } 3129 } 3130 }, 3131 "/kms/apis": { 3132 "get": { 3133 "tags": [ 3134 "KMS" 3135 ], 3136 "summary": "KMS apis", 3137 "operationId": "KMSAPIs", 3138 "responses": { 3139 "200": { 3140 "description": "A successful response.", 3141 "schema": { 3142 "$ref": "#/definitions/kmsAPIsResponse" 3143 } 3144 }, 3145 "default": { 3146 "description": "Generic error response.", 3147 "schema": { 3148 "$ref": "#/definitions/ApiError" 3149 } 3150 } 3151 } 3152 } 3153 }, 3154 "/kms/describe-self/identity": { 3155 "get": { 3156 "tags": [ 3157 "KMS" 3158 ], 3159 "summary": "KMS describe self identity", 3160 "operationId": "KMSDescribeSelfIdentity", 3161 "responses": { 3162 "200": { 3163 "description": "A successful response.", 3164 "schema": { 3165 "$ref": "#/definitions/kmsDescribeSelfIdentityResponse" 3166 } 3167 }, 3168 "default": { 3169 "description": "Generic error response.", 3170 "schema": { 3171 "$ref": "#/definitions/ApiError" 3172 } 3173 } 3174 } 3175 } 3176 }, 3177 "/kms/identities": { 3178 "get": { 3179 "tags": [ 3180 "KMS" 3181 ], 3182 "summary": "KMS list identities", 3183 "operationId": "KMSListIdentities", 3184 "parameters": [ 3185 { 3186 "type": "string", 3187 "description": "pattern to retrieve identities", 3188 "name": "pattern", 3189 "in": "query" 3190 } 3191 ], 3192 "responses": { 3193 "200": { 3194 "description": "A successful response.", 3195 "schema": { 3196 "$ref": "#/definitions/kmsListIdentitiesResponse" 3197 } 3198 }, 3199 "default": { 3200 "description": "Generic error response.", 3201 "schema": { 3202 "$ref": "#/definitions/ApiError" 3203 } 3204 } 3205 } 3206 } 3207 }, 3208 "/kms/identities/{name}": { 3209 "delete": { 3210 "tags": [ 3211 "KMS" 3212 ], 3213 "summary": "KMS delete identity", 3214 "operationId": "KMSDeleteIdentity", 3215 "parameters": [ 3216 { 3217 "type": "string", 3218 "description": "KMS identity name", 3219 "name": "name", 3220 "in": "path", 3221 "required": true 3222 } 3223 ], 3224 "responses": { 3225 "200": { 3226 "description": "A successful response." 3227 }, 3228 "default": { 3229 "description": "Generic error response.", 3230 "schema": { 3231 "$ref": "#/definitions/ApiError" 3232 } 3233 } 3234 } 3235 } 3236 }, 3237 "/kms/identities/{name}/describe": { 3238 "get": { 3239 "tags": [ 3240 "KMS" 3241 ], 3242 "summary": "KMS describe identity", 3243 "operationId": "KMSDescribeIdentity", 3244 "parameters": [ 3245 { 3246 "type": "string", 3247 "description": "KMS identity name", 3248 "name": "name", 3249 "in": "path", 3250 "required": true 3251 } 3252 ], 3253 "responses": { 3254 "200": { 3255 "description": "A successful response.", 3256 "schema": { 3257 "$ref": "#/definitions/kmsDescribeIdentityResponse" 3258 } 3259 }, 3260 "default": { 3261 "description": "Generic error response.", 3262 "schema": { 3263 "$ref": "#/definitions/ApiError" 3264 } 3265 } 3266 } 3267 } 3268 }, 3269 "/kms/keys": { 3270 "get": { 3271 "tags": [ 3272 "KMS" 3273 ], 3274 "summary": "KMS list keys", 3275 "operationId": "KMSListKeys", 3276 "parameters": [ 3277 { 3278 "type": "string", 3279 "description": "pattern to retrieve keys", 3280 "name": "pattern", 3281 "in": "query" 3282 } 3283 ], 3284 "responses": { 3285 "200": { 3286 "description": "A successful response.", 3287 "schema": { 3288 "$ref": "#/definitions/kmsListKeysResponse" 3289 } 3290 }, 3291 "default": { 3292 "description": "Generic error response.", 3293 "schema": { 3294 "$ref": "#/definitions/ApiError" 3295 } 3296 } 3297 } 3298 }, 3299 "post": { 3300 "tags": [ 3301 "KMS" 3302 ], 3303 "summary": "KMS create key", 3304 "operationId": "KMSCreateKey", 3305 "parameters": [ 3306 { 3307 "name": "body", 3308 "in": "body", 3309 "required": true, 3310 "schema": { 3311 "$ref": "#/definitions/kmsCreateKeyRequest" 3312 } 3313 } 3314 ], 3315 "responses": { 3316 "201": { 3317 "description": "A successful response." 3318 }, 3319 "default": { 3320 "description": "Generic error response.", 3321 "schema": { 3322 "$ref": "#/definitions/ApiError" 3323 } 3324 } 3325 } 3326 } 3327 }, 3328 "/kms/keys/{name}": { 3329 "get": { 3330 "tags": [ 3331 "KMS" 3332 ], 3333 "summary": "KMS key status", 3334 "operationId": "KMSKeyStatus", 3335 "parameters": [ 3336 { 3337 "type": "string", 3338 "description": "KMS key name", 3339 "name": "name", 3340 "in": "path", 3341 "required": true 3342 } 3343 ], 3344 "responses": { 3345 "200": { 3346 "description": "A successful response.", 3347 "schema": { 3348 "$ref": "#/definitions/kmsKeyStatusResponse" 3349 } 3350 }, 3351 "default": { 3352 "description": "Generic error response.", 3353 "schema": { 3354 "$ref": "#/definitions/ApiError" 3355 } 3356 } 3357 } 3358 }, 3359 "delete": { 3360 "tags": [ 3361 "KMS" 3362 ], 3363 "summary": "KMS delete key", 3364 "operationId": "KMSDeleteKey", 3365 "parameters": [ 3366 { 3367 "type": "string", 3368 "description": "KMS key name", 3369 "name": "name", 3370 "in": "path", 3371 "required": true 3372 } 3373 ], 3374 "responses": { 3375 "200": { 3376 "description": "A successful response." 3377 }, 3378 "default": { 3379 "description": "Generic error response.", 3380 "schema": { 3381 "$ref": "#/definitions/ApiError" 3382 } 3383 } 3384 } 3385 } 3386 }, 3387 "/kms/keys/{name}/import": { 3388 "post": { 3389 "tags": [ 3390 "KMS" 3391 ], 3392 "summary": "KMS import key", 3393 "operationId": "KMSImportKey", 3394 "parameters": [ 3395 { 3396 "name": "body", 3397 "in": "body", 3398 "required": true, 3399 "schema": { 3400 "$ref": "#/definitions/kmsImportKeyRequest" 3401 } 3402 }, 3403 { 3404 "type": "string", 3405 "description": "KMS key name", 3406 "name": "name", 3407 "in": "path", 3408 "required": true 3409 } 3410 ], 3411 "responses": { 3412 "201": { 3413 "description": "A successful response." 3414 }, 3415 "default": { 3416 "description": "Generic error response.", 3417 "schema": { 3418 "$ref": "#/definitions/ApiError" 3419 } 3420 } 3421 } 3422 } 3423 }, 3424 "/kms/metrics": { 3425 "get": { 3426 "tags": [ 3427 "KMS" 3428 ], 3429 "summary": "KMS metrics", 3430 "operationId": "KMSMetrics", 3431 "responses": { 3432 "200": { 3433 "description": "A successful response.", 3434 "schema": { 3435 "$ref": "#/definitions/kmsMetricsResponse" 3436 } 3437 }, 3438 "default": { 3439 "description": "Generic error response.", 3440 "schema": { 3441 "$ref": "#/definitions/ApiError" 3442 } 3443 } 3444 } 3445 } 3446 }, 3447 "/kms/policies": { 3448 "get": { 3449 "tags": [ 3450 "KMS" 3451 ], 3452 "summary": "KMS list policies", 3453 "operationId": "KMSListPolicies", 3454 "parameters": [ 3455 { 3456 "type": "string", 3457 "description": "pattern to retrieve policies", 3458 "name": "pattern", 3459 "in": "query" 3460 } 3461 ], 3462 "responses": { 3463 "200": { 3464 "description": "A successful response.", 3465 "schema": { 3466 "$ref": "#/definitions/kmsListPoliciesResponse" 3467 } 3468 }, 3469 "default": { 3470 "description": "Generic error response.", 3471 "schema": { 3472 "$ref": "#/definitions/ApiError" 3473 } 3474 } 3475 } 3476 }, 3477 "post": { 3478 "tags": [ 3479 "KMS" 3480 ], 3481 "summary": "KMS set policy", 3482 "operationId": "KMSSetPolicy", 3483 "parameters": [ 3484 { 3485 "name": "body", 3486 "in": "body", 3487 "required": true, 3488 "schema": { 3489 "$ref": "#/definitions/kmsSetPolicyRequest" 3490 } 3491 } 3492 ], 3493 "responses": { 3494 "200": { 3495 "description": "A successful response." 3496 }, 3497 "default": { 3498 "description": "Generic error response.", 3499 "schema": { 3500 "$ref": "#/definitions/ApiError" 3501 } 3502 } 3503 } 3504 } 3505 }, 3506 "/kms/policies/{name}": { 3507 "get": { 3508 "tags": [ 3509 "KMS" 3510 ], 3511 "summary": "KMS get policy", 3512 "operationId": "KMSGetPolicy", 3513 "parameters": [ 3514 { 3515 "type": "string", 3516 "description": "KMS policy name", 3517 "name": "name", 3518 "in": "path", 3519 "required": true 3520 } 3521 ], 3522 "responses": { 3523 "200": { 3524 "description": "A successful response.", 3525 "schema": { 3526 "$ref": "#/definitions/kmsGetPolicyResponse" 3527 } 3528 }, 3529 "default": { 3530 "description": "Generic error response.", 3531 "schema": { 3532 "$ref": "#/definitions/ApiError" 3533 } 3534 } 3535 } 3536 }, 3537 "delete": { 3538 "tags": [ 3539 "KMS" 3540 ], 3541 "summary": "KMS delete policy", 3542 "operationId": "KMSDeletePolicy", 3543 "parameters": [ 3544 { 3545 "type": "string", 3546 "description": "KMS policy name", 3547 "name": "name", 3548 "in": "path", 3549 "required": true 3550 } 3551 ], 3552 "responses": { 3553 "200": { 3554 "description": "A successful response." 3555 }, 3556 "default": { 3557 "description": "Generic error response.", 3558 "schema": { 3559 "$ref": "#/definitions/ApiError" 3560 } 3561 } 3562 } 3563 } 3564 }, 3565 "/kms/policies/{name}/assign": { 3566 "post": { 3567 "tags": [ 3568 "KMS" 3569 ], 3570 "summary": "KMS assign policy", 3571 "operationId": "KMSAssignPolicy", 3572 "parameters": [ 3573 { 3574 "name": "body", 3575 "in": "body", 3576 "required": true, 3577 "schema": { 3578 "$ref": "#/definitions/kmsAssignPolicyRequest" 3579 } 3580 }, 3581 { 3582 "type": "string", 3583 "description": "KMS policy name", 3584 "name": "name", 3585 "in": "path", 3586 "required": true 3587 } 3588 ], 3589 "responses": { 3590 "200": { 3591 "description": "A successful response." 3592 }, 3593 "default": { 3594 "description": "Generic error response.", 3595 "schema": { 3596 "$ref": "#/definitions/ApiError" 3597 } 3598 } 3599 } 3600 } 3601 }, 3602 "/kms/policies/{name}/describe": { 3603 "get": { 3604 "tags": [ 3605 "KMS" 3606 ], 3607 "summary": "KMS describe policy", 3608 "operationId": "KMSDescribePolicy", 3609 "parameters": [ 3610 { 3611 "type": "string", 3612 "description": "KMS policy name", 3613 "name": "name", 3614 "in": "path", 3615 "required": true 3616 } 3617 ], 3618 "responses": { 3619 "200": { 3620 "description": "A successful response.", 3621 "schema": { 3622 "$ref": "#/definitions/kmsDescribePolicyResponse" 3623 } 3624 }, 3625 "default": { 3626 "description": "Generic error response.", 3627 "schema": { 3628 "$ref": "#/definitions/ApiError" 3629 } 3630 } 3631 } 3632 } 3633 }, 3634 "/kms/status": { 3635 "get": { 3636 "tags": [ 3637 "KMS" 3638 ], 3639 "summary": "KMS status", 3640 "operationId": "KMSStatus", 3641 "responses": { 3642 "200": { 3643 "description": "A successful response.", 3644 "schema": { 3645 "$ref": "#/definitions/kmsStatusResponse" 3646 } 3647 }, 3648 "default": { 3649 "description": "Generic error response.", 3650 "schema": { 3651 "$ref": "#/definitions/ApiError" 3652 } 3653 } 3654 } 3655 } 3656 }, 3657 "/kms/version": { 3658 "get": { 3659 "tags": [ 3660 "KMS" 3661 ], 3662 "summary": "KMS version", 3663 "operationId": "KMSVersion", 3664 "responses": { 3665 "200": { 3666 "description": "A successful response.", 3667 "schema": { 3668 "$ref": "#/definitions/kmsVersionResponse" 3669 } 3670 }, 3671 "default": { 3672 "description": "Generic error response.", 3673 "schema": { 3674 "$ref": "#/definitions/ApiError" 3675 } 3676 } 3677 } 3678 } 3679 }, 3680 "/ldap-entities": { 3681 "post": { 3682 "tags": [ 3683 "idp" 3684 ], 3685 "summary": "Get LDAP Entities", 3686 "operationId": "GetLDAPEntities", 3687 "parameters": [ 3688 { 3689 "name": "body", 3690 "in": "body", 3691 "required": true, 3692 "schema": { 3693 "$ref": "#/definitions/ldapEntitiesRequest" 3694 } 3695 } 3696 ], 3697 "responses": { 3698 "200": { 3699 "description": "A successful response.", 3700 "schema": { 3701 "$ref": "#/definitions/ldapEntities" 3702 } 3703 }, 3704 "default": { 3705 "description": "Generic error response.", 3706 "schema": { 3707 "$ref": "#/definitions/ApiError" 3708 } 3709 } 3710 } 3711 } 3712 }, 3713 "/list-external-buckets": { 3714 "post": { 3715 "tags": [ 3716 "Bucket" 3717 ], 3718 "summary": "Lists an External list of buckets using custom credentials", 3719 "operationId": "ListExternalBuckets", 3720 "parameters": [ 3721 { 3722 "name": "body", 3723 "in": "body", 3724 "required": true, 3725 "schema": { 3726 "$ref": "#/definitions/listExternalBucketsParams" 3727 } 3728 } 3729 ], 3730 "responses": { 3731 "200": { 3732 "description": "A successful response.", 3733 "schema": { 3734 "$ref": "#/definitions/listBucketsResponse" 3735 } 3736 }, 3737 "default": { 3738 "description": "Generic error response.", 3739 "schema": { 3740 "$ref": "#/definitions/ApiError" 3741 } 3742 } 3743 } 3744 } 3745 }, 3746 "/login": { 3747 "get": { 3748 "security": [], 3749 "tags": [ 3750 "Auth" 3751 ], 3752 "summary": "Returns login strategy, form or sso.", 3753 "operationId": "LoginDetail", 3754 "responses": { 3755 "200": { 3756 "description": "A successful response.", 3757 "schema": { 3758 "$ref": "#/definitions/loginDetails" 3759 } 3760 }, 3761 "default": { 3762 "description": "Generic error response.", 3763 "schema": { 3764 "$ref": "#/definitions/ApiError" 3765 } 3766 } 3767 } 3768 }, 3769 "post": { 3770 "security": [], 3771 "tags": [ 3772 "Auth" 3773 ], 3774 "summary": "Login to Console", 3775 "operationId": "Login", 3776 "parameters": [ 3777 { 3778 "name": "body", 3779 "in": "body", 3780 "required": true, 3781 "schema": { 3782 "$ref": "#/definitions/loginRequest" 3783 } 3784 } 3785 ], 3786 "responses": { 3787 "204": { 3788 "description": "A successful login." 3789 }, 3790 "default": { 3791 "description": "Generic error response.", 3792 "schema": { 3793 "$ref": "#/definitions/ApiError" 3794 } 3795 } 3796 } 3797 } 3798 }, 3799 "/login/oauth2/auth": { 3800 "post": { 3801 "security": [], 3802 "tags": [ 3803 "Auth" 3804 ], 3805 "summary": "Identity Provider oauth2 callback endpoint.", 3806 "operationId": "LoginOauth2Auth", 3807 "parameters": [ 3808 { 3809 "name": "body", 3810 "in": "body", 3811 "required": true, 3812 "schema": { 3813 "$ref": "#/definitions/loginOauth2AuthRequest" 3814 } 3815 } 3816 ], 3817 "responses": { 3818 "204": { 3819 "description": "A successful login." 3820 }, 3821 "default": { 3822 "description": "Generic error response.", 3823 "schema": { 3824 "$ref": "#/definitions/ApiError" 3825 } 3826 } 3827 } 3828 } 3829 }, 3830 "/logout": { 3831 "post": { 3832 "tags": [ 3833 "Auth" 3834 ], 3835 "summary": "Logout from Console.", 3836 "operationId": "Logout", 3837 "parameters": [ 3838 { 3839 "name": "body", 3840 "in": "body", 3841 "required": true, 3842 "schema": { 3843 "$ref": "#/definitions/logoutRequest" 3844 } 3845 } 3846 ], 3847 "responses": { 3848 "200": { 3849 "description": "A successful response." 3850 }, 3851 "default": { 3852 "description": "Generic error response.", 3853 "schema": { 3854 "$ref": "#/definitions/ApiError" 3855 } 3856 } 3857 } 3858 } 3859 }, 3860 "/logs/search": { 3861 "get": { 3862 "tags": [ 3863 "Logging" 3864 ], 3865 "summary": "Search the logs", 3866 "operationId": "LogSearch", 3867 "parameters": [ 3868 { 3869 "type": "array", 3870 "items": { 3871 "type": "string" 3872 }, 3873 "collectionFormat": "multi", 3874 "description": "Filter Parameters", 3875 "name": "fp", 3876 "in": "query" 3877 }, 3878 { 3879 "type": "number", 3880 "format": "int32", 3881 "default": 10, 3882 "name": "pageSize", 3883 "in": "query" 3884 }, 3885 { 3886 "type": "number", 3887 "format": "int32", 3888 "default": 0, 3889 "name": "pageNo", 3890 "in": "query" 3891 }, 3892 { 3893 "enum": [ 3894 "timeDesc", 3895 "timeAsc" 3896 ], 3897 "type": "string", 3898 "default": "timeDesc", 3899 "name": "order", 3900 "in": "query" 3901 }, 3902 { 3903 "type": "string", 3904 "name": "timeStart", 3905 "in": "query" 3906 }, 3907 { 3908 "type": "string", 3909 "name": "timeEnd", 3910 "in": "query" 3911 } 3912 ], 3913 "responses": { 3914 "200": { 3915 "description": "A successful response.", 3916 "schema": { 3917 "$ref": "#/definitions/logSearchResponse" 3918 } 3919 }, 3920 "default": { 3921 "description": "Generic error response.", 3922 "schema": { 3923 "$ref": "#/definitions/ApiError" 3924 } 3925 } 3926 } 3927 } 3928 }, 3929 "/nodes": { 3930 "get": { 3931 "tags": [ 3932 "System" 3933 ], 3934 "summary": "Lists Nodes", 3935 "operationId": "ListNodes", 3936 "responses": { 3937 "200": { 3938 "description": "A successful response.", 3939 "schema": { 3940 "type": "array", 3941 "items": { 3942 "type": "string" 3943 } 3944 } 3945 }, 3946 "default": { 3947 "description": "Generic error response.", 3948 "schema": { 3949 "$ref": "#/definitions/ApiError" 3950 } 3951 } 3952 } 3953 } 3954 }, 3955 "/policies": { 3956 "get": { 3957 "tags": [ 3958 "Policy" 3959 ], 3960 "summary": "List Policies", 3961 "operationId": "ListPolicies", 3962 "parameters": [ 3963 { 3964 "$ref": "#/parameters/offset" 3965 }, 3966 { 3967 "$ref": "#/parameters/limit" 3968 } 3969 ], 3970 "responses": { 3971 "200": { 3972 "description": "A successful response.", 3973 "schema": { 3974 "$ref": "#/definitions/listPoliciesResponse" 3975 } 3976 }, 3977 "default": { 3978 "description": "Generic error response.", 3979 "schema": { 3980 "$ref": "#/definitions/ApiError" 3981 } 3982 } 3983 } 3984 }, 3985 "post": { 3986 "tags": [ 3987 "Policy" 3988 ], 3989 "summary": "Add Policy", 3990 "operationId": "AddPolicy", 3991 "parameters": [ 3992 { 3993 "name": "body", 3994 "in": "body", 3995 "required": true, 3996 "schema": { 3997 "$ref": "#/definitions/addPolicyRequest" 3998 } 3999 } 4000 ], 4001 "responses": { 4002 "201": { 4003 "description": "A successful response.", 4004 "schema": { 4005 "$ref": "#/definitions/policy" 4006 } 4007 }, 4008 "default": { 4009 "description": "Generic error response.", 4010 "schema": { 4011 "$ref": "#/definitions/ApiError" 4012 } 4013 } 4014 } 4015 } 4016 }, 4017 "/policies/{policy}/groups": { 4018 "get": { 4019 "tags": [ 4020 "Policy" 4021 ], 4022 "summary": "List Groups for a Policy", 4023 "operationId": "ListGroupsForPolicy", 4024 "parameters": [ 4025 { 4026 "type": "string", 4027 "name": "policy", 4028 "in": "path", 4029 "required": true 4030 } 4031 ], 4032 "responses": { 4033 "200": { 4034 "description": "A successful response.", 4035 "schema": { 4036 "type": "array", 4037 "items": { 4038 "type": "string" 4039 } 4040 } 4041 }, 4042 "default": { 4043 "description": "Generic error response.", 4044 "schema": { 4045 "$ref": "#/definitions/ApiError" 4046 } 4047 } 4048 } 4049 } 4050 }, 4051 "/policies/{policy}/users": { 4052 "get": { 4053 "tags": [ 4054 "Policy" 4055 ], 4056 "summary": "List Users for a Policy", 4057 "operationId": "ListUsersForPolicy", 4058 "parameters": [ 4059 { 4060 "type": "string", 4061 "name": "policy", 4062 "in": "path", 4063 "required": true 4064 } 4065 ], 4066 "responses": { 4067 "200": { 4068 "description": "A successful response.", 4069 "schema": { 4070 "type": "array", 4071 "items": { 4072 "type": "string" 4073 } 4074 } 4075 }, 4076 "default": { 4077 "description": "Generic error response.", 4078 "schema": { 4079 "$ref": "#/definitions/ApiError" 4080 } 4081 } 4082 } 4083 } 4084 }, 4085 "/policy/{name}": { 4086 "get": { 4087 "tags": [ 4088 "Policy" 4089 ], 4090 "summary": "Policy info", 4091 "operationId": "PolicyInfo", 4092 "parameters": [ 4093 { 4094 "type": "string", 4095 "name": "name", 4096 "in": "path", 4097 "required": true 4098 } 4099 ], 4100 "responses": { 4101 "200": { 4102 "description": "A successful response.", 4103 "schema": { 4104 "$ref": "#/definitions/policy" 4105 } 4106 }, 4107 "default": { 4108 "description": "Generic error response.", 4109 "schema": { 4110 "$ref": "#/definitions/ApiError" 4111 } 4112 } 4113 } 4114 }, 4115 "delete": { 4116 "tags": [ 4117 "Policy" 4118 ], 4119 "summary": "Remove policy", 4120 "operationId": "RemovePolicy", 4121 "parameters": [ 4122 { 4123 "type": "string", 4124 "name": "name", 4125 "in": "path", 4126 "required": true 4127 } 4128 ], 4129 "responses": { 4130 "204": { 4131 "description": "A successful response." 4132 }, 4133 "default": { 4134 "description": "Generic error response.", 4135 "schema": { 4136 "$ref": "#/definitions/ApiError" 4137 } 4138 } 4139 } 4140 } 4141 }, 4142 "/profiling/start": { 4143 "post": { 4144 "tags": [ 4145 "Profile" 4146 ], 4147 "summary": "Start recording profile data", 4148 "operationId": "ProfilingStart", 4149 "parameters": [ 4150 { 4151 "name": "body", 4152 "in": "body", 4153 "required": true, 4154 "schema": { 4155 "$ref": "#/definitions/profilingStartRequest" 4156 } 4157 } 4158 ], 4159 "responses": { 4160 "201": { 4161 "description": "A successful response.", 4162 "schema": { 4163 "$ref": "#/definitions/startProfilingList" 4164 } 4165 }, 4166 "default": { 4167 "description": "Generic error response.", 4168 "schema": { 4169 "$ref": "#/definitions/ApiError" 4170 } 4171 } 4172 } 4173 } 4174 }, 4175 "/profiling/stop": { 4176 "post": { 4177 "produces": [ 4178 "application/zip" 4179 ], 4180 "tags": [ 4181 "Profile" 4182 ], 4183 "summary": "Stop and download profile data", 4184 "operationId": "ProfilingStop", 4185 "responses": { 4186 "201": { 4187 "description": "A successful response.", 4188 "schema": { 4189 "type": "file" 4190 } 4191 }, 4192 "default": { 4193 "description": "Generic error response.", 4194 "schema": { 4195 "$ref": "#/definitions/ApiError" 4196 } 4197 } 4198 } 4199 } 4200 }, 4201 "/releases": { 4202 "get": { 4203 "tags": [ 4204 "release" 4205 ], 4206 "summary": "Get repo releases for a given version", 4207 "operationId": "ListReleases", 4208 "parameters": [ 4209 { 4210 "type": "string", 4211 "description": "repo name", 4212 "name": "repo", 4213 "in": "query", 4214 "required": true 4215 }, 4216 { 4217 "type": "string", 4218 "description": "Current Release", 4219 "name": "current", 4220 "in": "query" 4221 }, 4222 { 4223 "type": "string", 4224 "description": "search content", 4225 "name": "search", 4226 "in": "query" 4227 }, 4228 { 4229 "type": "string", 4230 "description": "filter releases", 4231 "name": "filter", 4232 "in": "query" 4233 } 4234 ], 4235 "responses": { 4236 "200": { 4237 "description": "A successful response.", 4238 "schema": { 4239 "$ref": "#/definitions/releaseListResponse" 4240 } 4241 }, 4242 "default": { 4243 "description": "Generic error response.", 4244 "schema": { 4245 "$ref": "#/definitions/ApiError" 4246 } 4247 } 4248 } 4249 } 4250 }, 4251 "/remote-buckets": { 4252 "get": { 4253 "tags": [ 4254 "Bucket" 4255 ], 4256 "summary": "List Remote Buckets", 4257 "operationId": "ListRemoteBuckets", 4258 "responses": { 4259 "200": { 4260 "description": "A successful response.", 4261 "schema": { 4262 "$ref": "#/definitions/listRemoteBucketsResponse" 4263 } 4264 }, 4265 "default": { 4266 "description": "Generic error response.", 4267 "schema": { 4268 "$ref": "#/definitions/ApiError" 4269 } 4270 } 4271 } 4272 }, 4273 "post": { 4274 "tags": [ 4275 "Bucket" 4276 ], 4277 "summary": "Add Remote Bucket", 4278 "operationId": "AddRemoteBucket", 4279 "parameters": [ 4280 { 4281 "name": "body", 4282 "in": "body", 4283 "required": true, 4284 "schema": { 4285 "$ref": "#/definitions/createRemoteBucket" 4286 } 4287 } 4288 ], 4289 "responses": { 4290 "201": { 4291 "description": "A successful response." 4292 }, 4293 "default": { 4294 "description": "Generic error response.", 4295 "schema": { 4296 "$ref": "#/definitions/ApiError" 4297 } 4298 } 4299 } 4300 } 4301 }, 4302 "/remote-buckets/{name}": { 4303 "get": { 4304 "tags": [ 4305 "Bucket" 4306 ], 4307 "summary": "Remote Bucket Details", 4308 "operationId": "RemoteBucketDetails", 4309 "parameters": [ 4310 { 4311 "type": "string", 4312 "name": "name", 4313 "in": "path", 4314 "required": true 4315 } 4316 ], 4317 "responses": { 4318 "200": { 4319 "description": "A successful response.", 4320 "schema": { 4321 "$ref": "#/definitions/remoteBucket" 4322 } 4323 }, 4324 "default": { 4325 "description": "Generic error response.", 4326 "schema": { 4327 "$ref": "#/definitions/ApiError" 4328 } 4329 } 4330 } 4331 } 4332 }, 4333 "/remote-buckets/{source-bucket-name}/{arn}": { 4334 "delete": { 4335 "tags": [ 4336 "Bucket" 4337 ], 4338 "summary": "Delete Remote Bucket", 4339 "operationId": "DeleteRemoteBucket", 4340 "parameters": [ 4341 { 4342 "type": "string", 4343 "name": "source-bucket-name", 4344 "in": "path", 4345 "required": true 4346 }, 4347 { 4348 "type": "string", 4349 "name": "arn", 4350 "in": "path", 4351 "required": true 4352 } 4353 ], 4354 "responses": { 4355 "204": { 4356 "description": "A successful response." 4357 }, 4358 "default": { 4359 "description": "Generic error response.", 4360 "schema": { 4361 "$ref": "#/definitions/ApiError" 4362 } 4363 } 4364 } 4365 } 4366 }, 4367 "/service-account-credentials": { 4368 "post": { 4369 "tags": [ 4370 "ServiceAccount" 4371 ], 4372 "summary": "Create Service Account With Credentials", 4373 "operationId": "CreateServiceAccountCreds", 4374 "parameters": [ 4375 { 4376 "name": "body", 4377 "in": "body", 4378 "required": true, 4379 "schema": { 4380 "$ref": "#/definitions/serviceAccountRequestCreds" 4381 } 4382 } 4383 ], 4384 "responses": { 4385 "201": { 4386 "description": "A successful response.", 4387 "schema": { 4388 "$ref": "#/definitions/serviceAccountCreds" 4389 } 4390 }, 4391 "default": { 4392 "description": "Generic error response.", 4393 "schema": { 4394 "$ref": "#/definitions/ApiError" 4395 } 4396 } 4397 } 4398 } 4399 }, 4400 "/service-accounts": { 4401 "get": { 4402 "tags": [ 4403 "ServiceAccount" 4404 ], 4405 "summary": "List User's Service Accounts", 4406 "operationId": "ListUserServiceAccounts", 4407 "parameters": [ 4408 { 4409 "$ref": "#/parameters/offset" 4410 }, 4411 { 4412 "$ref": "#/parameters/limit" 4413 } 4414 ], 4415 "responses": { 4416 "200": { 4417 "description": "A successful response.", 4418 "schema": { 4419 "$ref": "#/definitions/serviceAccounts" 4420 } 4421 }, 4422 "default": { 4423 "description": "Generic error response.", 4424 "schema": { 4425 "$ref": "#/definitions/ApiError" 4426 } 4427 } 4428 } 4429 }, 4430 "post": { 4431 "tags": [ 4432 "ServiceAccount" 4433 ], 4434 "summary": "Create Service Account", 4435 "operationId": "CreateServiceAccount", 4436 "parameters": [ 4437 { 4438 "name": "body", 4439 "in": "body", 4440 "required": true, 4441 "schema": { 4442 "$ref": "#/definitions/serviceAccountRequest" 4443 } 4444 } 4445 ], 4446 "responses": { 4447 "201": { 4448 "description": "A successful response.", 4449 "schema": { 4450 "$ref": "#/definitions/serviceAccountCreds" 4451 } 4452 }, 4453 "default": { 4454 "description": "Generic error response.", 4455 "schema": { 4456 "$ref": "#/definitions/ApiError" 4457 } 4458 } 4459 } 4460 } 4461 }, 4462 "/service-accounts/delete-multi": { 4463 "delete": { 4464 "tags": [ 4465 "ServiceAccount" 4466 ], 4467 "summary": "Delete Multiple Service Accounts", 4468 "operationId": "DeleteMultipleServiceAccounts", 4469 "parameters": [ 4470 { 4471 "name": "selectedSA", 4472 "in": "body", 4473 "required": true, 4474 "schema": { 4475 "$ref": "#/definitions/selectedSAs" 4476 } 4477 } 4478 ], 4479 "responses": { 4480 "204": { 4481 "description": "A successful response." 4482 }, 4483 "default": { 4484 "description": "Generic error response.", 4485 "schema": { 4486 "$ref": "#/definitions/ApiError" 4487 } 4488 } 4489 } 4490 } 4491 }, 4492 "/service-accounts/{access_key}": { 4493 "get": { 4494 "tags": [ 4495 "ServiceAccount" 4496 ], 4497 "summary": "Get Service Account", 4498 "operationId": "GetServiceAccount", 4499 "parameters": [ 4500 { 4501 "type": "string", 4502 "name": "access_key", 4503 "in": "path", 4504 "required": true 4505 } 4506 ], 4507 "responses": { 4508 "200": { 4509 "description": "A successful response.", 4510 "schema": { 4511 "$ref": "#/definitions/serviceAccount" 4512 } 4513 }, 4514 "default": { 4515 "description": "Generic error response.", 4516 "schema": { 4517 "$ref": "#/definitions/ApiError" 4518 } 4519 } 4520 } 4521 }, 4522 "put": { 4523 "tags": [ 4524 "ServiceAccount" 4525 ], 4526 "summary": "Set Service Account Policy", 4527 "operationId": "UpdateServiceAccount", 4528 "parameters": [ 4529 { 4530 "type": "string", 4531 "name": "access_key", 4532 "in": "path", 4533 "required": true 4534 }, 4535 { 4536 "name": "body", 4537 "in": "body", 4538 "required": true, 4539 "schema": { 4540 "$ref": "#/definitions/updateServiceAccountRequest" 4541 } 4542 } 4543 ], 4544 "responses": { 4545 "200": { 4546 "description": "A successful response." 4547 }, 4548 "default": { 4549 "description": "Generic error response.", 4550 "schema": { 4551 "$ref": "#/definitions/ApiError" 4552 } 4553 } 4554 } 4555 }, 4556 "delete": { 4557 "tags": [ 4558 "ServiceAccount" 4559 ], 4560 "summary": "Delete Service Account", 4561 "operationId": "DeleteServiceAccount", 4562 "parameters": [ 4563 { 4564 "type": "string", 4565 "name": "access_key", 4566 "in": "path", 4567 "required": true 4568 } 4569 ], 4570 "responses": { 4571 "204": { 4572 "description": "A successful response." 4573 }, 4574 "default": { 4575 "description": "Generic error response.", 4576 "schema": { 4577 "$ref": "#/definitions/ApiError" 4578 } 4579 } 4580 } 4581 } 4582 }, 4583 "/service/restart": { 4584 "post": { 4585 "tags": [ 4586 "Service" 4587 ], 4588 "summary": "Restart Service", 4589 "operationId": "RestartService", 4590 "responses": { 4591 "204": { 4592 "description": "A successful response." 4593 }, 4594 "default": { 4595 "description": "Generic error response.", 4596 "schema": { 4597 "$ref": "#/definitions/ApiError" 4598 } 4599 } 4600 } 4601 } 4602 }, 4603 "/session": { 4604 "get": { 4605 "tags": [ 4606 "Auth" 4607 ], 4608 "summary": "Endpoint to check if your session is still valid", 4609 "operationId": "SessionCheck", 4610 "responses": { 4611 "200": { 4612 "description": "A successful response.", 4613 "schema": { 4614 "$ref": "#/definitions/sessionResponse" 4615 } 4616 }, 4617 "default": { 4618 "description": "Generic error response.", 4619 "schema": { 4620 "$ref": "#/definitions/ApiError" 4621 } 4622 } 4623 } 4624 } 4625 }, 4626 "/set-policy": { 4627 "put": { 4628 "tags": [ 4629 "Policy" 4630 ], 4631 "summary": "Set policy", 4632 "operationId": "SetPolicy", 4633 "parameters": [ 4634 { 4635 "name": "body", 4636 "in": "body", 4637 "required": true, 4638 "schema": { 4639 "$ref": "#/definitions/setPolicyNameRequest" 4640 } 4641 } 4642 ], 4643 "responses": { 4644 "204": { 4645 "description": "A successful response." 4646 }, 4647 "default": { 4648 "description": "Generic error response.", 4649 "schema": { 4650 "$ref": "#/definitions/ApiError" 4651 } 4652 } 4653 } 4654 } 4655 }, 4656 "/set-policy-multi": { 4657 "put": { 4658 "tags": [ 4659 "Policy" 4660 ], 4661 "summary": "Set policy to multiple users/groups", 4662 "operationId": "SetPolicyMultiple", 4663 "parameters": [ 4664 { 4665 "name": "body", 4666 "in": "body", 4667 "required": true, 4668 "schema": { 4669 "$ref": "#/definitions/setPolicyMultipleNameRequest" 4670 } 4671 } 4672 ], 4673 "responses": { 4674 "204": { 4675 "description": "A successful response." 4676 }, 4677 "default": { 4678 "description": "Generic error response.", 4679 "schema": { 4680 "$ref": "#/definitions/ApiError" 4681 } 4682 } 4683 } 4684 } 4685 }, 4686 "/subnet/apikey": { 4687 "get": { 4688 "tags": [ 4689 "Subnet" 4690 ], 4691 "summary": "Subnet api key", 4692 "operationId": "SubnetApiKey", 4693 "parameters": [ 4694 { 4695 "type": "string", 4696 "name": "token", 4697 "in": "query", 4698 "required": true 4699 } 4700 ], 4701 "responses": { 4702 "200": { 4703 "description": "A successful response.", 4704 "schema": { 4705 "$ref": "#/definitions/apiKey" 4706 } 4707 }, 4708 "default": { 4709 "description": "Generic error response.", 4710 "schema": { 4711 "$ref": "#/definitions/ApiError" 4712 } 4713 } 4714 } 4715 } 4716 }, 4717 "/subnet/info": { 4718 "get": { 4719 "tags": [ 4720 "Subnet" 4721 ], 4722 "summary": "Subnet info", 4723 "operationId": "SubnetInfo", 4724 "responses": { 4725 "200": { 4726 "description": "A successful response.", 4727 "schema": { 4728 "$ref": "#/definitions/license" 4729 } 4730 }, 4731 "default": { 4732 "description": "Generic error response.", 4733 "schema": { 4734 "$ref": "#/definitions/ApiError" 4735 } 4736 } 4737 } 4738 } 4739 }, 4740 "/subnet/login": { 4741 "post": { 4742 "tags": [ 4743 "Subnet" 4744 ], 4745 "summary": "Login to SUBNET", 4746 "operationId": "SubnetLogin", 4747 "parameters": [ 4748 { 4749 "name": "body", 4750 "in": "body", 4751 "required": true, 4752 "schema": { 4753 "$ref": "#/definitions/subnetLoginRequest" 4754 } 4755 } 4756 ], 4757 "responses": { 4758 "200": { 4759 "description": "A successful response.", 4760 "schema": { 4761 "$ref": "#/definitions/subnetLoginResponse" 4762 } 4763 }, 4764 "default": { 4765 "description": "Generic error response.", 4766 "schema": { 4767 "$ref": "#/definitions/ApiError" 4768 } 4769 } 4770 } 4771 } 4772 }, 4773 "/subnet/login/mfa": { 4774 "post": { 4775 "tags": [ 4776 "Subnet" 4777 ], 4778 "summary": "Login to SUBNET using mfa", 4779 "operationId": "SubnetLoginMFA", 4780 "parameters": [ 4781 { 4782 "name": "body", 4783 "in": "body", 4784 "required": true, 4785 "schema": { 4786 "$ref": "#/definitions/subnetLoginMFARequest" 4787 } 4788 } 4789 ], 4790 "responses": { 4791 "200": { 4792 "description": "A successful response.", 4793 "schema": { 4794 "$ref": "#/definitions/subnetLoginResponse" 4795 } 4796 }, 4797 "default": { 4798 "description": "Generic error response.", 4799 "schema": { 4800 "$ref": "#/definitions/ApiError" 4801 } 4802 } 4803 } 4804 } 4805 }, 4806 "/subnet/register": { 4807 "post": { 4808 "tags": [ 4809 "Subnet" 4810 ], 4811 "summary": "Register cluster with Subnet", 4812 "operationId": "SubnetRegister", 4813 "parameters": [ 4814 { 4815 "name": "body", 4816 "in": "body", 4817 "required": true, 4818 "schema": { 4819 "$ref": "#/definitions/subnetRegisterRequest" 4820 } 4821 } 4822 ], 4823 "responses": { 4824 "200": { 4825 "description": "A successful response." 4826 }, 4827 "default": { 4828 "description": "Generic error response.", 4829 "schema": { 4830 "$ref": "#/definitions/ApiError" 4831 } 4832 } 4833 } 4834 } 4835 }, 4836 "/subnet/registration-token": { 4837 "get": { 4838 "tags": [ 4839 "Subnet" 4840 ], 4841 "summary": "SUBNET registraton token", 4842 "operationId": "SubnetRegToken", 4843 "responses": { 4844 "200": { 4845 "description": "A successful response.", 4846 "schema": { 4847 "$ref": "#/definitions/SubnetRegTokenResponse" 4848 } 4849 }, 4850 "default": { 4851 "description": "Generic error response.", 4852 "schema": { 4853 "$ref": "#/definitions/ApiError" 4854 } 4855 } 4856 } 4857 } 4858 }, 4859 "/support/callhome": { 4860 "get": { 4861 "tags": [ 4862 "Support" 4863 ], 4864 "summary": "Get Callhome current status", 4865 "operationId": "GetCallHomeOptionValue", 4866 "responses": { 4867 "200": { 4868 "description": "A successful response.", 4869 "schema": { 4870 "$ref": "#/definitions/callHomeGetResponse" 4871 } 4872 }, 4873 "default": { 4874 "description": "Generic error response.", 4875 "schema": { 4876 "$ref": "#/definitions/ApiError" 4877 } 4878 } 4879 } 4880 }, 4881 "put": { 4882 "tags": [ 4883 "Support" 4884 ], 4885 "summary": "Sets callhome status", 4886 "operationId": "SetCallHomeStatus", 4887 "parameters": [ 4888 { 4889 "name": "body", 4890 "in": "body", 4891 "required": true, 4892 "schema": { 4893 "$ref": "#/definitions/callHomeSetStatus" 4894 } 4895 } 4896 ], 4897 "responses": { 4898 "204": { 4899 "description": "A successful response." 4900 }, 4901 "default": { 4902 "description": "Generic error response.", 4903 "schema": { 4904 "$ref": "#/definitions/ApiError" 4905 } 4906 } 4907 } 4908 } 4909 }, 4910 "/user/policy": { 4911 "get": { 4912 "tags": [ 4913 "Policy" 4914 ], 4915 "summary": "returns policies for logged in user", 4916 "operationId": "GetUserPolicy", 4917 "responses": { 4918 "200": { 4919 "description": "A successful response.", 4920 "schema": { 4921 "type": "string" 4922 } 4923 }, 4924 "default": { 4925 "description": "Generic error response.", 4926 "schema": { 4927 "$ref": "#/definitions/ApiError" 4928 } 4929 } 4930 } 4931 } 4932 }, 4933 "/user/{name}": { 4934 "get": { 4935 "tags": [ 4936 "User" 4937 ], 4938 "summary": "Get User Info", 4939 "operationId": "GetUserInfo", 4940 "parameters": [ 4941 { 4942 "type": "string", 4943 "name": "name", 4944 "in": "path", 4945 "required": true 4946 } 4947 ], 4948 "responses": { 4949 "200": { 4950 "description": "A successful response.", 4951 "schema": { 4952 "$ref": "#/definitions/user" 4953 } 4954 }, 4955 "default": { 4956 "description": "Generic error response.", 4957 "schema": { 4958 "$ref": "#/definitions/ApiError" 4959 } 4960 } 4961 } 4962 }, 4963 "put": { 4964 "tags": [ 4965 "User" 4966 ], 4967 "summary": "Update User Info", 4968 "operationId": "UpdateUserInfo", 4969 "parameters": [ 4970 { 4971 "type": "string", 4972 "name": "name", 4973 "in": "path", 4974 "required": true 4975 }, 4976 { 4977 "name": "body", 4978 "in": "body", 4979 "required": true, 4980 "schema": { 4981 "$ref": "#/definitions/updateUser" 4982 } 4983 } 4984 ], 4985 "responses": { 4986 "200": { 4987 "description": "A successful response.", 4988 "schema": { 4989 "$ref": "#/definitions/user" 4990 } 4991 }, 4992 "default": { 4993 "description": "Generic error response.", 4994 "schema": { 4995 "$ref": "#/definitions/ApiError" 4996 } 4997 } 4998 } 4999 }, 5000 "delete": { 5001 "tags": [ 5002 "User" 5003 ], 5004 "summary": "Remove user", 5005 "operationId": "RemoveUser", 5006 "parameters": [ 5007 { 5008 "type": "string", 5009 "name": "name", 5010 "in": "path", 5011 "required": true 5012 } 5013 ], 5014 "responses": { 5015 "204": { 5016 "description": "A successful response." 5017 }, 5018 "default": { 5019 "description": "Generic error response.", 5020 "schema": { 5021 "$ref": "#/definitions/ApiError" 5022 } 5023 } 5024 } 5025 } 5026 }, 5027 "/user/{name}/groups": { 5028 "put": { 5029 "tags": [ 5030 "User" 5031 ], 5032 "summary": "Update Groups for a user", 5033 "operationId": "UpdateUserGroups", 5034 "parameters": [ 5035 { 5036 "type": "string", 5037 "name": "name", 5038 "in": "path", 5039 "required": true 5040 }, 5041 { 5042 "name": "body", 5043 "in": "body", 5044 "required": true, 5045 "schema": { 5046 "$ref": "#/definitions/updateUserGroups" 5047 } 5048 } 5049 ], 5050 "responses": { 5051 "200": { 5052 "description": "A successful response.", 5053 "schema": { 5054 "$ref": "#/definitions/user" 5055 } 5056 }, 5057 "default": { 5058 "description": "Generic error response.", 5059 "schema": { 5060 "$ref": "#/definitions/ApiError" 5061 } 5062 } 5063 } 5064 } 5065 }, 5066 "/user/{name}/policies": { 5067 "get": { 5068 "tags": [ 5069 "Policy" 5070 ], 5071 "summary": "returns policies assigned for a specified user", 5072 "operationId": "GetSAUserPolicy", 5073 "parameters": [ 5074 { 5075 "type": "string", 5076 "name": "name", 5077 "in": "path", 5078 "required": true 5079 } 5080 ], 5081 "responses": { 5082 "200": { 5083 "description": "A successful response.", 5084 "schema": { 5085 "$ref": "#/definitions/aUserPolicyResponse" 5086 } 5087 }, 5088 "default": { 5089 "description": "Generic error response.", 5090 "schema": { 5091 "$ref": "#/definitions/ApiError" 5092 } 5093 } 5094 } 5095 } 5096 }, 5097 "/user/{name}/service-account-credentials": { 5098 "post": { 5099 "tags": [ 5100 "User" 5101 ], 5102 "summary": "Create Service Account for User With Credentials", 5103 "operationId": "CreateServiceAccountCredentials", 5104 "parameters": [ 5105 { 5106 "type": "string", 5107 "name": "name", 5108 "in": "path", 5109 "required": true 5110 }, 5111 { 5112 "name": "body", 5113 "in": "body", 5114 "required": true, 5115 "schema": { 5116 "$ref": "#/definitions/serviceAccountRequestCreds" 5117 } 5118 } 5119 ], 5120 "responses": { 5121 "201": { 5122 "description": "A successful response.", 5123 "schema": { 5124 "$ref": "#/definitions/serviceAccountCreds" 5125 } 5126 }, 5127 "default": { 5128 "description": "Generic error response.", 5129 "schema": { 5130 "$ref": "#/definitions/ApiError" 5131 } 5132 } 5133 } 5134 } 5135 }, 5136 "/user/{name}/service-accounts": { 5137 "get": { 5138 "tags": [ 5139 "User" 5140 ], 5141 "summary": "returns a list of service accounts for a user", 5142 "operationId": "ListAUserServiceAccounts", 5143 "parameters": [ 5144 { 5145 "type": "string", 5146 "name": "name", 5147 "in": "path", 5148 "required": true 5149 } 5150 ], 5151 "responses": { 5152 "200": { 5153 "description": "A successful response.", 5154 "schema": { 5155 "$ref": "#/definitions/serviceAccounts" 5156 } 5157 }, 5158 "default": { 5159 "description": "Generic error response.", 5160 "schema": { 5161 "$ref": "#/definitions/ApiError" 5162 } 5163 } 5164 } 5165 }, 5166 "post": { 5167 "tags": [ 5168 "User" 5169 ], 5170 "summary": "Create Service Account for User", 5171 "operationId": "CreateAUserServiceAccount", 5172 "parameters": [ 5173 { 5174 "type": "string", 5175 "name": "name", 5176 "in": "path", 5177 "required": true 5178 }, 5179 { 5180 "name": "body", 5181 "in": "body", 5182 "required": true, 5183 "schema": { 5184 "$ref": "#/definitions/serviceAccountRequest" 5185 } 5186 } 5187 ], 5188 "responses": { 5189 "201": { 5190 "description": "A successful response.", 5191 "schema": { 5192 "$ref": "#/definitions/serviceAccountCreds" 5193 } 5194 }, 5195 "default": { 5196 "description": "Generic error response.", 5197 "schema": { 5198 "$ref": "#/definitions/ApiError" 5199 } 5200 } 5201 } 5202 } 5203 }, 5204 "/users": { 5205 "get": { 5206 "tags": [ 5207 "User" 5208 ], 5209 "summary": "List Users", 5210 "operationId": "ListUsers", 5211 "parameters": [ 5212 { 5213 "$ref": "#/parameters/offset" 5214 }, 5215 { 5216 "$ref": "#/parameters/limit" 5217 } 5218 ], 5219 "responses": { 5220 "200": { 5221 "description": "A successful response.", 5222 "schema": { 5223 "$ref": "#/definitions/listUsersResponse" 5224 } 5225 }, 5226 "default": { 5227 "description": "Generic error response.", 5228 "schema": { 5229 "$ref": "#/definitions/ApiError" 5230 } 5231 } 5232 } 5233 }, 5234 "post": { 5235 "tags": [ 5236 "User" 5237 ], 5238 "summary": "Add User", 5239 "operationId": "AddUser", 5240 "parameters": [ 5241 { 5242 "name": "body", 5243 "in": "body", 5244 "required": true, 5245 "schema": { 5246 "$ref": "#/definitions/addUserRequest" 5247 } 5248 } 5249 ], 5250 "responses": { 5251 "201": { 5252 "description": "A successful response.", 5253 "schema": { 5254 "$ref": "#/definitions/user" 5255 } 5256 }, 5257 "default": { 5258 "description": "Generic error response.", 5259 "schema": { 5260 "$ref": "#/definitions/ApiError" 5261 } 5262 } 5263 } 5264 } 5265 }, 5266 "/users-groups-bulk": { 5267 "put": { 5268 "tags": [ 5269 "User" 5270 ], 5271 "summary": "Bulk functionality to Add Users to Groups", 5272 "operationId": "BulkUpdateUsersGroups", 5273 "parameters": [ 5274 { 5275 "name": "body", 5276 "in": "body", 5277 "required": true, 5278 "schema": { 5279 "$ref": "#/definitions/bulkUserGroups" 5280 } 5281 } 5282 ], 5283 "responses": { 5284 "200": { 5285 "description": "A successful response." 5286 }, 5287 "default": { 5288 "description": "Generic error response.", 5289 "schema": { 5290 "$ref": "#/definitions/ApiError" 5291 } 5292 } 5293 } 5294 } 5295 }, 5296 "/users/service-accounts": { 5297 "post": { 5298 "tags": [ 5299 "User" 5300 ], 5301 "summary": "Check number of service accounts for each user specified", 5302 "operationId": "CheckUserServiceAccounts", 5303 "parameters": [ 5304 { 5305 "name": "selectedUsers", 5306 "in": "body", 5307 "required": true, 5308 "schema": { 5309 "$ref": "#/definitions/selectedUsers" 5310 } 5311 } 5312 ], 5313 "responses": { 5314 "200": { 5315 "description": "A successful response.", 5316 "schema": { 5317 "$ref": "#/definitions/userServiceAccountSummary" 5318 } 5319 }, 5320 "default": { 5321 "description": "Generic error response.", 5322 "schema": { 5323 "$ref": "#/definitions/ApiError" 5324 } 5325 } 5326 } 5327 } 5328 } 5329 }, 5330 "definitions": { 5331 "ApiError": { 5332 "type": "object", 5333 "properties": { 5334 "detailedMessage": { 5335 "type": "string" 5336 }, 5337 "message": { 5338 "type": "string" 5339 } 5340 } 5341 }, 5342 "BackendProperties": { 5343 "type": "object", 5344 "properties": { 5345 "backendType": { 5346 "type": "string" 5347 }, 5348 "offlineDrives": { 5349 "type": "integer" 5350 }, 5351 "onlineDrives": { 5352 "type": "integer" 5353 }, 5354 "rrSCParity": { 5355 "type": "integer" 5356 }, 5357 "standardSCParity": { 5358 "type": "integer" 5359 } 5360 } 5361 }, 5362 "SubnetRegTokenResponse": { 5363 "type": "object", 5364 "properties": { 5365 "regToken": { 5366 "type": "string" 5367 } 5368 } 5369 }, 5370 "aUserPolicyResponse": { 5371 "type": "object", 5372 "properties": { 5373 "policy": { 5374 "type": "string" 5375 } 5376 } 5377 }, 5378 "accessRule": { 5379 "type": "object", 5380 "properties": { 5381 "access": { 5382 "type": "string" 5383 }, 5384 "prefix": { 5385 "type": "string" 5386 } 5387 } 5388 }, 5389 "accountChangePasswordRequest": { 5390 "type": "object", 5391 "required": [ 5392 "current_secret_key", 5393 "new_secret_key" 5394 ], 5395 "properties": { 5396 "current_secret_key": { 5397 "type": "string" 5398 }, 5399 "new_secret_key": { 5400 "type": "string" 5401 } 5402 } 5403 }, 5404 "addBucketLifecycle": { 5405 "type": "object", 5406 "properties": { 5407 "disable": { 5408 "description": "Non required, toggle to disable or enable rule", 5409 "type": "boolean" 5410 }, 5411 "expired_object_delete_all": { 5412 "description": "Non required, toggle to disable or enable rule", 5413 "type": "boolean" 5414 }, 5415 "expired_object_delete_marker": { 5416 "description": "Non required, toggle to disable or enable rule", 5417 "type": "boolean" 5418 }, 5419 "expiry_days": { 5420 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 5421 "type": "integer", 5422 "format": "int32", 5423 "default": 0 5424 }, 5425 "newer_noncurrentversion_expiration_versions": { 5426 "description": "Non required, can be set in case of expiration is enabled", 5427 "type": "integer", 5428 "format": "int32", 5429 "default": 0 5430 }, 5431 "noncurrentversion_expiration_days": { 5432 "description": "Non required, can be set in case of expiration is enabled", 5433 "type": "integer", 5434 "format": "int32", 5435 "default": 0 5436 }, 5437 "noncurrentversion_transition_days": { 5438 "description": "Non required, can be set in case of transition is enabled", 5439 "type": "integer", 5440 "format": "int32", 5441 "default": 0 5442 }, 5443 "noncurrentversion_transition_storage_class": { 5444 "description": "Non required, can be set in case of transition is enabled", 5445 "type": "string" 5446 }, 5447 "prefix": { 5448 "description": "Non required field, it matches a prefix to perform ILM operations on it", 5449 "type": "string" 5450 }, 5451 "storage_class": { 5452 "description": "Required only in case of transition is set. it refers to a tier", 5453 "type": "string" 5454 }, 5455 "tags": { 5456 "description": "Non required field, tags to match ILM files", 5457 "type": "string" 5458 }, 5459 "transition_days": { 5460 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 5461 "type": "integer", 5462 "format": "int32", 5463 "default": 0 5464 }, 5465 "type": { 5466 "description": "ILM Rule type (Expiry or transition)", 5467 "type": "string", 5468 "enum": [ 5469 "expiry", 5470 "transition" 5471 ] 5472 } 5473 } 5474 }, 5475 "addBucketReplication": { 5476 "type": "object", 5477 "properties": { 5478 "arn": { 5479 "type": "string" 5480 }, 5481 "destination_bucket": { 5482 "type": "string" 5483 } 5484 } 5485 }, 5486 "addGroupRequest": { 5487 "type": "object", 5488 "required": [ 5489 "group", 5490 "members" 5491 ], 5492 "properties": { 5493 "group": { 5494 "type": "string" 5495 }, 5496 "members": { 5497 "type": "array", 5498 "items": { 5499 "type": "string" 5500 } 5501 } 5502 } 5503 }, 5504 "addMultiBucketLifecycle": { 5505 "type": "object", 5506 "required": [ 5507 "buckets", 5508 "type" 5509 ], 5510 "properties": { 5511 "buckets": { 5512 "type": "array", 5513 "items": { 5514 "type": "string" 5515 } 5516 }, 5517 "expired_object_delete_all": { 5518 "description": "Non required, toggle to disable or enable rule", 5519 "type": "boolean" 5520 }, 5521 "expired_object_delete_marker": { 5522 "description": "Non required, toggle to disable or enable rule", 5523 "type": "boolean" 5524 }, 5525 "expiry_days": { 5526 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 5527 "type": "integer", 5528 "format": "int32", 5529 "default": 0 5530 }, 5531 "noncurrentversion_expiration_days": { 5532 "description": "Non required, can be set in case of expiration is enabled", 5533 "type": "integer", 5534 "format": "int32", 5535 "default": 0 5536 }, 5537 "noncurrentversion_transition_days": { 5538 "description": "Non required, can be set in case of transition is enabled", 5539 "type": "integer", 5540 "format": "int32", 5541 "default": 0 5542 }, 5543 "noncurrentversion_transition_storage_class": { 5544 "description": "Non required, can be set in case of transition is enabled", 5545 "type": "string" 5546 }, 5547 "prefix": { 5548 "description": "Non required field, it matches a prefix to perform ILM operations on it", 5549 "type": "string" 5550 }, 5551 "storage_class": { 5552 "description": "Required only in case of transition is set. it refers to a tier", 5553 "type": "string" 5554 }, 5555 "tags": { 5556 "description": "Non required field, tags to match ILM files", 5557 "type": "string" 5558 }, 5559 "transition_days": { 5560 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 5561 "type": "integer", 5562 "format": "int32", 5563 "default": 0 5564 }, 5565 "type": { 5566 "description": "ILM Rule type (Expiry or transition)", 5567 "type": "string", 5568 "enum": [ 5569 "expiry", 5570 "transition" 5571 ] 5572 } 5573 } 5574 }, 5575 "addPolicyRequest": { 5576 "type": "object", 5577 "required": [ 5578 "name", 5579 "policy" 5580 ], 5581 "properties": { 5582 "name": { 5583 "type": "string" 5584 }, 5585 "policy": { 5586 "type": "string" 5587 } 5588 } 5589 }, 5590 "addUserRequest": { 5591 "type": "object", 5592 "required": [ 5593 "accessKey", 5594 "secretKey", 5595 "groups", 5596 "policies" 5597 ], 5598 "properties": { 5599 "accessKey": { 5600 "type": "string" 5601 }, 5602 "groups": { 5603 "type": "array", 5604 "items": { 5605 "type": "string" 5606 } 5607 }, 5608 "policies": { 5609 "type": "array", 5610 "items": { 5611 "type": "string" 5612 } 5613 }, 5614 "secretKey": { 5615 "type": "string" 5616 } 5617 } 5618 }, 5619 "adminInfoResponse": { 5620 "type": "object", 5621 "properties": { 5622 "advancedMetricsStatus": { 5623 "type": "string", 5624 "enum": [ 5625 "not configured", 5626 "available", 5627 "unavailable" 5628 ] 5629 }, 5630 "backend": { 5631 "$ref": "#/definitions/BackendProperties" 5632 }, 5633 "buckets": { 5634 "type": "integer" 5635 }, 5636 "objects": { 5637 "type": "integer" 5638 }, 5639 "servers": { 5640 "type": "array", 5641 "items": { 5642 "$ref": "#/definitions/serverProperties" 5643 } 5644 }, 5645 "usage": { 5646 "type": "integer" 5647 }, 5648 "widgets": { 5649 "type": "array", 5650 "items": { 5651 "$ref": "#/definitions/widget" 5652 } 5653 } 5654 } 5655 }, 5656 "apiKey": { 5657 "type": "object", 5658 "properties": { 5659 "apiKey": { 5660 "type": "string" 5661 } 5662 } 5663 }, 5664 "arnsResponse": { 5665 "type": "object", 5666 "properties": { 5667 "arns": { 5668 "type": "array", 5669 "items": { 5670 "type": "string" 5671 } 5672 } 5673 } 5674 }, 5675 "bucket": { 5676 "type": "object", 5677 "required": [ 5678 "name" 5679 ], 5680 "properties": { 5681 "access": { 5682 "$ref": "#/definitions/bucketAccess" 5683 }, 5684 "creation_date": { 5685 "type": "string" 5686 }, 5687 "definition": { 5688 "type": "string" 5689 }, 5690 "details": { 5691 "type": "object", 5692 "properties": { 5693 "locking": { 5694 "type": "boolean" 5695 }, 5696 "quota": { 5697 "type": "object", 5698 "properties": { 5699 "quota": { 5700 "type": "integer", 5701 "format": "int64" 5702 }, 5703 "type": { 5704 "type": "string", 5705 "enum": [ 5706 "hard" 5707 ] 5708 } 5709 } 5710 }, 5711 "replication": { 5712 "type": "boolean" 5713 }, 5714 "tags": { 5715 "type": "object", 5716 "additionalProperties": { 5717 "type": "string" 5718 } 5719 }, 5720 "versioning": { 5721 "type": "boolean" 5722 }, 5723 "versioningSuspended": { 5724 "type": "boolean" 5725 } 5726 } 5727 }, 5728 "name": { 5729 "type": "string", 5730 "minLength": 3 5731 }, 5732 "objects": { 5733 "type": "integer", 5734 "format": "int64" 5735 }, 5736 "rw_access": { 5737 "type": "object", 5738 "properties": { 5739 "read": { 5740 "type": "boolean" 5741 }, 5742 "write": { 5743 "type": "boolean" 5744 } 5745 } 5746 }, 5747 "size": { 5748 "type": "integer", 5749 "format": "int64" 5750 } 5751 } 5752 }, 5753 "bucketAccess": { 5754 "type": "string", 5755 "default": "PRIVATE", 5756 "enum": [ 5757 "PRIVATE", 5758 "PUBLIC", 5759 "CUSTOM" 5760 ] 5761 }, 5762 "bucketEncryptionInfo": { 5763 "type": "object", 5764 "properties": { 5765 "algorithm": { 5766 "type": "string" 5767 }, 5768 "kmsMasterKeyID": { 5769 "type": "string" 5770 } 5771 } 5772 }, 5773 "bucketEncryptionRequest": { 5774 "type": "object", 5775 "properties": { 5776 "encType": { 5777 "$ref": "#/definitions/bucketEncryptionType" 5778 }, 5779 "kmsKeyID": { 5780 "type": "string" 5781 } 5782 } 5783 }, 5784 "bucketEncryptionType": { 5785 "type": "string", 5786 "default": "sse-s3", 5787 "enum": [ 5788 "sse-s3", 5789 "sse-kms" 5790 ] 5791 }, 5792 "bucketEventRequest": { 5793 "type": "object", 5794 "required": [ 5795 "configuration" 5796 ], 5797 "properties": { 5798 "configuration": { 5799 "$ref": "#/definitions/notificationConfig" 5800 }, 5801 "ignoreExisting": { 5802 "type": "boolean" 5803 } 5804 } 5805 }, 5806 "bucketLifecycleResponse": { 5807 "type": "object", 5808 "properties": { 5809 "lifecycle": { 5810 "type": "array", 5811 "items": { 5812 "$ref": "#/definitions/objectBucketLifecycle" 5813 } 5814 } 5815 } 5816 }, 5817 "bucketObLockingResponse": { 5818 "type": "object", 5819 "properties": { 5820 "object_locking_enabled": { 5821 "type": "boolean" 5822 } 5823 } 5824 }, 5825 "bucketObject": { 5826 "type": "object", 5827 "properties": { 5828 "content_type": { 5829 "type": "string" 5830 }, 5831 "etag": { 5832 "type": "string" 5833 }, 5834 "expiration": { 5835 "type": "string" 5836 }, 5837 "expiration_rule_id": { 5838 "type": "string" 5839 }, 5840 "is_delete_marker": { 5841 "type": "boolean" 5842 }, 5843 "is_latest": { 5844 "type": "boolean" 5845 }, 5846 "last_modified": { 5847 "type": "string" 5848 }, 5849 "legal_hold_status": { 5850 "type": "string" 5851 }, 5852 "metadata": { 5853 "type": "object", 5854 "additionalProperties": { 5855 "type": "string" 5856 } 5857 }, 5858 "name": { 5859 "type": "string" 5860 }, 5861 "retention_mode": { 5862 "type": "string" 5863 }, 5864 "retention_until_date": { 5865 "type": "string" 5866 }, 5867 "size": { 5868 "type": "integer", 5869 "format": "int64" 5870 }, 5871 "tags": { 5872 "type": "object", 5873 "additionalProperties": { 5874 "type": "string" 5875 } 5876 }, 5877 "user_metadata": { 5878 "type": "object", 5879 "additionalProperties": { 5880 "type": "string" 5881 } 5882 }, 5883 "user_tags": { 5884 "type": "object", 5885 "additionalProperties": { 5886 "type": "string" 5887 } 5888 }, 5889 "version_id": { 5890 "type": "string" 5891 } 5892 } 5893 }, 5894 "bucketQuota": { 5895 "type": "object", 5896 "properties": { 5897 "quota": { 5898 "type": "integer" 5899 }, 5900 "type": { 5901 "type": "string", 5902 "enum": [ 5903 "hard" 5904 ] 5905 } 5906 } 5907 }, 5908 "bucketReplicationDestination": { 5909 "type": "object", 5910 "properties": { 5911 "bucket": { 5912 "type": "string" 5913 } 5914 } 5915 }, 5916 "bucketReplicationResponse": { 5917 "type": "object", 5918 "properties": { 5919 "rules": { 5920 "type": "array", 5921 "items": { 5922 "$ref": "#/definitions/bucketReplicationRule" 5923 } 5924 } 5925 } 5926 }, 5927 "bucketReplicationRule": { 5928 "type": "object", 5929 "properties": { 5930 "bandwidth": { 5931 "type": "string" 5932 }, 5933 "delete_marker_replication": { 5934 "type": "boolean" 5935 }, 5936 "deletes_replication": { 5937 "type": "boolean" 5938 }, 5939 "destination": { 5940 "$ref": "#/definitions/bucketReplicationDestination" 5941 }, 5942 "existingObjects": { 5943 "type": "boolean" 5944 }, 5945 "healthCheckPeriod": { 5946 "type": "integer" 5947 }, 5948 "id": { 5949 "type": "string" 5950 }, 5951 "metadata_replication": { 5952 "type": "boolean" 5953 }, 5954 "prefix": { 5955 "type": "string" 5956 }, 5957 "priority": { 5958 "type": "integer", 5959 "format": "int32" 5960 }, 5961 "status": { 5962 "type": "string", 5963 "enum": [ 5964 "Enabled", 5965 "Disabled" 5966 ] 5967 }, 5968 "storageClass": { 5969 "type": "string" 5970 }, 5971 "syncMode": { 5972 "type": "string", 5973 "default": "async", 5974 "enum": [ 5975 "async", 5976 "sync" 5977 ] 5978 }, 5979 "tags": { 5980 "type": "string" 5981 } 5982 } 5983 }, 5984 "bucketReplicationRuleList": { 5985 "type": "object", 5986 "properties": { 5987 "rules": { 5988 "type": "array", 5989 "items": { 5990 "type": "string" 5991 } 5992 } 5993 } 5994 }, 5995 "bucketVersioningResponse": { 5996 "type": "object", 5997 "properties": { 5998 "MFADelete": { 5999 "type": "string" 6000 }, 6001 "excludeFolders": { 6002 "type": "boolean" 6003 }, 6004 "excludedPrefixes": { 6005 "type": "array", 6006 "items": { 6007 "type": "object", 6008 "properties": { 6009 "prefix": { 6010 "type": "string" 6011 } 6012 } 6013 } 6014 }, 6015 "status": { 6016 "type": "string" 6017 } 6018 } 6019 }, 6020 "bulkUserGroups": { 6021 "type": "object", 6022 "required": [ 6023 "users", 6024 "groups" 6025 ], 6026 "properties": { 6027 "groups": { 6028 "type": "array", 6029 "items": { 6030 "type": "string" 6031 } 6032 }, 6033 "users": { 6034 "type": "array", 6035 "items": { 6036 "type": "string" 6037 } 6038 } 6039 } 6040 }, 6041 "callHomeGetResponse": { 6042 "type": "object", 6043 "properties": { 6044 "diagnosticsStatus": { 6045 "type": "boolean" 6046 }, 6047 "logsStatus": { 6048 "type": "boolean" 6049 } 6050 } 6051 }, 6052 "callHomeSetStatus": { 6053 "type": "object", 6054 "required": [ 6055 "diagState", 6056 "logsState" 6057 ], 6058 "properties": { 6059 "diagState": { 6060 "type": "boolean" 6061 }, 6062 "logsState": { 6063 "type": "boolean" 6064 } 6065 } 6066 }, 6067 "changeUserPasswordRequest": { 6068 "type": "object", 6069 "required": [ 6070 "selectedUser", 6071 "newSecretKey" 6072 ], 6073 "properties": { 6074 "newSecretKey": { 6075 "type": "string" 6076 }, 6077 "selectedUser": { 6078 "type": "string" 6079 } 6080 } 6081 }, 6082 "configDescription": { 6083 "type": "object", 6084 "properties": { 6085 "description": { 6086 "type": "string" 6087 }, 6088 "key": { 6089 "type": "string" 6090 } 6091 } 6092 }, 6093 "configExportResponse": { 6094 "type": "object", 6095 "properties": { 6096 "status": { 6097 "type": "string" 6098 }, 6099 "value": { 6100 "description": "Returns base64 encoded value", 6101 "type": "string" 6102 } 6103 } 6104 }, 6105 "configuration": { 6106 "type": "object", 6107 "properties": { 6108 "key_values": { 6109 "type": "array", 6110 "items": { 6111 "$ref": "#/definitions/configurationKV" 6112 } 6113 }, 6114 "name": { 6115 "type": "string" 6116 } 6117 } 6118 }, 6119 "configurationKV": { 6120 "type": "object", 6121 "properties": { 6122 "env_override": { 6123 "$ref": "#/definitions/envOverride" 6124 }, 6125 "key": { 6126 "type": "string" 6127 }, 6128 "value": { 6129 "type": "string" 6130 } 6131 } 6132 }, 6133 "createRemoteBucket": { 6134 "required": [ 6135 "accessKey", 6136 "secretKey", 6137 "targetURL", 6138 "sourceBucket", 6139 "targetBucket" 6140 ], 6141 "properties": { 6142 "accessKey": { 6143 "type": "string", 6144 "minLength": 3 6145 }, 6146 "bandwidth": { 6147 "type": "integer", 6148 "format": "int64" 6149 }, 6150 "healthCheckPeriod": { 6151 "type": "integer", 6152 "format": "int32" 6153 }, 6154 "region": { 6155 "type": "string" 6156 }, 6157 "secretKey": { 6158 "type": "string", 6159 "minLength": 8 6160 }, 6161 "sourceBucket": { 6162 "type": "string" 6163 }, 6164 "syncMode": { 6165 "type": "string", 6166 "default": "async", 6167 "enum": [ 6168 "async", 6169 "sync" 6170 ] 6171 }, 6172 "targetBucket": { 6173 "type": "string" 6174 }, 6175 "targetURL": { 6176 "type": "string" 6177 } 6178 } 6179 }, 6180 "deleteFile": { 6181 "type": "object", 6182 "properties": { 6183 "path": { 6184 "type": "string" 6185 }, 6186 "recursive": { 6187 "type": "boolean" 6188 }, 6189 "versionID": { 6190 "type": "string" 6191 } 6192 } 6193 }, 6194 "envOverride": { 6195 "type": "object", 6196 "properties": { 6197 "name": { 6198 "type": "string" 6199 }, 6200 "value": { 6201 "type": "string" 6202 } 6203 } 6204 }, 6205 "environmentConstants": { 6206 "type": "object", 6207 "properties": { 6208 "maxConcurrentDownloads": { 6209 "type": "integer" 6210 }, 6211 "maxConcurrentUploads": { 6212 "type": "integer" 6213 } 6214 } 6215 }, 6216 "expirationResponse": { 6217 "type": "object", 6218 "properties": { 6219 "date": { 6220 "type": "string" 6221 }, 6222 "days": { 6223 "type": "integer", 6224 "format": "int64" 6225 }, 6226 "delete_all": { 6227 "type": "boolean" 6228 }, 6229 "delete_marker": { 6230 "type": "boolean" 6231 }, 6232 "newer_noncurrent_expiration_versions": { 6233 "type": "integer", 6234 "format": "int64" 6235 }, 6236 "noncurrent_expiration_days": { 6237 "type": "integer", 6238 "format": "int64" 6239 } 6240 } 6241 }, 6242 "getBucketRetentionConfig": { 6243 "type": "object", 6244 "properties": { 6245 "mode": { 6246 "$ref": "#/definitions/objectRetentionMode" 6247 }, 6248 "unit": { 6249 "$ref": "#/definitions/objectRetentionUnit" 6250 }, 6251 "validity": { 6252 "type": "integer", 6253 "format": "int32" 6254 } 6255 } 6256 }, 6257 "group": { 6258 "type": "object", 6259 "properties": { 6260 "members": { 6261 "type": "array", 6262 "items": { 6263 "type": "string" 6264 } 6265 }, 6266 "name": { 6267 "type": "string" 6268 }, 6269 "policy": { 6270 "type": "string" 6271 }, 6272 "status": { 6273 "type": "string" 6274 } 6275 } 6276 }, 6277 "iamEntity": { 6278 "type": "string", 6279 "pattern": "^[\\w+=,.@-]{1,64}$" 6280 }, 6281 "iamPolicy": { 6282 "type": "object", 6283 "properties": { 6284 "statement": { 6285 "type": "array", 6286 "items": { 6287 "$ref": "#/definitions/iamPolicyStatement" 6288 } 6289 }, 6290 "version": { 6291 "type": "string" 6292 } 6293 } 6294 }, 6295 "iamPolicyStatement": { 6296 "type": "object", 6297 "properties": { 6298 "action": { 6299 "type": "array", 6300 "items": { 6301 "type": "string" 6302 } 6303 }, 6304 "condition": { 6305 "type": "object", 6306 "additionalProperties": { 6307 "type": "object" 6308 } 6309 }, 6310 "effect": { 6311 "type": "string" 6312 }, 6313 "resource": { 6314 "type": "array", 6315 "items": { 6316 "type": "string" 6317 } 6318 } 6319 } 6320 }, 6321 "idpListConfigurationsResponse": { 6322 "type": "object", 6323 "properties": { 6324 "results": { 6325 "type": "array", 6326 "items": { 6327 "$ref": "#/definitions/idpServerConfiguration" 6328 } 6329 } 6330 } 6331 }, 6332 "idpServerConfiguration": { 6333 "type": "object", 6334 "properties": { 6335 "enabled": { 6336 "type": "boolean" 6337 }, 6338 "info": { 6339 "type": "array", 6340 "items": { 6341 "$ref": "#/definitions/idpServerConfigurationInfo" 6342 } 6343 }, 6344 "input": { 6345 "type": "string" 6346 }, 6347 "name": { 6348 "type": "string" 6349 }, 6350 "type": { 6351 "type": "string" 6352 } 6353 } 6354 }, 6355 "idpServerConfigurationInfo": { 6356 "type": "object", 6357 "properties": { 6358 "isCfg": { 6359 "type": "boolean" 6360 }, 6361 "isEnv": { 6362 "type": "boolean" 6363 }, 6364 "key": { 6365 "type": "string" 6366 }, 6367 "value": { 6368 "type": "string" 6369 } 6370 } 6371 }, 6372 "kmDeleteKeyRequest": { 6373 "type": "object" 6374 }, 6375 "kmsAPI": { 6376 "type": "object", 6377 "properties": { 6378 "maxBody": { 6379 "type": "integer" 6380 }, 6381 "method": { 6382 "type": "string" 6383 }, 6384 "path": { 6385 "type": "string" 6386 }, 6387 "timeout": { 6388 "type": "integer" 6389 } 6390 } 6391 }, 6392 "kmsAPIsResponse": { 6393 "type": "object", 6394 "properties": { 6395 "results": { 6396 "type": "array", 6397 "items": { 6398 "$ref": "#/definitions/kmsAPI" 6399 } 6400 } 6401 } 6402 }, 6403 "kmsAssignPolicyRequest": { 6404 "type": "object", 6405 "properties": { 6406 "identity": { 6407 "type": "string" 6408 } 6409 } 6410 }, 6411 "kmsCreateKeyRequest": { 6412 "type": "object", 6413 "required": [ 6414 "key" 6415 ], 6416 "properties": { 6417 "key": { 6418 "type": "string" 6419 } 6420 } 6421 }, 6422 "kmsDescribeIdentityResponse": { 6423 "type": "object", 6424 "properties": { 6425 "admin": { 6426 "type": "boolean" 6427 }, 6428 "createdAt": { 6429 "type": "string" 6430 }, 6431 "createdBy": { 6432 "type": "string" 6433 }, 6434 "identity": { 6435 "type": "string" 6436 }, 6437 "policy": { 6438 "type": "string" 6439 } 6440 } 6441 }, 6442 "kmsDescribePolicyResponse": { 6443 "type": "object", 6444 "properties": { 6445 "createdAt": { 6446 "type": "string" 6447 }, 6448 "createdBy": { 6449 "type": "string" 6450 }, 6451 "name": { 6452 "type": "string" 6453 } 6454 } 6455 }, 6456 "kmsDescribeSelfIdentityResponse": { 6457 "type": "object", 6458 "properties": { 6459 "admin": { 6460 "type": "boolean" 6461 }, 6462 "createdAt": { 6463 "type": "string" 6464 }, 6465 "createdBy": { 6466 "type": "string" 6467 }, 6468 "identity": { 6469 "type": "string" 6470 }, 6471 "policy": { 6472 "$ref": "#/definitions/kmsGetPolicyResponse" 6473 }, 6474 "policyName": { 6475 "type": "string" 6476 } 6477 } 6478 }, 6479 "kmsEndpoint": { 6480 "type": "object", 6481 "properties": { 6482 "status": { 6483 "type": "string" 6484 }, 6485 "url": { 6486 "type": "string" 6487 } 6488 } 6489 }, 6490 "kmsGetPolicyResponse": { 6491 "type": "object", 6492 "properties": { 6493 "allow": { 6494 "type": "array", 6495 "items": { 6496 "type": "string" 6497 } 6498 }, 6499 "deny": { 6500 "type": "array", 6501 "items": { 6502 "type": "string" 6503 } 6504 } 6505 } 6506 }, 6507 "kmsIdentityInfo": { 6508 "type": "object", 6509 "properties": { 6510 "createdAt": { 6511 "type": "string" 6512 }, 6513 "createdBy": { 6514 "type": "string" 6515 }, 6516 "error": { 6517 "type": "string" 6518 }, 6519 "identity": { 6520 "type": "string" 6521 }, 6522 "policy": { 6523 "type": "string" 6524 } 6525 } 6526 }, 6527 "kmsImportKeyRequest": { 6528 "type": "object", 6529 "required": [ 6530 "bytes" 6531 ], 6532 "properties": { 6533 "bytes": { 6534 "type": "string" 6535 } 6536 } 6537 }, 6538 "kmsKeyInfo": { 6539 "type": "object", 6540 "properties": { 6541 "createdAt": { 6542 "type": "string" 6543 }, 6544 "createdBy": { 6545 "type": "string" 6546 }, 6547 "name": { 6548 "type": "string" 6549 } 6550 } 6551 }, 6552 "kmsKeyStatusResponse": { 6553 "type": "object", 6554 "properties": { 6555 "decryptionErr": { 6556 "type": "string" 6557 }, 6558 "encryptionErr": { 6559 "type": "string" 6560 }, 6561 "keyID": { 6562 "type": "string" 6563 } 6564 } 6565 }, 6566 "kmsLatencyHistogram": { 6567 "type": "object", 6568 "properties": { 6569 "duration": { 6570 "type": "integer" 6571 }, 6572 "total": { 6573 "type": "integer" 6574 } 6575 } 6576 }, 6577 "kmsListIdentitiesResponse": { 6578 "type": "object", 6579 "properties": { 6580 "results": { 6581 "type": "array", 6582 "items": { 6583 "$ref": "#/definitions/kmsIdentityInfo" 6584 } 6585 } 6586 } 6587 }, 6588 "kmsListKeysResponse": { 6589 "type": "object", 6590 "properties": { 6591 "results": { 6592 "type": "array", 6593 "items": { 6594 "$ref": "#/definitions/kmsKeyInfo" 6595 } 6596 } 6597 } 6598 }, 6599 "kmsListPoliciesResponse": { 6600 "type": "object", 6601 "properties": { 6602 "results": { 6603 "type": "array", 6604 "items": { 6605 "$ref": "#/definitions/kmsPolicyInfo" 6606 } 6607 } 6608 } 6609 }, 6610 "kmsMetricsResponse": { 6611 "type": "object", 6612 "required": [ 6613 "requestOK", 6614 "requestErr", 6615 "requestFail", 6616 "requestActive", 6617 "auditEvents", 6618 "errorEvents", 6619 "latencyHistogram", 6620 "uptime", 6621 "cpus", 6622 "usableCPUs", 6623 "threads", 6624 "heapAlloc", 6625 "stackAlloc" 6626 ], 6627 "properties": { 6628 "auditEvents": { 6629 "type": "integer" 6630 }, 6631 "cpus": { 6632 "type": "integer" 6633 }, 6634 "errorEvents": { 6635 "type": "integer" 6636 }, 6637 "heapAlloc": { 6638 "type": "integer" 6639 }, 6640 "heapObjects": { 6641 "type": "integer" 6642 }, 6643 "latencyHistogram": { 6644 "type": "array", 6645 "items": { 6646 "$ref": "#/definitions/kmsLatencyHistogram" 6647 } 6648 }, 6649 "requestActive": { 6650 "type": "integer" 6651 }, 6652 "requestErr": { 6653 "type": "integer" 6654 }, 6655 "requestFail": { 6656 "type": "integer" 6657 }, 6658 "requestOK": { 6659 "type": "integer" 6660 }, 6661 "stackAlloc": { 6662 "type": "integer" 6663 }, 6664 "threads": { 6665 "type": "integer" 6666 }, 6667 "uptime": { 6668 "type": "integer" 6669 }, 6670 "usableCPUs": { 6671 "type": "integer" 6672 } 6673 } 6674 }, 6675 "kmsPolicyInfo": { 6676 "type": "object", 6677 "properties": { 6678 "createdAt": { 6679 "type": "string" 6680 }, 6681 "createdBy": { 6682 "type": "string" 6683 }, 6684 "name": { 6685 "type": "string" 6686 } 6687 } 6688 }, 6689 "kmsSetPolicyRequest": { 6690 "type": "object", 6691 "required": [ 6692 "policy" 6693 ], 6694 "properties": { 6695 "allow": { 6696 "type": "array", 6697 "items": { 6698 "type": "string" 6699 } 6700 }, 6701 "deny": { 6702 "type": "array", 6703 "items": { 6704 "type": "string" 6705 } 6706 }, 6707 "policy": { 6708 "type": "string" 6709 } 6710 } 6711 }, 6712 "kmsStatusResponse": { 6713 "type": "object", 6714 "properties": { 6715 "defaultKeyID": { 6716 "type": "string" 6717 }, 6718 "endpoints": { 6719 "type": "array", 6720 "items": { 6721 "$ref": "#/definitions/kmsEndpoint" 6722 } 6723 }, 6724 "name": { 6725 "type": "string" 6726 } 6727 } 6728 }, 6729 "kmsVersionResponse": { 6730 "type": "object", 6731 "properties": { 6732 "version": { 6733 "type": "string" 6734 } 6735 } 6736 }, 6737 "ldapEntities": { 6738 "type": "object", 6739 "properties": { 6740 "groups": { 6741 "type": "array", 6742 "items": { 6743 "$ref": "#/definitions/ldapGroupPolicyEntity" 6744 } 6745 }, 6746 "policies": { 6747 "type": "array", 6748 "items": { 6749 "$ref": "#/definitions/ldapPolicyEntity" 6750 } 6751 }, 6752 "timestamp": { 6753 "type": "string" 6754 }, 6755 "users": { 6756 "type": "array", 6757 "items": { 6758 "$ref": "#/definitions/ldapUserPolicyEntity" 6759 } 6760 } 6761 } 6762 }, 6763 "ldapEntitiesRequest": { 6764 "type": "object", 6765 "properties": { 6766 "groups": { 6767 "type": "array", 6768 "items": { 6769 "type": "string" 6770 } 6771 }, 6772 "policies": { 6773 "type": "array", 6774 "items": { 6775 "type": "string" 6776 } 6777 }, 6778 "users": { 6779 "type": "array", 6780 "items": { 6781 "type": "string" 6782 } 6783 } 6784 } 6785 }, 6786 "ldapGroupPolicyEntity": { 6787 "type": "object", 6788 "properties": { 6789 "group": { 6790 "type": "string" 6791 }, 6792 "policies": { 6793 "type": "array", 6794 "items": { 6795 "type": "string" 6796 } 6797 } 6798 } 6799 }, 6800 "ldapPolicyEntity": { 6801 "type": "object", 6802 "properties": { 6803 "groups": { 6804 "type": "array", 6805 "items": { 6806 "type": "string" 6807 } 6808 }, 6809 "policy": { 6810 "type": "string" 6811 }, 6812 "users": { 6813 "type": "array", 6814 "items": { 6815 "type": "string" 6816 } 6817 } 6818 } 6819 }, 6820 "ldapUserPolicyEntity": { 6821 "type": "object", 6822 "properties": { 6823 "policies": { 6824 "type": "array", 6825 "items": { 6826 "type": "string" 6827 } 6828 }, 6829 "user": { 6830 "type": "string" 6831 } 6832 } 6833 }, 6834 "license": { 6835 "type": "object", 6836 "properties": { 6837 "account_id": { 6838 "type": "integer" 6839 }, 6840 "email": { 6841 "type": "string" 6842 }, 6843 "expires_at": { 6844 "type": "string" 6845 }, 6846 "organization": { 6847 "type": "string" 6848 }, 6849 "plan": { 6850 "type": "string" 6851 }, 6852 "storage_capacity": { 6853 "type": "integer" 6854 } 6855 } 6856 }, 6857 "lifecycleTag": { 6858 "type": "object", 6859 "properties": { 6860 "key": { 6861 "type": "string" 6862 }, 6863 "value": { 6864 "type": "string" 6865 } 6866 } 6867 }, 6868 "listAccessRulesResponse": { 6869 "type": "object", 6870 "properties": { 6871 "accessRules": { 6872 "type": "array", 6873 "title": "list of policies", 6874 "items": { 6875 "$ref": "#/definitions/accessRule" 6876 } 6877 }, 6878 "total": { 6879 "type": "integer", 6880 "format": "int64", 6881 "title": "total number of policies" 6882 } 6883 } 6884 }, 6885 "listBucketEventsResponse": { 6886 "type": "object", 6887 "properties": { 6888 "events": { 6889 "type": "array", 6890 "items": { 6891 "$ref": "#/definitions/notificationConfig" 6892 } 6893 }, 6894 "total": { 6895 "type": "integer", 6896 "format": "int64", 6897 "title": "total number of bucket events" 6898 } 6899 } 6900 }, 6901 "listBucketsResponse": { 6902 "type": "object", 6903 "properties": { 6904 "buckets": { 6905 "type": "array", 6906 "title": "list of resulting buckets", 6907 "items": { 6908 "$ref": "#/definitions/bucket" 6909 } 6910 }, 6911 "total": { 6912 "type": "integer", 6913 "format": "int64", 6914 "title": "number of buckets accessible to the user" 6915 } 6916 } 6917 }, 6918 "listConfigResponse": { 6919 "type": "object", 6920 "properties": { 6921 "configurations": { 6922 "type": "array", 6923 "items": { 6924 "$ref": "#/definitions/configDescription" 6925 } 6926 }, 6927 "total": { 6928 "type": "integer", 6929 "format": "int64", 6930 "title": "total number of configurations" 6931 } 6932 } 6933 }, 6934 "listExternalBucketsParams": { 6935 "required": [ 6936 "accessKey", 6937 "secretKey", 6938 "targetURL", 6939 "useTLS" 6940 ], 6941 "properties": { 6942 "accessKey": { 6943 "type": "string", 6944 "minLength": 3 6945 }, 6946 "region": { 6947 "type": "string" 6948 }, 6949 "secretKey": { 6950 "type": "string", 6951 "minLength": 8 6952 }, 6953 "targetURL": { 6954 "type": "string" 6955 }, 6956 "useTLS": { 6957 "type": "boolean" 6958 } 6959 } 6960 }, 6961 "listGroupsResponse": { 6962 "type": "object", 6963 "properties": { 6964 "groups": { 6965 "type": "array", 6966 "title": "list of groups", 6967 "items": { 6968 "type": "string" 6969 } 6970 }, 6971 "total": { 6972 "type": "integer", 6973 "format": "int64", 6974 "title": "total number of groups" 6975 } 6976 } 6977 }, 6978 "listObjectsResponse": { 6979 "type": "object", 6980 "properties": { 6981 "objects": { 6982 "type": "array", 6983 "title": "list of resulting objects", 6984 "items": { 6985 "$ref": "#/definitions/bucketObject" 6986 } 6987 }, 6988 "total": { 6989 "type": "integer", 6990 "format": "int64", 6991 "title": "number of objects" 6992 } 6993 } 6994 }, 6995 "listPoliciesResponse": { 6996 "type": "object", 6997 "properties": { 6998 "policies": { 6999 "type": "array", 7000 "title": "list of policies", 7001 "items": { 7002 "$ref": "#/definitions/policy" 7003 } 7004 }, 7005 "total": { 7006 "type": "integer", 7007 "format": "int64", 7008 "title": "total number of policies" 7009 } 7010 } 7011 }, 7012 "listRemoteBucketsResponse": { 7013 "type": "object", 7014 "properties": { 7015 "buckets": { 7016 "type": "array", 7017 "title": "list of remote buckets", 7018 "items": { 7019 "$ref": "#/definitions/remoteBucket" 7020 } 7021 }, 7022 "total": { 7023 "type": "integer", 7024 "format": "int64", 7025 "title": "number of remote buckets accessible to user" 7026 } 7027 } 7028 }, 7029 "listUsersResponse": { 7030 "type": "object", 7031 "properties": { 7032 "users": { 7033 "type": "array", 7034 "title": "list of resulting users", 7035 "items": { 7036 "$ref": "#/definitions/user" 7037 } 7038 } 7039 } 7040 }, 7041 "logSearchResponse": { 7042 "type": "object", 7043 "properties": { 7044 "results": { 7045 "type": "object", 7046 "title": "list of log search responses" 7047 } 7048 } 7049 }, 7050 "loginDetails": { 7051 "type": "object", 7052 "properties": { 7053 "animatedLogin": { 7054 "type": "boolean" 7055 }, 7056 "isK8S": { 7057 "type": "boolean" 7058 }, 7059 "loginStrategy": { 7060 "type": "string", 7061 "enum": [ 7062 "form", 7063 "redirect", 7064 "service-account", 7065 "redirect-service-account" 7066 ] 7067 }, 7068 "redirectRules": { 7069 "type": "array", 7070 "items": { 7071 "$ref": "#/definitions/redirectRule" 7072 } 7073 } 7074 } 7075 }, 7076 "loginOauth2AuthRequest": { 7077 "type": "object", 7078 "required": [ 7079 "state", 7080 "code" 7081 ], 7082 "properties": { 7083 "code": { 7084 "type": "string" 7085 }, 7086 "state": { 7087 "type": "string" 7088 } 7089 } 7090 }, 7091 "loginRequest": { 7092 "type": "object", 7093 "properties": { 7094 "accessKey": { 7095 "type": "string" 7096 }, 7097 "features": { 7098 "type": "object", 7099 "properties": { 7100 "hide_menu": { 7101 "type": "boolean" 7102 } 7103 } 7104 }, 7105 "secretKey": { 7106 "type": "string" 7107 }, 7108 "sts": { 7109 "type": "string" 7110 } 7111 } 7112 }, 7113 "loginResponse": { 7114 "type": "object", 7115 "properties": { 7116 "IDPRefreshToken": { 7117 "type": "string" 7118 }, 7119 "sessionId": { 7120 "type": "string" 7121 } 7122 } 7123 }, 7124 "logoutRequest": { 7125 "type": "object", 7126 "properties": { 7127 "state": { 7128 "type": "string" 7129 } 7130 } 7131 }, 7132 "makeBucketRequest": { 7133 "type": "object", 7134 "required": [ 7135 "name" 7136 ], 7137 "properties": { 7138 "locking": { 7139 "type": "boolean" 7140 }, 7141 "name": { 7142 "type": "string" 7143 }, 7144 "quota": { 7145 "$ref": "#/definitions/setBucketQuota" 7146 }, 7147 "retention": { 7148 "$ref": "#/definitions/putBucketRetentionRequest" 7149 }, 7150 "versioning": { 7151 "$ref": "#/definitions/setBucketVersioning" 7152 } 7153 } 7154 }, 7155 "makeBucketsResponse": { 7156 "type": "object", 7157 "properties": { 7158 "bucketName": { 7159 "type": "string" 7160 } 7161 } 7162 }, 7163 "maxShareLinkExpResponse": { 7164 "type": "object", 7165 "required": [ 7166 "exp" 7167 ], 7168 "properties": { 7169 "exp": { 7170 "type": "number", 7171 "format": "int64" 7172 } 7173 } 7174 }, 7175 "metadata": { 7176 "type": "object", 7177 "properties": { 7178 "objectMetadata": { 7179 "type": "object", 7180 "additionalProperties": true 7181 } 7182 } 7183 }, 7184 "multiBucketReplication": { 7185 "required": [ 7186 "accessKey", 7187 "secretKey", 7188 "targetURL", 7189 "bucketsRelation" 7190 ], 7191 "properties": { 7192 "accessKey": { 7193 "type": "string", 7194 "minLength": 3 7195 }, 7196 "bandwidth": { 7197 "type": "integer", 7198 "format": "int64" 7199 }, 7200 "bucketsRelation": { 7201 "type": "array", 7202 "minLength": 1, 7203 "items": { 7204 "$ref": "#/definitions/multiBucketsRelation" 7205 } 7206 }, 7207 "healthCheckPeriod": { 7208 "type": "integer", 7209 "format": "int32" 7210 }, 7211 "prefix": { 7212 "type": "string" 7213 }, 7214 "priority": { 7215 "type": "integer", 7216 "format": "int32", 7217 "default": 0 7218 }, 7219 "region": { 7220 "type": "string" 7221 }, 7222 "replicateDeleteMarkers": { 7223 "type": "boolean" 7224 }, 7225 "replicateDeletes": { 7226 "type": "boolean" 7227 }, 7228 "replicateMetadata": { 7229 "type": "boolean" 7230 }, 7231 "secretKey": { 7232 "type": "string", 7233 "minLength": 8 7234 }, 7235 "storageClass": { 7236 "type": "string", 7237 "default": "" 7238 }, 7239 "syncMode": { 7240 "type": "string", 7241 "default": "async", 7242 "enum": [ 7243 "async", 7244 "sync" 7245 ] 7246 }, 7247 "tags": { 7248 "type": "string" 7249 }, 7250 "targetURL": { 7251 "type": "string" 7252 } 7253 } 7254 }, 7255 "multiBucketReplicationEdit": { 7256 "properties": { 7257 "arn": { 7258 "type": "string" 7259 }, 7260 "prefix": { 7261 "type": "string" 7262 }, 7263 "priority": { 7264 "type": "integer", 7265 "format": "int32", 7266 "default": 0 7267 }, 7268 "replicateDeleteMarkers": { 7269 "type": "boolean" 7270 }, 7271 "replicateDeletes": { 7272 "type": "boolean" 7273 }, 7274 "replicateExistingObjects": { 7275 "type": "boolean" 7276 }, 7277 "replicateMetadata": { 7278 "type": "boolean" 7279 }, 7280 "ruleState": { 7281 "type": "boolean" 7282 }, 7283 "storageClass": { 7284 "type": "string", 7285 "default": "" 7286 }, 7287 "tags": { 7288 "type": "string", 7289 "default": "" 7290 } 7291 } 7292 }, 7293 "multiBucketResponseItem": { 7294 "type": "object", 7295 "properties": { 7296 "errorString": { 7297 "type": "string" 7298 }, 7299 "originBucket": { 7300 "type": "string" 7301 }, 7302 "targetBucket": { 7303 "type": "string" 7304 } 7305 } 7306 }, 7307 "multiBucketResponseState": { 7308 "type": "object", 7309 "properties": { 7310 "replicationState": { 7311 "type": "array", 7312 "items": { 7313 "$ref": "#/definitions/multiBucketResponseItem" 7314 } 7315 } 7316 } 7317 }, 7318 "multiBucketsRelation": { 7319 "type": "object", 7320 "properties": { 7321 "destinationBucket": { 7322 "type": "string" 7323 }, 7324 "originBucket": { 7325 "type": "string" 7326 } 7327 } 7328 }, 7329 "multiLifecycleResult": { 7330 "properties": { 7331 "results": { 7332 "type": "array", 7333 "items": { 7334 "$ref": "#/definitions/multicycleResultItem" 7335 } 7336 } 7337 } 7338 }, 7339 "multicycleResultItem": { 7340 "type": "object", 7341 "properties": { 7342 "bucketName": { 7343 "type": "string" 7344 }, 7345 "error": { 7346 "type": "string" 7347 } 7348 } 7349 }, 7350 "nofiticationService": { 7351 "type": "string", 7352 "enum": [ 7353 "webhook", 7354 "amqp", 7355 "kafka", 7356 "mqtt", 7357 "nats", 7358 "nsq", 7359 "mysql", 7360 "postgres", 7361 "elasticsearch", 7362 "redis" 7363 ] 7364 }, 7365 "notifEndpointResponse": { 7366 "type": "object", 7367 "properties": { 7368 "notification_endpoints": { 7369 "type": "array", 7370 "items": { 7371 "$ref": "#/definitions/notificationEndpointItem" 7372 } 7373 } 7374 } 7375 }, 7376 "notificationConfig": { 7377 "type": "object", 7378 "required": [ 7379 "arn" 7380 ], 7381 "properties": { 7382 "arn": { 7383 "type": "string" 7384 }, 7385 "events": { 7386 "type": "array", 7387 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 7388 "items": { 7389 "$ref": "#/definitions/notificationEventType" 7390 } 7391 }, 7392 "id": { 7393 "type": "string" 7394 }, 7395 "prefix": { 7396 "type": "string", 7397 "title": "filter event associated to the specified prefix" 7398 }, 7399 "suffix": { 7400 "type": "string", 7401 "title": "filter event associated to the specified suffix" 7402 } 7403 } 7404 }, 7405 "notificationDeleteRequest": { 7406 "type": "object", 7407 "required": [ 7408 "events", 7409 "prefix", 7410 "suffix" 7411 ], 7412 "properties": { 7413 "events": { 7414 "type": "array", 7415 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 7416 "minLength": 1, 7417 "items": { 7418 "$ref": "#/definitions/notificationEventType" 7419 } 7420 }, 7421 "prefix": { 7422 "type": "string", 7423 "title": "filter event associated to the specified prefix" 7424 }, 7425 "suffix": { 7426 "type": "string", 7427 "title": "filter event associated to the specified suffix" 7428 } 7429 } 7430 }, 7431 "notificationEndpoint": { 7432 "type": "object", 7433 "required": [ 7434 "service", 7435 "account_id", 7436 "properties" 7437 ], 7438 "properties": { 7439 "account_id": { 7440 "type": "string" 7441 }, 7442 "properties": { 7443 "type": "object", 7444 "additionalProperties": { 7445 "type": "string" 7446 } 7447 }, 7448 "service": { 7449 "$ref": "#/definitions/nofiticationService" 7450 } 7451 } 7452 }, 7453 "notificationEndpointItem": { 7454 "type": "object", 7455 "properties": { 7456 "account_id": { 7457 "type": "string" 7458 }, 7459 "service": { 7460 "$ref": "#/definitions/nofiticationService" 7461 }, 7462 "status": { 7463 "type": "string" 7464 } 7465 } 7466 }, 7467 "notificationEventType": { 7468 "type": "string", 7469 "enum": [ 7470 "put", 7471 "delete", 7472 "get", 7473 "replica", 7474 "ilm", 7475 "scanner" 7476 ] 7477 }, 7478 "objectBucketLifecycle": { 7479 "type": "object", 7480 "properties": { 7481 "expiration": { 7482 "$ref": "#/definitions/expirationResponse" 7483 }, 7484 "id": { 7485 "type": "string" 7486 }, 7487 "prefix": { 7488 "type": "string" 7489 }, 7490 "status": { 7491 "type": "string" 7492 }, 7493 "tags": { 7494 "type": "array", 7495 "items": { 7496 "$ref": "#/definitions/lifecycleTag" 7497 } 7498 }, 7499 "transition": { 7500 "$ref": "#/definitions/transitionResponse" 7501 } 7502 } 7503 }, 7504 "objectLegalHoldStatus": { 7505 "type": "string", 7506 "enum": [ 7507 "enabled", 7508 "disabled" 7509 ] 7510 }, 7511 "objectRetentionMode": { 7512 "type": "string", 7513 "enum": [ 7514 "governance", 7515 "compliance" 7516 ] 7517 }, 7518 "objectRetentionUnit": { 7519 "type": "string", 7520 "enum": [ 7521 "days", 7522 "years" 7523 ] 7524 }, 7525 "peerInfo": { 7526 "type": "object", 7527 "properties": { 7528 "deploymentID": { 7529 "type": "string" 7530 }, 7531 "endpoint": { 7532 "type": "string" 7533 }, 7534 "name": { 7535 "type": "string" 7536 } 7537 } 7538 }, 7539 "peerInfoRemove": { 7540 "type": "object", 7541 "required": [ 7542 "sites" 7543 ], 7544 "properties": { 7545 "all": { 7546 "type": "boolean" 7547 }, 7548 "sites": { 7549 "type": "array", 7550 "items": { 7551 "type": "string" 7552 } 7553 } 7554 } 7555 }, 7556 "peerSite": { 7557 "type": "object", 7558 "properties": { 7559 "accessKey": { 7560 "type": "string" 7561 }, 7562 "endpoint": { 7563 "type": "string" 7564 }, 7565 "name": { 7566 "type": "string" 7567 }, 7568 "secretKey": { 7569 "type": "string" 7570 } 7571 } 7572 }, 7573 "peerSiteEditResponse": { 7574 "type": "object", 7575 "properties": { 7576 "errorDetail": { 7577 "type": "string" 7578 }, 7579 "status": { 7580 "type": "string" 7581 }, 7582 "success": { 7583 "type": "boolean" 7584 } 7585 } 7586 }, 7587 "peerSiteRemoveResponse": { 7588 "type": "object", 7589 "properties": { 7590 "errorDetail": { 7591 "type": "string" 7592 }, 7593 "status": { 7594 "type": "string" 7595 } 7596 } 7597 }, 7598 "permissionResource": { 7599 "type": "object", 7600 "properties": { 7601 "conditionOperator": { 7602 "type": "string" 7603 }, 7604 "prefixes": { 7605 "type": "array", 7606 "items": { 7607 "type": "string" 7608 } 7609 }, 7610 "resource": { 7611 "type": "string" 7612 } 7613 } 7614 }, 7615 "policy": { 7616 "type": "object", 7617 "properties": { 7618 "name": { 7619 "type": "string" 7620 }, 7621 "policy": { 7622 "type": "string" 7623 } 7624 } 7625 }, 7626 "policyArgs": { 7627 "type": "object", 7628 "properties": { 7629 "action": { 7630 "type": "string" 7631 }, 7632 "bucket_name": { 7633 "type": "string" 7634 }, 7635 "id": { 7636 "type": "string" 7637 } 7638 } 7639 }, 7640 "policyEntity": { 7641 "type": "string", 7642 "default": "user", 7643 "enum": [ 7644 "user", 7645 "group" 7646 ] 7647 }, 7648 "prefixAccessPair": { 7649 "type": "object", 7650 "properties": { 7651 "access": { 7652 "type": "string" 7653 }, 7654 "prefix": { 7655 "type": "string" 7656 } 7657 } 7658 }, 7659 "prefixWrapper": { 7660 "type": "object", 7661 "properties": { 7662 "prefix": { 7663 "type": "string" 7664 } 7665 } 7666 }, 7667 "principal": { 7668 "type": "object", 7669 "properties": { 7670 "STSAccessKeyID": { 7671 "type": "string" 7672 }, 7673 "STSSecretAccessKey": { 7674 "type": "string" 7675 }, 7676 "STSSessionToken": { 7677 "type": "string" 7678 }, 7679 "accountAccessKey": { 7680 "type": "string" 7681 }, 7682 "customStyleOb": { 7683 "type": "string" 7684 }, 7685 "hm": { 7686 "type": "boolean" 7687 }, 7688 "ob": { 7689 "type": "boolean" 7690 } 7691 } 7692 }, 7693 "profilingStartRequest": { 7694 "type": "object", 7695 "required": [ 7696 "type" 7697 ], 7698 "properties": { 7699 "type": { 7700 "type": "string" 7701 } 7702 } 7703 }, 7704 "putBucketRetentionRequest": { 7705 "type": "object", 7706 "required": [ 7707 "mode", 7708 "unit", 7709 "validity" 7710 ], 7711 "properties": { 7712 "mode": { 7713 "$ref": "#/definitions/objectRetentionMode" 7714 }, 7715 "unit": { 7716 "$ref": "#/definitions/objectRetentionUnit" 7717 }, 7718 "validity": { 7719 "type": "integer", 7720 "format": "int32" 7721 } 7722 } 7723 }, 7724 "putBucketTagsRequest": { 7725 "type": "object", 7726 "properties": { 7727 "tags": { 7728 "additionalProperties": { 7729 "type": "string" 7730 } 7731 } 7732 } 7733 }, 7734 "putObjectLegalHoldRequest": { 7735 "type": "object", 7736 "required": [ 7737 "status" 7738 ], 7739 "properties": { 7740 "status": { 7741 "$ref": "#/definitions/objectLegalHoldStatus" 7742 } 7743 } 7744 }, 7745 "putObjectRetentionRequest": { 7746 "type": "object", 7747 "required": [ 7748 "mode", 7749 "expires" 7750 ], 7751 "properties": { 7752 "expires": { 7753 "type": "string" 7754 }, 7755 "governance_bypass": { 7756 "type": "boolean" 7757 }, 7758 "mode": { 7759 "$ref": "#/definitions/objectRetentionMode" 7760 } 7761 } 7762 }, 7763 "putObjectTagsRequest": { 7764 "type": "object", 7765 "properties": { 7766 "tags": { 7767 "additionalProperties": { 7768 "type": "string" 7769 } 7770 } 7771 } 7772 }, 7773 "redirectRule": { 7774 "type": "object", 7775 "properties": { 7776 "displayName": { 7777 "type": "string" 7778 }, 7779 "redirect": { 7780 "type": "string" 7781 }, 7782 "serviceType": { 7783 "type": "string" 7784 } 7785 } 7786 }, 7787 "releaseAuthor": { 7788 "type": "object", 7789 "properties": { 7790 "avatar_url": { 7791 "type": "string" 7792 }, 7793 "events_url": { 7794 "type": "string" 7795 }, 7796 "followers_url": { 7797 "type": "string" 7798 }, 7799 "following_url": { 7800 "type": "string" 7801 }, 7802 "gists_url": { 7803 "type": "string" 7804 }, 7805 "gravatar_id": { 7806 "type": "string" 7807 }, 7808 "html_url": { 7809 "type": "string" 7810 }, 7811 "id": { 7812 "type": "integer" 7813 }, 7814 "login": { 7815 "type": "string" 7816 }, 7817 "node_id": { 7818 "type": "string" 7819 }, 7820 "organizations_url": { 7821 "type": "string" 7822 }, 7823 "receivedEvents_url": { 7824 "type": "string" 7825 }, 7826 "repos_url": { 7827 "type": "string" 7828 }, 7829 "site_admin": { 7830 "type": "boolean" 7831 }, 7832 "starred_url": { 7833 "type": "string" 7834 }, 7835 "subscriptions_url": { 7836 "type": "string" 7837 }, 7838 "type": { 7839 "type": "string" 7840 }, 7841 "url": { 7842 "type": "string" 7843 } 7844 } 7845 }, 7846 "releaseInfo": { 7847 "type": "object", 7848 "properties": { 7849 "breakingChangesContent": { 7850 "type": "string" 7851 }, 7852 "contextContent": { 7853 "type": "string" 7854 }, 7855 "metadata": { 7856 "$ref": "#/definitions/releaseMetadata" 7857 }, 7858 "newFeaturesContent": { 7859 "type": "string" 7860 }, 7861 "notesContent": { 7862 "type": "string" 7863 }, 7864 "securityContent": { 7865 "type": "string" 7866 } 7867 } 7868 }, 7869 "releaseListResponse": { 7870 "type": "object", 7871 "properties": { 7872 "results": { 7873 "type": "array", 7874 "items": { 7875 "$ref": "#/definitions/releaseInfo" 7876 } 7877 } 7878 } 7879 }, 7880 "releaseMetadata": { 7881 "type": "object", 7882 "properties": { 7883 "assets_url": { 7884 "type": "string" 7885 }, 7886 "author": { 7887 "$ref": "#/definitions/releaseAuthor" 7888 }, 7889 "created_at": { 7890 "type": "string" 7891 }, 7892 "draft": { 7893 "type": "boolean" 7894 }, 7895 "html_url": { 7896 "type": "string" 7897 }, 7898 "id": { 7899 "type": "integer" 7900 }, 7901 "name": { 7902 "type": "string" 7903 }, 7904 "node_id": { 7905 "type": "string" 7906 }, 7907 "prerelease": { 7908 "type": "boolean" 7909 }, 7910 "published_at": { 7911 "type": "string" 7912 }, 7913 "tag_name": { 7914 "type": "string" 7915 }, 7916 "tarball_url": { 7917 "type": "string" 7918 }, 7919 "target_commitish": { 7920 "type": "string" 7921 }, 7922 "upload_url": { 7923 "type": "string" 7924 }, 7925 "url": { 7926 "type": "string" 7927 }, 7928 "zipball_url": { 7929 "type": "string" 7930 } 7931 } 7932 }, 7933 "remoteBucket": { 7934 "type": "object", 7935 "required": [ 7936 "accessKey", 7937 "sourceBucket", 7938 "remoteARN" 7939 ], 7940 "properties": { 7941 "accessKey": { 7942 "type": "string", 7943 "minLength": 3 7944 }, 7945 "bandwidth": { 7946 "type": "integer", 7947 "format": "int64" 7948 }, 7949 "healthCheckPeriod": { 7950 "type": "integer" 7951 }, 7952 "remoteARN": { 7953 "type": "string" 7954 }, 7955 "secretKey": { 7956 "type": "string", 7957 "minLength": 8 7958 }, 7959 "service": { 7960 "type": "string", 7961 "enum": [ 7962 "replication" 7963 ] 7964 }, 7965 "sourceBucket": { 7966 "type": "string" 7967 }, 7968 "status": { 7969 "type": "string" 7970 }, 7971 "syncMode": { 7972 "type": "string" 7973 }, 7974 "targetBucket": { 7975 "type": "string" 7976 }, 7977 "targetURL": { 7978 "type": "string" 7979 } 7980 } 7981 }, 7982 "resultTarget": { 7983 "type": "object", 7984 "properties": { 7985 "legendFormat": { 7986 "type": "string" 7987 }, 7988 "result": { 7989 "type": "array", 7990 "items": { 7991 "$ref": "#/definitions/widgetResult" 7992 } 7993 }, 7994 "resultType": { 7995 "type": "string" 7996 } 7997 } 7998 }, 7999 "rewindItem": { 8000 "type": "object", 8001 "properties": { 8002 "action": { 8003 "type": "string" 8004 }, 8005 "delete_flag": { 8006 "type": "boolean" 8007 }, 8008 "is_latest": { 8009 "type": "boolean" 8010 }, 8011 "last_modified": { 8012 "type": "string" 8013 }, 8014 "name": { 8015 "type": "string" 8016 }, 8017 "size": { 8018 "type": "integer", 8019 "format": "int64" 8020 }, 8021 "version_id": { 8022 "type": "string" 8023 } 8024 } 8025 }, 8026 "rewindResponse": { 8027 "type": "object", 8028 "properties": { 8029 "objects": { 8030 "type": "array", 8031 "items": { 8032 "$ref": "#/definitions/rewindItem" 8033 } 8034 } 8035 } 8036 }, 8037 "selectedSAs": { 8038 "type": "array", 8039 "items": { 8040 "type": "string" 8041 } 8042 }, 8043 "selectedUsers": { 8044 "type": "array", 8045 "items": { 8046 "type": "string" 8047 } 8048 }, 8049 "serverDrives": { 8050 "type": "object", 8051 "properties": { 8052 "availableSpace": { 8053 "type": "integer" 8054 }, 8055 "drivePath": { 8056 "type": "string" 8057 }, 8058 "endpoint": { 8059 "type": "string" 8060 }, 8061 "healing": { 8062 "type": "boolean" 8063 }, 8064 "model": { 8065 "type": "string" 8066 }, 8067 "rootDisk": { 8068 "type": "boolean" 8069 }, 8070 "state": { 8071 "type": "string" 8072 }, 8073 "totalSpace": { 8074 "type": "integer" 8075 }, 8076 "usedSpace": { 8077 "type": "integer" 8078 }, 8079 "uuid": { 8080 "type": "string" 8081 } 8082 } 8083 }, 8084 "serverProperties": { 8085 "type": "object", 8086 "properties": { 8087 "commitID": { 8088 "type": "string" 8089 }, 8090 "drives": { 8091 "type": "array", 8092 "items": { 8093 "$ref": "#/definitions/serverDrives" 8094 } 8095 }, 8096 "endpoint": { 8097 "type": "string" 8098 }, 8099 "network": { 8100 "type": "object", 8101 "additionalProperties": { 8102 "type": "string" 8103 } 8104 }, 8105 "poolNumber": { 8106 "type": "integer" 8107 }, 8108 "state": { 8109 "type": "string" 8110 }, 8111 "uptime": { 8112 "type": "integer" 8113 }, 8114 "version": { 8115 "type": "string" 8116 } 8117 } 8118 }, 8119 "serviceAccount": { 8120 "type": "object", 8121 "properties": { 8122 "accountStatus": { 8123 "type": "string" 8124 }, 8125 "description": { 8126 "type": "string" 8127 }, 8128 "expiration": { 8129 "type": "string" 8130 }, 8131 "impliedPolicy": { 8132 "type": "boolean" 8133 }, 8134 "name": { 8135 "type": "string" 8136 }, 8137 "parentUser": { 8138 "type": "string" 8139 }, 8140 "policy": { 8141 "type": "string" 8142 } 8143 } 8144 }, 8145 "serviceAccountCreds": { 8146 "type": "object", 8147 "properties": { 8148 "accessKey": { 8149 "type": "string" 8150 }, 8151 "secretKey": { 8152 "type": "string" 8153 }, 8154 "url": { 8155 "type": "string" 8156 } 8157 } 8158 }, 8159 "serviceAccountRequest": { 8160 "type": "object", 8161 "properties": { 8162 "comment": { 8163 "type": "string" 8164 }, 8165 "description": { 8166 "type": "string" 8167 }, 8168 "expiry": { 8169 "type": "string" 8170 }, 8171 "name": { 8172 "type": "string" 8173 }, 8174 "policy": { 8175 "type": "string", 8176 "title": "policy to be applied to the Service Account if any" 8177 } 8178 } 8179 }, 8180 "serviceAccountRequestCreds": { 8181 "type": "object", 8182 "properties": { 8183 "accessKey": { 8184 "type": "string" 8185 }, 8186 "comment": { 8187 "type": "string" 8188 }, 8189 "description": { 8190 "type": "string" 8191 }, 8192 "expiry": { 8193 "type": "string" 8194 }, 8195 "name": { 8196 "type": "string" 8197 }, 8198 "policy": { 8199 "type": "string", 8200 "title": "policy to be applied to the Service Account if any" 8201 }, 8202 "secretKey": { 8203 "type": "string" 8204 } 8205 } 8206 }, 8207 "serviceAccounts": { 8208 "type": "array", 8209 "items": { 8210 "type": "object", 8211 "properties": { 8212 "accessKey": { 8213 "type": "string" 8214 }, 8215 "accountStatus": { 8216 "type": "string" 8217 }, 8218 "description": { 8219 "type": "string" 8220 }, 8221 "expiration": { 8222 "type": "string" 8223 }, 8224 "name": { 8225 "type": "string" 8226 } 8227 } 8228 } 8229 }, 8230 "sessionResponse": { 8231 "type": "object", 8232 "properties": { 8233 "allowResources": { 8234 "type": "array", 8235 "items": { 8236 "$ref": "#/definitions/permissionResource" 8237 } 8238 }, 8239 "customStyles": { 8240 "type": "string" 8241 }, 8242 "distributedMode": { 8243 "type": "boolean" 8244 }, 8245 "envConstants": { 8246 "$ref": "#/definitions/environmentConstants" 8247 }, 8248 "features": { 8249 "type": "array", 8250 "items": { 8251 "type": "string" 8252 } 8253 }, 8254 "operator": { 8255 "type": "boolean" 8256 }, 8257 "permissions": { 8258 "type": "object", 8259 "additionalProperties": { 8260 "type": "array", 8261 "items": { 8262 "type": "string" 8263 } 8264 } 8265 }, 8266 "serverEndPoint": { 8267 "type": "string" 8268 }, 8269 "status": { 8270 "type": "string", 8271 "enum": [ 8272 "ok" 8273 ] 8274 } 8275 } 8276 }, 8277 "setBucketPolicyRequest": { 8278 "type": "object", 8279 "required": [ 8280 "access" 8281 ], 8282 "properties": { 8283 "access": { 8284 "$ref": "#/definitions/bucketAccess" 8285 }, 8286 "definition": { 8287 "type": "string" 8288 } 8289 } 8290 }, 8291 "setBucketQuota": { 8292 "type": "object", 8293 "required": [ 8294 "enabled" 8295 ], 8296 "properties": { 8297 "amount": { 8298 "type": "integer" 8299 }, 8300 "enabled": { 8301 "type": "boolean" 8302 }, 8303 "quota_type": { 8304 "type": "string", 8305 "enum": [ 8306 "hard" 8307 ] 8308 } 8309 } 8310 }, 8311 "setBucketVersioning": { 8312 "type": "object", 8313 "properties": { 8314 "enabled": { 8315 "type": "boolean" 8316 }, 8317 "excludeFolders": { 8318 "type": "boolean" 8319 }, 8320 "excludePrefixes": { 8321 "type": "array", 8322 "maxLength": 10, 8323 "items": { 8324 "type": "string" 8325 } 8326 } 8327 } 8328 }, 8329 "setConfigRequest": { 8330 "type": "object", 8331 "required": [ 8332 "key_values" 8333 ], 8334 "properties": { 8335 "arn_resource_id": { 8336 "type": "string", 8337 "title": "Used if configuration is an event notification's target" 8338 }, 8339 "key_values": { 8340 "type": "array", 8341 "minItems": 1, 8342 "items": { 8343 "$ref": "#/definitions/configurationKV" 8344 } 8345 } 8346 } 8347 }, 8348 "setConfigResponse": { 8349 "type": "object", 8350 "properties": { 8351 "restart": { 8352 "description": "Returns wheter server needs to restart to apply changes or not", 8353 "type": "boolean" 8354 } 8355 } 8356 }, 8357 "setIDPResponse": { 8358 "type": "object", 8359 "properties": { 8360 "restart": { 8361 "type": "boolean" 8362 } 8363 } 8364 }, 8365 "setNotificationEndpointResponse": { 8366 "type": "object", 8367 "required": [ 8368 "service", 8369 "account_id", 8370 "properties" 8371 ], 8372 "properties": { 8373 "account_id": { 8374 "type": "string" 8375 }, 8376 "properties": { 8377 "type": "object", 8378 "additionalProperties": { 8379 "type": "string" 8380 } 8381 }, 8382 "restart": { 8383 "type": "boolean" 8384 }, 8385 "service": { 8386 "$ref": "#/definitions/nofiticationService" 8387 } 8388 } 8389 }, 8390 "setPolicyMultipleNameRequest": { 8391 "type": "object", 8392 "properties": { 8393 "groups": { 8394 "type": "array", 8395 "items": { 8396 "$ref": "#/definitions/iamEntity" 8397 } 8398 }, 8399 "name": { 8400 "type": "array", 8401 "items": { 8402 "type": "string" 8403 } 8404 }, 8405 "users": { 8406 "type": "array", 8407 "items": { 8408 "$ref": "#/definitions/iamEntity" 8409 } 8410 } 8411 } 8412 }, 8413 "setPolicyNameRequest": { 8414 "type": "object", 8415 "required": [ 8416 "name", 8417 "entityType", 8418 "entityName" 8419 ], 8420 "properties": { 8421 "entityName": { 8422 "type": "string" 8423 }, 8424 "entityType": { 8425 "$ref": "#/definitions/policyEntity" 8426 }, 8427 "name": { 8428 "type": "array", 8429 "items": { 8430 "type": "string" 8431 } 8432 } 8433 } 8434 }, 8435 "setPolicyRequest": { 8436 "type": "object", 8437 "required": [ 8438 "entityType", 8439 "entityName" 8440 ], 8441 "properties": { 8442 "entityName": { 8443 "type": "string" 8444 }, 8445 "entityType": { 8446 "$ref": "#/definitions/policyEntity" 8447 } 8448 } 8449 }, 8450 "siteReplicationAddRequest": { 8451 "type": "array", 8452 "items": { 8453 "$ref": "#/definitions/peerSite" 8454 } 8455 }, 8456 "siteReplicationAddResponse": { 8457 "type": "object", 8458 "properties": { 8459 "errorDetail": { 8460 "type": "string" 8461 }, 8462 "initialSyncErrorMessage": { 8463 "type": "string" 8464 }, 8465 "status": { 8466 "type": "string" 8467 }, 8468 "success": { 8469 "type": "boolean" 8470 } 8471 } 8472 }, 8473 "siteReplicationInfoResponse": { 8474 "type": "object", 8475 "properties": { 8476 "enabled": { 8477 "type": "boolean" 8478 }, 8479 "name": { 8480 "type": "string" 8481 }, 8482 "serviceAccountAccessKey": { 8483 "type": "string" 8484 }, 8485 "sites": { 8486 "type": "array", 8487 "items": { 8488 "$ref": "#/definitions/peerInfo" 8489 } 8490 } 8491 } 8492 }, 8493 "siteReplicationStatusResponse": { 8494 "type": "object", 8495 "properties": { 8496 "bucketStats": { 8497 "type": "object" 8498 }, 8499 "enabled": { 8500 "type": "boolean" 8501 }, 8502 "groupStats": { 8503 "type": "object" 8504 }, 8505 "maxBuckets": { 8506 "type": "integer" 8507 }, 8508 "maxGroups": { 8509 "type": "integer" 8510 }, 8511 "maxPolicies": { 8512 "type": "integer" 8513 }, 8514 "maxUsers": { 8515 "type": "integer" 8516 }, 8517 "policyStats": { 8518 "type": "object" 8519 }, 8520 "sites": { 8521 "type": "object" 8522 }, 8523 "statsSummary": { 8524 "type": "object" 8525 }, 8526 "userStats": { 8527 "type": "object" 8528 } 8529 } 8530 }, 8531 "startProfilingItem": { 8532 "type": "object", 8533 "properties": { 8534 "error": { 8535 "type": "string" 8536 }, 8537 "nodeName": { 8538 "type": "string" 8539 }, 8540 "success": { 8541 "type": "boolean" 8542 } 8543 } 8544 }, 8545 "startProfilingList": { 8546 "type": "object", 8547 "properties": { 8548 "startResults": { 8549 "type": "array", 8550 "items": { 8551 "$ref": "#/definitions/startProfilingItem" 8552 } 8553 }, 8554 "total": { 8555 "type": "integer", 8556 "format": "int64", 8557 "title": "number of start results" 8558 } 8559 } 8560 }, 8561 "subnetLoginMFARequest": { 8562 "type": "object", 8563 "required": [ 8564 "username", 8565 "otp", 8566 "mfa_token" 8567 ], 8568 "properties": { 8569 "mfa_token": { 8570 "type": "string" 8571 }, 8572 "otp": { 8573 "type": "string" 8574 }, 8575 "username": { 8576 "type": "string" 8577 } 8578 } 8579 }, 8580 "subnetLoginRequest": { 8581 "type": "object", 8582 "properties": { 8583 "apiKey": { 8584 "type": "string" 8585 }, 8586 "password": { 8587 "type": "string" 8588 }, 8589 "username": { 8590 "type": "string" 8591 } 8592 } 8593 }, 8594 "subnetLoginResponse": { 8595 "type": "object", 8596 "properties": { 8597 "access_token": { 8598 "type": "string" 8599 }, 8600 "mfa_token": { 8601 "type": "string" 8602 }, 8603 "organizations": { 8604 "type": "array", 8605 "items": { 8606 "$ref": "#/definitions/subnetOrganization" 8607 } 8608 }, 8609 "registered": { 8610 "type": "boolean" 8611 } 8612 } 8613 }, 8614 "subnetOrganization": { 8615 "type": "object", 8616 "properties": { 8617 "accountId": { 8618 "type": "integer" 8619 }, 8620 "company": { 8621 "type": "string" 8622 }, 8623 "isAccountOwner": { 8624 "type": "boolean" 8625 }, 8626 "shortName": { 8627 "type": "string" 8628 }, 8629 "subscriptionStatus": { 8630 "type": "string" 8631 }, 8632 "userId": { 8633 "type": "integer" 8634 } 8635 } 8636 }, 8637 "subnetRegisterRequest": { 8638 "type": "object", 8639 "required": [ 8640 "token", 8641 "account_id" 8642 ], 8643 "properties": { 8644 "account_id": { 8645 "type": "string" 8646 }, 8647 "token": { 8648 "type": "string" 8649 } 8650 } 8651 }, 8652 "tier": { 8653 "type": "object", 8654 "properties": { 8655 "azure": { 8656 "type": "object", 8657 "$ref": "#/definitions/tier_azure" 8658 }, 8659 "gcs": { 8660 "type": "object", 8661 "$ref": "#/definitions/tier_gcs" 8662 }, 8663 "minio": { 8664 "type": "object", 8665 "$ref": "#/definitions/tier_minio" 8666 }, 8667 "s3": { 8668 "type": "object", 8669 "$ref": "#/definitions/tier_s3" 8670 }, 8671 "status": { 8672 "type": "boolean" 8673 }, 8674 "type": { 8675 "type": "string", 8676 "enum": [ 8677 "s3", 8678 "gcs", 8679 "azure", 8680 "minio", 8681 "unsupported" 8682 ] 8683 } 8684 } 8685 }, 8686 "tierCredentialsRequest": { 8687 "type": "object", 8688 "properties": { 8689 "access_key": { 8690 "type": "string" 8691 }, 8692 "creds": { 8693 "description": "a base64 encoded value", 8694 "type": "string" 8695 }, 8696 "secret_key": { 8697 "type": "string" 8698 } 8699 } 8700 }, 8701 "tierListResponse": { 8702 "type": "object", 8703 "properties": { 8704 "items": { 8705 "type": "array", 8706 "items": { 8707 "$ref": "#/definitions/tier" 8708 } 8709 } 8710 } 8711 }, 8712 "tier_azure": { 8713 "type": "object", 8714 "properties": { 8715 "accountkey": { 8716 "type": "string" 8717 }, 8718 "accountname": { 8719 "type": "string" 8720 }, 8721 "bucket": { 8722 "type": "string" 8723 }, 8724 "endpoint": { 8725 "type": "string" 8726 }, 8727 "name": { 8728 "type": "string" 8729 }, 8730 "objects": { 8731 "type": "string" 8732 }, 8733 "prefix": { 8734 "type": "string" 8735 }, 8736 "region": { 8737 "type": "string" 8738 }, 8739 "usage": { 8740 "type": "string" 8741 }, 8742 "versions": { 8743 "type": "string" 8744 } 8745 } 8746 }, 8747 "tier_gcs": { 8748 "type": "object", 8749 "properties": { 8750 "bucket": { 8751 "type": "string" 8752 }, 8753 "creds": { 8754 "type": "string" 8755 }, 8756 "endpoint": { 8757 "type": "string" 8758 }, 8759 "name": { 8760 "type": "string" 8761 }, 8762 "objects": { 8763 "type": "string" 8764 }, 8765 "prefix": { 8766 "type": "string" 8767 }, 8768 "region": { 8769 "type": "string" 8770 }, 8771 "usage": { 8772 "type": "string" 8773 }, 8774 "versions": { 8775 "type": "string" 8776 } 8777 } 8778 }, 8779 "tier_minio": { 8780 "type": "object", 8781 "properties": { 8782 "accesskey": { 8783 "type": "string" 8784 }, 8785 "bucket": { 8786 "type": "string" 8787 }, 8788 "endpoint": { 8789 "type": "string" 8790 }, 8791 "name": { 8792 "type": "string" 8793 }, 8794 "objects": { 8795 "type": "string" 8796 }, 8797 "prefix": { 8798 "type": "string" 8799 }, 8800 "region": { 8801 "type": "string" 8802 }, 8803 "secretkey": { 8804 "type": "string" 8805 }, 8806 "storageclass": { 8807 "type": "string" 8808 }, 8809 "usage": { 8810 "type": "string" 8811 }, 8812 "versions": { 8813 "type": "string" 8814 } 8815 } 8816 }, 8817 "tier_s3": { 8818 "type": "object", 8819 "properties": { 8820 "accesskey": { 8821 "type": "string" 8822 }, 8823 "bucket": { 8824 "type": "string" 8825 }, 8826 "endpoint": { 8827 "type": "string" 8828 }, 8829 "name": { 8830 "type": "string" 8831 }, 8832 "objects": { 8833 "type": "string" 8834 }, 8835 "prefix": { 8836 "type": "string" 8837 }, 8838 "region": { 8839 "type": "string" 8840 }, 8841 "secretkey": { 8842 "type": "string" 8843 }, 8844 "storageclass": { 8845 "type": "string" 8846 }, 8847 "usage": { 8848 "type": "string" 8849 }, 8850 "versions": { 8851 "type": "string" 8852 } 8853 } 8854 }, 8855 "transitionResponse": { 8856 "type": "object", 8857 "properties": { 8858 "date": { 8859 "type": "string" 8860 }, 8861 "days": { 8862 "type": "integer", 8863 "format": "int64" 8864 }, 8865 "noncurrent_storage_class": { 8866 "type": "string" 8867 }, 8868 "noncurrent_transition_days": { 8869 "type": "integer", 8870 "format": "int64" 8871 }, 8872 "storage_class": { 8873 "type": "string" 8874 } 8875 } 8876 }, 8877 "updateBucketLifecycle": { 8878 "type": "object", 8879 "required": [ 8880 "type" 8881 ], 8882 "properties": { 8883 "disable": { 8884 "description": "Non required, toggle to disable or enable rule", 8885 "type": "boolean" 8886 }, 8887 "expired_object_delete_all": { 8888 "description": "Non required, toggle to disable or enable rule", 8889 "type": "boolean" 8890 }, 8891 "expired_object_delete_marker": { 8892 "description": "Non required, toggle to disable or enable rule", 8893 "type": "boolean" 8894 }, 8895 "expiry_days": { 8896 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 8897 "type": "integer", 8898 "format": "int32", 8899 "default": 0 8900 }, 8901 "noncurrentversion_expiration_days": { 8902 "description": "Non required, can be set in case of expiration is enabled", 8903 "type": "integer", 8904 "format": "int32", 8905 "default": 0 8906 }, 8907 "noncurrentversion_transition_days": { 8908 "description": "Non required, can be set in case of transition is enabled", 8909 "type": "integer", 8910 "format": "int32", 8911 "default": 0 8912 }, 8913 "noncurrentversion_transition_storage_class": { 8914 "description": "Non required, can be set in case of transition is enabled", 8915 "type": "string" 8916 }, 8917 "prefix": { 8918 "description": "Non required field, it matches a prefix to perform ILM operations on it", 8919 "type": "string" 8920 }, 8921 "storage_class": { 8922 "description": "Required only in case of transition is set. it refers to a tier", 8923 "type": "string" 8924 }, 8925 "tags": { 8926 "description": "Non required field, tags to match ILM files", 8927 "type": "string" 8928 }, 8929 "transition_days": { 8930 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 8931 "type": "integer", 8932 "format": "int32", 8933 "default": 0 8934 }, 8935 "type": { 8936 "description": "ILM Rule type (Expiry or transition)", 8937 "type": "string", 8938 "enum": [ 8939 "expiry", 8940 "transition" 8941 ] 8942 } 8943 } 8944 }, 8945 "updateGroupRequest": { 8946 "type": "object", 8947 "required": [ 8948 "members", 8949 "status" 8950 ], 8951 "properties": { 8952 "members": { 8953 "type": "array", 8954 "items": { 8955 "type": "string" 8956 } 8957 }, 8958 "status": { 8959 "type": "string" 8960 } 8961 } 8962 }, 8963 "updateServiceAccountRequest": { 8964 "type": "object", 8965 "required": [ 8966 "policy" 8967 ], 8968 "properties": { 8969 "description": { 8970 "type": "string" 8971 }, 8972 "expiry": { 8973 "type": "string" 8974 }, 8975 "name": { 8976 "type": "string" 8977 }, 8978 "policy": { 8979 "type": "string" 8980 }, 8981 "secretKey": { 8982 "type": "string" 8983 }, 8984 "status": { 8985 "type": "string" 8986 } 8987 } 8988 }, 8989 "updateUser": { 8990 "type": "object", 8991 "required": [ 8992 "status", 8993 "groups" 8994 ], 8995 "properties": { 8996 "groups": { 8997 "type": "array", 8998 "items": { 8999 "type": "string" 9000 } 9001 }, 9002 "status": { 9003 "type": "string" 9004 } 9005 } 9006 }, 9007 "updateUserGroups": { 9008 "type": "object", 9009 "required": [ 9010 "groups" 9011 ], 9012 "properties": { 9013 "groups": { 9014 "type": "array", 9015 "items": { 9016 "type": "string" 9017 } 9018 } 9019 } 9020 }, 9021 "user": { 9022 "type": "object", 9023 "properties": { 9024 "accessKey": { 9025 "type": "string" 9026 }, 9027 "hasPolicy": { 9028 "type": "boolean" 9029 }, 9030 "memberOf": { 9031 "type": "array", 9032 "items": { 9033 "type": "string" 9034 } 9035 }, 9036 "policy": { 9037 "type": "array", 9038 "items": { 9039 "type": "string" 9040 } 9041 }, 9042 "status": { 9043 "type": "string" 9044 } 9045 } 9046 }, 9047 "userSAs": { 9048 "type": "object", 9049 "properties": { 9050 "path": { 9051 "type": "string" 9052 }, 9053 "recursive": { 9054 "type": "boolean" 9055 }, 9056 "versionID": { 9057 "type": "string" 9058 } 9059 } 9060 }, 9061 "userServiceAccountItem": { 9062 "type": "object", 9063 "properties": { 9064 "numSAs": { 9065 "type": "integer", 9066 "format": "int64" 9067 }, 9068 "userName": { 9069 "type": "string" 9070 } 9071 } 9072 }, 9073 "userServiceAccountSummary": { 9074 "type": "object", 9075 "properties": { 9076 "hasSA": { 9077 "type": "boolean" 9078 }, 9079 "userServiceAccountList": { 9080 "type": "array", 9081 "title": "list of users with number of service accounts", 9082 "items": { 9083 "$ref": "#/definitions/userServiceAccountItem" 9084 } 9085 } 9086 } 9087 }, 9088 "widget": { 9089 "type": "object", 9090 "properties": { 9091 "id": { 9092 "type": "integer", 9093 "format": "int32" 9094 }, 9095 "options": { 9096 "type": "object", 9097 "properties": { 9098 "reduceOptions": { 9099 "type": "object", 9100 "properties": { 9101 "calcs": { 9102 "type": "array", 9103 "items": { 9104 "type": "string" 9105 } 9106 } 9107 } 9108 } 9109 } 9110 }, 9111 "targets": { 9112 "type": "array", 9113 "items": { 9114 "$ref": "#/definitions/resultTarget" 9115 } 9116 }, 9117 "title": { 9118 "type": "string" 9119 }, 9120 "type": { 9121 "type": "string" 9122 } 9123 } 9124 }, 9125 "widgetDetails": { 9126 "type": "object", 9127 "properties": { 9128 "id": { 9129 "type": "integer", 9130 "format": "int32" 9131 }, 9132 "options": { 9133 "type": "object", 9134 "properties": { 9135 "reduceOptions": { 9136 "type": "object", 9137 "properties": { 9138 "calcs": { 9139 "type": "array", 9140 "items": { 9141 "type": "string" 9142 } 9143 } 9144 } 9145 } 9146 } 9147 }, 9148 "targets": { 9149 "type": "array", 9150 "items": { 9151 "$ref": "#/definitions/resultTarget" 9152 } 9153 }, 9154 "title": { 9155 "type": "string" 9156 }, 9157 "type": { 9158 "type": "string" 9159 } 9160 } 9161 }, 9162 "widgetResult": { 9163 "type": "object", 9164 "properties": { 9165 "metric": { 9166 "type": "object", 9167 "additionalProperties": { 9168 "type": "string" 9169 } 9170 }, 9171 "values": { 9172 "type": "array", 9173 "items": {} 9174 } 9175 } 9176 } 9177 }, 9178 "parameters": { 9179 "limit": { 9180 "type": "number", 9181 "format": "int32", 9182 "default": 20, 9183 "name": "limit", 9184 "in": "query" 9185 }, 9186 "offset": { 9187 "type": "number", 9188 "format": "int32", 9189 "default": 0, 9190 "name": "offset", 9191 "in": "query" 9192 } 9193 }, 9194 "securityDefinitions": { 9195 "anonymous": { 9196 "type": "apiKey", 9197 "name": "X-Anonymous", 9198 "in": "header" 9199 }, 9200 "key": { 9201 "type": "oauth2", 9202 "flow": "accessCode", 9203 "authorizationUrl": "http://min.io", 9204 "tokenUrl": "http://min.io" 9205 } 9206 }, 9207 "security": [ 9208 { 9209 "key": [] 9210 } 9211 ] 9212 }`)) 9213 FlatSwaggerJSON = json.RawMessage([]byte(`{ 9214 "consumes": [ 9215 "application/json" 9216 ], 9217 "produces": [ 9218 "application/json" 9219 ], 9220 "schemes": [ 9221 "http", 9222 "ws" 9223 ], 9224 "swagger": "2.0", 9225 "info": { 9226 "title": "MinIO Console Server", 9227 "version": "0.1.0" 9228 }, 9229 "basePath": "/api/v1", 9230 "paths": { 9231 "/account/change-password": { 9232 "post": { 9233 "tags": [ 9234 "Account" 9235 ], 9236 "summary": "Change password of currently logged in user.", 9237 "operationId": "AccountChangePassword", 9238 "parameters": [ 9239 { 9240 "name": "body", 9241 "in": "body", 9242 "required": true, 9243 "schema": { 9244 "$ref": "#/definitions/accountChangePasswordRequest" 9245 } 9246 } 9247 ], 9248 "responses": { 9249 "204": { 9250 "description": "A successful login." 9251 }, 9252 "default": { 9253 "description": "Generic error response.", 9254 "schema": { 9255 "$ref": "#/definitions/ApiError" 9256 } 9257 } 9258 } 9259 } 9260 }, 9261 "/account/change-user-password": { 9262 "post": { 9263 "tags": [ 9264 "Account" 9265 ], 9266 "summary": "Change password of currently logged in user.", 9267 "operationId": "ChangeUserPassword", 9268 "parameters": [ 9269 { 9270 "name": "body", 9271 "in": "body", 9272 "required": true, 9273 "schema": { 9274 "$ref": "#/definitions/changeUserPasswordRequest" 9275 } 9276 } 9277 ], 9278 "responses": { 9279 "201": { 9280 "description": "Password successfully changed." 9281 }, 9282 "default": { 9283 "description": "Generic error response.", 9284 "schema": { 9285 "$ref": "#/definitions/ApiError" 9286 } 9287 } 9288 } 9289 } 9290 }, 9291 "/admin/arns": { 9292 "get": { 9293 "tags": [ 9294 "System" 9295 ], 9296 "summary": "Returns a list of active ARNs in the instance", 9297 "operationId": "ArnList", 9298 "responses": { 9299 "200": { 9300 "description": "A successful response.", 9301 "schema": { 9302 "$ref": "#/definitions/arnsResponse" 9303 } 9304 }, 9305 "default": { 9306 "description": "Generic error response.", 9307 "schema": { 9308 "$ref": "#/definitions/ApiError" 9309 } 9310 } 9311 } 9312 } 9313 }, 9314 "/admin/info": { 9315 "get": { 9316 "tags": [ 9317 "System" 9318 ], 9319 "summary": "Returns information about the deployment", 9320 "operationId": "AdminInfo", 9321 "parameters": [ 9322 { 9323 "type": "boolean", 9324 "default": false, 9325 "name": "defaultOnly", 9326 "in": "query" 9327 } 9328 ], 9329 "responses": { 9330 "200": { 9331 "description": "A successful response.", 9332 "schema": { 9333 "$ref": "#/definitions/adminInfoResponse" 9334 } 9335 }, 9336 "default": { 9337 "description": "Generic error response.", 9338 "schema": { 9339 "$ref": "#/definitions/ApiError" 9340 } 9341 } 9342 } 9343 } 9344 }, 9345 "/admin/info/widgets/{widgetId}": { 9346 "get": { 9347 "tags": [ 9348 "System" 9349 ], 9350 "summary": "Returns information about the deployment", 9351 "operationId": "DashboardWidgetDetails", 9352 "parameters": [ 9353 { 9354 "type": "integer", 9355 "format": "int32", 9356 "name": "widgetId", 9357 "in": "path", 9358 "required": true 9359 }, 9360 { 9361 "type": "integer", 9362 "name": "start", 9363 "in": "query" 9364 }, 9365 { 9366 "type": "integer", 9367 "name": "end", 9368 "in": "query" 9369 }, 9370 { 9371 "type": "integer", 9372 "format": "int32", 9373 "name": "step", 9374 "in": "query" 9375 } 9376 ], 9377 "responses": { 9378 "200": { 9379 "description": "A successful response.", 9380 "schema": { 9381 "$ref": "#/definitions/widgetDetails" 9382 } 9383 }, 9384 "default": { 9385 "description": "Generic error response.", 9386 "schema": { 9387 "$ref": "#/definitions/ApiError" 9388 } 9389 } 9390 } 9391 } 9392 }, 9393 "/admin/inspect": { 9394 "get": { 9395 "produces": [ 9396 "application/octet-stream" 9397 ], 9398 "tags": [ 9399 "Inspect" 9400 ], 9401 "summary": "Inspect Files on Drive", 9402 "operationId": "Inspect", 9403 "parameters": [ 9404 { 9405 "type": "string", 9406 "name": "file", 9407 "in": "query", 9408 "required": true 9409 }, 9410 { 9411 "type": "string", 9412 "name": "volume", 9413 "in": "query", 9414 "required": true 9415 }, 9416 { 9417 "type": "boolean", 9418 "name": "encrypt", 9419 "in": "query" 9420 } 9421 ], 9422 "responses": { 9423 "200": { 9424 "description": "A successful response.", 9425 "schema": { 9426 "type": "file" 9427 } 9428 }, 9429 "default": { 9430 "description": "Generic error response.", 9431 "schema": { 9432 "$ref": "#/definitions/ApiError" 9433 } 9434 } 9435 } 9436 } 9437 }, 9438 "/admin/notification_endpoints": { 9439 "get": { 9440 "tags": [ 9441 "Configuration" 9442 ], 9443 "summary": "Returns a list of active notification endpoints", 9444 "operationId": "NotificationEndpointList", 9445 "responses": { 9446 "200": { 9447 "description": "A successful response.", 9448 "schema": { 9449 "$ref": "#/definitions/notifEndpointResponse" 9450 } 9451 }, 9452 "default": { 9453 "description": "Generic error response.", 9454 "schema": { 9455 "$ref": "#/definitions/ApiError" 9456 } 9457 } 9458 } 9459 }, 9460 "post": { 9461 "tags": [ 9462 "Configuration" 9463 ], 9464 "summary": "Allows to configure a new notification endpoint", 9465 "operationId": "AddNotificationEndpoint", 9466 "parameters": [ 9467 { 9468 "name": "body", 9469 "in": "body", 9470 "required": true, 9471 "schema": { 9472 "$ref": "#/definitions/notificationEndpoint" 9473 } 9474 } 9475 ], 9476 "responses": { 9477 "201": { 9478 "description": "A successful response.", 9479 "schema": { 9480 "$ref": "#/definitions/setNotificationEndpointResponse" 9481 } 9482 }, 9483 "default": { 9484 "description": "Generic error response.", 9485 "schema": { 9486 "$ref": "#/definitions/ApiError" 9487 } 9488 } 9489 } 9490 } 9491 }, 9492 "/admin/site-replication": { 9493 "get": { 9494 "tags": [ 9495 "SiteReplication" 9496 ], 9497 "summary": "Get list of Replication Sites", 9498 "operationId": "GetSiteReplicationInfo", 9499 "responses": { 9500 "200": { 9501 "description": "A successful response.", 9502 "schema": { 9503 "$ref": "#/definitions/siteReplicationInfoResponse" 9504 } 9505 }, 9506 "default": { 9507 "description": "Generic error response.", 9508 "schema": { 9509 "$ref": "#/definitions/ApiError" 9510 } 9511 } 9512 } 9513 }, 9514 "put": { 9515 "tags": [ 9516 "SiteReplication" 9517 ], 9518 "summary": "Edit a Replication Site", 9519 "operationId": "SiteReplicationEdit", 9520 "parameters": [ 9521 { 9522 "name": "body", 9523 "in": "body", 9524 "required": true, 9525 "schema": { 9526 "$ref": "#/definitions/peerInfo" 9527 } 9528 } 9529 ], 9530 "responses": { 9531 "200": { 9532 "description": "A successful response.", 9533 "schema": { 9534 "$ref": "#/definitions/peerSiteEditResponse" 9535 } 9536 }, 9537 "default": { 9538 "description": "Generic error response.", 9539 "schema": { 9540 "$ref": "#/definitions/ApiError" 9541 } 9542 } 9543 } 9544 }, 9545 "post": { 9546 "tags": [ 9547 "SiteReplication" 9548 ], 9549 "summary": "Add a Replication Site", 9550 "operationId": "SiteReplicationInfoAdd", 9551 "parameters": [ 9552 { 9553 "name": "body", 9554 "in": "body", 9555 "required": true, 9556 "schema": { 9557 "$ref": "#/definitions/siteReplicationAddRequest" 9558 } 9559 } 9560 ], 9561 "responses": { 9562 "200": { 9563 "description": "A successful response.", 9564 "schema": { 9565 "$ref": "#/definitions/siteReplicationAddResponse" 9566 } 9567 }, 9568 "default": { 9569 "description": "Generic error response.", 9570 "schema": { 9571 "$ref": "#/definitions/ApiError" 9572 } 9573 } 9574 } 9575 }, 9576 "delete": { 9577 "tags": [ 9578 "SiteReplication" 9579 ], 9580 "summary": "Remove a Replication Site", 9581 "operationId": "SiteReplicationRemove", 9582 "parameters": [ 9583 { 9584 "name": "body", 9585 "in": "body", 9586 "required": true, 9587 "schema": { 9588 "$ref": "#/definitions/peerInfoRemove" 9589 } 9590 } 9591 ], 9592 "responses": { 9593 "204": { 9594 "description": "A successful response.", 9595 "schema": { 9596 "$ref": "#/definitions/peerSiteRemoveResponse" 9597 } 9598 }, 9599 "default": { 9600 "description": "Generic error response.", 9601 "schema": { 9602 "$ref": "#/definitions/ApiError" 9603 } 9604 } 9605 } 9606 } 9607 }, 9608 "/admin/site-replication/status": { 9609 "get": { 9610 "tags": [ 9611 "SiteReplication" 9612 ], 9613 "summary": "Display overall site replication status", 9614 "operationId": "GetSiteReplicationStatus", 9615 "parameters": [ 9616 { 9617 "type": "boolean", 9618 "default": true, 9619 "description": "Include Bucket stats", 9620 "name": "buckets", 9621 "in": "query" 9622 }, 9623 { 9624 "type": "boolean", 9625 "default": true, 9626 "description": "Include Group stats", 9627 "name": "groups", 9628 "in": "query" 9629 }, 9630 { 9631 "type": "boolean", 9632 "default": true, 9633 "description": "Include Policies stats", 9634 "name": "policies", 9635 "in": "query" 9636 }, 9637 { 9638 "type": "boolean", 9639 "default": true, 9640 "description": "Include Policies stats", 9641 "name": "users", 9642 "in": "query" 9643 }, 9644 { 9645 "type": "string", 9646 "description": "Entity Type to lookup", 9647 "name": "entityType", 9648 "in": "query" 9649 }, 9650 { 9651 "type": "string", 9652 "description": "Entity Value to lookup", 9653 "name": "entityValue", 9654 "in": "query" 9655 } 9656 ], 9657 "responses": { 9658 "200": { 9659 "description": "A successful response.", 9660 "schema": { 9661 "$ref": "#/definitions/siteReplicationStatusResponse" 9662 } 9663 }, 9664 "default": { 9665 "description": "Generic error response.", 9666 "schema": { 9667 "$ref": "#/definitions/ApiError" 9668 } 9669 } 9670 } 9671 } 9672 }, 9673 "/admin/tiers": { 9674 "get": { 9675 "tags": [ 9676 "Tiering" 9677 ], 9678 "summary": "Returns a list of tiers for ilm", 9679 "operationId": "TiersList", 9680 "responses": { 9681 "200": { 9682 "description": "A successful response.", 9683 "schema": { 9684 "$ref": "#/definitions/tierListResponse" 9685 } 9686 }, 9687 "default": { 9688 "description": "Generic error response.", 9689 "schema": { 9690 "$ref": "#/definitions/ApiError" 9691 } 9692 } 9693 } 9694 }, 9695 "post": { 9696 "tags": [ 9697 "Tiering" 9698 ], 9699 "summary": "Allows to configure a new tier", 9700 "operationId": "AddTier", 9701 "parameters": [ 9702 { 9703 "name": "body", 9704 "in": "body", 9705 "required": true, 9706 "schema": { 9707 "$ref": "#/definitions/tier" 9708 } 9709 } 9710 ], 9711 "responses": { 9712 "201": { 9713 "description": "A successful response." 9714 }, 9715 "default": { 9716 "description": "Generic error response.", 9717 "schema": { 9718 "$ref": "#/definitions/ApiError" 9719 } 9720 } 9721 } 9722 } 9723 }, 9724 "/admin/tiers/{type}/{name}": { 9725 "get": { 9726 "tags": [ 9727 "Tiering" 9728 ], 9729 "summary": "Get Tier", 9730 "operationId": "GetTier", 9731 "parameters": [ 9732 { 9733 "enum": [ 9734 "s3", 9735 "gcs", 9736 "azure", 9737 "minio" 9738 ], 9739 "type": "string", 9740 "name": "type", 9741 "in": "path", 9742 "required": true 9743 }, 9744 { 9745 "type": "string", 9746 "name": "name", 9747 "in": "path", 9748 "required": true 9749 } 9750 ], 9751 "responses": { 9752 "200": { 9753 "description": "A successful response.", 9754 "schema": { 9755 "$ref": "#/definitions/tier" 9756 } 9757 }, 9758 "default": { 9759 "description": "Generic error response.", 9760 "schema": { 9761 "$ref": "#/definitions/ApiError" 9762 } 9763 } 9764 } 9765 } 9766 }, 9767 "/admin/tiers/{type}/{name}/credentials": { 9768 "put": { 9769 "tags": [ 9770 "Tiering" 9771 ], 9772 "summary": "Edit Tier Credentials", 9773 "operationId": "EditTierCredentials", 9774 "parameters": [ 9775 { 9776 "enum": [ 9777 "s3", 9778 "gcs", 9779 "azure", 9780 "minio" 9781 ], 9782 "type": "string", 9783 "name": "type", 9784 "in": "path", 9785 "required": true 9786 }, 9787 { 9788 "type": "string", 9789 "name": "name", 9790 "in": "path", 9791 "required": true 9792 }, 9793 { 9794 "name": "body", 9795 "in": "body", 9796 "required": true, 9797 "schema": { 9798 "$ref": "#/definitions/tierCredentialsRequest" 9799 } 9800 } 9801 ], 9802 "responses": { 9803 "200": { 9804 "description": "A successful response." 9805 }, 9806 "default": { 9807 "description": "Generic error response.", 9808 "schema": { 9809 "$ref": "#/definitions/ApiError" 9810 } 9811 } 9812 } 9813 } 9814 }, 9815 "/bucket-policy/{bucket}": { 9816 "get": { 9817 "tags": [ 9818 "Bucket" 9819 ], 9820 "summary": "List Policies With Given Bucket", 9821 "operationId": "ListPoliciesWithBucket", 9822 "parameters": [ 9823 { 9824 "type": "string", 9825 "name": "bucket", 9826 "in": "path", 9827 "required": true 9828 }, 9829 { 9830 "type": "number", 9831 "format": "int32", 9832 "default": 0, 9833 "name": "offset", 9834 "in": "query" 9835 }, 9836 { 9837 "type": "number", 9838 "format": "int32", 9839 "default": 20, 9840 "name": "limit", 9841 "in": "query" 9842 } 9843 ], 9844 "responses": { 9845 "200": { 9846 "description": "A successful response.", 9847 "schema": { 9848 "$ref": "#/definitions/listPoliciesResponse" 9849 } 9850 }, 9851 "default": { 9852 "description": "Generic error response.", 9853 "schema": { 9854 "$ref": "#/definitions/ApiError" 9855 } 9856 } 9857 } 9858 } 9859 }, 9860 "/bucket-users/{bucket}": { 9861 "get": { 9862 "tags": [ 9863 "Bucket" 9864 ], 9865 "summary": "List Users With Access to a Given Bucket", 9866 "operationId": "ListUsersWithAccessToBucket", 9867 "parameters": [ 9868 { 9869 "type": "string", 9870 "name": "bucket", 9871 "in": "path", 9872 "required": true 9873 }, 9874 { 9875 "type": "number", 9876 "format": "int32", 9877 "default": 0, 9878 "name": "offset", 9879 "in": "query" 9880 }, 9881 { 9882 "type": "number", 9883 "format": "int32", 9884 "default": 20, 9885 "name": "limit", 9886 "in": "query" 9887 } 9888 ], 9889 "responses": { 9890 "200": { 9891 "description": "A successful response.", 9892 "schema": { 9893 "type": "array", 9894 "items": { 9895 "type": "string" 9896 } 9897 } 9898 }, 9899 "default": { 9900 "description": "Generic error response.", 9901 "schema": { 9902 "$ref": "#/definitions/ApiError" 9903 } 9904 } 9905 } 9906 } 9907 }, 9908 "/bucket/{bucket}/access-rules": { 9909 "get": { 9910 "tags": [ 9911 "Bucket" 9912 ], 9913 "summary": "List Access Rules With Given Bucket", 9914 "operationId": "ListAccessRulesWithBucket", 9915 "parameters": [ 9916 { 9917 "type": "string", 9918 "name": "bucket", 9919 "in": "path", 9920 "required": true 9921 }, 9922 { 9923 "type": "number", 9924 "format": "int32", 9925 "default": 0, 9926 "name": "offset", 9927 "in": "query" 9928 }, 9929 { 9930 "type": "number", 9931 "format": "int32", 9932 "default": 20, 9933 "name": "limit", 9934 "in": "query" 9935 } 9936 ], 9937 "responses": { 9938 "200": { 9939 "description": "A successful response.", 9940 "schema": { 9941 "$ref": "#/definitions/listAccessRulesResponse" 9942 } 9943 }, 9944 "default": { 9945 "description": "Generic error response.", 9946 "schema": { 9947 "$ref": "#/definitions/ApiError" 9948 } 9949 } 9950 } 9951 }, 9952 "put": { 9953 "tags": [ 9954 "Bucket" 9955 ], 9956 "summary": "Add Access Rule To Given Bucket", 9957 "operationId": "SetAccessRuleWithBucket", 9958 "parameters": [ 9959 { 9960 "type": "string", 9961 "name": "bucket", 9962 "in": "path", 9963 "required": true 9964 }, 9965 { 9966 "name": "prefixaccess", 9967 "in": "body", 9968 "required": true, 9969 "schema": { 9970 "$ref": "#/definitions/prefixAccessPair" 9971 } 9972 } 9973 ], 9974 "responses": { 9975 "200": { 9976 "description": "A successful response.", 9977 "schema": { 9978 "type": "boolean" 9979 } 9980 }, 9981 "default": { 9982 "description": "Generic error response.", 9983 "schema": { 9984 "$ref": "#/definitions/ApiError" 9985 } 9986 } 9987 } 9988 }, 9989 "delete": { 9990 "tags": [ 9991 "Bucket" 9992 ], 9993 "summary": "Delete Access Rule From Given Bucket", 9994 "operationId": "DeleteAccessRuleWithBucket", 9995 "parameters": [ 9996 { 9997 "type": "string", 9998 "name": "bucket", 9999 "in": "path", 10000 "required": true 10001 }, 10002 { 10003 "name": "prefix", 10004 "in": "body", 10005 "required": true, 10006 "schema": { 10007 "$ref": "#/definitions/prefixWrapper" 10008 } 10009 } 10010 ], 10011 "responses": { 10012 "200": { 10013 "description": "A successful response.", 10014 "schema": { 10015 "type": "boolean" 10016 } 10017 }, 10018 "default": { 10019 "description": "Generic error response.", 10020 "schema": { 10021 "$ref": "#/definitions/ApiError" 10022 } 10023 } 10024 } 10025 } 10026 }, 10027 "/buckets": { 10028 "get": { 10029 "tags": [ 10030 "Bucket" 10031 ], 10032 "summary": "List Buckets", 10033 "operationId": "ListBuckets", 10034 "responses": { 10035 "200": { 10036 "description": "A successful response.", 10037 "schema": { 10038 "$ref": "#/definitions/listBucketsResponse" 10039 } 10040 }, 10041 "default": { 10042 "description": "Generic error response.", 10043 "schema": { 10044 "$ref": "#/definitions/ApiError" 10045 } 10046 } 10047 } 10048 }, 10049 "post": { 10050 "tags": [ 10051 "Bucket" 10052 ], 10053 "summary": "Make bucket", 10054 "operationId": "MakeBucket", 10055 "parameters": [ 10056 { 10057 "name": "body", 10058 "in": "body", 10059 "required": true, 10060 "schema": { 10061 "$ref": "#/definitions/makeBucketRequest" 10062 } 10063 } 10064 ], 10065 "responses": { 10066 "200": { 10067 "description": "A successful response.", 10068 "schema": { 10069 "$ref": "#/definitions/makeBucketsResponse" 10070 } 10071 }, 10072 "default": { 10073 "description": "Generic error response.", 10074 "schema": { 10075 "$ref": "#/definitions/ApiError" 10076 } 10077 } 10078 } 10079 } 10080 }, 10081 "/buckets-replication": { 10082 "post": { 10083 "tags": [ 10084 "Bucket" 10085 ], 10086 "summary": "Sets Multi Bucket Replication in multiple Buckets", 10087 "operationId": "SetMultiBucketReplication", 10088 "parameters": [ 10089 { 10090 "name": "body", 10091 "in": "body", 10092 "required": true, 10093 "schema": { 10094 "$ref": "#/definitions/multiBucketReplication" 10095 } 10096 } 10097 ], 10098 "responses": { 10099 "200": { 10100 "description": "A successful response.", 10101 "schema": { 10102 "$ref": "#/definitions/multiBucketResponseState" 10103 } 10104 }, 10105 "default": { 10106 "description": "Generic error response.", 10107 "schema": { 10108 "$ref": "#/definitions/ApiError" 10109 } 10110 } 10111 } 10112 } 10113 }, 10114 "/buckets/max-share-exp": { 10115 "get": { 10116 "tags": [ 10117 "Bucket" 10118 ], 10119 "summary": "Get max expiration time for share link in seconds", 10120 "operationId": "GetMaxShareLinkExp", 10121 "responses": { 10122 "200": { 10123 "description": "A successful response.", 10124 "schema": { 10125 "$ref": "#/definitions/maxShareLinkExpResponse" 10126 } 10127 }, 10128 "default": { 10129 "description": "Generic error response.", 10130 "schema": { 10131 "$ref": "#/definitions/ApiError" 10132 } 10133 } 10134 } 10135 } 10136 }, 10137 "/buckets/multi-lifecycle": { 10138 "post": { 10139 "tags": [ 10140 "Bucket" 10141 ], 10142 "summary": "Add Multi Bucket Lifecycle", 10143 "operationId": "AddMultiBucketLifecycle", 10144 "parameters": [ 10145 { 10146 "name": "body", 10147 "in": "body", 10148 "required": true, 10149 "schema": { 10150 "$ref": "#/definitions/addMultiBucketLifecycle" 10151 } 10152 } 10153 ], 10154 "responses": { 10155 "200": { 10156 "description": "A successful response.", 10157 "schema": { 10158 "$ref": "#/definitions/multiLifecycleResult" 10159 } 10160 }, 10161 "default": { 10162 "description": "Generic error response.", 10163 "schema": { 10164 "$ref": "#/definitions/ApiError" 10165 } 10166 } 10167 } 10168 } 10169 }, 10170 "/buckets/{bucket_name}/delete-all-replication-rules": { 10171 "delete": { 10172 "tags": [ 10173 "Bucket" 10174 ], 10175 "summary": "Deletes all replication rules from a bucket", 10176 "operationId": "DeleteAllReplicationRules", 10177 "parameters": [ 10178 { 10179 "type": "string", 10180 "name": "bucket_name", 10181 "in": "path", 10182 "required": true 10183 } 10184 ], 10185 "responses": { 10186 "204": { 10187 "description": "A successful response." 10188 }, 10189 "default": { 10190 "description": "Generic error response.", 10191 "schema": { 10192 "$ref": "#/definitions/ApiError" 10193 } 10194 } 10195 } 10196 } 10197 }, 10198 "/buckets/{bucket_name}/delete-objects": { 10199 "post": { 10200 "tags": [ 10201 "Object" 10202 ], 10203 "summary": "Delete Multiple Objects", 10204 "operationId": "DeleteMultipleObjects", 10205 "parameters": [ 10206 { 10207 "type": "string", 10208 "name": "bucket_name", 10209 "in": "path", 10210 "required": true 10211 }, 10212 { 10213 "type": "boolean", 10214 "name": "all_versions", 10215 "in": "query" 10216 }, 10217 { 10218 "type": "boolean", 10219 "name": "bypass", 10220 "in": "query" 10221 }, 10222 { 10223 "name": "files", 10224 "in": "body", 10225 "required": true, 10226 "schema": { 10227 "type": "array", 10228 "items": { 10229 "$ref": "#/definitions/deleteFile" 10230 } 10231 } 10232 } 10233 ], 10234 "responses": { 10235 "200": { 10236 "description": "A successful response." 10237 }, 10238 "default": { 10239 "description": "Generic error response.", 10240 "schema": { 10241 "$ref": "#/definitions/ApiError" 10242 } 10243 } 10244 } 10245 } 10246 }, 10247 "/buckets/{bucket_name}/delete-selected-replication-rules": { 10248 "delete": { 10249 "tags": [ 10250 "Bucket" 10251 ], 10252 "summary": "Deletes selected replication rules from a bucket", 10253 "operationId": "DeleteSelectedReplicationRules", 10254 "parameters": [ 10255 { 10256 "type": "string", 10257 "name": "bucket_name", 10258 "in": "path", 10259 "required": true 10260 }, 10261 { 10262 "name": "rules", 10263 "in": "body", 10264 "required": true, 10265 "schema": { 10266 "$ref": "#/definitions/bucketReplicationRuleList" 10267 } 10268 } 10269 ], 10270 "responses": { 10271 "204": { 10272 "description": "A successful response." 10273 }, 10274 "default": { 10275 "description": "Generic error response.", 10276 "schema": { 10277 "$ref": "#/definitions/ApiError" 10278 } 10279 } 10280 } 10281 } 10282 }, 10283 "/buckets/{bucket_name}/encryption/disable": { 10284 "post": { 10285 "tags": [ 10286 "Bucket" 10287 ], 10288 "summary": "Disable bucket encryption.", 10289 "operationId": "DisableBucketEncryption", 10290 "parameters": [ 10291 { 10292 "type": "string", 10293 "name": "bucket_name", 10294 "in": "path", 10295 "required": true 10296 } 10297 ], 10298 "responses": { 10299 "200": { 10300 "description": "A successful response." 10301 }, 10302 "default": { 10303 "description": "Generic error response.", 10304 "schema": { 10305 "$ref": "#/definitions/ApiError" 10306 } 10307 } 10308 } 10309 } 10310 }, 10311 "/buckets/{bucket_name}/encryption/enable": { 10312 "post": { 10313 "tags": [ 10314 "Bucket" 10315 ], 10316 "summary": "Enable bucket encryption.", 10317 "operationId": "EnableBucketEncryption", 10318 "parameters": [ 10319 { 10320 "type": "string", 10321 "name": "bucket_name", 10322 "in": "path", 10323 "required": true 10324 }, 10325 { 10326 "name": "body", 10327 "in": "body", 10328 "required": true, 10329 "schema": { 10330 "$ref": "#/definitions/bucketEncryptionRequest" 10331 } 10332 } 10333 ], 10334 "responses": { 10335 "200": { 10336 "description": "A successful response." 10337 }, 10338 "default": { 10339 "description": "Generic error response.", 10340 "schema": { 10341 "$ref": "#/definitions/ApiError" 10342 } 10343 } 10344 } 10345 } 10346 }, 10347 "/buckets/{bucket_name}/encryption/info": { 10348 "get": { 10349 "tags": [ 10350 "Bucket" 10351 ], 10352 "summary": "Get bucket encryption information.", 10353 "operationId": "GetBucketEncryptionInfo", 10354 "parameters": [ 10355 { 10356 "type": "string", 10357 "name": "bucket_name", 10358 "in": "path", 10359 "required": true 10360 } 10361 ], 10362 "responses": { 10363 "200": { 10364 "description": "A successful response.", 10365 "schema": { 10366 "$ref": "#/definitions/bucketEncryptionInfo" 10367 } 10368 }, 10369 "default": { 10370 "description": "Generic error response.", 10371 "schema": { 10372 "$ref": "#/definitions/ApiError" 10373 } 10374 } 10375 } 10376 } 10377 }, 10378 "/buckets/{bucket_name}/events": { 10379 "get": { 10380 "tags": [ 10381 "Bucket" 10382 ], 10383 "summary": "List Bucket Events", 10384 "operationId": "ListBucketEvents", 10385 "parameters": [ 10386 { 10387 "type": "string", 10388 "name": "bucket_name", 10389 "in": "path", 10390 "required": true 10391 }, 10392 { 10393 "type": "number", 10394 "format": "int32", 10395 "default": 0, 10396 "name": "offset", 10397 "in": "query" 10398 }, 10399 { 10400 "type": "number", 10401 "format": "int32", 10402 "default": 20, 10403 "name": "limit", 10404 "in": "query" 10405 } 10406 ], 10407 "responses": { 10408 "200": { 10409 "description": "A successful response.", 10410 "schema": { 10411 "$ref": "#/definitions/listBucketEventsResponse" 10412 } 10413 }, 10414 "default": { 10415 "description": "Generic error response.", 10416 "schema": { 10417 "$ref": "#/definitions/ApiError" 10418 } 10419 } 10420 } 10421 }, 10422 "post": { 10423 "tags": [ 10424 "Bucket" 10425 ], 10426 "summary": "Create Bucket Event", 10427 "operationId": "CreateBucketEvent", 10428 "parameters": [ 10429 { 10430 "type": "string", 10431 "name": "bucket_name", 10432 "in": "path", 10433 "required": true 10434 }, 10435 { 10436 "name": "body", 10437 "in": "body", 10438 "required": true, 10439 "schema": { 10440 "$ref": "#/definitions/bucketEventRequest" 10441 } 10442 } 10443 ], 10444 "responses": { 10445 "201": { 10446 "description": "A successful response." 10447 }, 10448 "default": { 10449 "description": "Generic error response.", 10450 "schema": { 10451 "$ref": "#/definitions/ApiError" 10452 } 10453 } 10454 } 10455 } 10456 }, 10457 "/buckets/{bucket_name}/events/{arn}": { 10458 "delete": { 10459 "tags": [ 10460 "Bucket" 10461 ], 10462 "summary": "Delete Bucket Event", 10463 "operationId": "DeleteBucketEvent", 10464 "parameters": [ 10465 { 10466 "type": "string", 10467 "name": "bucket_name", 10468 "in": "path", 10469 "required": true 10470 }, 10471 { 10472 "type": "string", 10473 "name": "arn", 10474 "in": "path", 10475 "required": true 10476 }, 10477 { 10478 "name": "body", 10479 "in": "body", 10480 "required": true, 10481 "schema": { 10482 "$ref": "#/definitions/notificationDeleteRequest" 10483 } 10484 } 10485 ], 10486 "responses": { 10487 "204": { 10488 "description": "A successful response." 10489 }, 10490 "default": { 10491 "description": "Generic error response.", 10492 "schema": { 10493 "$ref": "#/definitions/ApiError" 10494 } 10495 } 10496 } 10497 } 10498 }, 10499 "/buckets/{bucket_name}/lifecycle": { 10500 "get": { 10501 "tags": [ 10502 "Bucket" 10503 ], 10504 "summary": "Bucket Lifecycle", 10505 "operationId": "GetBucketLifecycle", 10506 "parameters": [ 10507 { 10508 "type": "string", 10509 "name": "bucket_name", 10510 "in": "path", 10511 "required": true 10512 } 10513 ], 10514 "responses": { 10515 "200": { 10516 "description": "A successful response.", 10517 "schema": { 10518 "$ref": "#/definitions/bucketLifecycleResponse" 10519 } 10520 }, 10521 "default": { 10522 "description": "Generic error response.", 10523 "schema": { 10524 "$ref": "#/definitions/ApiError" 10525 } 10526 } 10527 } 10528 }, 10529 "post": { 10530 "tags": [ 10531 "Bucket" 10532 ], 10533 "summary": "Add Bucket Lifecycle", 10534 "operationId": "AddBucketLifecycle", 10535 "parameters": [ 10536 { 10537 "type": "string", 10538 "name": "bucket_name", 10539 "in": "path", 10540 "required": true 10541 }, 10542 { 10543 "name": "body", 10544 "in": "body", 10545 "required": true, 10546 "schema": { 10547 "$ref": "#/definitions/addBucketLifecycle" 10548 } 10549 } 10550 ], 10551 "responses": { 10552 "201": { 10553 "description": "A successful response." 10554 }, 10555 "default": { 10556 "description": "Generic error response.", 10557 "schema": { 10558 "$ref": "#/definitions/ApiError" 10559 } 10560 } 10561 } 10562 } 10563 }, 10564 "/buckets/{bucket_name}/lifecycle/{lifecycle_id}": { 10565 "put": { 10566 "tags": [ 10567 "Bucket" 10568 ], 10569 "summary": "Update Lifecycle rule", 10570 "operationId": "UpdateBucketLifecycle", 10571 "parameters": [ 10572 { 10573 "type": "string", 10574 "name": "bucket_name", 10575 "in": "path", 10576 "required": true 10577 }, 10578 { 10579 "type": "string", 10580 "name": "lifecycle_id", 10581 "in": "path", 10582 "required": true 10583 }, 10584 { 10585 "name": "body", 10586 "in": "body", 10587 "required": true, 10588 "schema": { 10589 "$ref": "#/definitions/updateBucketLifecycle" 10590 } 10591 } 10592 ], 10593 "responses": { 10594 "200": { 10595 "description": "A successful response." 10596 }, 10597 "default": { 10598 "description": "Generic error response.", 10599 "schema": { 10600 "$ref": "#/definitions/ApiError" 10601 } 10602 } 10603 } 10604 }, 10605 "delete": { 10606 "tags": [ 10607 "Bucket" 10608 ], 10609 "summary": "Delete Lifecycle rule", 10610 "operationId": "DeleteBucketLifecycleRule", 10611 "parameters": [ 10612 { 10613 "type": "string", 10614 "name": "bucket_name", 10615 "in": "path", 10616 "required": true 10617 }, 10618 { 10619 "type": "string", 10620 "name": "lifecycle_id", 10621 "in": "path", 10622 "required": true 10623 } 10624 ], 10625 "responses": { 10626 "204": { 10627 "description": "A successful response." 10628 }, 10629 "default": { 10630 "description": "Generic error response.", 10631 "schema": { 10632 "$ref": "#/definitions/ApiError" 10633 } 10634 } 10635 } 10636 } 10637 }, 10638 "/buckets/{bucket_name}/object-locking": { 10639 "get": { 10640 "tags": [ 10641 "Bucket" 10642 ], 10643 "summary": "Returns the status of object locking support on the bucket", 10644 "operationId": "GetBucketObjectLockingStatus", 10645 "parameters": [ 10646 { 10647 "type": "string", 10648 "name": "bucket_name", 10649 "in": "path", 10650 "required": true 10651 } 10652 ], 10653 "responses": { 10654 "200": { 10655 "description": "A successful response.", 10656 "schema": { 10657 "$ref": "#/definitions/bucketObLockingResponse" 10658 } 10659 }, 10660 "default": { 10661 "description": "Generic error response.", 10662 "schema": { 10663 "$ref": "#/definitions/ApiError" 10664 } 10665 } 10666 } 10667 } 10668 }, 10669 "/buckets/{bucket_name}/objects": { 10670 "get": { 10671 "security": [ 10672 { 10673 "key": [] 10674 }, 10675 { 10676 "anonymous": [] 10677 } 10678 ], 10679 "tags": [ 10680 "Object" 10681 ], 10682 "summary": "List Objects", 10683 "operationId": "ListObjects", 10684 "parameters": [ 10685 { 10686 "type": "string", 10687 "name": "bucket_name", 10688 "in": "path", 10689 "required": true 10690 }, 10691 { 10692 "type": "string", 10693 "name": "prefix", 10694 "in": "query" 10695 }, 10696 { 10697 "type": "boolean", 10698 "name": "recursive", 10699 "in": "query" 10700 }, 10701 { 10702 "type": "boolean", 10703 "name": "with_versions", 10704 "in": "query" 10705 }, 10706 { 10707 "type": "boolean", 10708 "name": "with_metadata", 10709 "in": "query" 10710 }, 10711 { 10712 "type": "number", 10713 "format": "int32", 10714 "default": 20, 10715 "name": "limit", 10716 "in": "query" 10717 } 10718 ], 10719 "responses": { 10720 "200": { 10721 "description": "A successful response.", 10722 "schema": { 10723 "$ref": "#/definitions/listObjectsResponse" 10724 } 10725 }, 10726 "default": { 10727 "description": "Generic error response.", 10728 "schema": { 10729 "$ref": "#/definitions/ApiError" 10730 } 10731 } 10732 } 10733 }, 10734 "delete": { 10735 "tags": [ 10736 "Object" 10737 ], 10738 "summary": "Delete Object", 10739 "operationId": "DeleteObject", 10740 "parameters": [ 10741 { 10742 "type": "string", 10743 "name": "bucket_name", 10744 "in": "path", 10745 "required": true 10746 }, 10747 { 10748 "type": "string", 10749 "name": "prefix", 10750 "in": "query", 10751 "required": true 10752 }, 10753 { 10754 "type": "string", 10755 "name": "version_id", 10756 "in": "query" 10757 }, 10758 { 10759 "type": "boolean", 10760 "name": "recursive", 10761 "in": "query" 10762 }, 10763 { 10764 "type": "boolean", 10765 "name": "all_versions", 10766 "in": "query" 10767 }, 10768 { 10769 "type": "boolean", 10770 "name": "non_current_versions", 10771 "in": "query" 10772 }, 10773 { 10774 "type": "boolean", 10775 "name": "bypass", 10776 "in": "query" 10777 } 10778 ], 10779 "responses": { 10780 "200": { 10781 "description": "A successful response." 10782 }, 10783 "default": { 10784 "description": "Generic error response.", 10785 "schema": { 10786 "$ref": "#/definitions/ApiError" 10787 } 10788 } 10789 } 10790 } 10791 }, 10792 "/buckets/{bucket_name}/objects/download": { 10793 "get": { 10794 "security": [ 10795 { 10796 "key": [] 10797 }, 10798 { 10799 "anonymous": [] 10800 } 10801 ], 10802 "produces": [ 10803 "application/octet-stream" 10804 ], 10805 "tags": [ 10806 "Object" 10807 ], 10808 "summary": "Download Object", 10809 "operationId": "Download Object", 10810 "parameters": [ 10811 { 10812 "type": "string", 10813 "name": "bucket_name", 10814 "in": "path", 10815 "required": true 10816 }, 10817 { 10818 "type": "string", 10819 "name": "prefix", 10820 "in": "query", 10821 "required": true 10822 }, 10823 { 10824 "type": "string", 10825 "name": "version_id", 10826 "in": "query" 10827 }, 10828 { 10829 "type": "boolean", 10830 "default": false, 10831 "name": "preview", 10832 "in": "query" 10833 }, 10834 { 10835 "type": "string", 10836 "default": "", 10837 "name": "override_file_name", 10838 "in": "query" 10839 } 10840 ], 10841 "responses": { 10842 "200": { 10843 "description": "A successful response.", 10844 "schema": { 10845 "type": "file" 10846 } 10847 }, 10848 "default": { 10849 "description": "Generic error response.", 10850 "schema": { 10851 "$ref": "#/definitions/ApiError" 10852 } 10853 } 10854 } 10855 } 10856 }, 10857 "/buckets/{bucket_name}/objects/download-multiple": { 10858 "post": { 10859 "security": [ 10860 { 10861 "key": [] 10862 }, 10863 { 10864 "anonymous": [] 10865 } 10866 ], 10867 "produces": [ 10868 "application/octet-stream" 10869 ], 10870 "tags": [ 10871 "Object" 10872 ], 10873 "summary": "Download Multiple Objects", 10874 "operationId": "DownloadMultipleObjects", 10875 "parameters": [ 10876 { 10877 "type": "string", 10878 "name": "bucket_name", 10879 "in": "path", 10880 "required": true 10881 }, 10882 { 10883 "name": "objectList", 10884 "in": "body", 10885 "required": true, 10886 "schema": { 10887 "type": "array", 10888 "items": { 10889 "type": "string" 10890 } 10891 } 10892 } 10893 ], 10894 "responses": { 10895 "200": { 10896 "description": "A successful response.", 10897 "schema": { 10898 "type": "file" 10899 } 10900 }, 10901 "default": { 10902 "description": "Generic error response.", 10903 "schema": { 10904 "$ref": "#/definitions/ApiError" 10905 } 10906 } 10907 } 10908 } 10909 }, 10910 "/buckets/{bucket_name}/objects/legalhold": { 10911 "put": { 10912 "tags": [ 10913 "Object" 10914 ], 10915 "summary": "Put Object's legalhold status", 10916 "operationId": "PutObjectLegalHold", 10917 "parameters": [ 10918 { 10919 "type": "string", 10920 "name": "bucket_name", 10921 "in": "path", 10922 "required": true 10923 }, 10924 { 10925 "type": "string", 10926 "name": "prefix", 10927 "in": "query", 10928 "required": true 10929 }, 10930 { 10931 "type": "string", 10932 "name": "version_id", 10933 "in": "query", 10934 "required": true 10935 }, 10936 { 10937 "name": "body", 10938 "in": "body", 10939 "required": true, 10940 "schema": { 10941 "$ref": "#/definitions/putObjectLegalHoldRequest" 10942 } 10943 } 10944 ], 10945 "responses": { 10946 "200": { 10947 "description": "A successful response." 10948 }, 10949 "default": { 10950 "description": "Generic error response.", 10951 "schema": { 10952 "$ref": "#/definitions/ApiError" 10953 } 10954 } 10955 } 10956 } 10957 }, 10958 "/buckets/{bucket_name}/objects/metadata": { 10959 "get": { 10960 "tags": [ 10961 "Object" 10962 ], 10963 "summary": "Gets the metadata of an object", 10964 "operationId": "GetObjectMetadata", 10965 "parameters": [ 10966 { 10967 "type": "string", 10968 "name": "bucket_name", 10969 "in": "path", 10970 "required": true 10971 }, 10972 { 10973 "type": "string", 10974 "name": "prefix", 10975 "in": "query", 10976 "required": true 10977 } 10978 ], 10979 "responses": { 10980 "200": { 10981 "description": "A successful response.", 10982 "schema": { 10983 "$ref": "#/definitions/metadata" 10984 } 10985 }, 10986 "default": { 10987 "description": "Generic error response.", 10988 "schema": { 10989 "$ref": "#/definitions/ApiError" 10990 } 10991 } 10992 } 10993 } 10994 }, 10995 "/buckets/{bucket_name}/objects/restore": { 10996 "put": { 10997 "tags": [ 10998 "Object" 10999 ], 11000 "summary": "Restore Object to a selected version", 11001 "operationId": "PutObjectRestore", 11002 "parameters": [ 11003 { 11004 "type": "string", 11005 "name": "bucket_name", 11006 "in": "path", 11007 "required": true 11008 }, 11009 { 11010 "type": "string", 11011 "name": "prefix", 11012 "in": "query", 11013 "required": true 11014 }, 11015 { 11016 "type": "string", 11017 "name": "version_id", 11018 "in": "query", 11019 "required": true 11020 } 11021 ], 11022 "responses": { 11023 "200": { 11024 "description": "A successful response." 11025 }, 11026 "default": { 11027 "description": "Generic error response.", 11028 "schema": { 11029 "$ref": "#/definitions/ApiError" 11030 } 11031 } 11032 } 11033 } 11034 }, 11035 "/buckets/{bucket_name}/objects/retention": { 11036 "put": { 11037 "tags": [ 11038 "Object" 11039 ], 11040 "summary": "Put Object's retention status", 11041 "operationId": "PutObjectRetention", 11042 "parameters": [ 11043 { 11044 "type": "string", 11045 "name": "bucket_name", 11046 "in": "path", 11047 "required": true 11048 }, 11049 { 11050 "type": "string", 11051 "name": "prefix", 11052 "in": "query", 11053 "required": true 11054 }, 11055 { 11056 "type": "string", 11057 "name": "version_id", 11058 "in": "query", 11059 "required": true 11060 }, 11061 { 11062 "name": "body", 11063 "in": "body", 11064 "required": true, 11065 "schema": { 11066 "$ref": "#/definitions/putObjectRetentionRequest" 11067 } 11068 } 11069 ], 11070 "responses": { 11071 "200": { 11072 "description": "A successful response." 11073 }, 11074 "default": { 11075 "description": "Generic error response.", 11076 "schema": { 11077 "$ref": "#/definitions/ApiError" 11078 } 11079 } 11080 } 11081 }, 11082 "delete": { 11083 "tags": [ 11084 "Object" 11085 ], 11086 "summary": "Delete Object retention from an object", 11087 "operationId": "DeleteObjectRetention", 11088 "parameters": [ 11089 { 11090 "type": "string", 11091 "name": "bucket_name", 11092 "in": "path", 11093 "required": true 11094 }, 11095 { 11096 "type": "string", 11097 "name": "prefix", 11098 "in": "query", 11099 "required": true 11100 }, 11101 { 11102 "type": "string", 11103 "name": "version_id", 11104 "in": "query", 11105 "required": true 11106 } 11107 ], 11108 "responses": { 11109 "200": { 11110 "description": "A successful response." 11111 }, 11112 "default": { 11113 "description": "Generic error response.", 11114 "schema": { 11115 "$ref": "#/definitions/ApiError" 11116 } 11117 } 11118 } 11119 } 11120 }, 11121 "/buckets/{bucket_name}/objects/share": { 11122 "get": { 11123 "tags": [ 11124 "Object" 11125 ], 11126 "summary": "Shares an Object on a url", 11127 "operationId": "ShareObject", 11128 "parameters": [ 11129 { 11130 "type": "string", 11131 "name": "bucket_name", 11132 "in": "path", 11133 "required": true 11134 }, 11135 { 11136 "type": "string", 11137 "name": "prefix", 11138 "in": "query", 11139 "required": true 11140 }, 11141 { 11142 "type": "string", 11143 "name": "version_id", 11144 "in": "query", 11145 "required": true 11146 }, 11147 { 11148 "type": "string", 11149 "name": "expires", 11150 "in": "query" 11151 } 11152 ], 11153 "responses": { 11154 "200": { 11155 "description": "A successful response.", 11156 "schema": { 11157 "type": "string" 11158 } 11159 }, 11160 "default": { 11161 "description": "Generic error response.", 11162 "schema": { 11163 "$ref": "#/definitions/ApiError" 11164 } 11165 } 11166 } 11167 } 11168 }, 11169 "/buckets/{bucket_name}/objects/tags": { 11170 "put": { 11171 "tags": [ 11172 "Object" 11173 ], 11174 "summary": "Put Object's tags", 11175 "operationId": "PutObjectTags", 11176 "parameters": [ 11177 { 11178 "type": "string", 11179 "name": "bucket_name", 11180 "in": "path", 11181 "required": true 11182 }, 11183 { 11184 "type": "string", 11185 "name": "prefix", 11186 "in": "query", 11187 "required": true 11188 }, 11189 { 11190 "type": "string", 11191 "name": "version_id", 11192 "in": "query", 11193 "required": true 11194 }, 11195 { 11196 "name": "body", 11197 "in": "body", 11198 "required": true, 11199 "schema": { 11200 "$ref": "#/definitions/putObjectTagsRequest" 11201 } 11202 } 11203 ], 11204 "responses": { 11205 "200": { 11206 "description": "A successful response." 11207 }, 11208 "default": { 11209 "description": "Generic error response.", 11210 "schema": { 11211 "$ref": "#/definitions/ApiError" 11212 } 11213 } 11214 } 11215 } 11216 }, 11217 "/buckets/{bucket_name}/objects/upload": { 11218 "post": { 11219 "security": [ 11220 { 11221 "key": [] 11222 }, 11223 { 11224 "anonymous": [] 11225 } 11226 ], 11227 "consumes": [ 11228 "multipart/form-data" 11229 ], 11230 "tags": [ 11231 "Object" 11232 ], 11233 "summary": "Uploads an Object.", 11234 "parameters": [ 11235 { 11236 "type": "string", 11237 "name": "bucket_name", 11238 "in": "path", 11239 "required": true 11240 }, 11241 { 11242 "type": "string", 11243 "name": "prefix", 11244 "in": "query" 11245 } 11246 ], 11247 "responses": { 11248 "200": { 11249 "description": "A successful response." 11250 }, 11251 "default": { 11252 "description": "Generic error response.", 11253 "schema": { 11254 "$ref": "#/definitions/ApiError" 11255 } 11256 } 11257 } 11258 } 11259 }, 11260 "/buckets/{bucket_name}/replication": { 11261 "get": { 11262 "tags": [ 11263 "Bucket" 11264 ], 11265 "summary": "Bucket Replication", 11266 "operationId": "GetBucketReplication", 11267 "parameters": [ 11268 { 11269 "type": "string", 11270 "name": "bucket_name", 11271 "in": "path", 11272 "required": true 11273 } 11274 ], 11275 "responses": { 11276 "200": { 11277 "description": "A successful response.", 11278 "schema": { 11279 "$ref": "#/definitions/bucketReplicationResponse" 11280 } 11281 }, 11282 "default": { 11283 "description": "Generic error response.", 11284 "schema": { 11285 "$ref": "#/definitions/ApiError" 11286 } 11287 } 11288 } 11289 } 11290 }, 11291 "/buckets/{bucket_name}/replication/{rule_id}": { 11292 "get": { 11293 "tags": [ 11294 "Bucket" 11295 ], 11296 "summary": "Bucket Replication", 11297 "operationId": "GetBucketReplicationRule", 11298 "parameters": [ 11299 { 11300 "type": "string", 11301 "name": "bucket_name", 11302 "in": "path", 11303 "required": true 11304 }, 11305 { 11306 "type": "string", 11307 "name": "rule_id", 11308 "in": "path", 11309 "required": true 11310 } 11311 ], 11312 "responses": { 11313 "200": { 11314 "description": "A successful response.", 11315 "schema": { 11316 "$ref": "#/definitions/bucketReplicationRule" 11317 } 11318 }, 11319 "default": { 11320 "description": "Generic error response.", 11321 "schema": { 11322 "$ref": "#/definitions/ApiError" 11323 } 11324 } 11325 } 11326 }, 11327 "put": { 11328 "tags": [ 11329 "Bucket" 11330 ], 11331 "summary": "Update Replication rule", 11332 "operationId": "UpdateMultiBucketReplication", 11333 "parameters": [ 11334 { 11335 "type": "string", 11336 "name": "bucket_name", 11337 "in": "path", 11338 "required": true 11339 }, 11340 { 11341 "type": "string", 11342 "name": "rule_id", 11343 "in": "path", 11344 "required": true 11345 }, 11346 { 11347 "name": "body", 11348 "in": "body", 11349 "required": true, 11350 "schema": { 11351 "$ref": "#/definitions/multiBucketReplicationEdit" 11352 } 11353 } 11354 ], 11355 "responses": { 11356 "201": { 11357 "description": "A successful response." 11358 }, 11359 "default": { 11360 "description": "Generic error response.", 11361 "schema": { 11362 "$ref": "#/definitions/ApiError" 11363 } 11364 } 11365 } 11366 }, 11367 "delete": { 11368 "tags": [ 11369 "Bucket" 11370 ], 11371 "summary": "Bucket Replication Rule Delete", 11372 "operationId": "DeleteBucketReplicationRule", 11373 "parameters": [ 11374 { 11375 "type": "string", 11376 "name": "bucket_name", 11377 "in": "path", 11378 "required": true 11379 }, 11380 { 11381 "type": "string", 11382 "name": "rule_id", 11383 "in": "path", 11384 "required": true 11385 } 11386 ], 11387 "responses": { 11388 "204": { 11389 "description": "A successful response." 11390 }, 11391 "default": { 11392 "description": "Generic error response.", 11393 "schema": { 11394 "$ref": "#/definitions/ApiError" 11395 } 11396 } 11397 } 11398 } 11399 }, 11400 "/buckets/{bucket_name}/retention": { 11401 "get": { 11402 "tags": [ 11403 "Bucket" 11404 ], 11405 "summary": "Get Bucket's retention config", 11406 "operationId": "GetBucketRetentionConfig", 11407 "parameters": [ 11408 { 11409 "type": "string", 11410 "name": "bucket_name", 11411 "in": "path", 11412 "required": true 11413 } 11414 ], 11415 "responses": { 11416 "200": { 11417 "description": "A successful response.", 11418 "schema": { 11419 "$ref": "#/definitions/getBucketRetentionConfig" 11420 } 11421 }, 11422 "default": { 11423 "description": "Generic error response.", 11424 "schema": { 11425 "$ref": "#/definitions/ApiError" 11426 } 11427 } 11428 } 11429 }, 11430 "put": { 11431 "tags": [ 11432 "Bucket" 11433 ], 11434 "summary": "Set Bucket's retention config", 11435 "operationId": "SetBucketRetentionConfig", 11436 "parameters": [ 11437 { 11438 "type": "string", 11439 "name": "bucket_name", 11440 "in": "path", 11441 "required": true 11442 }, 11443 { 11444 "name": "body", 11445 "in": "body", 11446 "required": true, 11447 "schema": { 11448 "$ref": "#/definitions/putBucketRetentionRequest" 11449 } 11450 } 11451 ], 11452 "responses": { 11453 "200": { 11454 "description": "A successful response." 11455 }, 11456 "default": { 11457 "description": "Generic error response.", 11458 "schema": { 11459 "$ref": "#/definitions/ApiError" 11460 } 11461 } 11462 } 11463 } 11464 }, 11465 "/buckets/{bucket_name}/rewind/{date}": { 11466 "get": { 11467 "tags": [ 11468 "Bucket" 11469 ], 11470 "summary": "Get objects in a bucket for a rewind date", 11471 "operationId": "GetBucketRewind", 11472 "parameters": [ 11473 { 11474 "type": "string", 11475 "name": "bucket_name", 11476 "in": "path", 11477 "required": true 11478 }, 11479 { 11480 "type": "string", 11481 "name": "date", 11482 "in": "path", 11483 "required": true 11484 }, 11485 { 11486 "type": "string", 11487 "name": "prefix", 11488 "in": "query" 11489 } 11490 ], 11491 "responses": { 11492 "200": { 11493 "description": "A successful response.", 11494 "schema": { 11495 "$ref": "#/definitions/rewindResponse" 11496 } 11497 }, 11498 "default": { 11499 "description": "Generic error response.", 11500 "schema": { 11501 "$ref": "#/definitions/ApiError" 11502 } 11503 } 11504 } 11505 } 11506 }, 11507 "/buckets/{bucket_name}/tags": { 11508 "put": { 11509 "tags": [ 11510 "Bucket" 11511 ], 11512 "summary": "Put Bucket's tags", 11513 "operationId": "PutBucketTags", 11514 "parameters": [ 11515 { 11516 "type": "string", 11517 "name": "bucket_name", 11518 "in": "path", 11519 "required": true 11520 }, 11521 { 11522 "name": "body", 11523 "in": "body", 11524 "required": true, 11525 "schema": { 11526 "$ref": "#/definitions/putBucketTagsRequest" 11527 } 11528 } 11529 ], 11530 "responses": { 11531 "200": { 11532 "description": "A successful response." 11533 }, 11534 "default": { 11535 "description": "Generic error response.", 11536 "schema": { 11537 "$ref": "#/definitions/ApiError" 11538 } 11539 } 11540 } 11541 } 11542 }, 11543 "/buckets/{bucket_name}/versioning": { 11544 "get": { 11545 "tags": [ 11546 "Bucket" 11547 ], 11548 "summary": "Bucket Versioning", 11549 "operationId": "GetBucketVersioning", 11550 "parameters": [ 11551 { 11552 "type": "string", 11553 "name": "bucket_name", 11554 "in": "path", 11555 "required": true 11556 } 11557 ], 11558 "responses": { 11559 "200": { 11560 "description": "A successful response.", 11561 "schema": { 11562 "$ref": "#/definitions/bucketVersioningResponse" 11563 } 11564 }, 11565 "default": { 11566 "description": "Generic error response.", 11567 "schema": { 11568 "$ref": "#/definitions/ApiError" 11569 } 11570 } 11571 } 11572 }, 11573 "put": { 11574 "tags": [ 11575 "Bucket" 11576 ], 11577 "summary": "Set Bucket Versioning", 11578 "operationId": "SetBucketVersioning", 11579 "parameters": [ 11580 { 11581 "type": "string", 11582 "name": "bucket_name", 11583 "in": "path", 11584 "required": true 11585 }, 11586 { 11587 "name": "body", 11588 "in": "body", 11589 "required": true, 11590 "schema": { 11591 "$ref": "#/definitions/setBucketVersioning" 11592 } 11593 } 11594 ], 11595 "responses": { 11596 "201": { 11597 "description": "A successful response." 11598 }, 11599 "default": { 11600 "description": "Generic error response.", 11601 "schema": { 11602 "$ref": "#/definitions/ApiError" 11603 } 11604 } 11605 } 11606 } 11607 }, 11608 "/buckets/{name}": { 11609 "get": { 11610 "tags": [ 11611 "Bucket" 11612 ], 11613 "summary": "Bucket Info", 11614 "operationId": "BucketInfo", 11615 "parameters": [ 11616 { 11617 "type": "string", 11618 "name": "name", 11619 "in": "path", 11620 "required": true 11621 } 11622 ], 11623 "responses": { 11624 "200": { 11625 "description": "A successful response.", 11626 "schema": { 11627 "$ref": "#/definitions/bucket" 11628 } 11629 }, 11630 "default": { 11631 "description": "Generic error response.", 11632 "schema": { 11633 "$ref": "#/definitions/ApiError" 11634 } 11635 } 11636 } 11637 }, 11638 "delete": { 11639 "tags": [ 11640 "Bucket" 11641 ], 11642 "summary": "Delete Bucket", 11643 "operationId": "DeleteBucket", 11644 "parameters": [ 11645 { 11646 "type": "string", 11647 "name": "name", 11648 "in": "path", 11649 "required": true 11650 } 11651 ], 11652 "responses": { 11653 "204": { 11654 "description": "A successful response." 11655 }, 11656 "default": { 11657 "description": "Generic error response.", 11658 "schema": { 11659 "$ref": "#/definitions/ApiError" 11660 } 11661 } 11662 } 11663 } 11664 }, 11665 "/buckets/{name}/quota": { 11666 "get": { 11667 "tags": [ 11668 "Bucket" 11669 ], 11670 "summary": "Get Bucket Quota", 11671 "operationId": "GetBucketQuota", 11672 "parameters": [ 11673 { 11674 "type": "string", 11675 "name": "name", 11676 "in": "path", 11677 "required": true 11678 } 11679 ], 11680 "responses": { 11681 "200": { 11682 "description": "A successful response.", 11683 "schema": { 11684 "$ref": "#/definitions/bucketQuota" 11685 } 11686 }, 11687 "default": { 11688 "description": "Generic error response.", 11689 "schema": { 11690 "$ref": "#/definitions/ApiError" 11691 } 11692 } 11693 } 11694 }, 11695 "put": { 11696 "tags": [ 11697 "Bucket" 11698 ], 11699 "summary": "Bucket Quota", 11700 "operationId": "SetBucketQuota", 11701 "parameters": [ 11702 { 11703 "type": "string", 11704 "name": "name", 11705 "in": "path", 11706 "required": true 11707 }, 11708 { 11709 "name": "body", 11710 "in": "body", 11711 "required": true, 11712 "schema": { 11713 "$ref": "#/definitions/setBucketQuota" 11714 } 11715 } 11716 ], 11717 "responses": { 11718 "200": { 11719 "description": "A successful response.", 11720 "schema": { 11721 "$ref": "#/definitions/bucket" 11722 } 11723 }, 11724 "default": { 11725 "description": "Generic error response.", 11726 "schema": { 11727 "$ref": "#/definitions/ApiError" 11728 } 11729 } 11730 } 11731 } 11732 }, 11733 "/buckets/{name}/set-policy": { 11734 "put": { 11735 "tags": [ 11736 "Bucket" 11737 ], 11738 "summary": "Bucket Set Policy", 11739 "operationId": "BucketSetPolicy", 11740 "parameters": [ 11741 { 11742 "type": "string", 11743 "name": "name", 11744 "in": "path", 11745 "required": true 11746 }, 11747 { 11748 "name": "body", 11749 "in": "body", 11750 "required": true, 11751 "schema": { 11752 "$ref": "#/definitions/setBucketPolicyRequest" 11753 } 11754 } 11755 ], 11756 "responses": { 11757 "200": { 11758 "description": "A successful response.", 11759 "schema": { 11760 "$ref": "#/definitions/bucket" 11761 } 11762 }, 11763 "default": { 11764 "description": "Generic error response.", 11765 "schema": { 11766 "$ref": "#/definitions/ApiError" 11767 } 11768 } 11769 } 11770 } 11771 }, 11772 "/configs": { 11773 "get": { 11774 "tags": [ 11775 "Configuration" 11776 ], 11777 "summary": "List Configurations", 11778 "operationId": "ListConfig", 11779 "parameters": [ 11780 { 11781 "type": "number", 11782 "format": "int32", 11783 "default": 0, 11784 "name": "offset", 11785 "in": "query" 11786 }, 11787 { 11788 "type": "number", 11789 "format": "int32", 11790 "default": 20, 11791 "name": "limit", 11792 "in": "query" 11793 } 11794 ], 11795 "responses": { 11796 "200": { 11797 "description": "A successful response.", 11798 "schema": { 11799 "$ref": "#/definitions/listConfigResponse" 11800 } 11801 }, 11802 "default": { 11803 "description": "Generic error response.", 11804 "schema": { 11805 "$ref": "#/definitions/ApiError" 11806 } 11807 } 11808 } 11809 } 11810 }, 11811 "/configs/export": { 11812 "get": { 11813 "tags": [ 11814 "Configuration" 11815 ], 11816 "summary": "Export the current config from MinIO server", 11817 "operationId": "ExportConfig", 11818 "responses": { 11819 "200": { 11820 "description": "A successful response.", 11821 "schema": { 11822 "$ref": "#/definitions/configExportResponse" 11823 } 11824 }, 11825 "default": { 11826 "description": "Generic error response.", 11827 "schema": { 11828 "$ref": "#/definitions/ApiError" 11829 } 11830 } 11831 } 11832 } 11833 }, 11834 "/configs/import": { 11835 "post": { 11836 "consumes": [ 11837 "multipart/form-data" 11838 ], 11839 "tags": [ 11840 "Configuration" 11841 ], 11842 "summary": "Uploads a file to import MinIO server config.", 11843 "parameters": [ 11844 { 11845 "type": "file", 11846 "name": "file", 11847 "in": "formData", 11848 "required": true 11849 } 11850 ], 11851 "responses": { 11852 "200": { 11853 "description": "A successful response." 11854 }, 11855 "default": { 11856 "description": "Generic error response.", 11857 "schema": { 11858 "$ref": "#/definitions/ApiError" 11859 } 11860 } 11861 } 11862 } 11863 }, 11864 "/configs/{name}": { 11865 "get": { 11866 "tags": [ 11867 "Configuration" 11868 ], 11869 "summary": "Configuration info", 11870 "operationId": "ConfigInfo", 11871 "parameters": [ 11872 { 11873 "type": "string", 11874 "name": "name", 11875 "in": "path", 11876 "required": true 11877 } 11878 ], 11879 "responses": { 11880 "200": { 11881 "description": "A successful response.", 11882 "schema": { 11883 "type": "array", 11884 "items": { 11885 "$ref": "#/definitions/configuration" 11886 } 11887 } 11888 }, 11889 "default": { 11890 "description": "Generic error response.", 11891 "schema": { 11892 "$ref": "#/definitions/ApiError" 11893 } 11894 } 11895 } 11896 }, 11897 "put": { 11898 "tags": [ 11899 "Configuration" 11900 ], 11901 "summary": "Set Configuration", 11902 "operationId": "SetConfig", 11903 "parameters": [ 11904 { 11905 "type": "string", 11906 "name": "name", 11907 "in": "path", 11908 "required": true 11909 }, 11910 { 11911 "name": "body", 11912 "in": "body", 11913 "required": true, 11914 "schema": { 11915 "$ref": "#/definitions/setConfigRequest" 11916 } 11917 } 11918 ], 11919 "responses": { 11920 "200": { 11921 "description": "A successful response.", 11922 "schema": { 11923 "$ref": "#/definitions/setConfigResponse" 11924 } 11925 }, 11926 "default": { 11927 "description": "Generic error response.", 11928 "schema": { 11929 "$ref": "#/definitions/ApiError" 11930 } 11931 } 11932 } 11933 } 11934 }, 11935 "/configs/{name}/reset": { 11936 "post": { 11937 "tags": [ 11938 "Configuration" 11939 ], 11940 "summary": "Configuration reset", 11941 "operationId": "ResetConfig", 11942 "parameters": [ 11943 { 11944 "type": "string", 11945 "name": "name", 11946 "in": "path", 11947 "required": true 11948 } 11949 ], 11950 "responses": { 11951 "200": { 11952 "description": "A successful response.", 11953 "schema": { 11954 "$ref": "#/definitions/setConfigResponse" 11955 } 11956 }, 11957 "default": { 11958 "description": "Generic error response.", 11959 "schema": { 11960 "$ref": "#/definitions/ApiError" 11961 } 11962 } 11963 } 11964 } 11965 }, 11966 "/download-shared-object/{url}": { 11967 "get": { 11968 "security": [], 11969 "produces": [ 11970 "application/octet-stream" 11971 ], 11972 "tags": [ 11973 "Public" 11974 ], 11975 "summary": "Downloads an object from a presigned url", 11976 "operationId": "DownloadSharedObject", 11977 "parameters": [ 11978 { 11979 "type": "string", 11980 "name": "url", 11981 "in": "path", 11982 "required": true 11983 } 11984 ], 11985 "responses": { 11986 "200": { 11987 "description": "A successful response.", 11988 "schema": { 11989 "type": "file" 11990 } 11991 }, 11992 "default": { 11993 "description": "Generic error response.", 11994 "schema": { 11995 "$ref": "#/definitions/ApiError" 11996 } 11997 } 11998 } 11999 } 12000 }, 12001 "/group/{name}": { 12002 "get": { 12003 "tags": [ 12004 "Group" 12005 ], 12006 "summary": "Group info", 12007 "operationId": "GroupInfo", 12008 "parameters": [ 12009 { 12010 "type": "string", 12011 "name": "name", 12012 "in": "path", 12013 "required": true 12014 } 12015 ], 12016 "responses": { 12017 "200": { 12018 "description": "A successful response.", 12019 "schema": { 12020 "$ref": "#/definitions/group" 12021 } 12022 }, 12023 "default": { 12024 "description": "Generic error response.", 12025 "schema": { 12026 "$ref": "#/definitions/ApiError" 12027 } 12028 } 12029 } 12030 }, 12031 "put": { 12032 "tags": [ 12033 "Group" 12034 ], 12035 "summary": "Update Group Members or Status", 12036 "operationId": "UpdateGroup", 12037 "parameters": [ 12038 { 12039 "type": "string", 12040 "name": "name", 12041 "in": "path", 12042 "required": true 12043 }, 12044 { 12045 "name": "body", 12046 "in": "body", 12047 "required": true, 12048 "schema": { 12049 "$ref": "#/definitions/updateGroupRequest" 12050 } 12051 } 12052 ], 12053 "responses": { 12054 "200": { 12055 "description": "A successful response.", 12056 "schema": { 12057 "$ref": "#/definitions/group" 12058 } 12059 }, 12060 "default": { 12061 "description": "Generic error response.", 12062 "schema": { 12063 "$ref": "#/definitions/ApiError" 12064 } 12065 } 12066 } 12067 }, 12068 "delete": { 12069 "tags": [ 12070 "Group" 12071 ], 12072 "summary": "Remove group", 12073 "operationId": "RemoveGroup", 12074 "parameters": [ 12075 { 12076 "type": "string", 12077 "name": "name", 12078 "in": "path", 12079 "required": true 12080 } 12081 ], 12082 "responses": { 12083 "204": { 12084 "description": "A successful response." 12085 }, 12086 "default": { 12087 "description": "Generic error response.", 12088 "schema": { 12089 "$ref": "#/definitions/ApiError" 12090 } 12091 } 12092 } 12093 } 12094 }, 12095 "/groups": { 12096 "get": { 12097 "tags": [ 12098 "Group" 12099 ], 12100 "summary": "List Groups", 12101 "operationId": "ListGroups", 12102 "parameters": [ 12103 { 12104 "type": "number", 12105 "format": "int32", 12106 "default": 0, 12107 "name": "offset", 12108 "in": "query" 12109 }, 12110 { 12111 "type": "number", 12112 "format": "int32", 12113 "default": 20, 12114 "name": "limit", 12115 "in": "query" 12116 } 12117 ], 12118 "responses": { 12119 "200": { 12120 "description": "A successful response.", 12121 "schema": { 12122 "$ref": "#/definitions/listGroupsResponse" 12123 } 12124 }, 12125 "default": { 12126 "description": "Generic error response.", 12127 "schema": { 12128 "$ref": "#/definitions/ApiError" 12129 } 12130 } 12131 } 12132 }, 12133 "post": { 12134 "tags": [ 12135 "Group" 12136 ], 12137 "summary": "Add Group", 12138 "operationId": "AddGroup", 12139 "parameters": [ 12140 { 12141 "name": "body", 12142 "in": "body", 12143 "required": true, 12144 "schema": { 12145 "$ref": "#/definitions/addGroupRequest" 12146 } 12147 } 12148 ], 12149 "responses": { 12150 "201": { 12151 "description": "A successful response." 12152 }, 12153 "default": { 12154 "description": "Generic error response.", 12155 "schema": { 12156 "$ref": "#/definitions/ApiError" 12157 } 12158 } 12159 } 12160 } 12161 }, 12162 "/idp/{type}": { 12163 "get": { 12164 "tags": [ 12165 "idp" 12166 ], 12167 "summary": "List IDP Configurations", 12168 "operationId": "ListConfigurations", 12169 "parameters": [ 12170 { 12171 "type": "string", 12172 "description": "IDP Configuration Type", 12173 "name": "type", 12174 "in": "path", 12175 "required": true 12176 } 12177 ], 12178 "responses": { 12179 "200": { 12180 "description": "A successful response.", 12181 "schema": { 12182 "$ref": "#/definitions/idpListConfigurationsResponse" 12183 } 12184 }, 12185 "default": { 12186 "description": "Generic error response.", 12187 "schema": { 12188 "$ref": "#/definitions/ApiError" 12189 } 12190 } 12191 } 12192 }, 12193 "post": { 12194 "consumes": [ 12195 "application/json" 12196 ], 12197 "tags": [ 12198 "idp" 12199 ], 12200 "summary": "Create IDP Configuration", 12201 "operationId": "CreateConfiguration", 12202 "parameters": [ 12203 { 12204 "type": "string", 12205 "description": "IDP Configuration Type", 12206 "name": "type", 12207 "in": "path", 12208 "required": true 12209 }, 12210 { 12211 "name": "body", 12212 "in": "body", 12213 "required": true, 12214 "schema": { 12215 "$ref": "#/definitions/idpServerConfiguration" 12216 } 12217 } 12218 ], 12219 "responses": { 12220 "201": { 12221 "description": "A successful response.", 12222 "schema": { 12223 "$ref": "#/definitions/setIDPResponse" 12224 } 12225 }, 12226 "default": { 12227 "description": "Generic error response.", 12228 "schema": { 12229 "$ref": "#/definitions/ApiError" 12230 } 12231 } 12232 } 12233 } 12234 }, 12235 "/idp/{type}/{name}": { 12236 "get": { 12237 "tags": [ 12238 "idp" 12239 ], 12240 "summary": "Get IDP Configuration", 12241 "operationId": "GetConfiguration", 12242 "parameters": [ 12243 { 12244 "type": "string", 12245 "description": "IDP Configuration Name", 12246 "name": "name", 12247 "in": "path", 12248 "required": true 12249 }, 12250 { 12251 "type": "string", 12252 "description": "IDP Configuration Type", 12253 "name": "type", 12254 "in": "path", 12255 "required": true 12256 } 12257 ], 12258 "responses": { 12259 "200": { 12260 "description": "A successful response.", 12261 "schema": { 12262 "$ref": "#/definitions/idpServerConfiguration" 12263 } 12264 }, 12265 "default": { 12266 "description": "Generic error response.", 12267 "schema": { 12268 "$ref": "#/definitions/ApiError" 12269 } 12270 } 12271 } 12272 }, 12273 "put": { 12274 "consumes": [ 12275 "application/json" 12276 ], 12277 "tags": [ 12278 "idp" 12279 ], 12280 "summary": "Update IDP Configuration", 12281 "operationId": "UpdateConfiguration", 12282 "parameters": [ 12283 { 12284 "name": "body", 12285 "in": "body", 12286 "required": true, 12287 "schema": { 12288 "$ref": "#/definitions/idpServerConfiguration" 12289 } 12290 }, 12291 { 12292 "type": "string", 12293 "description": "IDP Configuration Name", 12294 "name": "name", 12295 "in": "path", 12296 "required": true 12297 }, 12298 { 12299 "type": "string", 12300 "description": "IDP Configuration Type", 12301 "name": "type", 12302 "in": "path", 12303 "required": true 12304 } 12305 ], 12306 "responses": { 12307 "200": { 12308 "description": "A successful response.", 12309 "schema": { 12310 "$ref": "#/definitions/setIDPResponse" 12311 } 12312 }, 12313 "default": { 12314 "description": "Generic error response.", 12315 "schema": { 12316 "$ref": "#/definitions/ApiError" 12317 } 12318 } 12319 } 12320 }, 12321 "delete": { 12322 "tags": [ 12323 "idp" 12324 ], 12325 "summary": "Delete IDP Configuration", 12326 "operationId": "DeleteConfiguration", 12327 "parameters": [ 12328 { 12329 "type": "string", 12330 "description": "IDP Configuration Name", 12331 "name": "name", 12332 "in": "path", 12333 "required": true 12334 }, 12335 { 12336 "type": "string", 12337 "description": "IDP Configuration Type", 12338 "name": "type", 12339 "in": "path", 12340 "required": true 12341 } 12342 ], 12343 "responses": { 12344 "200": { 12345 "description": "A successful response.", 12346 "schema": { 12347 "$ref": "#/definitions/setIDPResponse" 12348 } 12349 }, 12350 "default": { 12351 "description": "Generic error response.", 12352 "schema": { 12353 "$ref": "#/definitions/ApiError" 12354 } 12355 } 12356 } 12357 } 12358 }, 12359 "/kms/apis": { 12360 "get": { 12361 "tags": [ 12362 "KMS" 12363 ], 12364 "summary": "KMS apis", 12365 "operationId": "KMSAPIs", 12366 "responses": { 12367 "200": { 12368 "description": "A successful response.", 12369 "schema": { 12370 "$ref": "#/definitions/kmsAPIsResponse" 12371 } 12372 }, 12373 "default": { 12374 "description": "Generic error response.", 12375 "schema": { 12376 "$ref": "#/definitions/ApiError" 12377 } 12378 } 12379 } 12380 } 12381 }, 12382 "/kms/describe-self/identity": { 12383 "get": { 12384 "tags": [ 12385 "KMS" 12386 ], 12387 "summary": "KMS describe self identity", 12388 "operationId": "KMSDescribeSelfIdentity", 12389 "responses": { 12390 "200": { 12391 "description": "A successful response.", 12392 "schema": { 12393 "$ref": "#/definitions/kmsDescribeSelfIdentityResponse" 12394 } 12395 }, 12396 "default": { 12397 "description": "Generic error response.", 12398 "schema": { 12399 "$ref": "#/definitions/ApiError" 12400 } 12401 } 12402 } 12403 } 12404 }, 12405 "/kms/identities": { 12406 "get": { 12407 "tags": [ 12408 "KMS" 12409 ], 12410 "summary": "KMS list identities", 12411 "operationId": "KMSListIdentities", 12412 "parameters": [ 12413 { 12414 "type": "string", 12415 "description": "pattern to retrieve identities", 12416 "name": "pattern", 12417 "in": "query" 12418 } 12419 ], 12420 "responses": { 12421 "200": { 12422 "description": "A successful response.", 12423 "schema": { 12424 "$ref": "#/definitions/kmsListIdentitiesResponse" 12425 } 12426 }, 12427 "default": { 12428 "description": "Generic error response.", 12429 "schema": { 12430 "$ref": "#/definitions/ApiError" 12431 } 12432 } 12433 } 12434 } 12435 }, 12436 "/kms/identities/{name}": { 12437 "delete": { 12438 "tags": [ 12439 "KMS" 12440 ], 12441 "summary": "KMS delete identity", 12442 "operationId": "KMSDeleteIdentity", 12443 "parameters": [ 12444 { 12445 "type": "string", 12446 "description": "KMS identity name", 12447 "name": "name", 12448 "in": "path", 12449 "required": true 12450 } 12451 ], 12452 "responses": { 12453 "200": { 12454 "description": "A successful response." 12455 }, 12456 "default": { 12457 "description": "Generic error response.", 12458 "schema": { 12459 "$ref": "#/definitions/ApiError" 12460 } 12461 } 12462 } 12463 } 12464 }, 12465 "/kms/identities/{name}/describe": { 12466 "get": { 12467 "tags": [ 12468 "KMS" 12469 ], 12470 "summary": "KMS describe identity", 12471 "operationId": "KMSDescribeIdentity", 12472 "parameters": [ 12473 { 12474 "type": "string", 12475 "description": "KMS identity name", 12476 "name": "name", 12477 "in": "path", 12478 "required": true 12479 } 12480 ], 12481 "responses": { 12482 "200": { 12483 "description": "A successful response.", 12484 "schema": { 12485 "$ref": "#/definitions/kmsDescribeIdentityResponse" 12486 } 12487 }, 12488 "default": { 12489 "description": "Generic error response.", 12490 "schema": { 12491 "$ref": "#/definitions/ApiError" 12492 } 12493 } 12494 } 12495 } 12496 }, 12497 "/kms/keys": { 12498 "get": { 12499 "tags": [ 12500 "KMS" 12501 ], 12502 "summary": "KMS list keys", 12503 "operationId": "KMSListKeys", 12504 "parameters": [ 12505 { 12506 "type": "string", 12507 "description": "pattern to retrieve keys", 12508 "name": "pattern", 12509 "in": "query" 12510 } 12511 ], 12512 "responses": { 12513 "200": { 12514 "description": "A successful response.", 12515 "schema": { 12516 "$ref": "#/definitions/kmsListKeysResponse" 12517 } 12518 }, 12519 "default": { 12520 "description": "Generic error response.", 12521 "schema": { 12522 "$ref": "#/definitions/ApiError" 12523 } 12524 } 12525 } 12526 }, 12527 "post": { 12528 "tags": [ 12529 "KMS" 12530 ], 12531 "summary": "KMS create key", 12532 "operationId": "KMSCreateKey", 12533 "parameters": [ 12534 { 12535 "name": "body", 12536 "in": "body", 12537 "required": true, 12538 "schema": { 12539 "$ref": "#/definitions/kmsCreateKeyRequest" 12540 } 12541 } 12542 ], 12543 "responses": { 12544 "201": { 12545 "description": "A successful response." 12546 }, 12547 "default": { 12548 "description": "Generic error response.", 12549 "schema": { 12550 "$ref": "#/definitions/ApiError" 12551 } 12552 } 12553 } 12554 } 12555 }, 12556 "/kms/keys/{name}": { 12557 "get": { 12558 "tags": [ 12559 "KMS" 12560 ], 12561 "summary": "KMS key status", 12562 "operationId": "KMSKeyStatus", 12563 "parameters": [ 12564 { 12565 "type": "string", 12566 "description": "KMS key name", 12567 "name": "name", 12568 "in": "path", 12569 "required": true 12570 } 12571 ], 12572 "responses": { 12573 "200": { 12574 "description": "A successful response.", 12575 "schema": { 12576 "$ref": "#/definitions/kmsKeyStatusResponse" 12577 } 12578 }, 12579 "default": { 12580 "description": "Generic error response.", 12581 "schema": { 12582 "$ref": "#/definitions/ApiError" 12583 } 12584 } 12585 } 12586 }, 12587 "delete": { 12588 "tags": [ 12589 "KMS" 12590 ], 12591 "summary": "KMS delete key", 12592 "operationId": "KMSDeleteKey", 12593 "parameters": [ 12594 { 12595 "type": "string", 12596 "description": "KMS key name", 12597 "name": "name", 12598 "in": "path", 12599 "required": true 12600 } 12601 ], 12602 "responses": { 12603 "200": { 12604 "description": "A successful response." 12605 }, 12606 "default": { 12607 "description": "Generic error response.", 12608 "schema": { 12609 "$ref": "#/definitions/ApiError" 12610 } 12611 } 12612 } 12613 } 12614 }, 12615 "/kms/keys/{name}/import": { 12616 "post": { 12617 "tags": [ 12618 "KMS" 12619 ], 12620 "summary": "KMS import key", 12621 "operationId": "KMSImportKey", 12622 "parameters": [ 12623 { 12624 "name": "body", 12625 "in": "body", 12626 "required": true, 12627 "schema": { 12628 "$ref": "#/definitions/kmsImportKeyRequest" 12629 } 12630 }, 12631 { 12632 "type": "string", 12633 "description": "KMS key name", 12634 "name": "name", 12635 "in": "path", 12636 "required": true 12637 } 12638 ], 12639 "responses": { 12640 "201": { 12641 "description": "A successful response." 12642 }, 12643 "default": { 12644 "description": "Generic error response.", 12645 "schema": { 12646 "$ref": "#/definitions/ApiError" 12647 } 12648 } 12649 } 12650 } 12651 }, 12652 "/kms/metrics": { 12653 "get": { 12654 "tags": [ 12655 "KMS" 12656 ], 12657 "summary": "KMS metrics", 12658 "operationId": "KMSMetrics", 12659 "responses": { 12660 "200": { 12661 "description": "A successful response.", 12662 "schema": { 12663 "$ref": "#/definitions/kmsMetricsResponse" 12664 } 12665 }, 12666 "default": { 12667 "description": "Generic error response.", 12668 "schema": { 12669 "$ref": "#/definitions/ApiError" 12670 } 12671 } 12672 } 12673 } 12674 }, 12675 "/kms/policies": { 12676 "get": { 12677 "tags": [ 12678 "KMS" 12679 ], 12680 "summary": "KMS list policies", 12681 "operationId": "KMSListPolicies", 12682 "parameters": [ 12683 { 12684 "type": "string", 12685 "description": "pattern to retrieve policies", 12686 "name": "pattern", 12687 "in": "query" 12688 } 12689 ], 12690 "responses": { 12691 "200": { 12692 "description": "A successful response.", 12693 "schema": { 12694 "$ref": "#/definitions/kmsListPoliciesResponse" 12695 } 12696 }, 12697 "default": { 12698 "description": "Generic error response.", 12699 "schema": { 12700 "$ref": "#/definitions/ApiError" 12701 } 12702 } 12703 } 12704 }, 12705 "post": { 12706 "tags": [ 12707 "KMS" 12708 ], 12709 "summary": "KMS set policy", 12710 "operationId": "KMSSetPolicy", 12711 "parameters": [ 12712 { 12713 "name": "body", 12714 "in": "body", 12715 "required": true, 12716 "schema": { 12717 "$ref": "#/definitions/kmsSetPolicyRequest" 12718 } 12719 } 12720 ], 12721 "responses": { 12722 "200": { 12723 "description": "A successful response." 12724 }, 12725 "default": { 12726 "description": "Generic error response.", 12727 "schema": { 12728 "$ref": "#/definitions/ApiError" 12729 } 12730 } 12731 } 12732 } 12733 }, 12734 "/kms/policies/{name}": { 12735 "get": { 12736 "tags": [ 12737 "KMS" 12738 ], 12739 "summary": "KMS get policy", 12740 "operationId": "KMSGetPolicy", 12741 "parameters": [ 12742 { 12743 "type": "string", 12744 "description": "KMS policy name", 12745 "name": "name", 12746 "in": "path", 12747 "required": true 12748 } 12749 ], 12750 "responses": { 12751 "200": { 12752 "description": "A successful response.", 12753 "schema": { 12754 "$ref": "#/definitions/kmsGetPolicyResponse" 12755 } 12756 }, 12757 "default": { 12758 "description": "Generic error response.", 12759 "schema": { 12760 "$ref": "#/definitions/ApiError" 12761 } 12762 } 12763 } 12764 }, 12765 "delete": { 12766 "tags": [ 12767 "KMS" 12768 ], 12769 "summary": "KMS delete policy", 12770 "operationId": "KMSDeletePolicy", 12771 "parameters": [ 12772 { 12773 "type": "string", 12774 "description": "KMS policy name", 12775 "name": "name", 12776 "in": "path", 12777 "required": true 12778 } 12779 ], 12780 "responses": { 12781 "200": { 12782 "description": "A successful response." 12783 }, 12784 "default": { 12785 "description": "Generic error response.", 12786 "schema": { 12787 "$ref": "#/definitions/ApiError" 12788 } 12789 } 12790 } 12791 } 12792 }, 12793 "/kms/policies/{name}/assign": { 12794 "post": { 12795 "tags": [ 12796 "KMS" 12797 ], 12798 "summary": "KMS assign policy", 12799 "operationId": "KMSAssignPolicy", 12800 "parameters": [ 12801 { 12802 "name": "body", 12803 "in": "body", 12804 "required": true, 12805 "schema": { 12806 "$ref": "#/definitions/kmsAssignPolicyRequest" 12807 } 12808 }, 12809 { 12810 "type": "string", 12811 "description": "KMS policy name", 12812 "name": "name", 12813 "in": "path", 12814 "required": true 12815 } 12816 ], 12817 "responses": { 12818 "200": { 12819 "description": "A successful response." 12820 }, 12821 "default": { 12822 "description": "Generic error response.", 12823 "schema": { 12824 "$ref": "#/definitions/ApiError" 12825 } 12826 } 12827 } 12828 } 12829 }, 12830 "/kms/policies/{name}/describe": { 12831 "get": { 12832 "tags": [ 12833 "KMS" 12834 ], 12835 "summary": "KMS describe policy", 12836 "operationId": "KMSDescribePolicy", 12837 "parameters": [ 12838 { 12839 "type": "string", 12840 "description": "KMS policy name", 12841 "name": "name", 12842 "in": "path", 12843 "required": true 12844 } 12845 ], 12846 "responses": { 12847 "200": { 12848 "description": "A successful response.", 12849 "schema": { 12850 "$ref": "#/definitions/kmsDescribePolicyResponse" 12851 } 12852 }, 12853 "default": { 12854 "description": "Generic error response.", 12855 "schema": { 12856 "$ref": "#/definitions/ApiError" 12857 } 12858 } 12859 } 12860 } 12861 }, 12862 "/kms/status": { 12863 "get": { 12864 "tags": [ 12865 "KMS" 12866 ], 12867 "summary": "KMS status", 12868 "operationId": "KMSStatus", 12869 "responses": { 12870 "200": { 12871 "description": "A successful response.", 12872 "schema": { 12873 "$ref": "#/definitions/kmsStatusResponse" 12874 } 12875 }, 12876 "default": { 12877 "description": "Generic error response.", 12878 "schema": { 12879 "$ref": "#/definitions/ApiError" 12880 } 12881 } 12882 } 12883 } 12884 }, 12885 "/kms/version": { 12886 "get": { 12887 "tags": [ 12888 "KMS" 12889 ], 12890 "summary": "KMS version", 12891 "operationId": "KMSVersion", 12892 "responses": { 12893 "200": { 12894 "description": "A successful response.", 12895 "schema": { 12896 "$ref": "#/definitions/kmsVersionResponse" 12897 } 12898 }, 12899 "default": { 12900 "description": "Generic error response.", 12901 "schema": { 12902 "$ref": "#/definitions/ApiError" 12903 } 12904 } 12905 } 12906 } 12907 }, 12908 "/ldap-entities": { 12909 "post": { 12910 "tags": [ 12911 "idp" 12912 ], 12913 "summary": "Get LDAP Entities", 12914 "operationId": "GetLDAPEntities", 12915 "parameters": [ 12916 { 12917 "name": "body", 12918 "in": "body", 12919 "required": true, 12920 "schema": { 12921 "$ref": "#/definitions/ldapEntitiesRequest" 12922 } 12923 } 12924 ], 12925 "responses": { 12926 "200": { 12927 "description": "A successful response.", 12928 "schema": { 12929 "$ref": "#/definitions/ldapEntities" 12930 } 12931 }, 12932 "default": { 12933 "description": "Generic error response.", 12934 "schema": { 12935 "$ref": "#/definitions/ApiError" 12936 } 12937 } 12938 } 12939 } 12940 }, 12941 "/list-external-buckets": { 12942 "post": { 12943 "tags": [ 12944 "Bucket" 12945 ], 12946 "summary": "Lists an External list of buckets using custom credentials", 12947 "operationId": "ListExternalBuckets", 12948 "parameters": [ 12949 { 12950 "name": "body", 12951 "in": "body", 12952 "required": true, 12953 "schema": { 12954 "$ref": "#/definitions/listExternalBucketsParams" 12955 } 12956 } 12957 ], 12958 "responses": { 12959 "200": { 12960 "description": "A successful response.", 12961 "schema": { 12962 "$ref": "#/definitions/listBucketsResponse" 12963 } 12964 }, 12965 "default": { 12966 "description": "Generic error response.", 12967 "schema": { 12968 "$ref": "#/definitions/ApiError" 12969 } 12970 } 12971 } 12972 } 12973 }, 12974 "/login": { 12975 "get": { 12976 "security": [], 12977 "tags": [ 12978 "Auth" 12979 ], 12980 "summary": "Returns login strategy, form or sso.", 12981 "operationId": "LoginDetail", 12982 "responses": { 12983 "200": { 12984 "description": "A successful response.", 12985 "schema": { 12986 "$ref": "#/definitions/loginDetails" 12987 } 12988 }, 12989 "default": { 12990 "description": "Generic error response.", 12991 "schema": { 12992 "$ref": "#/definitions/ApiError" 12993 } 12994 } 12995 } 12996 }, 12997 "post": { 12998 "security": [], 12999 "tags": [ 13000 "Auth" 13001 ], 13002 "summary": "Login to Console", 13003 "operationId": "Login", 13004 "parameters": [ 13005 { 13006 "name": "body", 13007 "in": "body", 13008 "required": true, 13009 "schema": { 13010 "$ref": "#/definitions/loginRequest" 13011 } 13012 } 13013 ], 13014 "responses": { 13015 "204": { 13016 "description": "A successful login." 13017 }, 13018 "default": { 13019 "description": "Generic error response.", 13020 "schema": { 13021 "$ref": "#/definitions/ApiError" 13022 } 13023 } 13024 } 13025 } 13026 }, 13027 "/login/oauth2/auth": { 13028 "post": { 13029 "security": [], 13030 "tags": [ 13031 "Auth" 13032 ], 13033 "summary": "Identity Provider oauth2 callback endpoint.", 13034 "operationId": "LoginOauth2Auth", 13035 "parameters": [ 13036 { 13037 "name": "body", 13038 "in": "body", 13039 "required": true, 13040 "schema": { 13041 "$ref": "#/definitions/loginOauth2AuthRequest" 13042 } 13043 } 13044 ], 13045 "responses": { 13046 "204": { 13047 "description": "A successful login." 13048 }, 13049 "default": { 13050 "description": "Generic error response.", 13051 "schema": { 13052 "$ref": "#/definitions/ApiError" 13053 } 13054 } 13055 } 13056 } 13057 }, 13058 "/logout": { 13059 "post": { 13060 "tags": [ 13061 "Auth" 13062 ], 13063 "summary": "Logout from Console.", 13064 "operationId": "Logout", 13065 "parameters": [ 13066 { 13067 "name": "body", 13068 "in": "body", 13069 "required": true, 13070 "schema": { 13071 "$ref": "#/definitions/logoutRequest" 13072 } 13073 } 13074 ], 13075 "responses": { 13076 "200": { 13077 "description": "A successful response." 13078 }, 13079 "default": { 13080 "description": "Generic error response.", 13081 "schema": { 13082 "$ref": "#/definitions/ApiError" 13083 } 13084 } 13085 } 13086 } 13087 }, 13088 "/logs/search": { 13089 "get": { 13090 "tags": [ 13091 "Logging" 13092 ], 13093 "summary": "Search the logs", 13094 "operationId": "LogSearch", 13095 "parameters": [ 13096 { 13097 "type": "array", 13098 "items": { 13099 "type": "string" 13100 }, 13101 "collectionFormat": "multi", 13102 "description": "Filter Parameters", 13103 "name": "fp", 13104 "in": "query" 13105 }, 13106 { 13107 "type": "number", 13108 "format": "int32", 13109 "default": 10, 13110 "name": "pageSize", 13111 "in": "query" 13112 }, 13113 { 13114 "type": "number", 13115 "format": "int32", 13116 "default": 0, 13117 "name": "pageNo", 13118 "in": "query" 13119 }, 13120 { 13121 "enum": [ 13122 "timeDesc", 13123 "timeAsc" 13124 ], 13125 "type": "string", 13126 "default": "timeDesc", 13127 "name": "order", 13128 "in": "query" 13129 }, 13130 { 13131 "type": "string", 13132 "name": "timeStart", 13133 "in": "query" 13134 }, 13135 { 13136 "type": "string", 13137 "name": "timeEnd", 13138 "in": "query" 13139 } 13140 ], 13141 "responses": { 13142 "200": { 13143 "description": "A successful response.", 13144 "schema": { 13145 "$ref": "#/definitions/logSearchResponse" 13146 } 13147 }, 13148 "default": { 13149 "description": "Generic error response.", 13150 "schema": { 13151 "$ref": "#/definitions/ApiError" 13152 } 13153 } 13154 } 13155 } 13156 }, 13157 "/nodes": { 13158 "get": { 13159 "tags": [ 13160 "System" 13161 ], 13162 "summary": "Lists Nodes", 13163 "operationId": "ListNodes", 13164 "responses": { 13165 "200": { 13166 "description": "A successful response.", 13167 "schema": { 13168 "type": "array", 13169 "items": { 13170 "type": "string" 13171 } 13172 } 13173 }, 13174 "default": { 13175 "description": "Generic error response.", 13176 "schema": { 13177 "$ref": "#/definitions/ApiError" 13178 } 13179 } 13180 } 13181 } 13182 }, 13183 "/policies": { 13184 "get": { 13185 "tags": [ 13186 "Policy" 13187 ], 13188 "summary": "List Policies", 13189 "operationId": "ListPolicies", 13190 "parameters": [ 13191 { 13192 "type": "number", 13193 "format": "int32", 13194 "default": 0, 13195 "name": "offset", 13196 "in": "query" 13197 }, 13198 { 13199 "type": "number", 13200 "format": "int32", 13201 "default": 20, 13202 "name": "limit", 13203 "in": "query" 13204 } 13205 ], 13206 "responses": { 13207 "200": { 13208 "description": "A successful response.", 13209 "schema": { 13210 "$ref": "#/definitions/listPoliciesResponse" 13211 } 13212 }, 13213 "default": { 13214 "description": "Generic error response.", 13215 "schema": { 13216 "$ref": "#/definitions/ApiError" 13217 } 13218 } 13219 } 13220 }, 13221 "post": { 13222 "tags": [ 13223 "Policy" 13224 ], 13225 "summary": "Add Policy", 13226 "operationId": "AddPolicy", 13227 "parameters": [ 13228 { 13229 "name": "body", 13230 "in": "body", 13231 "required": true, 13232 "schema": { 13233 "$ref": "#/definitions/addPolicyRequest" 13234 } 13235 } 13236 ], 13237 "responses": { 13238 "201": { 13239 "description": "A successful response.", 13240 "schema": { 13241 "$ref": "#/definitions/policy" 13242 } 13243 }, 13244 "default": { 13245 "description": "Generic error response.", 13246 "schema": { 13247 "$ref": "#/definitions/ApiError" 13248 } 13249 } 13250 } 13251 } 13252 }, 13253 "/policies/{policy}/groups": { 13254 "get": { 13255 "tags": [ 13256 "Policy" 13257 ], 13258 "summary": "List Groups for a Policy", 13259 "operationId": "ListGroupsForPolicy", 13260 "parameters": [ 13261 { 13262 "type": "string", 13263 "name": "policy", 13264 "in": "path", 13265 "required": true 13266 } 13267 ], 13268 "responses": { 13269 "200": { 13270 "description": "A successful response.", 13271 "schema": { 13272 "type": "array", 13273 "items": { 13274 "type": "string" 13275 } 13276 } 13277 }, 13278 "default": { 13279 "description": "Generic error response.", 13280 "schema": { 13281 "$ref": "#/definitions/ApiError" 13282 } 13283 } 13284 } 13285 } 13286 }, 13287 "/policies/{policy}/users": { 13288 "get": { 13289 "tags": [ 13290 "Policy" 13291 ], 13292 "summary": "List Users for a Policy", 13293 "operationId": "ListUsersForPolicy", 13294 "parameters": [ 13295 { 13296 "type": "string", 13297 "name": "policy", 13298 "in": "path", 13299 "required": true 13300 } 13301 ], 13302 "responses": { 13303 "200": { 13304 "description": "A successful response.", 13305 "schema": { 13306 "type": "array", 13307 "items": { 13308 "type": "string" 13309 } 13310 } 13311 }, 13312 "default": { 13313 "description": "Generic error response.", 13314 "schema": { 13315 "$ref": "#/definitions/ApiError" 13316 } 13317 } 13318 } 13319 } 13320 }, 13321 "/policy/{name}": { 13322 "get": { 13323 "tags": [ 13324 "Policy" 13325 ], 13326 "summary": "Policy info", 13327 "operationId": "PolicyInfo", 13328 "parameters": [ 13329 { 13330 "type": "string", 13331 "name": "name", 13332 "in": "path", 13333 "required": true 13334 } 13335 ], 13336 "responses": { 13337 "200": { 13338 "description": "A successful response.", 13339 "schema": { 13340 "$ref": "#/definitions/policy" 13341 } 13342 }, 13343 "default": { 13344 "description": "Generic error response.", 13345 "schema": { 13346 "$ref": "#/definitions/ApiError" 13347 } 13348 } 13349 } 13350 }, 13351 "delete": { 13352 "tags": [ 13353 "Policy" 13354 ], 13355 "summary": "Remove policy", 13356 "operationId": "RemovePolicy", 13357 "parameters": [ 13358 { 13359 "type": "string", 13360 "name": "name", 13361 "in": "path", 13362 "required": true 13363 } 13364 ], 13365 "responses": { 13366 "204": { 13367 "description": "A successful response." 13368 }, 13369 "default": { 13370 "description": "Generic error response.", 13371 "schema": { 13372 "$ref": "#/definitions/ApiError" 13373 } 13374 } 13375 } 13376 } 13377 }, 13378 "/profiling/start": { 13379 "post": { 13380 "tags": [ 13381 "Profile" 13382 ], 13383 "summary": "Start recording profile data", 13384 "operationId": "ProfilingStart", 13385 "parameters": [ 13386 { 13387 "name": "body", 13388 "in": "body", 13389 "required": true, 13390 "schema": { 13391 "$ref": "#/definitions/profilingStartRequest" 13392 } 13393 } 13394 ], 13395 "responses": { 13396 "201": { 13397 "description": "A successful response.", 13398 "schema": { 13399 "$ref": "#/definitions/startProfilingList" 13400 } 13401 }, 13402 "default": { 13403 "description": "Generic error response.", 13404 "schema": { 13405 "$ref": "#/definitions/ApiError" 13406 } 13407 } 13408 } 13409 } 13410 }, 13411 "/profiling/stop": { 13412 "post": { 13413 "produces": [ 13414 "application/zip" 13415 ], 13416 "tags": [ 13417 "Profile" 13418 ], 13419 "summary": "Stop and download profile data", 13420 "operationId": "ProfilingStop", 13421 "responses": { 13422 "201": { 13423 "description": "A successful response.", 13424 "schema": { 13425 "type": "file" 13426 } 13427 }, 13428 "default": { 13429 "description": "Generic error response.", 13430 "schema": { 13431 "$ref": "#/definitions/ApiError" 13432 } 13433 } 13434 } 13435 } 13436 }, 13437 "/releases": { 13438 "get": { 13439 "tags": [ 13440 "release" 13441 ], 13442 "summary": "Get repo releases for a given version", 13443 "operationId": "ListReleases", 13444 "parameters": [ 13445 { 13446 "type": "string", 13447 "description": "repo name", 13448 "name": "repo", 13449 "in": "query", 13450 "required": true 13451 }, 13452 { 13453 "type": "string", 13454 "description": "Current Release", 13455 "name": "current", 13456 "in": "query" 13457 }, 13458 { 13459 "type": "string", 13460 "description": "search content", 13461 "name": "search", 13462 "in": "query" 13463 }, 13464 { 13465 "type": "string", 13466 "description": "filter releases", 13467 "name": "filter", 13468 "in": "query" 13469 } 13470 ], 13471 "responses": { 13472 "200": { 13473 "description": "A successful response.", 13474 "schema": { 13475 "$ref": "#/definitions/releaseListResponse" 13476 } 13477 }, 13478 "default": { 13479 "description": "Generic error response.", 13480 "schema": { 13481 "$ref": "#/definitions/ApiError" 13482 } 13483 } 13484 } 13485 } 13486 }, 13487 "/remote-buckets": { 13488 "get": { 13489 "tags": [ 13490 "Bucket" 13491 ], 13492 "summary": "List Remote Buckets", 13493 "operationId": "ListRemoteBuckets", 13494 "responses": { 13495 "200": { 13496 "description": "A successful response.", 13497 "schema": { 13498 "$ref": "#/definitions/listRemoteBucketsResponse" 13499 } 13500 }, 13501 "default": { 13502 "description": "Generic error response.", 13503 "schema": { 13504 "$ref": "#/definitions/ApiError" 13505 } 13506 } 13507 } 13508 }, 13509 "post": { 13510 "tags": [ 13511 "Bucket" 13512 ], 13513 "summary": "Add Remote Bucket", 13514 "operationId": "AddRemoteBucket", 13515 "parameters": [ 13516 { 13517 "name": "body", 13518 "in": "body", 13519 "required": true, 13520 "schema": { 13521 "$ref": "#/definitions/createRemoteBucket" 13522 } 13523 } 13524 ], 13525 "responses": { 13526 "201": { 13527 "description": "A successful response." 13528 }, 13529 "default": { 13530 "description": "Generic error response.", 13531 "schema": { 13532 "$ref": "#/definitions/ApiError" 13533 } 13534 } 13535 } 13536 } 13537 }, 13538 "/remote-buckets/{name}": { 13539 "get": { 13540 "tags": [ 13541 "Bucket" 13542 ], 13543 "summary": "Remote Bucket Details", 13544 "operationId": "RemoteBucketDetails", 13545 "parameters": [ 13546 { 13547 "type": "string", 13548 "name": "name", 13549 "in": "path", 13550 "required": true 13551 } 13552 ], 13553 "responses": { 13554 "200": { 13555 "description": "A successful response.", 13556 "schema": { 13557 "$ref": "#/definitions/remoteBucket" 13558 } 13559 }, 13560 "default": { 13561 "description": "Generic error response.", 13562 "schema": { 13563 "$ref": "#/definitions/ApiError" 13564 } 13565 } 13566 } 13567 } 13568 }, 13569 "/remote-buckets/{source-bucket-name}/{arn}": { 13570 "delete": { 13571 "tags": [ 13572 "Bucket" 13573 ], 13574 "summary": "Delete Remote Bucket", 13575 "operationId": "DeleteRemoteBucket", 13576 "parameters": [ 13577 { 13578 "type": "string", 13579 "name": "source-bucket-name", 13580 "in": "path", 13581 "required": true 13582 }, 13583 { 13584 "type": "string", 13585 "name": "arn", 13586 "in": "path", 13587 "required": true 13588 } 13589 ], 13590 "responses": { 13591 "204": { 13592 "description": "A successful response." 13593 }, 13594 "default": { 13595 "description": "Generic error response.", 13596 "schema": { 13597 "$ref": "#/definitions/ApiError" 13598 } 13599 } 13600 } 13601 } 13602 }, 13603 "/service-account-credentials": { 13604 "post": { 13605 "tags": [ 13606 "ServiceAccount" 13607 ], 13608 "summary": "Create Service Account With Credentials", 13609 "operationId": "CreateServiceAccountCreds", 13610 "parameters": [ 13611 { 13612 "name": "body", 13613 "in": "body", 13614 "required": true, 13615 "schema": { 13616 "$ref": "#/definitions/serviceAccountRequestCreds" 13617 } 13618 } 13619 ], 13620 "responses": { 13621 "201": { 13622 "description": "A successful response.", 13623 "schema": { 13624 "$ref": "#/definitions/serviceAccountCreds" 13625 } 13626 }, 13627 "default": { 13628 "description": "Generic error response.", 13629 "schema": { 13630 "$ref": "#/definitions/ApiError" 13631 } 13632 } 13633 } 13634 } 13635 }, 13636 "/service-accounts": { 13637 "get": { 13638 "tags": [ 13639 "ServiceAccount" 13640 ], 13641 "summary": "List User's Service Accounts", 13642 "operationId": "ListUserServiceAccounts", 13643 "parameters": [ 13644 { 13645 "type": "number", 13646 "format": "int32", 13647 "default": 0, 13648 "name": "offset", 13649 "in": "query" 13650 }, 13651 { 13652 "type": "number", 13653 "format": "int32", 13654 "default": 20, 13655 "name": "limit", 13656 "in": "query" 13657 } 13658 ], 13659 "responses": { 13660 "200": { 13661 "description": "A successful response.", 13662 "schema": { 13663 "$ref": "#/definitions/serviceAccounts" 13664 } 13665 }, 13666 "default": { 13667 "description": "Generic error response.", 13668 "schema": { 13669 "$ref": "#/definitions/ApiError" 13670 } 13671 } 13672 } 13673 }, 13674 "post": { 13675 "tags": [ 13676 "ServiceAccount" 13677 ], 13678 "summary": "Create Service Account", 13679 "operationId": "CreateServiceAccount", 13680 "parameters": [ 13681 { 13682 "name": "body", 13683 "in": "body", 13684 "required": true, 13685 "schema": { 13686 "$ref": "#/definitions/serviceAccountRequest" 13687 } 13688 } 13689 ], 13690 "responses": { 13691 "201": { 13692 "description": "A successful response.", 13693 "schema": { 13694 "$ref": "#/definitions/serviceAccountCreds" 13695 } 13696 }, 13697 "default": { 13698 "description": "Generic error response.", 13699 "schema": { 13700 "$ref": "#/definitions/ApiError" 13701 } 13702 } 13703 } 13704 } 13705 }, 13706 "/service-accounts/delete-multi": { 13707 "delete": { 13708 "tags": [ 13709 "ServiceAccount" 13710 ], 13711 "summary": "Delete Multiple Service Accounts", 13712 "operationId": "DeleteMultipleServiceAccounts", 13713 "parameters": [ 13714 { 13715 "name": "selectedSA", 13716 "in": "body", 13717 "required": true, 13718 "schema": { 13719 "$ref": "#/definitions/selectedSAs" 13720 } 13721 } 13722 ], 13723 "responses": { 13724 "204": { 13725 "description": "A successful response." 13726 }, 13727 "default": { 13728 "description": "Generic error response.", 13729 "schema": { 13730 "$ref": "#/definitions/ApiError" 13731 } 13732 } 13733 } 13734 } 13735 }, 13736 "/service-accounts/{access_key}": { 13737 "get": { 13738 "tags": [ 13739 "ServiceAccount" 13740 ], 13741 "summary": "Get Service Account", 13742 "operationId": "GetServiceAccount", 13743 "parameters": [ 13744 { 13745 "type": "string", 13746 "name": "access_key", 13747 "in": "path", 13748 "required": true 13749 } 13750 ], 13751 "responses": { 13752 "200": { 13753 "description": "A successful response.", 13754 "schema": { 13755 "$ref": "#/definitions/serviceAccount" 13756 } 13757 }, 13758 "default": { 13759 "description": "Generic error response.", 13760 "schema": { 13761 "$ref": "#/definitions/ApiError" 13762 } 13763 } 13764 } 13765 }, 13766 "put": { 13767 "tags": [ 13768 "ServiceAccount" 13769 ], 13770 "summary": "Set Service Account Policy", 13771 "operationId": "UpdateServiceAccount", 13772 "parameters": [ 13773 { 13774 "type": "string", 13775 "name": "access_key", 13776 "in": "path", 13777 "required": true 13778 }, 13779 { 13780 "name": "body", 13781 "in": "body", 13782 "required": true, 13783 "schema": { 13784 "$ref": "#/definitions/updateServiceAccountRequest" 13785 } 13786 } 13787 ], 13788 "responses": { 13789 "200": { 13790 "description": "A successful response." 13791 }, 13792 "default": { 13793 "description": "Generic error response.", 13794 "schema": { 13795 "$ref": "#/definitions/ApiError" 13796 } 13797 } 13798 } 13799 }, 13800 "delete": { 13801 "tags": [ 13802 "ServiceAccount" 13803 ], 13804 "summary": "Delete Service Account", 13805 "operationId": "DeleteServiceAccount", 13806 "parameters": [ 13807 { 13808 "type": "string", 13809 "name": "access_key", 13810 "in": "path", 13811 "required": true 13812 } 13813 ], 13814 "responses": { 13815 "204": { 13816 "description": "A successful response." 13817 }, 13818 "default": { 13819 "description": "Generic error response.", 13820 "schema": { 13821 "$ref": "#/definitions/ApiError" 13822 } 13823 } 13824 } 13825 } 13826 }, 13827 "/service/restart": { 13828 "post": { 13829 "tags": [ 13830 "Service" 13831 ], 13832 "summary": "Restart Service", 13833 "operationId": "RestartService", 13834 "responses": { 13835 "204": { 13836 "description": "A successful response." 13837 }, 13838 "default": { 13839 "description": "Generic error response.", 13840 "schema": { 13841 "$ref": "#/definitions/ApiError" 13842 } 13843 } 13844 } 13845 } 13846 }, 13847 "/session": { 13848 "get": { 13849 "tags": [ 13850 "Auth" 13851 ], 13852 "summary": "Endpoint to check if your session is still valid", 13853 "operationId": "SessionCheck", 13854 "responses": { 13855 "200": { 13856 "description": "A successful response.", 13857 "schema": { 13858 "$ref": "#/definitions/sessionResponse" 13859 } 13860 }, 13861 "default": { 13862 "description": "Generic error response.", 13863 "schema": { 13864 "$ref": "#/definitions/ApiError" 13865 } 13866 } 13867 } 13868 } 13869 }, 13870 "/set-policy": { 13871 "put": { 13872 "tags": [ 13873 "Policy" 13874 ], 13875 "summary": "Set policy", 13876 "operationId": "SetPolicy", 13877 "parameters": [ 13878 { 13879 "name": "body", 13880 "in": "body", 13881 "required": true, 13882 "schema": { 13883 "$ref": "#/definitions/setPolicyNameRequest" 13884 } 13885 } 13886 ], 13887 "responses": { 13888 "204": { 13889 "description": "A successful response." 13890 }, 13891 "default": { 13892 "description": "Generic error response.", 13893 "schema": { 13894 "$ref": "#/definitions/ApiError" 13895 } 13896 } 13897 } 13898 } 13899 }, 13900 "/set-policy-multi": { 13901 "put": { 13902 "tags": [ 13903 "Policy" 13904 ], 13905 "summary": "Set policy to multiple users/groups", 13906 "operationId": "SetPolicyMultiple", 13907 "parameters": [ 13908 { 13909 "name": "body", 13910 "in": "body", 13911 "required": true, 13912 "schema": { 13913 "$ref": "#/definitions/setPolicyMultipleNameRequest" 13914 } 13915 } 13916 ], 13917 "responses": { 13918 "204": { 13919 "description": "A successful response." 13920 }, 13921 "default": { 13922 "description": "Generic error response.", 13923 "schema": { 13924 "$ref": "#/definitions/ApiError" 13925 } 13926 } 13927 } 13928 } 13929 }, 13930 "/subnet/apikey": { 13931 "get": { 13932 "tags": [ 13933 "Subnet" 13934 ], 13935 "summary": "Subnet api key", 13936 "operationId": "SubnetApiKey", 13937 "parameters": [ 13938 { 13939 "type": "string", 13940 "name": "token", 13941 "in": "query", 13942 "required": true 13943 } 13944 ], 13945 "responses": { 13946 "200": { 13947 "description": "A successful response.", 13948 "schema": { 13949 "$ref": "#/definitions/apiKey" 13950 } 13951 }, 13952 "default": { 13953 "description": "Generic error response.", 13954 "schema": { 13955 "$ref": "#/definitions/ApiError" 13956 } 13957 } 13958 } 13959 } 13960 }, 13961 "/subnet/info": { 13962 "get": { 13963 "tags": [ 13964 "Subnet" 13965 ], 13966 "summary": "Subnet info", 13967 "operationId": "SubnetInfo", 13968 "responses": { 13969 "200": { 13970 "description": "A successful response.", 13971 "schema": { 13972 "$ref": "#/definitions/license" 13973 } 13974 }, 13975 "default": { 13976 "description": "Generic error response.", 13977 "schema": { 13978 "$ref": "#/definitions/ApiError" 13979 } 13980 } 13981 } 13982 } 13983 }, 13984 "/subnet/login": { 13985 "post": { 13986 "tags": [ 13987 "Subnet" 13988 ], 13989 "summary": "Login to SUBNET", 13990 "operationId": "SubnetLogin", 13991 "parameters": [ 13992 { 13993 "name": "body", 13994 "in": "body", 13995 "required": true, 13996 "schema": { 13997 "$ref": "#/definitions/subnetLoginRequest" 13998 } 13999 } 14000 ], 14001 "responses": { 14002 "200": { 14003 "description": "A successful response.", 14004 "schema": { 14005 "$ref": "#/definitions/subnetLoginResponse" 14006 } 14007 }, 14008 "default": { 14009 "description": "Generic error response.", 14010 "schema": { 14011 "$ref": "#/definitions/ApiError" 14012 } 14013 } 14014 } 14015 } 14016 }, 14017 "/subnet/login/mfa": { 14018 "post": { 14019 "tags": [ 14020 "Subnet" 14021 ], 14022 "summary": "Login to SUBNET using mfa", 14023 "operationId": "SubnetLoginMFA", 14024 "parameters": [ 14025 { 14026 "name": "body", 14027 "in": "body", 14028 "required": true, 14029 "schema": { 14030 "$ref": "#/definitions/subnetLoginMFARequest" 14031 } 14032 } 14033 ], 14034 "responses": { 14035 "200": { 14036 "description": "A successful response.", 14037 "schema": { 14038 "$ref": "#/definitions/subnetLoginResponse" 14039 } 14040 }, 14041 "default": { 14042 "description": "Generic error response.", 14043 "schema": { 14044 "$ref": "#/definitions/ApiError" 14045 } 14046 } 14047 } 14048 } 14049 }, 14050 "/subnet/register": { 14051 "post": { 14052 "tags": [ 14053 "Subnet" 14054 ], 14055 "summary": "Register cluster with Subnet", 14056 "operationId": "SubnetRegister", 14057 "parameters": [ 14058 { 14059 "name": "body", 14060 "in": "body", 14061 "required": true, 14062 "schema": { 14063 "$ref": "#/definitions/subnetRegisterRequest" 14064 } 14065 } 14066 ], 14067 "responses": { 14068 "200": { 14069 "description": "A successful response." 14070 }, 14071 "default": { 14072 "description": "Generic error response.", 14073 "schema": { 14074 "$ref": "#/definitions/ApiError" 14075 } 14076 } 14077 } 14078 } 14079 }, 14080 "/subnet/registration-token": { 14081 "get": { 14082 "tags": [ 14083 "Subnet" 14084 ], 14085 "summary": "SUBNET registraton token", 14086 "operationId": "SubnetRegToken", 14087 "responses": { 14088 "200": { 14089 "description": "A successful response.", 14090 "schema": { 14091 "$ref": "#/definitions/SubnetRegTokenResponse" 14092 } 14093 }, 14094 "default": { 14095 "description": "Generic error response.", 14096 "schema": { 14097 "$ref": "#/definitions/ApiError" 14098 } 14099 } 14100 } 14101 } 14102 }, 14103 "/support/callhome": { 14104 "get": { 14105 "tags": [ 14106 "Support" 14107 ], 14108 "summary": "Get Callhome current status", 14109 "operationId": "GetCallHomeOptionValue", 14110 "responses": { 14111 "200": { 14112 "description": "A successful response.", 14113 "schema": { 14114 "$ref": "#/definitions/callHomeGetResponse" 14115 } 14116 }, 14117 "default": { 14118 "description": "Generic error response.", 14119 "schema": { 14120 "$ref": "#/definitions/ApiError" 14121 } 14122 } 14123 } 14124 }, 14125 "put": { 14126 "tags": [ 14127 "Support" 14128 ], 14129 "summary": "Sets callhome status", 14130 "operationId": "SetCallHomeStatus", 14131 "parameters": [ 14132 { 14133 "name": "body", 14134 "in": "body", 14135 "required": true, 14136 "schema": { 14137 "$ref": "#/definitions/callHomeSetStatus" 14138 } 14139 } 14140 ], 14141 "responses": { 14142 "204": { 14143 "description": "A successful response." 14144 }, 14145 "default": { 14146 "description": "Generic error response.", 14147 "schema": { 14148 "$ref": "#/definitions/ApiError" 14149 } 14150 } 14151 } 14152 } 14153 }, 14154 "/user/policy": { 14155 "get": { 14156 "tags": [ 14157 "Policy" 14158 ], 14159 "summary": "returns policies for logged in user", 14160 "operationId": "GetUserPolicy", 14161 "responses": { 14162 "200": { 14163 "description": "A successful response.", 14164 "schema": { 14165 "type": "string" 14166 } 14167 }, 14168 "default": { 14169 "description": "Generic error response.", 14170 "schema": { 14171 "$ref": "#/definitions/ApiError" 14172 } 14173 } 14174 } 14175 } 14176 }, 14177 "/user/{name}": { 14178 "get": { 14179 "tags": [ 14180 "User" 14181 ], 14182 "summary": "Get User Info", 14183 "operationId": "GetUserInfo", 14184 "parameters": [ 14185 { 14186 "type": "string", 14187 "name": "name", 14188 "in": "path", 14189 "required": true 14190 } 14191 ], 14192 "responses": { 14193 "200": { 14194 "description": "A successful response.", 14195 "schema": { 14196 "$ref": "#/definitions/user" 14197 } 14198 }, 14199 "default": { 14200 "description": "Generic error response.", 14201 "schema": { 14202 "$ref": "#/definitions/ApiError" 14203 } 14204 } 14205 } 14206 }, 14207 "put": { 14208 "tags": [ 14209 "User" 14210 ], 14211 "summary": "Update User Info", 14212 "operationId": "UpdateUserInfo", 14213 "parameters": [ 14214 { 14215 "type": "string", 14216 "name": "name", 14217 "in": "path", 14218 "required": true 14219 }, 14220 { 14221 "name": "body", 14222 "in": "body", 14223 "required": true, 14224 "schema": { 14225 "$ref": "#/definitions/updateUser" 14226 } 14227 } 14228 ], 14229 "responses": { 14230 "200": { 14231 "description": "A successful response.", 14232 "schema": { 14233 "$ref": "#/definitions/user" 14234 } 14235 }, 14236 "default": { 14237 "description": "Generic error response.", 14238 "schema": { 14239 "$ref": "#/definitions/ApiError" 14240 } 14241 } 14242 } 14243 }, 14244 "delete": { 14245 "tags": [ 14246 "User" 14247 ], 14248 "summary": "Remove user", 14249 "operationId": "RemoveUser", 14250 "parameters": [ 14251 { 14252 "type": "string", 14253 "name": "name", 14254 "in": "path", 14255 "required": true 14256 } 14257 ], 14258 "responses": { 14259 "204": { 14260 "description": "A successful response." 14261 }, 14262 "default": { 14263 "description": "Generic error response.", 14264 "schema": { 14265 "$ref": "#/definitions/ApiError" 14266 } 14267 } 14268 } 14269 } 14270 }, 14271 "/user/{name}/groups": { 14272 "put": { 14273 "tags": [ 14274 "User" 14275 ], 14276 "summary": "Update Groups for a user", 14277 "operationId": "UpdateUserGroups", 14278 "parameters": [ 14279 { 14280 "type": "string", 14281 "name": "name", 14282 "in": "path", 14283 "required": true 14284 }, 14285 { 14286 "name": "body", 14287 "in": "body", 14288 "required": true, 14289 "schema": { 14290 "$ref": "#/definitions/updateUserGroups" 14291 } 14292 } 14293 ], 14294 "responses": { 14295 "200": { 14296 "description": "A successful response.", 14297 "schema": { 14298 "$ref": "#/definitions/user" 14299 } 14300 }, 14301 "default": { 14302 "description": "Generic error response.", 14303 "schema": { 14304 "$ref": "#/definitions/ApiError" 14305 } 14306 } 14307 } 14308 } 14309 }, 14310 "/user/{name}/policies": { 14311 "get": { 14312 "tags": [ 14313 "Policy" 14314 ], 14315 "summary": "returns policies assigned for a specified user", 14316 "operationId": "GetSAUserPolicy", 14317 "parameters": [ 14318 { 14319 "type": "string", 14320 "name": "name", 14321 "in": "path", 14322 "required": true 14323 } 14324 ], 14325 "responses": { 14326 "200": { 14327 "description": "A successful response.", 14328 "schema": { 14329 "$ref": "#/definitions/aUserPolicyResponse" 14330 } 14331 }, 14332 "default": { 14333 "description": "Generic error response.", 14334 "schema": { 14335 "$ref": "#/definitions/ApiError" 14336 } 14337 } 14338 } 14339 } 14340 }, 14341 "/user/{name}/service-account-credentials": { 14342 "post": { 14343 "tags": [ 14344 "User" 14345 ], 14346 "summary": "Create Service Account for User With Credentials", 14347 "operationId": "CreateServiceAccountCredentials", 14348 "parameters": [ 14349 { 14350 "type": "string", 14351 "name": "name", 14352 "in": "path", 14353 "required": true 14354 }, 14355 { 14356 "name": "body", 14357 "in": "body", 14358 "required": true, 14359 "schema": { 14360 "$ref": "#/definitions/serviceAccountRequestCreds" 14361 } 14362 } 14363 ], 14364 "responses": { 14365 "201": { 14366 "description": "A successful response.", 14367 "schema": { 14368 "$ref": "#/definitions/serviceAccountCreds" 14369 } 14370 }, 14371 "default": { 14372 "description": "Generic error response.", 14373 "schema": { 14374 "$ref": "#/definitions/ApiError" 14375 } 14376 } 14377 } 14378 } 14379 }, 14380 "/user/{name}/service-accounts": { 14381 "get": { 14382 "tags": [ 14383 "User" 14384 ], 14385 "summary": "returns a list of service accounts for a user", 14386 "operationId": "ListAUserServiceAccounts", 14387 "parameters": [ 14388 { 14389 "type": "string", 14390 "name": "name", 14391 "in": "path", 14392 "required": true 14393 } 14394 ], 14395 "responses": { 14396 "200": { 14397 "description": "A successful response.", 14398 "schema": { 14399 "$ref": "#/definitions/serviceAccounts" 14400 } 14401 }, 14402 "default": { 14403 "description": "Generic error response.", 14404 "schema": { 14405 "$ref": "#/definitions/ApiError" 14406 } 14407 } 14408 } 14409 }, 14410 "post": { 14411 "tags": [ 14412 "User" 14413 ], 14414 "summary": "Create Service Account for User", 14415 "operationId": "CreateAUserServiceAccount", 14416 "parameters": [ 14417 { 14418 "type": "string", 14419 "name": "name", 14420 "in": "path", 14421 "required": true 14422 }, 14423 { 14424 "name": "body", 14425 "in": "body", 14426 "required": true, 14427 "schema": { 14428 "$ref": "#/definitions/serviceAccountRequest" 14429 } 14430 } 14431 ], 14432 "responses": { 14433 "201": { 14434 "description": "A successful response.", 14435 "schema": { 14436 "$ref": "#/definitions/serviceAccountCreds" 14437 } 14438 }, 14439 "default": { 14440 "description": "Generic error response.", 14441 "schema": { 14442 "$ref": "#/definitions/ApiError" 14443 } 14444 } 14445 } 14446 } 14447 }, 14448 "/users": { 14449 "get": { 14450 "tags": [ 14451 "User" 14452 ], 14453 "summary": "List Users", 14454 "operationId": "ListUsers", 14455 "parameters": [ 14456 { 14457 "type": "number", 14458 "format": "int32", 14459 "default": 0, 14460 "name": "offset", 14461 "in": "query" 14462 }, 14463 { 14464 "type": "number", 14465 "format": "int32", 14466 "default": 20, 14467 "name": "limit", 14468 "in": "query" 14469 } 14470 ], 14471 "responses": { 14472 "200": { 14473 "description": "A successful response.", 14474 "schema": { 14475 "$ref": "#/definitions/listUsersResponse" 14476 } 14477 }, 14478 "default": { 14479 "description": "Generic error response.", 14480 "schema": { 14481 "$ref": "#/definitions/ApiError" 14482 } 14483 } 14484 } 14485 }, 14486 "post": { 14487 "tags": [ 14488 "User" 14489 ], 14490 "summary": "Add User", 14491 "operationId": "AddUser", 14492 "parameters": [ 14493 { 14494 "name": "body", 14495 "in": "body", 14496 "required": true, 14497 "schema": { 14498 "$ref": "#/definitions/addUserRequest" 14499 } 14500 } 14501 ], 14502 "responses": { 14503 "201": { 14504 "description": "A successful response.", 14505 "schema": { 14506 "$ref": "#/definitions/user" 14507 } 14508 }, 14509 "default": { 14510 "description": "Generic error response.", 14511 "schema": { 14512 "$ref": "#/definitions/ApiError" 14513 } 14514 } 14515 } 14516 } 14517 }, 14518 "/users-groups-bulk": { 14519 "put": { 14520 "tags": [ 14521 "User" 14522 ], 14523 "summary": "Bulk functionality to Add Users to Groups", 14524 "operationId": "BulkUpdateUsersGroups", 14525 "parameters": [ 14526 { 14527 "name": "body", 14528 "in": "body", 14529 "required": true, 14530 "schema": { 14531 "$ref": "#/definitions/bulkUserGroups" 14532 } 14533 } 14534 ], 14535 "responses": { 14536 "200": { 14537 "description": "A successful response." 14538 }, 14539 "default": { 14540 "description": "Generic error response.", 14541 "schema": { 14542 "$ref": "#/definitions/ApiError" 14543 } 14544 } 14545 } 14546 } 14547 }, 14548 "/users/service-accounts": { 14549 "post": { 14550 "tags": [ 14551 "User" 14552 ], 14553 "summary": "Check number of service accounts for each user specified", 14554 "operationId": "CheckUserServiceAccounts", 14555 "parameters": [ 14556 { 14557 "name": "selectedUsers", 14558 "in": "body", 14559 "required": true, 14560 "schema": { 14561 "$ref": "#/definitions/selectedUsers" 14562 } 14563 } 14564 ], 14565 "responses": { 14566 "200": { 14567 "description": "A successful response.", 14568 "schema": { 14569 "$ref": "#/definitions/userServiceAccountSummary" 14570 } 14571 }, 14572 "default": { 14573 "description": "Generic error response.", 14574 "schema": { 14575 "$ref": "#/definitions/ApiError" 14576 } 14577 } 14578 } 14579 } 14580 } 14581 }, 14582 "definitions": { 14583 "ApiError": { 14584 "type": "object", 14585 "properties": { 14586 "detailedMessage": { 14587 "type": "string" 14588 }, 14589 "message": { 14590 "type": "string" 14591 } 14592 } 14593 }, 14594 "BackendProperties": { 14595 "type": "object", 14596 "properties": { 14597 "backendType": { 14598 "type": "string" 14599 }, 14600 "offlineDrives": { 14601 "type": "integer" 14602 }, 14603 "onlineDrives": { 14604 "type": "integer" 14605 }, 14606 "rrSCParity": { 14607 "type": "integer" 14608 }, 14609 "standardSCParity": { 14610 "type": "integer" 14611 } 14612 } 14613 }, 14614 "BucketDetails": { 14615 "type": "object", 14616 "properties": { 14617 "locking": { 14618 "type": "boolean" 14619 }, 14620 "quota": { 14621 "type": "object", 14622 "properties": { 14623 "quota": { 14624 "type": "integer", 14625 "format": "int64" 14626 }, 14627 "type": { 14628 "type": "string", 14629 "enum": [ 14630 "hard" 14631 ] 14632 } 14633 } 14634 }, 14635 "replication": { 14636 "type": "boolean" 14637 }, 14638 "tags": { 14639 "type": "object", 14640 "additionalProperties": { 14641 "type": "string" 14642 } 14643 }, 14644 "versioning": { 14645 "type": "boolean" 14646 }, 14647 "versioningSuspended": { 14648 "type": "boolean" 14649 } 14650 } 14651 }, 14652 "BucketDetailsQuota": { 14653 "type": "object", 14654 "properties": { 14655 "quota": { 14656 "type": "integer", 14657 "format": "int64" 14658 }, 14659 "type": { 14660 "type": "string", 14661 "enum": [ 14662 "hard" 14663 ] 14664 } 14665 } 14666 }, 14667 "BucketRwAccess": { 14668 "type": "object", 14669 "properties": { 14670 "read": { 14671 "type": "boolean" 14672 }, 14673 "write": { 14674 "type": "boolean" 14675 } 14676 } 14677 }, 14678 "BucketVersioningResponseExcludedPrefixesItems0": { 14679 "type": "object", 14680 "properties": { 14681 "prefix": { 14682 "type": "string" 14683 } 14684 } 14685 }, 14686 "LoginRequestFeatures": { 14687 "type": "object", 14688 "properties": { 14689 "hide_menu": { 14690 "type": "boolean" 14691 } 14692 } 14693 }, 14694 "ServiceAccountsItems0": { 14695 "type": "object", 14696 "properties": { 14697 "accessKey": { 14698 "type": "string" 14699 }, 14700 "accountStatus": { 14701 "type": "string" 14702 }, 14703 "description": { 14704 "type": "string" 14705 }, 14706 "expiration": { 14707 "type": "string" 14708 }, 14709 "name": { 14710 "type": "string" 14711 } 14712 } 14713 }, 14714 "SubnetRegTokenResponse": { 14715 "type": "object", 14716 "properties": { 14717 "regToken": { 14718 "type": "string" 14719 } 14720 } 14721 }, 14722 "WidgetDetailsOptions": { 14723 "type": "object", 14724 "properties": { 14725 "reduceOptions": { 14726 "type": "object", 14727 "properties": { 14728 "calcs": { 14729 "type": "array", 14730 "items": { 14731 "type": "string" 14732 } 14733 } 14734 } 14735 } 14736 } 14737 }, 14738 "WidgetDetailsOptionsReduceOptions": { 14739 "type": "object", 14740 "properties": { 14741 "calcs": { 14742 "type": "array", 14743 "items": { 14744 "type": "string" 14745 } 14746 } 14747 } 14748 }, 14749 "WidgetOptions": { 14750 "type": "object", 14751 "properties": { 14752 "reduceOptions": { 14753 "type": "object", 14754 "properties": { 14755 "calcs": { 14756 "type": "array", 14757 "items": { 14758 "type": "string" 14759 } 14760 } 14761 } 14762 } 14763 } 14764 }, 14765 "WidgetOptionsReduceOptions": { 14766 "type": "object", 14767 "properties": { 14768 "calcs": { 14769 "type": "array", 14770 "items": { 14771 "type": "string" 14772 } 14773 } 14774 } 14775 }, 14776 "aUserPolicyResponse": { 14777 "type": "object", 14778 "properties": { 14779 "policy": { 14780 "type": "string" 14781 } 14782 } 14783 }, 14784 "accessRule": { 14785 "type": "object", 14786 "properties": { 14787 "access": { 14788 "type": "string" 14789 }, 14790 "prefix": { 14791 "type": "string" 14792 } 14793 } 14794 }, 14795 "accountChangePasswordRequest": { 14796 "type": "object", 14797 "required": [ 14798 "current_secret_key", 14799 "new_secret_key" 14800 ], 14801 "properties": { 14802 "current_secret_key": { 14803 "type": "string" 14804 }, 14805 "new_secret_key": { 14806 "type": "string" 14807 } 14808 } 14809 }, 14810 "addBucketLifecycle": { 14811 "type": "object", 14812 "properties": { 14813 "disable": { 14814 "description": "Non required, toggle to disable or enable rule", 14815 "type": "boolean" 14816 }, 14817 "expired_object_delete_all": { 14818 "description": "Non required, toggle to disable or enable rule", 14819 "type": "boolean" 14820 }, 14821 "expired_object_delete_marker": { 14822 "description": "Non required, toggle to disable or enable rule", 14823 "type": "boolean" 14824 }, 14825 "expiry_days": { 14826 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 14827 "type": "integer", 14828 "format": "int32", 14829 "default": 0 14830 }, 14831 "newer_noncurrentversion_expiration_versions": { 14832 "description": "Non required, can be set in case of expiration is enabled", 14833 "type": "integer", 14834 "format": "int32", 14835 "default": 0 14836 }, 14837 "noncurrentversion_expiration_days": { 14838 "description": "Non required, can be set in case of expiration is enabled", 14839 "type": "integer", 14840 "format": "int32", 14841 "default": 0 14842 }, 14843 "noncurrentversion_transition_days": { 14844 "description": "Non required, can be set in case of transition is enabled", 14845 "type": "integer", 14846 "format": "int32", 14847 "default": 0 14848 }, 14849 "noncurrentversion_transition_storage_class": { 14850 "description": "Non required, can be set in case of transition is enabled", 14851 "type": "string" 14852 }, 14853 "prefix": { 14854 "description": "Non required field, it matches a prefix to perform ILM operations on it", 14855 "type": "string" 14856 }, 14857 "storage_class": { 14858 "description": "Required only in case of transition is set. it refers to a tier", 14859 "type": "string" 14860 }, 14861 "tags": { 14862 "description": "Non required field, tags to match ILM files", 14863 "type": "string" 14864 }, 14865 "transition_days": { 14866 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 14867 "type": "integer", 14868 "format": "int32", 14869 "default": 0 14870 }, 14871 "type": { 14872 "description": "ILM Rule type (Expiry or transition)", 14873 "type": "string", 14874 "enum": [ 14875 "expiry", 14876 "transition" 14877 ] 14878 } 14879 } 14880 }, 14881 "addBucketReplication": { 14882 "type": "object", 14883 "properties": { 14884 "arn": { 14885 "type": "string" 14886 }, 14887 "destination_bucket": { 14888 "type": "string" 14889 } 14890 } 14891 }, 14892 "addGroupRequest": { 14893 "type": "object", 14894 "required": [ 14895 "group", 14896 "members" 14897 ], 14898 "properties": { 14899 "group": { 14900 "type": "string" 14901 }, 14902 "members": { 14903 "type": "array", 14904 "items": { 14905 "type": "string" 14906 } 14907 } 14908 } 14909 }, 14910 "addMultiBucketLifecycle": { 14911 "type": "object", 14912 "required": [ 14913 "buckets", 14914 "type" 14915 ], 14916 "properties": { 14917 "buckets": { 14918 "type": "array", 14919 "items": { 14920 "type": "string" 14921 } 14922 }, 14923 "expired_object_delete_all": { 14924 "description": "Non required, toggle to disable or enable rule", 14925 "type": "boolean" 14926 }, 14927 "expired_object_delete_marker": { 14928 "description": "Non required, toggle to disable or enable rule", 14929 "type": "boolean" 14930 }, 14931 "expiry_days": { 14932 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 14933 "type": "integer", 14934 "format": "int32", 14935 "default": 0 14936 }, 14937 "noncurrentversion_expiration_days": { 14938 "description": "Non required, can be set in case of expiration is enabled", 14939 "type": "integer", 14940 "format": "int32", 14941 "default": 0 14942 }, 14943 "noncurrentversion_transition_days": { 14944 "description": "Non required, can be set in case of transition is enabled", 14945 "type": "integer", 14946 "format": "int32", 14947 "default": 0 14948 }, 14949 "noncurrentversion_transition_storage_class": { 14950 "description": "Non required, can be set in case of transition is enabled", 14951 "type": "string" 14952 }, 14953 "prefix": { 14954 "description": "Non required field, it matches a prefix to perform ILM operations on it", 14955 "type": "string" 14956 }, 14957 "storage_class": { 14958 "description": "Required only in case of transition is set. it refers to a tier", 14959 "type": "string" 14960 }, 14961 "tags": { 14962 "description": "Non required field, tags to match ILM files", 14963 "type": "string" 14964 }, 14965 "transition_days": { 14966 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 14967 "type": "integer", 14968 "format": "int32", 14969 "default": 0 14970 }, 14971 "type": { 14972 "description": "ILM Rule type (Expiry or transition)", 14973 "type": "string", 14974 "enum": [ 14975 "expiry", 14976 "transition" 14977 ] 14978 } 14979 } 14980 }, 14981 "addPolicyRequest": { 14982 "type": "object", 14983 "required": [ 14984 "name", 14985 "policy" 14986 ], 14987 "properties": { 14988 "name": { 14989 "type": "string" 14990 }, 14991 "policy": { 14992 "type": "string" 14993 } 14994 } 14995 }, 14996 "addUserRequest": { 14997 "type": "object", 14998 "required": [ 14999 "accessKey", 15000 "secretKey", 15001 "groups", 15002 "policies" 15003 ], 15004 "properties": { 15005 "accessKey": { 15006 "type": "string" 15007 }, 15008 "groups": { 15009 "type": "array", 15010 "items": { 15011 "type": "string" 15012 } 15013 }, 15014 "policies": { 15015 "type": "array", 15016 "items": { 15017 "type": "string" 15018 } 15019 }, 15020 "secretKey": { 15021 "type": "string" 15022 } 15023 } 15024 }, 15025 "adminInfoResponse": { 15026 "type": "object", 15027 "properties": { 15028 "advancedMetricsStatus": { 15029 "type": "string", 15030 "enum": [ 15031 "not configured", 15032 "available", 15033 "unavailable" 15034 ] 15035 }, 15036 "backend": { 15037 "$ref": "#/definitions/BackendProperties" 15038 }, 15039 "buckets": { 15040 "type": "integer" 15041 }, 15042 "objects": { 15043 "type": "integer" 15044 }, 15045 "servers": { 15046 "type": "array", 15047 "items": { 15048 "$ref": "#/definitions/serverProperties" 15049 } 15050 }, 15051 "usage": { 15052 "type": "integer" 15053 }, 15054 "widgets": { 15055 "type": "array", 15056 "items": { 15057 "$ref": "#/definitions/widget" 15058 } 15059 } 15060 } 15061 }, 15062 "apiKey": { 15063 "type": "object", 15064 "properties": { 15065 "apiKey": { 15066 "type": "string" 15067 } 15068 } 15069 }, 15070 "arnsResponse": { 15071 "type": "object", 15072 "properties": { 15073 "arns": { 15074 "type": "array", 15075 "items": { 15076 "type": "string" 15077 } 15078 } 15079 } 15080 }, 15081 "bucket": { 15082 "type": "object", 15083 "required": [ 15084 "name" 15085 ], 15086 "properties": { 15087 "access": { 15088 "$ref": "#/definitions/bucketAccess" 15089 }, 15090 "creation_date": { 15091 "type": "string" 15092 }, 15093 "definition": { 15094 "type": "string" 15095 }, 15096 "details": { 15097 "type": "object", 15098 "properties": { 15099 "locking": { 15100 "type": "boolean" 15101 }, 15102 "quota": { 15103 "type": "object", 15104 "properties": { 15105 "quota": { 15106 "type": "integer", 15107 "format": "int64" 15108 }, 15109 "type": { 15110 "type": "string", 15111 "enum": [ 15112 "hard" 15113 ] 15114 } 15115 } 15116 }, 15117 "replication": { 15118 "type": "boolean" 15119 }, 15120 "tags": { 15121 "type": "object", 15122 "additionalProperties": { 15123 "type": "string" 15124 } 15125 }, 15126 "versioning": { 15127 "type": "boolean" 15128 }, 15129 "versioningSuspended": { 15130 "type": "boolean" 15131 } 15132 } 15133 }, 15134 "name": { 15135 "type": "string", 15136 "minLength": 3 15137 }, 15138 "objects": { 15139 "type": "integer", 15140 "format": "int64" 15141 }, 15142 "rw_access": { 15143 "type": "object", 15144 "properties": { 15145 "read": { 15146 "type": "boolean" 15147 }, 15148 "write": { 15149 "type": "boolean" 15150 } 15151 } 15152 }, 15153 "size": { 15154 "type": "integer", 15155 "format": "int64" 15156 } 15157 } 15158 }, 15159 "bucketAccess": { 15160 "type": "string", 15161 "default": "PRIVATE", 15162 "enum": [ 15163 "PRIVATE", 15164 "PUBLIC", 15165 "CUSTOM" 15166 ] 15167 }, 15168 "bucketEncryptionInfo": { 15169 "type": "object", 15170 "properties": { 15171 "algorithm": { 15172 "type": "string" 15173 }, 15174 "kmsMasterKeyID": { 15175 "type": "string" 15176 } 15177 } 15178 }, 15179 "bucketEncryptionRequest": { 15180 "type": "object", 15181 "properties": { 15182 "encType": { 15183 "$ref": "#/definitions/bucketEncryptionType" 15184 }, 15185 "kmsKeyID": { 15186 "type": "string" 15187 } 15188 } 15189 }, 15190 "bucketEncryptionType": { 15191 "type": "string", 15192 "default": "sse-s3", 15193 "enum": [ 15194 "sse-s3", 15195 "sse-kms" 15196 ] 15197 }, 15198 "bucketEventRequest": { 15199 "type": "object", 15200 "required": [ 15201 "configuration" 15202 ], 15203 "properties": { 15204 "configuration": { 15205 "$ref": "#/definitions/notificationConfig" 15206 }, 15207 "ignoreExisting": { 15208 "type": "boolean" 15209 } 15210 } 15211 }, 15212 "bucketLifecycleResponse": { 15213 "type": "object", 15214 "properties": { 15215 "lifecycle": { 15216 "type": "array", 15217 "items": { 15218 "$ref": "#/definitions/objectBucketLifecycle" 15219 } 15220 } 15221 } 15222 }, 15223 "bucketObLockingResponse": { 15224 "type": "object", 15225 "properties": { 15226 "object_locking_enabled": { 15227 "type": "boolean" 15228 } 15229 } 15230 }, 15231 "bucketObject": { 15232 "type": "object", 15233 "properties": { 15234 "content_type": { 15235 "type": "string" 15236 }, 15237 "etag": { 15238 "type": "string" 15239 }, 15240 "expiration": { 15241 "type": "string" 15242 }, 15243 "expiration_rule_id": { 15244 "type": "string" 15245 }, 15246 "is_delete_marker": { 15247 "type": "boolean" 15248 }, 15249 "is_latest": { 15250 "type": "boolean" 15251 }, 15252 "last_modified": { 15253 "type": "string" 15254 }, 15255 "legal_hold_status": { 15256 "type": "string" 15257 }, 15258 "metadata": { 15259 "type": "object", 15260 "additionalProperties": { 15261 "type": "string" 15262 } 15263 }, 15264 "name": { 15265 "type": "string" 15266 }, 15267 "retention_mode": { 15268 "type": "string" 15269 }, 15270 "retention_until_date": { 15271 "type": "string" 15272 }, 15273 "size": { 15274 "type": "integer", 15275 "format": "int64" 15276 }, 15277 "tags": { 15278 "type": "object", 15279 "additionalProperties": { 15280 "type": "string" 15281 } 15282 }, 15283 "user_metadata": { 15284 "type": "object", 15285 "additionalProperties": { 15286 "type": "string" 15287 } 15288 }, 15289 "user_tags": { 15290 "type": "object", 15291 "additionalProperties": { 15292 "type": "string" 15293 } 15294 }, 15295 "version_id": { 15296 "type": "string" 15297 } 15298 } 15299 }, 15300 "bucketQuota": { 15301 "type": "object", 15302 "properties": { 15303 "quota": { 15304 "type": "integer" 15305 }, 15306 "type": { 15307 "type": "string", 15308 "enum": [ 15309 "hard" 15310 ] 15311 } 15312 } 15313 }, 15314 "bucketReplicationDestination": { 15315 "type": "object", 15316 "properties": { 15317 "bucket": { 15318 "type": "string" 15319 } 15320 } 15321 }, 15322 "bucketReplicationResponse": { 15323 "type": "object", 15324 "properties": { 15325 "rules": { 15326 "type": "array", 15327 "items": { 15328 "$ref": "#/definitions/bucketReplicationRule" 15329 } 15330 } 15331 } 15332 }, 15333 "bucketReplicationRule": { 15334 "type": "object", 15335 "properties": { 15336 "bandwidth": { 15337 "type": "string" 15338 }, 15339 "delete_marker_replication": { 15340 "type": "boolean" 15341 }, 15342 "deletes_replication": { 15343 "type": "boolean" 15344 }, 15345 "destination": { 15346 "$ref": "#/definitions/bucketReplicationDestination" 15347 }, 15348 "existingObjects": { 15349 "type": "boolean" 15350 }, 15351 "healthCheckPeriod": { 15352 "type": "integer" 15353 }, 15354 "id": { 15355 "type": "string" 15356 }, 15357 "metadata_replication": { 15358 "type": "boolean" 15359 }, 15360 "prefix": { 15361 "type": "string" 15362 }, 15363 "priority": { 15364 "type": "integer", 15365 "format": "int32" 15366 }, 15367 "status": { 15368 "type": "string", 15369 "enum": [ 15370 "Enabled", 15371 "Disabled" 15372 ] 15373 }, 15374 "storageClass": { 15375 "type": "string" 15376 }, 15377 "syncMode": { 15378 "type": "string", 15379 "default": "async", 15380 "enum": [ 15381 "async", 15382 "sync" 15383 ] 15384 }, 15385 "tags": { 15386 "type": "string" 15387 } 15388 } 15389 }, 15390 "bucketReplicationRuleList": { 15391 "type": "object", 15392 "properties": { 15393 "rules": { 15394 "type": "array", 15395 "items": { 15396 "type": "string" 15397 } 15398 } 15399 } 15400 }, 15401 "bucketVersioningResponse": { 15402 "type": "object", 15403 "properties": { 15404 "MFADelete": { 15405 "type": "string" 15406 }, 15407 "excludeFolders": { 15408 "type": "boolean" 15409 }, 15410 "excludedPrefixes": { 15411 "type": "array", 15412 "items": { 15413 "$ref": "#/definitions/BucketVersioningResponseExcludedPrefixesItems0" 15414 } 15415 }, 15416 "status": { 15417 "type": "string" 15418 } 15419 } 15420 }, 15421 "bulkUserGroups": { 15422 "type": "object", 15423 "required": [ 15424 "users", 15425 "groups" 15426 ], 15427 "properties": { 15428 "groups": { 15429 "type": "array", 15430 "items": { 15431 "type": "string" 15432 } 15433 }, 15434 "users": { 15435 "type": "array", 15436 "items": { 15437 "type": "string" 15438 } 15439 } 15440 } 15441 }, 15442 "callHomeGetResponse": { 15443 "type": "object", 15444 "properties": { 15445 "diagnosticsStatus": { 15446 "type": "boolean" 15447 }, 15448 "logsStatus": { 15449 "type": "boolean" 15450 } 15451 } 15452 }, 15453 "callHomeSetStatus": { 15454 "type": "object", 15455 "required": [ 15456 "diagState", 15457 "logsState" 15458 ], 15459 "properties": { 15460 "diagState": { 15461 "type": "boolean" 15462 }, 15463 "logsState": { 15464 "type": "boolean" 15465 } 15466 } 15467 }, 15468 "changeUserPasswordRequest": { 15469 "type": "object", 15470 "required": [ 15471 "selectedUser", 15472 "newSecretKey" 15473 ], 15474 "properties": { 15475 "newSecretKey": { 15476 "type": "string" 15477 }, 15478 "selectedUser": { 15479 "type": "string" 15480 } 15481 } 15482 }, 15483 "configDescription": { 15484 "type": "object", 15485 "properties": { 15486 "description": { 15487 "type": "string" 15488 }, 15489 "key": { 15490 "type": "string" 15491 } 15492 } 15493 }, 15494 "configExportResponse": { 15495 "type": "object", 15496 "properties": { 15497 "status": { 15498 "type": "string" 15499 }, 15500 "value": { 15501 "description": "Returns base64 encoded value", 15502 "type": "string" 15503 } 15504 } 15505 }, 15506 "configuration": { 15507 "type": "object", 15508 "properties": { 15509 "key_values": { 15510 "type": "array", 15511 "items": { 15512 "$ref": "#/definitions/configurationKV" 15513 } 15514 }, 15515 "name": { 15516 "type": "string" 15517 } 15518 } 15519 }, 15520 "configurationKV": { 15521 "type": "object", 15522 "properties": { 15523 "env_override": { 15524 "$ref": "#/definitions/envOverride" 15525 }, 15526 "key": { 15527 "type": "string" 15528 }, 15529 "value": { 15530 "type": "string" 15531 } 15532 } 15533 }, 15534 "createRemoteBucket": { 15535 "required": [ 15536 "accessKey", 15537 "secretKey", 15538 "targetURL", 15539 "sourceBucket", 15540 "targetBucket" 15541 ], 15542 "properties": { 15543 "accessKey": { 15544 "type": "string", 15545 "minLength": 3 15546 }, 15547 "bandwidth": { 15548 "type": "integer", 15549 "format": "int64" 15550 }, 15551 "healthCheckPeriod": { 15552 "type": "integer", 15553 "format": "int32" 15554 }, 15555 "region": { 15556 "type": "string" 15557 }, 15558 "secretKey": { 15559 "type": "string", 15560 "minLength": 8 15561 }, 15562 "sourceBucket": { 15563 "type": "string" 15564 }, 15565 "syncMode": { 15566 "type": "string", 15567 "default": "async", 15568 "enum": [ 15569 "async", 15570 "sync" 15571 ] 15572 }, 15573 "targetBucket": { 15574 "type": "string" 15575 }, 15576 "targetURL": { 15577 "type": "string" 15578 } 15579 } 15580 }, 15581 "deleteFile": { 15582 "type": "object", 15583 "properties": { 15584 "path": { 15585 "type": "string" 15586 }, 15587 "recursive": { 15588 "type": "boolean" 15589 }, 15590 "versionID": { 15591 "type": "string" 15592 } 15593 } 15594 }, 15595 "envOverride": { 15596 "type": "object", 15597 "properties": { 15598 "name": { 15599 "type": "string" 15600 }, 15601 "value": { 15602 "type": "string" 15603 } 15604 } 15605 }, 15606 "environmentConstants": { 15607 "type": "object", 15608 "properties": { 15609 "maxConcurrentDownloads": { 15610 "type": "integer" 15611 }, 15612 "maxConcurrentUploads": { 15613 "type": "integer" 15614 } 15615 } 15616 }, 15617 "expirationResponse": { 15618 "type": "object", 15619 "properties": { 15620 "date": { 15621 "type": "string" 15622 }, 15623 "days": { 15624 "type": "integer", 15625 "format": "int64" 15626 }, 15627 "delete_all": { 15628 "type": "boolean" 15629 }, 15630 "delete_marker": { 15631 "type": "boolean" 15632 }, 15633 "newer_noncurrent_expiration_versions": { 15634 "type": "integer", 15635 "format": "int64" 15636 }, 15637 "noncurrent_expiration_days": { 15638 "type": "integer", 15639 "format": "int64" 15640 } 15641 } 15642 }, 15643 "getBucketRetentionConfig": { 15644 "type": "object", 15645 "properties": { 15646 "mode": { 15647 "$ref": "#/definitions/objectRetentionMode" 15648 }, 15649 "unit": { 15650 "$ref": "#/definitions/objectRetentionUnit" 15651 }, 15652 "validity": { 15653 "type": "integer", 15654 "format": "int32" 15655 } 15656 } 15657 }, 15658 "group": { 15659 "type": "object", 15660 "properties": { 15661 "members": { 15662 "type": "array", 15663 "items": { 15664 "type": "string" 15665 } 15666 }, 15667 "name": { 15668 "type": "string" 15669 }, 15670 "policy": { 15671 "type": "string" 15672 }, 15673 "status": { 15674 "type": "string" 15675 } 15676 } 15677 }, 15678 "iamEntity": { 15679 "type": "string", 15680 "pattern": "^[\\w+=,.@-]{1,64}$" 15681 }, 15682 "iamPolicy": { 15683 "type": "object", 15684 "properties": { 15685 "statement": { 15686 "type": "array", 15687 "items": { 15688 "$ref": "#/definitions/iamPolicyStatement" 15689 } 15690 }, 15691 "version": { 15692 "type": "string" 15693 } 15694 } 15695 }, 15696 "iamPolicyStatement": { 15697 "type": "object", 15698 "properties": { 15699 "action": { 15700 "type": "array", 15701 "items": { 15702 "type": "string" 15703 } 15704 }, 15705 "condition": { 15706 "type": "object", 15707 "additionalProperties": { 15708 "type": "object" 15709 } 15710 }, 15711 "effect": { 15712 "type": "string" 15713 }, 15714 "resource": { 15715 "type": "array", 15716 "items": { 15717 "type": "string" 15718 } 15719 } 15720 } 15721 }, 15722 "idpListConfigurationsResponse": { 15723 "type": "object", 15724 "properties": { 15725 "results": { 15726 "type": "array", 15727 "items": { 15728 "$ref": "#/definitions/idpServerConfiguration" 15729 } 15730 } 15731 } 15732 }, 15733 "idpServerConfiguration": { 15734 "type": "object", 15735 "properties": { 15736 "enabled": { 15737 "type": "boolean" 15738 }, 15739 "info": { 15740 "type": "array", 15741 "items": { 15742 "$ref": "#/definitions/idpServerConfigurationInfo" 15743 } 15744 }, 15745 "input": { 15746 "type": "string" 15747 }, 15748 "name": { 15749 "type": "string" 15750 }, 15751 "type": { 15752 "type": "string" 15753 } 15754 } 15755 }, 15756 "idpServerConfigurationInfo": { 15757 "type": "object", 15758 "properties": { 15759 "isCfg": { 15760 "type": "boolean" 15761 }, 15762 "isEnv": { 15763 "type": "boolean" 15764 }, 15765 "key": { 15766 "type": "string" 15767 }, 15768 "value": { 15769 "type": "string" 15770 } 15771 } 15772 }, 15773 "kmDeleteKeyRequest": { 15774 "type": "object" 15775 }, 15776 "kmsAPI": { 15777 "type": "object", 15778 "properties": { 15779 "maxBody": { 15780 "type": "integer" 15781 }, 15782 "method": { 15783 "type": "string" 15784 }, 15785 "path": { 15786 "type": "string" 15787 }, 15788 "timeout": { 15789 "type": "integer" 15790 } 15791 } 15792 }, 15793 "kmsAPIsResponse": { 15794 "type": "object", 15795 "properties": { 15796 "results": { 15797 "type": "array", 15798 "items": { 15799 "$ref": "#/definitions/kmsAPI" 15800 } 15801 } 15802 } 15803 }, 15804 "kmsAssignPolicyRequest": { 15805 "type": "object", 15806 "properties": { 15807 "identity": { 15808 "type": "string" 15809 } 15810 } 15811 }, 15812 "kmsCreateKeyRequest": { 15813 "type": "object", 15814 "required": [ 15815 "key" 15816 ], 15817 "properties": { 15818 "key": { 15819 "type": "string" 15820 } 15821 } 15822 }, 15823 "kmsDescribeIdentityResponse": { 15824 "type": "object", 15825 "properties": { 15826 "admin": { 15827 "type": "boolean" 15828 }, 15829 "createdAt": { 15830 "type": "string" 15831 }, 15832 "createdBy": { 15833 "type": "string" 15834 }, 15835 "identity": { 15836 "type": "string" 15837 }, 15838 "policy": { 15839 "type": "string" 15840 } 15841 } 15842 }, 15843 "kmsDescribePolicyResponse": { 15844 "type": "object", 15845 "properties": { 15846 "createdAt": { 15847 "type": "string" 15848 }, 15849 "createdBy": { 15850 "type": "string" 15851 }, 15852 "name": { 15853 "type": "string" 15854 } 15855 } 15856 }, 15857 "kmsDescribeSelfIdentityResponse": { 15858 "type": "object", 15859 "properties": { 15860 "admin": { 15861 "type": "boolean" 15862 }, 15863 "createdAt": { 15864 "type": "string" 15865 }, 15866 "createdBy": { 15867 "type": "string" 15868 }, 15869 "identity": { 15870 "type": "string" 15871 }, 15872 "policy": { 15873 "$ref": "#/definitions/kmsGetPolicyResponse" 15874 }, 15875 "policyName": { 15876 "type": "string" 15877 } 15878 } 15879 }, 15880 "kmsEndpoint": { 15881 "type": "object", 15882 "properties": { 15883 "status": { 15884 "type": "string" 15885 }, 15886 "url": { 15887 "type": "string" 15888 } 15889 } 15890 }, 15891 "kmsGetPolicyResponse": { 15892 "type": "object", 15893 "properties": { 15894 "allow": { 15895 "type": "array", 15896 "items": { 15897 "type": "string" 15898 } 15899 }, 15900 "deny": { 15901 "type": "array", 15902 "items": { 15903 "type": "string" 15904 } 15905 } 15906 } 15907 }, 15908 "kmsIdentityInfo": { 15909 "type": "object", 15910 "properties": { 15911 "createdAt": { 15912 "type": "string" 15913 }, 15914 "createdBy": { 15915 "type": "string" 15916 }, 15917 "error": { 15918 "type": "string" 15919 }, 15920 "identity": { 15921 "type": "string" 15922 }, 15923 "policy": { 15924 "type": "string" 15925 } 15926 } 15927 }, 15928 "kmsImportKeyRequest": { 15929 "type": "object", 15930 "required": [ 15931 "bytes" 15932 ], 15933 "properties": { 15934 "bytes": { 15935 "type": "string" 15936 } 15937 } 15938 }, 15939 "kmsKeyInfo": { 15940 "type": "object", 15941 "properties": { 15942 "createdAt": { 15943 "type": "string" 15944 }, 15945 "createdBy": { 15946 "type": "string" 15947 }, 15948 "name": { 15949 "type": "string" 15950 } 15951 } 15952 }, 15953 "kmsKeyStatusResponse": { 15954 "type": "object", 15955 "properties": { 15956 "decryptionErr": { 15957 "type": "string" 15958 }, 15959 "encryptionErr": { 15960 "type": "string" 15961 }, 15962 "keyID": { 15963 "type": "string" 15964 } 15965 } 15966 }, 15967 "kmsLatencyHistogram": { 15968 "type": "object", 15969 "properties": { 15970 "duration": { 15971 "type": "integer" 15972 }, 15973 "total": { 15974 "type": "integer" 15975 } 15976 } 15977 }, 15978 "kmsListIdentitiesResponse": { 15979 "type": "object", 15980 "properties": { 15981 "results": { 15982 "type": "array", 15983 "items": { 15984 "$ref": "#/definitions/kmsIdentityInfo" 15985 } 15986 } 15987 } 15988 }, 15989 "kmsListKeysResponse": { 15990 "type": "object", 15991 "properties": { 15992 "results": { 15993 "type": "array", 15994 "items": { 15995 "$ref": "#/definitions/kmsKeyInfo" 15996 } 15997 } 15998 } 15999 }, 16000 "kmsListPoliciesResponse": { 16001 "type": "object", 16002 "properties": { 16003 "results": { 16004 "type": "array", 16005 "items": { 16006 "$ref": "#/definitions/kmsPolicyInfo" 16007 } 16008 } 16009 } 16010 }, 16011 "kmsMetricsResponse": { 16012 "type": "object", 16013 "required": [ 16014 "requestOK", 16015 "requestErr", 16016 "requestFail", 16017 "requestActive", 16018 "auditEvents", 16019 "errorEvents", 16020 "latencyHistogram", 16021 "uptime", 16022 "cpus", 16023 "usableCPUs", 16024 "threads", 16025 "heapAlloc", 16026 "stackAlloc" 16027 ], 16028 "properties": { 16029 "auditEvents": { 16030 "type": "integer" 16031 }, 16032 "cpus": { 16033 "type": "integer" 16034 }, 16035 "errorEvents": { 16036 "type": "integer" 16037 }, 16038 "heapAlloc": { 16039 "type": "integer" 16040 }, 16041 "heapObjects": { 16042 "type": "integer" 16043 }, 16044 "latencyHistogram": { 16045 "type": "array", 16046 "items": { 16047 "$ref": "#/definitions/kmsLatencyHistogram" 16048 } 16049 }, 16050 "requestActive": { 16051 "type": "integer" 16052 }, 16053 "requestErr": { 16054 "type": "integer" 16055 }, 16056 "requestFail": { 16057 "type": "integer" 16058 }, 16059 "requestOK": { 16060 "type": "integer" 16061 }, 16062 "stackAlloc": { 16063 "type": "integer" 16064 }, 16065 "threads": { 16066 "type": "integer" 16067 }, 16068 "uptime": { 16069 "type": "integer" 16070 }, 16071 "usableCPUs": { 16072 "type": "integer" 16073 } 16074 } 16075 }, 16076 "kmsPolicyInfo": { 16077 "type": "object", 16078 "properties": { 16079 "createdAt": { 16080 "type": "string" 16081 }, 16082 "createdBy": { 16083 "type": "string" 16084 }, 16085 "name": { 16086 "type": "string" 16087 } 16088 } 16089 }, 16090 "kmsSetPolicyRequest": { 16091 "type": "object", 16092 "required": [ 16093 "policy" 16094 ], 16095 "properties": { 16096 "allow": { 16097 "type": "array", 16098 "items": { 16099 "type": "string" 16100 } 16101 }, 16102 "deny": { 16103 "type": "array", 16104 "items": { 16105 "type": "string" 16106 } 16107 }, 16108 "policy": { 16109 "type": "string" 16110 } 16111 } 16112 }, 16113 "kmsStatusResponse": { 16114 "type": "object", 16115 "properties": { 16116 "defaultKeyID": { 16117 "type": "string" 16118 }, 16119 "endpoints": { 16120 "type": "array", 16121 "items": { 16122 "$ref": "#/definitions/kmsEndpoint" 16123 } 16124 }, 16125 "name": { 16126 "type": "string" 16127 } 16128 } 16129 }, 16130 "kmsVersionResponse": { 16131 "type": "object", 16132 "properties": { 16133 "version": { 16134 "type": "string" 16135 } 16136 } 16137 }, 16138 "ldapEntities": { 16139 "type": "object", 16140 "properties": { 16141 "groups": { 16142 "type": "array", 16143 "items": { 16144 "$ref": "#/definitions/ldapGroupPolicyEntity" 16145 } 16146 }, 16147 "policies": { 16148 "type": "array", 16149 "items": { 16150 "$ref": "#/definitions/ldapPolicyEntity" 16151 } 16152 }, 16153 "timestamp": { 16154 "type": "string" 16155 }, 16156 "users": { 16157 "type": "array", 16158 "items": { 16159 "$ref": "#/definitions/ldapUserPolicyEntity" 16160 } 16161 } 16162 } 16163 }, 16164 "ldapEntitiesRequest": { 16165 "type": "object", 16166 "properties": { 16167 "groups": { 16168 "type": "array", 16169 "items": { 16170 "type": "string" 16171 } 16172 }, 16173 "policies": { 16174 "type": "array", 16175 "items": { 16176 "type": "string" 16177 } 16178 }, 16179 "users": { 16180 "type": "array", 16181 "items": { 16182 "type": "string" 16183 } 16184 } 16185 } 16186 }, 16187 "ldapGroupPolicyEntity": { 16188 "type": "object", 16189 "properties": { 16190 "group": { 16191 "type": "string" 16192 }, 16193 "policies": { 16194 "type": "array", 16195 "items": { 16196 "type": "string" 16197 } 16198 } 16199 } 16200 }, 16201 "ldapPolicyEntity": { 16202 "type": "object", 16203 "properties": { 16204 "groups": { 16205 "type": "array", 16206 "items": { 16207 "type": "string" 16208 } 16209 }, 16210 "policy": { 16211 "type": "string" 16212 }, 16213 "users": { 16214 "type": "array", 16215 "items": { 16216 "type": "string" 16217 } 16218 } 16219 } 16220 }, 16221 "ldapUserPolicyEntity": { 16222 "type": "object", 16223 "properties": { 16224 "policies": { 16225 "type": "array", 16226 "items": { 16227 "type": "string" 16228 } 16229 }, 16230 "user": { 16231 "type": "string" 16232 } 16233 } 16234 }, 16235 "license": { 16236 "type": "object", 16237 "properties": { 16238 "account_id": { 16239 "type": "integer" 16240 }, 16241 "email": { 16242 "type": "string" 16243 }, 16244 "expires_at": { 16245 "type": "string" 16246 }, 16247 "organization": { 16248 "type": "string" 16249 }, 16250 "plan": { 16251 "type": "string" 16252 }, 16253 "storage_capacity": { 16254 "type": "integer" 16255 } 16256 } 16257 }, 16258 "lifecycleTag": { 16259 "type": "object", 16260 "properties": { 16261 "key": { 16262 "type": "string" 16263 }, 16264 "value": { 16265 "type": "string" 16266 } 16267 } 16268 }, 16269 "listAccessRulesResponse": { 16270 "type": "object", 16271 "properties": { 16272 "accessRules": { 16273 "type": "array", 16274 "title": "list of policies", 16275 "items": { 16276 "$ref": "#/definitions/accessRule" 16277 } 16278 }, 16279 "total": { 16280 "type": "integer", 16281 "format": "int64", 16282 "title": "total number of policies" 16283 } 16284 } 16285 }, 16286 "listBucketEventsResponse": { 16287 "type": "object", 16288 "properties": { 16289 "events": { 16290 "type": "array", 16291 "items": { 16292 "$ref": "#/definitions/notificationConfig" 16293 } 16294 }, 16295 "total": { 16296 "type": "integer", 16297 "format": "int64", 16298 "title": "total number of bucket events" 16299 } 16300 } 16301 }, 16302 "listBucketsResponse": { 16303 "type": "object", 16304 "properties": { 16305 "buckets": { 16306 "type": "array", 16307 "title": "list of resulting buckets", 16308 "items": { 16309 "$ref": "#/definitions/bucket" 16310 } 16311 }, 16312 "total": { 16313 "type": "integer", 16314 "format": "int64", 16315 "title": "number of buckets accessible to the user" 16316 } 16317 } 16318 }, 16319 "listConfigResponse": { 16320 "type": "object", 16321 "properties": { 16322 "configurations": { 16323 "type": "array", 16324 "items": { 16325 "$ref": "#/definitions/configDescription" 16326 } 16327 }, 16328 "total": { 16329 "type": "integer", 16330 "format": "int64", 16331 "title": "total number of configurations" 16332 } 16333 } 16334 }, 16335 "listExternalBucketsParams": { 16336 "required": [ 16337 "accessKey", 16338 "secretKey", 16339 "targetURL", 16340 "useTLS" 16341 ], 16342 "properties": { 16343 "accessKey": { 16344 "type": "string", 16345 "minLength": 3 16346 }, 16347 "region": { 16348 "type": "string" 16349 }, 16350 "secretKey": { 16351 "type": "string", 16352 "minLength": 8 16353 }, 16354 "targetURL": { 16355 "type": "string" 16356 }, 16357 "useTLS": { 16358 "type": "boolean" 16359 } 16360 } 16361 }, 16362 "listGroupsResponse": { 16363 "type": "object", 16364 "properties": { 16365 "groups": { 16366 "type": "array", 16367 "title": "list of groups", 16368 "items": { 16369 "type": "string" 16370 } 16371 }, 16372 "total": { 16373 "type": "integer", 16374 "format": "int64", 16375 "title": "total number of groups" 16376 } 16377 } 16378 }, 16379 "listObjectsResponse": { 16380 "type": "object", 16381 "properties": { 16382 "objects": { 16383 "type": "array", 16384 "title": "list of resulting objects", 16385 "items": { 16386 "$ref": "#/definitions/bucketObject" 16387 } 16388 }, 16389 "total": { 16390 "type": "integer", 16391 "format": "int64", 16392 "title": "number of objects" 16393 } 16394 } 16395 }, 16396 "listPoliciesResponse": { 16397 "type": "object", 16398 "properties": { 16399 "policies": { 16400 "type": "array", 16401 "title": "list of policies", 16402 "items": { 16403 "$ref": "#/definitions/policy" 16404 } 16405 }, 16406 "total": { 16407 "type": "integer", 16408 "format": "int64", 16409 "title": "total number of policies" 16410 } 16411 } 16412 }, 16413 "listRemoteBucketsResponse": { 16414 "type": "object", 16415 "properties": { 16416 "buckets": { 16417 "type": "array", 16418 "title": "list of remote buckets", 16419 "items": { 16420 "$ref": "#/definitions/remoteBucket" 16421 } 16422 }, 16423 "total": { 16424 "type": "integer", 16425 "format": "int64", 16426 "title": "number of remote buckets accessible to user" 16427 } 16428 } 16429 }, 16430 "listUsersResponse": { 16431 "type": "object", 16432 "properties": { 16433 "users": { 16434 "type": "array", 16435 "title": "list of resulting users", 16436 "items": { 16437 "$ref": "#/definitions/user" 16438 } 16439 } 16440 } 16441 }, 16442 "logSearchResponse": { 16443 "type": "object", 16444 "properties": { 16445 "results": { 16446 "type": "object", 16447 "title": "list of log search responses" 16448 } 16449 } 16450 }, 16451 "loginDetails": { 16452 "type": "object", 16453 "properties": { 16454 "animatedLogin": { 16455 "type": "boolean" 16456 }, 16457 "isK8S": { 16458 "type": "boolean" 16459 }, 16460 "loginStrategy": { 16461 "type": "string", 16462 "enum": [ 16463 "form", 16464 "redirect", 16465 "service-account", 16466 "redirect-service-account" 16467 ] 16468 }, 16469 "redirectRules": { 16470 "type": "array", 16471 "items": { 16472 "$ref": "#/definitions/redirectRule" 16473 } 16474 } 16475 } 16476 }, 16477 "loginOauth2AuthRequest": { 16478 "type": "object", 16479 "required": [ 16480 "state", 16481 "code" 16482 ], 16483 "properties": { 16484 "code": { 16485 "type": "string" 16486 }, 16487 "state": { 16488 "type": "string" 16489 } 16490 } 16491 }, 16492 "loginRequest": { 16493 "type": "object", 16494 "properties": { 16495 "accessKey": { 16496 "type": "string" 16497 }, 16498 "features": { 16499 "type": "object", 16500 "properties": { 16501 "hide_menu": { 16502 "type": "boolean" 16503 } 16504 } 16505 }, 16506 "secretKey": { 16507 "type": "string" 16508 }, 16509 "sts": { 16510 "type": "string" 16511 } 16512 } 16513 }, 16514 "loginResponse": { 16515 "type": "object", 16516 "properties": { 16517 "IDPRefreshToken": { 16518 "type": "string" 16519 }, 16520 "sessionId": { 16521 "type": "string" 16522 } 16523 } 16524 }, 16525 "logoutRequest": { 16526 "type": "object", 16527 "properties": { 16528 "state": { 16529 "type": "string" 16530 } 16531 } 16532 }, 16533 "makeBucketRequest": { 16534 "type": "object", 16535 "required": [ 16536 "name" 16537 ], 16538 "properties": { 16539 "locking": { 16540 "type": "boolean" 16541 }, 16542 "name": { 16543 "type": "string" 16544 }, 16545 "quota": { 16546 "$ref": "#/definitions/setBucketQuota" 16547 }, 16548 "retention": { 16549 "$ref": "#/definitions/putBucketRetentionRequest" 16550 }, 16551 "versioning": { 16552 "$ref": "#/definitions/setBucketVersioning" 16553 } 16554 } 16555 }, 16556 "makeBucketsResponse": { 16557 "type": "object", 16558 "properties": { 16559 "bucketName": { 16560 "type": "string" 16561 } 16562 } 16563 }, 16564 "maxShareLinkExpResponse": { 16565 "type": "object", 16566 "required": [ 16567 "exp" 16568 ], 16569 "properties": { 16570 "exp": { 16571 "type": "number", 16572 "format": "int64" 16573 } 16574 } 16575 }, 16576 "metadata": { 16577 "type": "object", 16578 "properties": { 16579 "objectMetadata": { 16580 "type": "object", 16581 "additionalProperties": true 16582 } 16583 } 16584 }, 16585 "multiBucketReplication": { 16586 "required": [ 16587 "accessKey", 16588 "secretKey", 16589 "targetURL", 16590 "bucketsRelation" 16591 ], 16592 "properties": { 16593 "accessKey": { 16594 "type": "string", 16595 "minLength": 3 16596 }, 16597 "bandwidth": { 16598 "type": "integer", 16599 "format": "int64" 16600 }, 16601 "bucketsRelation": { 16602 "type": "array", 16603 "minLength": 1, 16604 "items": { 16605 "$ref": "#/definitions/multiBucketsRelation" 16606 } 16607 }, 16608 "healthCheckPeriod": { 16609 "type": "integer", 16610 "format": "int32" 16611 }, 16612 "prefix": { 16613 "type": "string" 16614 }, 16615 "priority": { 16616 "type": "integer", 16617 "format": "int32", 16618 "default": 0 16619 }, 16620 "region": { 16621 "type": "string" 16622 }, 16623 "replicateDeleteMarkers": { 16624 "type": "boolean" 16625 }, 16626 "replicateDeletes": { 16627 "type": "boolean" 16628 }, 16629 "replicateMetadata": { 16630 "type": "boolean" 16631 }, 16632 "secretKey": { 16633 "type": "string", 16634 "minLength": 8 16635 }, 16636 "storageClass": { 16637 "type": "string", 16638 "default": "" 16639 }, 16640 "syncMode": { 16641 "type": "string", 16642 "default": "async", 16643 "enum": [ 16644 "async", 16645 "sync" 16646 ] 16647 }, 16648 "tags": { 16649 "type": "string" 16650 }, 16651 "targetURL": { 16652 "type": "string" 16653 } 16654 } 16655 }, 16656 "multiBucketReplicationEdit": { 16657 "properties": { 16658 "arn": { 16659 "type": "string" 16660 }, 16661 "prefix": { 16662 "type": "string" 16663 }, 16664 "priority": { 16665 "type": "integer", 16666 "format": "int32", 16667 "default": 0 16668 }, 16669 "replicateDeleteMarkers": { 16670 "type": "boolean" 16671 }, 16672 "replicateDeletes": { 16673 "type": "boolean" 16674 }, 16675 "replicateExistingObjects": { 16676 "type": "boolean" 16677 }, 16678 "replicateMetadata": { 16679 "type": "boolean" 16680 }, 16681 "ruleState": { 16682 "type": "boolean" 16683 }, 16684 "storageClass": { 16685 "type": "string", 16686 "default": "" 16687 }, 16688 "tags": { 16689 "type": "string", 16690 "default": "" 16691 } 16692 } 16693 }, 16694 "multiBucketResponseItem": { 16695 "type": "object", 16696 "properties": { 16697 "errorString": { 16698 "type": "string" 16699 }, 16700 "originBucket": { 16701 "type": "string" 16702 }, 16703 "targetBucket": { 16704 "type": "string" 16705 } 16706 } 16707 }, 16708 "multiBucketResponseState": { 16709 "type": "object", 16710 "properties": { 16711 "replicationState": { 16712 "type": "array", 16713 "items": { 16714 "$ref": "#/definitions/multiBucketResponseItem" 16715 } 16716 } 16717 } 16718 }, 16719 "multiBucketsRelation": { 16720 "type": "object", 16721 "properties": { 16722 "destinationBucket": { 16723 "type": "string" 16724 }, 16725 "originBucket": { 16726 "type": "string" 16727 } 16728 } 16729 }, 16730 "multiLifecycleResult": { 16731 "properties": { 16732 "results": { 16733 "type": "array", 16734 "items": { 16735 "$ref": "#/definitions/multicycleResultItem" 16736 } 16737 } 16738 } 16739 }, 16740 "multicycleResultItem": { 16741 "type": "object", 16742 "properties": { 16743 "bucketName": { 16744 "type": "string" 16745 }, 16746 "error": { 16747 "type": "string" 16748 } 16749 } 16750 }, 16751 "nofiticationService": { 16752 "type": "string", 16753 "enum": [ 16754 "webhook", 16755 "amqp", 16756 "kafka", 16757 "mqtt", 16758 "nats", 16759 "nsq", 16760 "mysql", 16761 "postgres", 16762 "elasticsearch", 16763 "redis" 16764 ] 16765 }, 16766 "notifEndpointResponse": { 16767 "type": "object", 16768 "properties": { 16769 "notification_endpoints": { 16770 "type": "array", 16771 "items": { 16772 "$ref": "#/definitions/notificationEndpointItem" 16773 } 16774 } 16775 } 16776 }, 16777 "notificationConfig": { 16778 "type": "object", 16779 "required": [ 16780 "arn" 16781 ], 16782 "properties": { 16783 "arn": { 16784 "type": "string" 16785 }, 16786 "events": { 16787 "type": "array", 16788 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 16789 "items": { 16790 "$ref": "#/definitions/notificationEventType" 16791 } 16792 }, 16793 "id": { 16794 "type": "string" 16795 }, 16796 "prefix": { 16797 "type": "string", 16798 "title": "filter event associated to the specified prefix" 16799 }, 16800 "suffix": { 16801 "type": "string", 16802 "title": "filter event associated to the specified suffix" 16803 } 16804 } 16805 }, 16806 "notificationDeleteRequest": { 16807 "type": "object", 16808 "required": [ 16809 "events", 16810 "prefix", 16811 "suffix" 16812 ], 16813 "properties": { 16814 "events": { 16815 "type": "array", 16816 "title": "filter specific type of event. Defaults to all event (default: '[put,delete,get]')", 16817 "minLength": 1, 16818 "items": { 16819 "$ref": "#/definitions/notificationEventType" 16820 } 16821 }, 16822 "prefix": { 16823 "type": "string", 16824 "title": "filter event associated to the specified prefix" 16825 }, 16826 "suffix": { 16827 "type": "string", 16828 "title": "filter event associated to the specified suffix" 16829 } 16830 } 16831 }, 16832 "notificationEndpoint": { 16833 "type": "object", 16834 "required": [ 16835 "service", 16836 "account_id", 16837 "properties" 16838 ], 16839 "properties": { 16840 "account_id": { 16841 "type": "string" 16842 }, 16843 "properties": { 16844 "type": "object", 16845 "additionalProperties": { 16846 "type": "string" 16847 } 16848 }, 16849 "service": { 16850 "$ref": "#/definitions/nofiticationService" 16851 } 16852 } 16853 }, 16854 "notificationEndpointItem": { 16855 "type": "object", 16856 "properties": { 16857 "account_id": { 16858 "type": "string" 16859 }, 16860 "service": { 16861 "$ref": "#/definitions/nofiticationService" 16862 }, 16863 "status": { 16864 "type": "string" 16865 } 16866 } 16867 }, 16868 "notificationEventType": { 16869 "type": "string", 16870 "enum": [ 16871 "put", 16872 "delete", 16873 "get", 16874 "replica", 16875 "ilm", 16876 "scanner" 16877 ] 16878 }, 16879 "objectBucketLifecycle": { 16880 "type": "object", 16881 "properties": { 16882 "expiration": { 16883 "$ref": "#/definitions/expirationResponse" 16884 }, 16885 "id": { 16886 "type": "string" 16887 }, 16888 "prefix": { 16889 "type": "string" 16890 }, 16891 "status": { 16892 "type": "string" 16893 }, 16894 "tags": { 16895 "type": "array", 16896 "items": { 16897 "$ref": "#/definitions/lifecycleTag" 16898 } 16899 }, 16900 "transition": { 16901 "$ref": "#/definitions/transitionResponse" 16902 } 16903 } 16904 }, 16905 "objectLegalHoldStatus": { 16906 "type": "string", 16907 "enum": [ 16908 "enabled", 16909 "disabled" 16910 ] 16911 }, 16912 "objectRetentionMode": { 16913 "type": "string", 16914 "enum": [ 16915 "governance", 16916 "compliance" 16917 ] 16918 }, 16919 "objectRetentionUnit": { 16920 "type": "string", 16921 "enum": [ 16922 "days", 16923 "years" 16924 ] 16925 }, 16926 "peerInfo": { 16927 "type": "object", 16928 "properties": { 16929 "deploymentID": { 16930 "type": "string" 16931 }, 16932 "endpoint": { 16933 "type": "string" 16934 }, 16935 "name": { 16936 "type": "string" 16937 } 16938 } 16939 }, 16940 "peerInfoRemove": { 16941 "type": "object", 16942 "required": [ 16943 "sites" 16944 ], 16945 "properties": { 16946 "all": { 16947 "type": "boolean" 16948 }, 16949 "sites": { 16950 "type": "array", 16951 "items": { 16952 "type": "string" 16953 } 16954 } 16955 } 16956 }, 16957 "peerSite": { 16958 "type": "object", 16959 "properties": { 16960 "accessKey": { 16961 "type": "string" 16962 }, 16963 "endpoint": { 16964 "type": "string" 16965 }, 16966 "name": { 16967 "type": "string" 16968 }, 16969 "secretKey": { 16970 "type": "string" 16971 } 16972 } 16973 }, 16974 "peerSiteEditResponse": { 16975 "type": "object", 16976 "properties": { 16977 "errorDetail": { 16978 "type": "string" 16979 }, 16980 "status": { 16981 "type": "string" 16982 }, 16983 "success": { 16984 "type": "boolean" 16985 } 16986 } 16987 }, 16988 "peerSiteRemoveResponse": { 16989 "type": "object", 16990 "properties": { 16991 "errorDetail": { 16992 "type": "string" 16993 }, 16994 "status": { 16995 "type": "string" 16996 } 16997 } 16998 }, 16999 "permissionResource": { 17000 "type": "object", 17001 "properties": { 17002 "conditionOperator": { 17003 "type": "string" 17004 }, 17005 "prefixes": { 17006 "type": "array", 17007 "items": { 17008 "type": "string" 17009 } 17010 }, 17011 "resource": { 17012 "type": "string" 17013 } 17014 } 17015 }, 17016 "policy": { 17017 "type": "object", 17018 "properties": { 17019 "name": { 17020 "type": "string" 17021 }, 17022 "policy": { 17023 "type": "string" 17024 } 17025 } 17026 }, 17027 "policyArgs": { 17028 "type": "object", 17029 "properties": { 17030 "action": { 17031 "type": "string" 17032 }, 17033 "bucket_name": { 17034 "type": "string" 17035 }, 17036 "id": { 17037 "type": "string" 17038 } 17039 } 17040 }, 17041 "policyEntity": { 17042 "type": "string", 17043 "default": "user", 17044 "enum": [ 17045 "user", 17046 "group" 17047 ] 17048 }, 17049 "prefixAccessPair": { 17050 "type": "object", 17051 "properties": { 17052 "access": { 17053 "type": "string" 17054 }, 17055 "prefix": { 17056 "type": "string" 17057 } 17058 } 17059 }, 17060 "prefixWrapper": { 17061 "type": "object", 17062 "properties": { 17063 "prefix": { 17064 "type": "string" 17065 } 17066 } 17067 }, 17068 "principal": { 17069 "type": "object", 17070 "properties": { 17071 "STSAccessKeyID": { 17072 "type": "string" 17073 }, 17074 "STSSecretAccessKey": { 17075 "type": "string" 17076 }, 17077 "STSSessionToken": { 17078 "type": "string" 17079 }, 17080 "accountAccessKey": { 17081 "type": "string" 17082 }, 17083 "customStyleOb": { 17084 "type": "string" 17085 }, 17086 "hm": { 17087 "type": "boolean" 17088 }, 17089 "ob": { 17090 "type": "boolean" 17091 } 17092 } 17093 }, 17094 "profilingStartRequest": { 17095 "type": "object", 17096 "required": [ 17097 "type" 17098 ], 17099 "properties": { 17100 "type": { 17101 "type": "string" 17102 } 17103 } 17104 }, 17105 "putBucketRetentionRequest": { 17106 "type": "object", 17107 "required": [ 17108 "mode", 17109 "unit", 17110 "validity" 17111 ], 17112 "properties": { 17113 "mode": { 17114 "$ref": "#/definitions/objectRetentionMode" 17115 }, 17116 "unit": { 17117 "$ref": "#/definitions/objectRetentionUnit" 17118 }, 17119 "validity": { 17120 "type": "integer", 17121 "format": "int32" 17122 } 17123 } 17124 }, 17125 "putBucketTagsRequest": { 17126 "type": "object", 17127 "properties": { 17128 "tags": { 17129 "additionalProperties": { 17130 "type": "string" 17131 } 17132 } 17133 } 17134 }, 17135 "putObjectLegalHoldRequest": { 17136 "type": "object", 17137 "required": [ 17138 "status" 17139 ], 17140 "properties": { 17141 "status": { 17142 "$ref": "#/definitions/objectLegalHoldStatus" 17143 } 17144 } 17145 }, 17146 "putObjectRetentionRequest": { 17147 "type": "object", 17148 "required": [ 17149 "mode", 17150 "expires" 17151 ], 17152 "properties": { 17153 "expires": { 17154 "type": "string" 17155 }, 17156 "governance_bypass": { 17157 "type": "boolean" 17158 }, 17159 "mode": { 17160 "$ref": "#/definitions/objectRetentionMode" 17161 } 17162 } 17163 }, 17164 "putObjectTagsRequest": { 17165 "type": "object", 17166 "properties": { 17167 "tags": { 17168 "additionalProperties": { 17169 "type": "string" 17170 } 17171 } 17172 } 17173 }, 17174 "redirectRule": { 17175 "type": "object", 17176 "properties": { 17177 "displayName": { 17178 "type": "string" 17179 }, 17180 "redirect": { 17181 "type": "string" 17182 }, 17183 "serviceType": { 17184 "type": "string" 17185 } 17186 } 17187 }, 17188 "releaseAuthor": { 17189 "type": "object", 17190 "properties": { 17191 "avatar_url": { 17192 "type": "string" 17193 }, 17194 "events_url": { 17195 "type": "string" 17196 }, 17197 "followers_url": { 17198 "type": "string" 17199 }, 17200 "following_url": { 17201 "type": "string" 17202 }, 17203 "gists_url": { 17204 "type": "string" 17205 }, 17206 "gravatar_id": { 17207 "type": "string" 17208 }, 17209 "html_url": { 17210 "type": "string" 17211 }, 17212 "id": { 17213 "type": "integer" 17214 }, 17215 "login": { 17216 "type": "string" 17217 }, 17218 "node_id": { 17219 "type": "string" 17220 }, 17221 "organizations_url": { 17222 "type": "string" 17223 }, 17224 "receivedEvents_url": { 17225 "type": "string" 17226 }, 17227 "repos_url": { 17228 "type": "string" 17229 }, 17230 "site_admin": { 17231 "type": "boolean" 17232 }, 17233 "starred_url": { 17234 "type": "string" 17235 }, 17236 "subscriptions_url": { 17237 "type": "string" 17238 }, 17239 "type": { 17240 "type": "string" 17241 }, 17242 "url": { 17243 "type": "string" 17244 } 17245 } 17246 }, 17247 "releaseInfo": { 17248 "type": "object", 17249 "properties": { 17250 "breakingChangesContent": { 17251 "type": "string" 17252 }, 17253 "contextContent": { 17254 "type": "string" 17255 }, 17256 "metadata": { 17257 "$ref": "#/definitions/releaseMetadata" 17258 }, 17259 "newFeaturesContent": { 17260 "type": "string" 17261 }, 17262 "notesContent": { 17263 "type": "string" 17264 }, 17265 "securityContent": { 17266 "type": "string" 17267 } 17268 } 17269 }, 17270 "releaseListResponse": { 17271 "type": "object", 17272 "properties": { 17273 "results": { 17274 "type": "array", 17275 "items": { 17276 "$ref": "#/definitions/releaseInfo" 17277 } 17278 } 17279 } 17280 }, 17281 "releaseMetadata": { 17282 "type": "object", 17283 "properties": { 17284 "assets_url": { 17285 "type": "string" 17286 }, 17287 "author": { 17288 "$ref": "#/definitions/releaseAuthor" 17289 }, 17290 "created_at": { 17291 "type": "string" 17292 }, 17293 "draft": { 17294 "type": "boolean" 17295 }, 17296 "html_url": { 17297 "type": "string" 17298 }, 17299 "id": { 17300 "type": "integer" 17301 }, 17302 "name": { 17303 "type": "string" 17304 }, 17305 "node_id": { 17306 "type": "string" 17307 }, 17308 "prerelease": { 17309 "type": "boolean" 17310 }, 17311 "published_at": { 17312 "type": "string" 17313 }, 17314 "tag_name": { 17315 "type": "string" 17316 }, 17317 "tarball_url": { 17318 "type": "string" 17319 }, 17320 "target_commitish": { 17321 "type": "string" 17322 }, 17323 "upload_url": { 17324 "type": "string" 17325 }, 17326 "url": { 17327 "type": "string" 17328 }, 17329 "zipball_url": { 17330 "type": "string" 17331 } 17332 } 17333 }, 17334 "remoteBucket": { 17335 "type": "object", 17336 "required": [ 17337 "accessKey", 17338 "sourceBucket", 17339 "remoteARN" 17340 ], 17341 "properties": { 17342 "accessKey": { 17343 "type": "string", 17344 "minLength": 3 17345 }, 17346 "bandwidth": { 17347 "type": "integer", 17348 "format": "int64" 17349 }, 17350 "healthCheckPeriod": { 17351 "type": "integer" 17352 }, 17353 "remoteARN": { 17354 "type": "string" 17355 }, 17356 "secretKey": { 17357 "type": "string", 17358 "minLength": 8 17359 }, 17360 "service": { 17361 "type": "string", 17362 "enum": [ 17363 "replication" 17364 ] 17365 }, 17366 "sourceBucket": { 17367 "type": "string" 17368 }, 17369 "status": { 17370 "type": "string" 17371 }, 17372 "syncMode": { 17373 "type": "string" 17374 }, 17375 "targetBucket": { 17376 "type": "string" 17377 }, 17378 "targetURL": { 17379 "type": "string" 17380 } 17381 } 17382 }, 17383 "resultTarget": { 17384 "type": "object", 17385 "properties": { 17386 "legendFormat": { 17387 "type": "string" 17388 }, 17389 "result": { 17390 "type": "array", 17391 "items": { 17392 "$ref": "#/definitions/widgetResult" 17393 } 17394 }, 17395 "resultType": { 17396 "type": "string" 17397 } 17398 } 17399 }, 17400 "rewindItem": { 17401 "type": "object", 17402 "properties": { 17403 "action": { 17404 "type": "string" 17405 }, 17406 "delete_flag": { 17407 "type": "boolean" 17408 }, 17409 "is_latest": { 17410 "type": "boolean" 17411 }, 17412 "last_modified": { 17413 "type": "string" 17414 }, 17415 "name": { 17416 "type": "string" 17417 }, 17418 "size": { 17419 "type": "integer", 17420 "format": "int64" 17421 }, 17422 "version_id": { 17423 "type": "string" 17424 } 17425 } 17426 }, 17427 "rewindResponse": { 17428 "type": "object", 17429 "properties": { 17430 "objects": { 17431 "type": "array", 17432 "items": { 17433 "$ref": "#/definitions/rewindItem" 17434 } 17435 } 17436 } 17437 }, 17438 "selectedSAs": { 17439 "type": "array", 17440 "items": { 17441 "type": "string" 17442 } 17443 }, 17444 "selectedUsers": { 17445 "type": "array", 17446 "items": { 17447 "type": "string" 17448 } 17449 }, 17450 "serverDrives": { 17451 "type": "object", 17452 "properties": { 17453 "availableSpace": { 17454 "type": "integer" 17455 }, 17456 "drivePath": { 17457 "type": "string" 17458 }, 17459 "endpoint": { 17460 "type": "string" 17461 }, 17462 "healing": { 17463 "type": "boolean" 17464 }, 17465 "model": { 17466 "type": "string" 17467 }, 17468 "rootDisk": { 17469 "type": "boolean" 17470 }, 17471 "state": { 17472 "type": "string" 17473 }, 17474 "totalSpace": { 17475 "type": "integer" 17476 }, 17477 "usedSpace": { 17478 "type": "integer" 17479 }, 17480 "uuid": { 17481 "type": "string" 17482 } 17483 } 17484 }, 17485 "serverProperties": { 17486 "type": "object", 17487 "properties": { 17488 "commitID": { 17489 "type": "string" 17490 }, 17491 "drives": { 17492 "type": "array", 17493 "items": { 17494 "$ref": "#/definitions/serverDrives" 17495 } 17496 }, 17497 "endpoint": { 17498 "type": "string" 17499 }, 17500 "network": { 17501 "type": "object", 17502 "additionalProperties": { 17503 "type": "string" 17504 } 17505 }, 17506 "poolNumber": { 17507 "type": "integer" 17508 }, 17509 "state": { 17510 "type": "string" 17511 }, 17512 "uptime": { 17513 "type": "integer" 17514 }, 17515 "version": { 17516 "type": "string" 17517 } 17518 } 17519 }, 17520 "serviceAccount": { 17521 "type": "object", 17522 "properties": { 17523 "accountStatus": { 17524 "type": "string" 17525 }, 17526 "description": { 17527 "type": "string" 17528 }, 17529 "expiration": { 17530 "type": "string" 17531 }, 17532 "impliedPolicy": { 17533 "type": "boolean" 17534 }, 17535 "name": { 17536 "type": "string" 17537 }, 17538 "parentUser": { 17539 "type": "string" 17540 }, 17541 "policy": { 17542 "type": "string" 17543 } 17544 } 17545 }, 17546 "serviceAccountCreds": { 17547 "type": "object", 17548 "properties": { 17549 "accessKey": { 17550 "type": "string" 17551 }, 17552 "secretKey": { 17553 "type": "string" 17554 }, 17555 "url": { 17556 "type": "string" 17557 } 17558 } 17559 }, 17560 "serviceAccountRequest": { 17561 "type": "object", 17562 "properties": { 17563 "comment": { 17564 "type": "string" 17565 }, 17566 "description": { 17567 "type": "string" 17568 }, 17569 "expiry": { 17570 "type": "string" 17571 }, 17572 "name": { 17573 "type": "string" 17574 }, 17575 "policy": { 17576 "type": "string", 17577 "title": "policy to be applied to the Service Account if any" 17578 } 17579 } 17580 }, 17581 "serviceAccountRequestCreds": { 17582 "type": "object", 17583 "properties": { 17584 "accessKey": { 17585 "type": "string" 17586 }, 17587 "comment": { 17588 "type": "string" 17589 }, 17590 "description": { 17591 "type": "string" 17592 }, 17593 "expiry": { 17594 "type": "string" 17595 }, 17596 "name": { 17597 "type": "string" 17598 }, 17599 "policy": { 17600 "type": "string", 17601 "title": "policy to be applied to the Service Account if any" 17602 }, 17603 "secretKey": { 17604 "type": "string" 17605 } 17606 } 17607 }, 17608 "serviceAccounts": { 17609 "type": "array", 17610 "items": { 17611 "$ref": "#/definitions/ServiceAccountsItems0" 17612 } 17613 }, 17614 "sessionResponse": { 17615 "type": "object", 17616 "properties": { 17617 "allowResources": { 17618 "type": "array", 17619 "items": { 17620 "$ref": "#/definitions/permissionResource" 17621 } 17622 }, 17623 "customStyles": { 17624 "type": "string" 17625 }, 17626 "distributedMode": { 17627 "type": "boolean" 17628 }, 17629 "envConstants": { 17630 "$ref": "#/definitions/environmentConstants" 17631 }, 17632 "features": { 17633 "type": "array", 17634 "items": { 17635 "type": "string" 17636 } 17637 }, 17638 "operator": { 17639 "type": "boolean" 17640 }, 17641 "permissions": { 17642 "type": "object", 17643 "additionalProperties": { 17644 "type": "array", 17645 "items": { 17646 "type": "string" 17647 } 17648 } 17649 }, 17650 "serverEndPoint": { 17651 "type": "string" 17652 }, 17653 "status": { 17654 "type": "string", 17655 "enum": [ 17656 "ok" 17657 ] 17658 } 17659 } 17660 }, 17661 "setBucketPolicyRequest": { 17662 "type": "object", 17663 "required": [ 17664 "access" 17665 ], 17666 "properties": { 17667 "access": { 17668 "$ref": "#/definitions/bucketAccess" 17669 }, 17670 "definition": { 17671 "type": "string" 17672 } 17673 } 17674 }, 17675 "setBucketQuota": { 17676 "type": "object", 17677 "required": [ 17678 "enabled" 17679 ], 17680 "properties": { 17681 "amount": { 17682 "type": "integer" 17683 }, 17684 "enabled": { 17685 "type": "boolean" 17686 }, 17687 "quota_type": { 17688 "type": "string", 17689 "enum": [ 17690 "hard" 17691 ] 17692 } 17693 } 17694 }, 17695 "setBucketVersioning": { 17696 "type": "object", 17697 "properties": { 17698 "enabled": { 17699 "type": "boolean" 17700 }, 17701 "excludeFolders": { 17702 "type": "boolean" 17703 }, 17704 "excludePrefixes": { 17705 "type": "array", 17706 "maxLength": 10, 17707 "items": { 17708 "type": "string" 17709 } 17710 } 17711 } 17712 }, 17713 "setConfigRequest": { 17714 "type": "object", 17715 "required": [ 17716 "key_values" 17717 ], 17718 "properties": { 17719 "arn_resource_id": { 17720 "type": "string", 17721 "title": "Used if configuration is an event notification's target" 17722 }, 17723 "key_values": { 17724 "type": "array", 17725 "minItems": 1, 17726 "items": { 17727 "$ref": "#/definitions/configurationKV" 17728 } 17729 } 17730 } 17731 }, 17732 "setConfigResponse": { 17733 "type": "object", 17734 "properties": { 17735 "restart": { 17736 "description": "Returns wheter server needs to restart to apply changes or not", 17737 "type": "boolean" 17738 } 17739 } 17740 }, 17741 "setIDPResponse": { 17742 "type": "object", 17743 "properties": { 17744 "restart": { 17745 "type": "boolean" 17746 } 17747 } 17748 }, 17749 "setNotificationEndpointResponse": { 17750 "type": "object", 17751 "required": [ 17752 "service", 17753 "account_id", 17754 "properties" 17755 ], 17756 "properties": { 17757 "account_id": { 17758 "type": "string" 17759 }, 17760 "properties": { 17761 "type": "object", 17762 "additionalProperties": { 17763 "type": "string" 17764 } 17765 }, 17766 "restart": { 17767 "type": "boolean" 17768 }, 17769 "service": { 17770 "$ref": "#/definitions/nofiticationService" 17771 } 17772 } 17773 }, 17774 "setPolicyMultipleNameRequest": { 17775 "type": "object", 17776 "properties": { 17777 "groups": { 17778 "type": "array", 17779 "items": { 17780 "$ref": "#/definitions/iamEntity" 17781 } 17782 }, 17783 "name": { 17784 "type": "array", 17785 "items": { 17786 "type": "string" 17787 } 17788 }, 17789 "users": { 17790 "type": "array", 17791 "items": { 17792 "$ref": "#/definitions/iamEntity" 17793 } 17794 } 17795 } 17796 }, 17797 "setPolicyNameRequest": { 17798 "type": "object", 17799 "required": [ 17800 "name", 17801 "entityType", 17802 "entityName" 17803 ], 17804 "properties": { 17805 "entityName": { 17806 "type": "string" 17807 }, 17808 "entityType": { 17809 "$ref": "#/definitions/policyEntity" 17810 }, 17811 "name": { 17812 "type": "array", 17813 "items": { 17814 "type": "string" 17815 } 17816 } 17817 } 17818 }, 17819 "setPolicyRequest": { 17820 "type": "object", 17821 "required": [ 17822 "entityType", 17823 "entityName" 17824 ], 17825 "properties": { 17826 "entityName": { 17827 "type": "string" 17828 }, 17829 "entityType": { 17830 "$ref": "#/definitions/policyEntity" 17831 } 17832 } 17833 }, 17834 "siteReplicationAddRequest": { 17835 "type": "array", 17836 "items": { 17837 "$ref": "#/definitions/peerSite" 17838 } 17839 }, 17840 "siteReplicationAddResponse": { 17841 "type": "object", 17842 "properties": { 17843 "errorDetail": { 17844 "type": "string" 17845 }, 17846 "initialSyncErrorMessage": { 17847 "type": "string" 17848 }, 17849 "status": { 17850 "type": "string" 17851 }, 17852 "success": { 17853 "type": "boolean" 17854 } 17855 } 17856 }, 17857 "siteReplicationInfoResponse": { 17858 "type": "object", 17859 "properties": { 17860 "enabled": { 17861 "type": "boolean" 17862 }, 17863 "name": { 17864 "type": "string" 17865 }, 17866 "serviceAccountAccessKey": { 17867 "type": "string" 17868 }, 17869 "sites": { 17870 "type": "array", 17871 "items": { 17872 "$ref": "#/definitions/peerInfo" 17873 } 17874 } 17875 } 17876 }, 17877 "siteReplicationStatusResponse": { 17878 "type": "object", 17879 "properties": { 17880 "bucketStats": { 17881 "type": "object" 17882 }, 17883 "enabled": { 17884 "type": "boolean" 17885 }, 17886 "groupStats": { 17887 "type": "object" 17888 }, 17889 "maxBuckets": { 17890 "type": "integer" 17891 }, 17892 "maxGroups": { 17893 "type": "integer" 17894 }, 17895 "maxPolicies": { 17896 "type": "integer" 17897 }, 17898 "maxUsers": { 17899 "type": "integer" 17900 }, 17901 "policyStats": { 17902 "type": "object" 17903 }, 17904 "sites": { 17905 "type": "object" 17906 }, 17907 "statsSummary": { 17908 "type": "object" 17909 }, 17910 "userStats": { 17911 "type": "object" 17912 } 17913 } 17914 }, 17915 "startProfilingItem": { 17916 "type": "object", 17917 "properties": { 17918 "error": { 17919 "type": "string" 17920 }, 17921 "nodeName": { 17922 "type": "string" 17923 }, 17924 "success": { 17925 "type": "boolean" 17926 } 17927 } 17928 }, 17929 "startProfilingList": { 17930 "type": "object", 17931 "properties": { 17932 "startResults": { 17933 "type": "array", 17934 "items": { 17935 "$ref": "#/definitions/startProfilingItem" 17936 } 17937 }, 17938 "total": { 17939 "type": "integer", 17940 "format": "int64", 17941 "title": "number of start results" 17942 } 17943 } 17944 }, 17945 "subnetLoginMFARequest": { 17946 "type": "object", 17947 "required": [ 17948 "username", 17949 "otp", 17950 "mfa_token" 17951 ], 17952 "properties": { 17953 "mfa_token": { 17954 "type": "string" 17955 }, 17956 "otp": { 17957 "type": "string" 17958 }, 17959 "username": { 17960 "type": "string" 17961 } 17962 } 17963 }, 17964 "subnetLoginRequest": { 17965 "type": "object", 17966 "properties": { 17967 "apiKey": { 17968 "type": "string" 17969 }, 17970 "password": { 17971 "type": "string" 17972 }, 17973 "username": { 17974 "type": "string" 17975 } 17976 } 17977 }, 17978 "subnetLoginResponse": { 17979 "type": "object", 17980 "properties": { 17981 "access_token": { 17982 "type": "string" 17983 }, 17984 "mfa_token": { 17985 "type": "string" 17986 }, 17987 "organizations": { 17988 "type": "array", 17989 "items": { 17990 "$ref": "#/definitions/subnetOrganization" 17991 } 17992 }, 17993 "registered": { 17994 "type": "boolean" 17995 } 17996 } 17997 }, 17998 "subnetOrganization": { 17999 "type": "object", 18000 "properties": { 18001 "accountId": { 18002 "type": "integer" 18003 }, 18004 "company": { 18005 "type": "string" 18006 }, 18007 "isAccountOwner": { 18008 "type": "boolean" 18009 }, 18010 "shortName": { 18011 "type": "string" 18012 }, 18013 "subscriptionStatus": { 18014 "type": "string" 18015 }, 18016 "userId": { 18017 "type": "integer" 18018 } 18019 } 18020 }, 18021 "subnetRegisterRequest": { 18022 "type": "object", 18023 "required": [ 18024 "token", 18025 "account_id" 18026 ], 18027 "properties": { 18028 "account_id": { 18029 "type": "string" 18030 }, 18031 "token": { 18032 "type": "string" 18033 } 18034 } 18035 }, 18036 "tier": { 18037 "type": "object", 18038 "properties": { 18039 "azure": { 18040 "type": "object", 18041 "$ref": "#/definitions/tier_azure" 18042 }, 18043 "gcs": { 18044 "type": "object", 18045 "$ref": "#/definitions/tier_gcs" 18046 }, 18047 "minio": { 18048 "type": "object", 18049 "$ref": "#/definitions/tier_minio" 18050 }, 18051 "s3": { 18052 "type": "object", 18053 "$ref": "#/definitions/tier_s3" 18054 }, 18055 "status": { 18056 "type": "boolean" 18057 }, 18058 "type": { 18059 "type": "string", 18060 "enum": [ 18061 "s3", 18062 "gcs", 18063 "azure", 18064 "minio", 18065 "unsupported" 18066 ] 18067 } 18068 } 18069 }, 18070 "tierCredentialsRequest": { 18071 "type": "object", 18072 "properties": { 18073 "access_key": { 18074 "type": "string" 18075 }, 18076 "creds": { 18077 "description": "a base64 encoded value", 18078 "type": "string" 18079 }, 18080 "secret_key": { 18081 "type": "string" 18082 } 18083 } 18084 }, 18085 "tierListResponse": { 18086 "type": "object", 18087 "properties": { 18088 "items": { 18089 "type": "array", 18090 "items": { 18091 "$ref": "#/definitions/tier" 18092 } 18093 } 18094 } 18095 }, 18096 "tier_azure": { 18097 "type": "object", 18098 "properties": { 18099 "accountkey": { 18100 "type": "string" 18101 }, 18102 "accountname": { 18103 "type": "string" 18104 }, 18105 "bucket": { 18106 "type": "string" 18107 }, 18108 "endpoint": { 18109 "type": "string" 18110 }, 18111 "name": { 18112 "type": "string" 18113 }, 18114 "objects": { 18115 "type": "string" 18116 }, 18117 "prefix": { 18118 "type": "string" 18119 }, 18120 "region": { 18121 "type": "string" 18122 }, 18123 "usage": { 18124 "type": "string" 18125 }, 18126 "versions": { 18127 "type": "string" 18128 } 18129 } 18130 }, 18131 "tier_gcs": { 18132 "type": "object", 18133 "properties": { 18134 "bucket": { 18135 "type": "string" 18136 }, 18137 "creds": { 18138 "type": "string" 18139 }, 18140 "endpoint": { 18141 "type": "string" 18142 }, 18143 "name": { 18144 "type": "string" 18145 }, 18146 "objects": { 18147 "type": "string" 18148 }, 18149 "prefix": { 18150 "type": "string" 18151 }, 18152 "region": { 18153 "type": "string" 18154 }, 18155 "usage": { 18156 "type": "string" 18157 }, 18158 "versions": { 18159 "type": "string" 18160 } 18161 } 18162 }, 18163 "tier_minio": { 18164 "type": "object", 18165 "properties": { 18166 "accesskey": { 18167 "type": "string" 18168 }, 18169 "bucket": { 18170 "type": "string" 18171 }, 18172 "endpoint": { 18173 "type": "string" 18174 }, 18175 "name": { 18176 "type": "string" 18177 }, 18178 "objects": { 18179 "type": "string" 18180 }, 18181 "prefix": { 18182 "type": "string" 18183 }, 18184 "region": { 18185 "type": "string" 18186 }, 18187 "secretkey": { 18188 "type": "string" 18189 }, 18190 "storageclass": { 18191 "type": "string" 18192 }, 18193 "usage": { 18194 "type": "string" 18195 }, 18196 "versions": { 18197 "type": "string" 18198 } 18199 } 18200 }, 18201 "tier_s3": { 18202 "type": "object", 18203 "properties": { 18204 "accesskey": { 18205 "type": "string" 18206 }, 18207 "bucket": { 18208 "type": "string" 18209 }, 18210 "endpoint": { 18211 "type": "string" 18212 }, 18213 "name": { 18214 "type": "string" 18215 }, 18216 "objects": { 18217 "type": "string" 18218 }, 18219 "prefix": { 18220 "type": "string" 18221 }, 18222 "region": { 18223 "type": "string" 18224 }, 18225 "secretkey": { 18226 "type": "string" 18227 }, 18228 "storageclass": { 18229 "type": "string" 18230 }, 18231 "usage": { 18232 "type": "string" 18233 }, 18234 "versions": { 18235 "type": "string" 18236 } 18237 } 18238 }, 18239 "transitionResponse": { 18240 "type": "object", 18241 "properties": { 18242 "date": { 18243 "type": "string" 18244 }, 18245 "days": { 18246 "type": "integer", 18247 "format": "int64" 18248 }, 18249 "noncurrent_storage_class": { 18250 "type": "string" 18251 }, 18252 "noncurrent_transition_days": { 18253 "type": "integer", 18254 "format": "int64" 18255 }, 18256 "storage_class": { 18257 "type": "string" 18258 } 18259 } 18260 }, 18261 "updateBucketLifecycle": { 18262 "type": "object", 18263 "required": [ 18264 "type" 18265 ], 18266 "properties": { 18267 "disable": { 18268 "description": "Non required, toggle to disable or enable rule", 18269 "type": "boolean" 18270 }, 18271 "expired_object_delete_all": { 18272 "description": "Non required, toggle to disable or enable rule", 18273 "type": "boolean" 18274 }, 18275 "expired_object_delete_marker": { 18276 "description": "Non required, toggle to disable or enable rule", 18277 "type": "boolean" 18278 }, 18279 "expiry_days": { 18280 "description": "Required in case of expiry_date or transition fields are not set. it defines an expiry days for ILM", 18281 "type": "integer", 18282 "format": "int32", 18283 "default": 0 18284 }, 18285 "noncurrentversion_expiration_days": { 18286 "description": "Non required, can be set in case of expiration is enabled", 18287 "type": "integer", 18288 "format": "int32", 18289 "default": 0 18290 }, 18291 "noncurrentversion_transition_days": { 18292 "description": "Non required, can be set in case of transition is enabled", 18293 "type": "integer", 18294 "format": "int32", 18295 "default": 0 18296 }, 18297 "noncurrentversion_transition_storage_class": { 18298 "description": "Non required, can be set in case of transition is enabled", 18299 "type": "string" 18300 }, 18301 "prefix": { 18302 "description": "Non required field, it matches a prefix to perform ILM operations on it", 18303 "type": "string" 18304 }, 18305 "storage_class": { 18306 "description": "Required only in case of transition is set. it refers to a tier", 18307 "type": "string" 18308 }, 18309 "tags": { 18310 "description": "Non required field, tags to match ILM files", 18311 "type": "string" 18312 }, 18313 "transition_days": { 18314 "description": "Required in case of transition_date or expiry fields are not set. it defines a transition days for ILM", 18315 "type": "integer", 18316 "format": "int32", 18317 "default": 0 18318 }, 18319 "type": { 18320 "description": "ILM Rule type (Expiry or transition)", 18321 "type": "string", 18322 "enum": [ 18323 "expiry", 18324 "transition" 18325 ] 18326 } 18327 } 18328 }, 18329 "updateGroupRequest": { 18330 "type": "object", 18331 "required": [ 18332 "members", 18333 "status" 18334 ], 18335 "properties": { 18336 "members": { 18337 "type": "array", 18338 "items": { 18339 "type": "string" 18340 } 18341 }, 18342 "status": { 18343 "type": "string" 18344 } 18345 } 18346 }, 18347 "updateServiceAccountRequest": { 18348 "type": "object", 18349 "required": [ 18350 "policy" 18351 ], 18352 "properties": { 18353 "description": { 18354 "type": "string" 18355 }, 18356 "expiry": { 18357 "type": "string" 18358 }, 18359 "name": { 18360 "type": "string" 18361 }, 18362 "policy": { 18363 "type": "string" 18364 }, 18365 "secretKey": { 18366 "type": "string" 18367 }, 18368 "status": { 18369 "type": "string" 18370 } 18371 } 18372 }, 18373 "updateUser": { 18374 "type": "object", 18375 "required": [ 18376 "status", 18377 "groups" 18378 ], 18379 "properties": { 18380 "groups": { 18381 "type": "array", 18382 "items": { 18383 "type": "string" 18384 } 18385 }, 18386 "status": { 18387 "type": "string" 18388 } 18389 } 18390 }, 18391 "updateUserGroups": { 18392 "type": "object", 18393 "required": [ 18394 "groups" 18395 ], 18396 "properties": { 18397 "groups": { 18398 "type": "array", 18399 "items": { 18400 "type": "string" 18401 } 18402 } 18403 } 18404 }, 18405 "user": { 18406 "type": "object", 18407 "properties": { 18408 "accessKey": { 18409 "type": "string" 18410 }, 18411 "hasPolicy": { 18412 "type": "boolean" 18413 }, 18414 "memberOf": { 18415 "type": "array", 18416 "items": { 18417 "type": "string" 18418 } 18419 }, 18420 "policy": { 18421 "type": "array", 18422 "items": { 18423 "type": "string" 18424 } 18425 }, 18426 "status": { 18427 "type": "string" 18428 } 18429 } 18430 }, 18431 "userSAs": { 18432 "type": "object", 18433 "properties": { 18434 "path": { 18435 "type": "string" 18436 }, 18437 "recursive": { 18438 "type": "boolean" 18439 }, 18440 "versionID": { 18441 "type": "string" 18442 } 18443 } 18444 }, 18445 "userServiceAccountItem": { 18446 "type": "object", 18447 "properties": { 18448 "numSAs": { 18449 "type": "integer", 18450 "format": "int64" 18451 }, 18452 "userName": { 18453 "type": "string" 18454 } 18455 } 18456 }, 18457 "userServiceAccountSummary": { 18458 "type": "object", 18459 "properties": { 18460 "hasSA": { 18461 "type": "boolean" 18462 }, 18463 "userServiceAccountList": { 18464 "type": "array", 18465 "title": "list of users with number of service accounts", 18466 "items": { 18467 "$ref": "#/definitions/userServiceAccountItem" 18468 } 18469 } 18470 } 18471 }, 18472 "widget": { 18473 "type": "object", 18474 "properties": { 18475 "id": { 18476 "type": "integer", 18477 "format": "int32" 18478 }, 18479 "options": { 18480 "type": "object", 18481 "properties": { 18482 "reduceOptions": { 18483 "type": "object", 18484 "properties": { 18485 "calcs": { 18486 "type": "array", 18487 "items": { 18488 "type": "string" 18489 } 18490 } 18491 } 18492 } 18493 } 18494 }, 18495 "targets": { 18496 "type": "array", 18497 "items": { 18498 "$ref": "#/definitions/resultTarget" 18499 } 18500 }, 18501 "title": { 18502 "type": "string" 18503 }, 18504 "type": { 18505 "type": "string" 18506 } 18507 } 18508 }, 18509 "widgetDetails": { 18510 "type": "object", 18511 "properties": { 18512 "id": { 18513 "type": "integer", 18514 "format": "int32" 18515 }, 18516 "options": { 18517 "type": "object", 18518 "properties": { 18519 "reduceOptions": { 18520 "type": "object", 18521 "properties": { 18522 "calcs": { 18523 "type": "array", 18524 "items": { 18525 "type": "string" 18526 } 18527 } 18528 } 18529 } 18530 } 18531 }, 18532 "targets": { 18533 "type": "array", 18534 "items": { 18535 "$ref": "#/definitions/resultTarget" 18536 } 18537 }, 18538 "title": { 18539 "type": "string" 18540 }, 18541 "type": { 18542 "type": "string" 18543 } 18544 } 18545 }, 18546 "widgetResult": { 18547 "type": "object", 18548 "properties": { 18549 "metric": { 18550 "type": "object", 18551 "additionalProperties": { 18552 "type": "string" 18553 } 18554 }, 18555 "values": { 18556 "type": "array", 18557 "items": {} 18558 } 18559 } 18560 } 18561 }, 18562 "parameters": { 18563 "limit": { 18564 "type": "number", 18565 "format": "int32", 18566 "default": 20, 18567 "name": "limit", 18568 "in": "query" 18569 }, 18570 "offset": { 18571 "type": "number", 18572 "format": "int32", 18573 "default": 0, 18574 "name": "offset", 18575 "in": "query" 18576 } 18577 }, 18578 "securityDefinitions": { 18579 "anonymous": { 18580 "type": "apiKey", 18581 "name": "X-Anonymous", 18582 "in": "header" 18583 }, 18584 "key": { 18585 "type": "oauth2", 18586 "flow": "accessCode", 18587 "authorizationUrl": "http://min.io", 18588 "tokenUrl": "http://min.io" 18589 } 18590 }, 18591 "security": [ 18592 { 18593 "key": [] 18594 } 18595 ] 18596 }`)) 18597 }