ceph/src/pybind/mgr/dashboard/openapi.yaml

   1 basePath: /
   2 components:
   3   securitySchemes:
   4     jwt:
   5       bearerFormat: JWT
   6       scheme: bearer
   7       type: http
   8 host: example.com
   9 info:
  10   description: This is the official Ceph REST API
  11   title: Ceph REST API
  12   version: v1
  13 openapi: 3.0.0
  14 paths:
  15   /api/auth:
  16     post:
  17       parameters: []
  18       requestBody:
  19         content:
  20           application/json:
  21             schema:
  22               properties:
  23                 password:
  24                   type: string
  25                 username:
  26                   type: string
  27               required:
  28               - username
  29               - password
  30               type: object
  31       responses:
  32         '201':
  33           content:
  34             application/vnd.ceph.api.v1.0+json:
  35               type: object
  36           description: Resource created.
  37         '202':
  38           content:
  39             application/vnd.ceph.api.v1.0+json:
  40               type: object
  41           description: Operation is still executing. Please check the task queue.
  42         '400':
  43           description: Operation exception. Please check the response body for details.
  44         '401':
  45           description: Unauthenticated access. Please login first.
  46         '403':
  47           description: Unauthorized access. Please check your permissions.
  48         '500':
  49           description: Unexpected error. Please check the response body for the stack
  50             trace.
  51       tags:
  52       - Auth
  53   /api/auth/check:
  54     post:
  55       parameters:
  56       - description: Authentication Token
  57         in: query
  58         name: token
  59         required: true
  60         schema:
  61           type: string
  62       requestBody:
  63         content:
  64           application/json:
  65             schema:
  66               properties:
  67                 token:
  68                   description: Authentication Token
  69                   type: string
  70               required:
  71               - token
  72               type: object
  73       responses:
  74         '201':
  75           content:
  76             application/vnd.ceph.api.v1.0+json:
  77               schema:
  78                 properties:
  79                   permissions:
  80                     description: List of permissions acquired
  81                     properties:
  82                       cephfs:
  83                         description: ''
  84                         items:
  85                           type: string
  86                         type: array
  87                     required:
  88                     - cephfs
  89                     type: object
  90                   pwdUpdateRequired:
  91                     description: Is password update required?
  92                     type: boolean
  93                   sso:
  94                     description: Uses single sign on?
  95                     type: boolean
  96                   username:
  97                     description: Username
  98                     type: string
  99                 required:
 100                 - username
 101                 - permissions
 102                 - sso
 103                 - pwdUpdateRequired
 104                 type: object
 105           description: Resource created.
 106         '202':
 107           content:
 108             application/vnd.ceph.api.v1.0+json:
 109               type: object
 110           description: Operation is still executing. Please check the task queue.
 111         '400':
 112           description: Operation exception. Please check the response body for details.
 113         '401':
 114           description: Unauthenticated access. Please login first.
 115         '403':
 116           description: Unauthorized access. Please check your permissions.
 117         '500':
 118           description: Unexpected error. Please check the response body for the stack
 119             trace.
 120       summary: Check token Authentication
 121       tags:
 122       - Auth
 123   /api/auth/logout:
 124     post:
 125       parameters: []
 126       responses:
 127         '201':
 128           content:
 129             application/vnd.ceph.api.v1.0+json:
 130               type: object
 131           description: Resource created.
 132         '202':
 133           content:
 134             application/vnd.ceph.api.v1.0+json:
 135               type: object
 136           description: Operation is still executing. Please check the task queue.
 137         '400':
 138           description: Operation exception. Please check the response body for details.
 139         '401':
 140           description: Unauthenticated access. Please login first.
 141         '403':
 142           description: Unauthorized access. Please check your permissions.
 143         '500':
 144           description: Unexpected error. Please check the response body for the stack
 145             trace.
 146       tags:
 147       - Auth
 148   /api/block/image:
 149     get:
 150       parameters:
 151       - allowEmptyValue: true
 152         description: Pool Name
 153         in: query
 154         name: pool_name
 155         schema:
 156           type: string
 157       responses:
 158         '200':
 159           content:
 160             application/vnd.ceph.api.v1.0+json:
 161               schema:
 162                 items:
 163                   properties:
 164                     pool_name:
 165                       description: pool name
 166                       type: string
 167                     status:
 168                       description: Status of the image
 169                       type: integer
 170                     value:
 171                       description: ''
 172                       items:
 173                         type: string
 174                       type: array
 175                   type: object
 176                 required:
 177                 - status
 178                 - value
 179                 - pool_name
 180                 type: array
 181           description: OK
 182         '400':
 183           description: Operation exception. Please check the response body for details.
 184         '401':
 185           description: Unauthenticated access. Please login first.
 186         '403':
 187           description: Unauthorized access. Please check your permissions.
 188         '500':
 189           description: Unexpected error. Please check the response body for the stack
 190             trace.
 191       security:
 192       - jwt: []
 193       summary: Display Rbd Images
 194       tags:
 195       - Rbd
 196     post:
 197       parameters: []
 198       requestBody:
 199         content:
 200           application/json:
 201             schema:
 202               properties:
 203                 configuration:
 204                   type: string
 205                 data_pool:
 206                   type: string
 207                 features:
 208                   type: string
 209                 name:
 210                   type: string
 211                 namespace:
 212                   type: string
 213                 obj_size:
 214                   type: integer
 215                 pool_name:
 216                   type: string
 217                 size:
 218                   type: integer
 219                 stripe_count:
 220                   type: integer
 221                 stripe_unit:
 222                   type: string
 223               required:
 224               - name
 225               - pool_name
 226               - size
 227               type: object
 228       responses:
 229         '201':
 230           content:
 231             application/vnd.ceph.api.v1.0+json:
 232               type: object
 233           description: Resource created.
 234         '202':
 235           content:
 236             application/vnd.ceph.api.v1.0+json:
 237               type: object
 238           description: Operation is still executing. Please check the task queue.
 239         '400':
 240           description: Operation exception. Please check the response body for details.
 241         '401':
 242           description: Unauthenticated access. Please login first.
 243         '403':
 244           description: Unauthorized access. Please check your permissions.
 245         '500':
 246           description: Unexpected error. Please check the response body for the stack
 247             trace.
 248       security:
 249       - jwt: []
 250       tags:
 251       - Rbd
 252   /api/block/image/clone_format_version:
 253     get:
 254       description: "Return the RBD clone format version.\n        "
 255       parameters: []
 256       responses:
 257         '200':
 258           content:
 259             application/vnd.ceph.api.v1.0+json:
 260               type: object
 261           description: OK
 262         '400':
 263           description: Operation exception. Please check the response body for details.
 264         '401':
 265           description: Unauthenticated access. Please login first.
 266         '403':
 267           description: Unauthorized access. Please check your permissions.
 268         '500':
 269           description: Unexpected error. Please check the response body for the stack
 270             trace.
 271       security:
 272       - jwt: []
 273       tags:
 274       - Rbd
 275   /api/block/image/default_features:
 276     get:
 277       parameters: []
 278       responses:
 279         '200':
 280           content:
 281             application/vnd.ceph.api.v1.0+json:
 282               type: object
 283           description: OK
 284         '400':
 285           description: Operation exception. Please check the response body for details.
 286         '401':
 287           description: Unauthenticated access. Please login first.
 288         '403':
 289           description: Unauthorized access. Please check your permissions.
 290         '500':
 291           description: Unexpected error. Please check the response body for the stack
 292             trace.
 293       security:
 294       - jwt: []
 295       tags:
 296       - Rbd
 297   /api/block/image/trash:
 298     get:
 299       description: List all entries from trash.
 300       parameters:
 301       - allowEmptyValue: true
 302         description: Name of the pool
 303         in: query
 304         name: pool_name
 305         schema:
 306           type: string
 307       responses:
 308         '200':
 309           content:
 310             application/vnd.ceph.api.v1.0+json:
 311               schema:
 312                 items:
 313                   properties:
 314                     pool_name:
 315                       description: pool name
 316                       type: string
 317                     status:
 318                       description: ''
 319                       type: integer
 320                     value:
 321                       description: ''
 322                       items:
 323                         type: string
 324                       type: array
 325                   type: object
 326                 required:
 327                 - status
 328                 - value
 329                 - pool_name
 330                 type: array
 331           description: OK
 332         '400':
 333           description: Operation exception. Please check the response body for details.
 334         '401':
 335           description: Unauthenticated access. Please login first.
 336         '403':
 337           description: Unauthorized access. Please check your permissions.
 338         '500':
 339           description: Unexpected error. Please check the response body for the stack
 340             trace.
 341       security:
 342       - jwt: []
 343       summary: Get RBD Trash Details by pool name
 344       tags:
 345       - RbdTrash
 346   /api/block/image/trash/purge:
 347     post:
 348       description: Remove all expired images from trash.
 349       parameters:
 350       - allowEmptyValue: true
 351         in: query
 352         name: pool_name
 353         schema:
 354           type: string
 355       requestBody:
 356         content:
 357           application/json:
 358             schema:
 359               properties:
 360                 pool_name:
 361                   type: string
 362               type: object
 363       responses:
 364         '201':
 365           content:
 366             application/vnd.ceph.api.v1.0+json:
 367               type: object
 368           description: Resource created.
 369         '202':
 370           content:
 371             application/vnd.ceph.api.v1.0+json:
 372               type: object
 373           description: Operation is still executing. Please check the task queue.
 374         '400':
 375           description: Operation exception. Please check the response body for details.
 376         '401':
 377           description: Unauthenticated access. Please login first.
 378         '403':
 379           description: Unauthorized access. Please check your permissions.
 380         '500':
 381           description: Unexpected error. Please check the response body for the stack
 382             trace.
 383       security:
 384       - jwt: []
 385       tags:
 386       - RbdTrash
 387   /api/block/image/trash/{image_id_spec}:
 388     delete:
 389       description: "Delete an image from trash.\n        If image deferment time has\
 390         \ not expired you can not removed it unless use force.\n        But an actively\
 391         \ in-use by clones or has snapshots can not be removed.\n        "
 392       parameters:
 393       - in: path
 394         name: image_id_spec
 395         required: true
 396         schema:
 397           type: string
 398       - default: false
 399         in: query
 400         name: force
 401         schema:
 402           type: boolean
 403       responses:
 404         '202':
 405           content:
 406             application/vnd.ceph.api.v1.0+json:
 407               type: object
 408           description: Operation is still executing. Please check the task queue.
 409         '204':
 410           content:
 411             application/vnd.ceph.api.v1.0+json:
 412               type: object
 413           description: Resource deleted.
 414         '400':
 415           description: Operation exception. Please check the response body for details.
 416         '401':
 417           description: Unauthenticated access. Please login first.
 418         '403':
 419           description: Unauthorized access. Please check your permissions.
 420         '500':
 421           description: Unexpected error. Please check the response body for the stack
 422             trace.
 423       security:
 424       - jwt: []
 425       tags:
 426       - RbdTrash
 427   /api/block/image/trash/{image_id_spec}/restore:
 428     post:
 429       description: Restore an image from trash.
 430       parameters:
 431       - in: path
 432         name: image_id_spec
 433         required: true
 434         schema:
 435           type: string
 436       requestBody:
 437         content:
 438           application/json:
 439             schema:
 440               properties:
 441                 new_image_name:
 442                   type: string
 443               required:
 444               - new_image_name
 445               type: object
 446       responses:
 447         '201':
 448           content:
 449             application/vnd.ceph.api.v1.0+json:
 450               type: object
 451           description: Resource created.
 452         '202':
 453           content:
 454             application/vnd.ceph.api.v1.0+json:
 455               type: object
 456           description: Operation is still executing. Please check the task queue.
 457         '400':
 458           description: Operation exception. Please check the response body for details.
 459         '401':
 460           description: Unauthenticated access. Please login first.
 461         '403':
 462           description: Unauthorized access. Please check your permissions.
 463         '500':
 464           description: Unexpected error. Please check the response body for the stack
 465             trace.
 466       security:
 467       - jwt: []
 468       tags:
 469       - RbdTrash
 470   /api/block/image/{image_spec}:
 471     delete:
 472       parameters:
 473       - in: path
 474         name: image_spec
 475         required: true
 476         schema:
 477           type: string
 478       responses:
 479         '202':
 480           content:
 481             application/vnd.ceph.api.v1.0+json:
 482               type: object
 483           description: Operation is still executing. Please check the task queue.
 484         '204':
 485           content:
 486             application/vnd.ceph.api.v1.0+json:
 487               type: object
 488           description: Resource deleted.
 489         '400':
 490           description: Operation exception. Please check the response body for details.
 491         '401':
 492           description: Unauthenticated access. Please login first.
 493         '403':
 494           description: Unauthorized access. Please check your permissions.
 495         '500':
 496           description: Unexpected error. Please check the response body for the stack
 497             trace.
 498       security:
 499       - jwt: []
 500       tags:
 501       - Rbd
 502     get:
 503       parameters:
 504       - in: path
 505         name: image_spec
 506         required: true
 507         schema:
 508           type: string
 509       responses:
 510         '200':
 511           content:
 512             application/vnd.ceph.api.v1.0+json:
 513               type: object
 514           description: OK
 515         '400':
 516           description: Operation exception. Please check the response body for details.
 517         '401':
 518           description: Unauthenticated access. Please login first.
 519         '403':
 520           description: Unauthorized access. Please check your permissions.
 521         '500':
 522           description: Unexpected error. Please check the response body for the stack
 523             trace.
 524       security:
 525       - jwt: []
 526       tags:
 527       - Rbd
 528     put:
 529       parameters:
 530       - in: path
 531         name: image_spec
 532         required: true
 533         schema:
 534           type: string
 535       requestBody:
 536         content:
 537           application/json:
 538             schema:
 539               properties:
 540                 configuration:
 541                   type: string
 542                 features:
 543                   type: string
 544                 name:
 545                   type: string
 546                 size:
 547                   type: integer
 548               type: object
 549       responses:
 550         '200':
 551           content:
 552             application/vnd.ceph.api.v1.0+json:
 553               type: object
 554           description: Resource updated.
 555         '202':
 556           content:
 557             application/vnd.ceph.api.v1.0+json:
 558               type: object
 559           description: Operation is still executing. Please check the task queue.
 560         '400':
 561           description: Operation exception. Please check the response body for details.
 562         '401':
 563           description: Unauthenticated access. Please login first.
 564         '403':
 565           description: Unauthorized access. Please check your permissions.
 566         '500':
 567           description: Unexpected error. Please check the response body for the stack
 568             trace.
 569       security:
 570       - jwt: []
 571       tags:
 572       - Rbd
 573   /api/block/image/{image_spec}/copy:
 574     post:
 575       parameters:
 576       - in: path
 577         name: image_spec
 578         required: true
 579         schema:
 580           type: string
 581       requestBody:
 582         content:
 583           application/json:
 584             schema:
 585               properties:
 586                 configuration:
 587                   type: string
 588                 data_pool:
 589                   type: string
 590                 dest_image_name:
 591                   type: string
 592                 dest_namespace:
 593                   type: string
 594                 dest_pool_name:
 595                   type: string
 596                 features:
 597                   type: string
 598                 obj_size:
 599                   type: integer
 600                 snapshot_name:
 601                   type: string
 602                 stripe_count:
 603                   type: integer
 604                 stripe_unit:
 605                   type: string
 606               required:
 607               - dest_pool_name
 608               - dest_namespace
 609               - dest_image_name
 610               type: object
 611       responses:
 612         '201':
 613           content:
 614             application/vnd.ceph.api.v1.0+json:
 615               type: object
 616           description: Resource created.
 617         '202':
 618           content:
 619             application/vnd.ceph.api.v1.0+json:
 620               type: object
 621           description: Operation is still executing. Please check the task queue.
 622         '400':
 623           description: Operation exception. Please check the response body for details.
 624         '401':
 625           description: Unauthenticated access. Please login first.
 626         '403':
 627           description: Unauthorized access. Please check your permissions.
 628         '500':
 629           description: Unexpected error. Please check the response body for the stack
 630             trace.
 631       security:
 632       - jwt: []
 633       tags:
 634       - Rbd
 635   /api/block/image/{image_spec}/flatten:
 636     post:
 637       parameters:
 638       - in: path
 639         name: image_spec
 640         required: true
 641         schema:
 642           type: string
 643       responses:
 644         '201':
 645           content:
 646             application/vnd.ceph.api.v1.0+json:
 647               type: object
 648           description: Resource created.
 649         '202':
 650           content:
 651             application/vnd.ceph.api.v1.0+json:
 652               type: object
 653           description: Operation is still executing. Please check the task queue.
 654         '400':
 655           description: Operation exception. Please check the response body for details.
 656         '401':
 657           description: Unauthenticated access. Please login first.
 658         '403':
 659           description: Unauthorized access. Please check your permissions.
 660         '500':
 661           description: Unexpected error. Please check the response body for the stack
 662             trace.
 663       security:
 664       - jwt: []
 665       tags:
 666       - Rbd
 667   /api/block/image/{image_spec}/move_trash:
 668     post:
 669       description: "Move an image to the trash.\n        Images, even ones actively\
 670         \ in-use by clones,\n        can be moved to the trash and deleted at a later\
 671         \ time.\n        "
 672       parameters:
 673       - in: path
 674         name: image_spec
 675         required: true
 676         schema:
 677           type: string
 678       requestBody:
 679         content:
 680           application/json:
 681             schema:
 682               properties:
 683                 delay:
 684                   default: 0
 685                   type: integer
 686               type: object
 687       responses:
 688         '201':
 689           content:
 690             application/vnd.ceph.api.v1.0+json:
 691               type: object
 692           description: Resource created.
 693         '202':
 694           content:
 695             application/vnd.ceph.api.v1.0+json:
 696               type: object
 697           description: Operation is still executing. Please check the task queue.
 698         '400':
 699           description: Operation exception. Please check the response body for details.
 700         '401':
 701           description: Unauthenticated access. Please login first.
 702         '403':
 703           description: Unauthorized access. Please check your permissions.
 704         '500':
 705           description: Unexpected error. Please check the response body for the stack
 706             trace.
 707       security:
 708       - jwt: []
 709       tags:
 710       - Rbd
 711   /api/block/image/{image_spec}/snap:
 712     post:
 713       parameters:
 714       - in: path
 715         name: image_spec
 716         required: true
 717         schema:
 718           type: string
 719       requestBody:
 720         content:
 721           application/json:
 722             schema:
 723               properties:
 724                 snapshot_name:
 725                   type: string
 726               required:
 727               - snapshot_name
 728               type: object
 729       responses:
 730         '201':
 731           content:
 732             application/vnd.ceph.api.v1.0+json:
 733               type: object
 734           description: Resource created.
 735         '202':
 736           content:
 737             application/vnd.ceph.api.v1.0+json:
 738               type: object
 739           description: Operation is still executing. Please check the task queue.
 740         '400':
 741           description: Operation exception. Please check the response body for details.
 742         '401':
 743           description: Unauthenticated access. Please login first.
 744         '403':
 745           description: Unauthorized access. Please check your permissions.
 746         '500':
 747           description: Unexpected error. Please check the response body for the stack
 748             trace.
 749       security:
 750       - jwt: []
 751       tags:
 752       - RbdSnapshot
 753   /api/block/image/{image_spec}/snap/{snapshot_name}:
 754     delete:
 755       parameters:
 756       - in: path
 757         name: image_spec
 758         required: true
 759         schema:
 760           type: string
 761       - in: path
 762         name: snapshot_name
 763         required: true
 764         schema:
 765           type: string
 766       responses:
 767         '202':
 768           content:
 769             application/vnd.ceph.api.v1.0+json:
 770               type: object
 771           description: Operation is still executing. Please check the task queue.
 772         '204':
 773           content:
 774             application/vnd.ceph.api.v1.0+json:
 775               type: object
 776           description: Resource deleted.
 777         '400':
 778           description: Operation exception. Please check the response body for details.
 779         '401':
 780           description: Unauthenticated access. Please login first.
 781         '403':
 782           description: Unauthorized access. Please check your permissions.
 783         '500':
 784           description: Unexpected error. Please check the response body for the stack
 785             trace.
 786       security:
 787       - jwt: []
 788       tags:
 789       - RbdSnapshot
 790     put:
 791       parameters:
 792       - in: path
 793         name: image_spec
 794         required: true
 795         schema:
 796           type: string
 797       - in: path
 798         name: snapshot_name
 799         required: true
 800         schema:
 801           type: string
 802       requestBody:
 803         content:
 804           application/json:
 805             schema:
 806               properties:
 807                 is_protected:
 808                   type: boolean
 809                 new_snap_name:
 810                   type: string
 811               type: object
 812       responses:
 813         '200':
 814           content:
 815             application/vnd.ceph.api.v1.0+json:
 816               type: object
 817           description: Resource updated.
 818         '202':
 819           content:
 820             application/vnd.ceph.api.v1.0+json:
 821               type: object
 822           description: Operation is still executing. Please check the task queue.
 823         '400':
 824           description: Operation exception. Please check the response body for details.
 825         '401':
 826           description: Unauthenticated access. Please login first.
 827         '403':
 828           description: Unauthorized access. Please check your permissions.
 829         '500':
 830           description: Unexpected error. Please check the response body for the stack
 831             trace.
 832       security:
 833       - jwt: []
 834       tags:
 835       - RbdSnapshot
 836   /api/block/image/{image_spec}/snap/{snapshot_name}/clone:
 837     post:
 838       description: "\n        Clones a snapshot to an image\n        "
 839       parameters:
 840       - in: path
 841         name: image_spec
 842         required: true
 843         schema:
 844           type: string
 845       - in: path
 846         name: snapshot_name
 847         required: true
 848         schema:
 849           type: string
 850       requestBody:
 851         content:
 852           application/json:
 853             schema:
 854               properties:
 855                 child_image_name:
 856                   type: string
 857                 child_namespace:
 858                   type: string
 859                 child_pool_name:
 860                   type: string
 861                 configuration:
 862                   type: string
 863                 data_pool:
 864                   type: string
 865                 features:
 866                   type: string
 867                 obj_size:
 868                   type: integer
 869                 stripe_count:
 870                   type: integer
 871                 stripe_unit:
 872                   type: string
 873               required:
 874               - child_pool_name
 875               - child_image_name
 876               type: object
 877       responses:
 878         '201':
 879           content:
 880             application/vnd.ceph.api.v1.0+json:
 881               type: object
 882           description: Resource created.
 883         '202':
 884           content:
 885             application/vnd.ceph.api.v1.0+json:
 886               type: object
 887           description: Operation is still executing. Please check the task queue.
 888         '400':
 889           description: Operation exception. Please check the response body for details.
 890         '401':
 891           description: Unauthenticated access. Please login first.
 892         '403':
 893           description: Unauthorized access. Please check your permissions.
 894         '500':
 895           description: Unexpected error. Please check the response body for the stack
 896             trace.
 897       security:
 898       - jwt: []
 899       tags:
 900       - RbdSnapshot
 901   /api/block/image/{image_spec}/snap/{snapshot_name}/rollback:
 902     post:
 903       parameters:
 904       - in: path
 905         name: image_spec
 906         required: true
 907         schema:
 908           type: string
 909       - in: path
 910         name: snapshot_name
 911         required: true
 912         schema:
 913           type: string
 914       responses:
 915         '201':
 916           content:
 917             application/vnd.ceph.api.v1.0+json:
 918               type: object
 919           description: Resource created.
 920         '202':
 921           content:
 922             application/vnd.ceph.api.v1.0+json:
 923               type: object
 924           description: Operation is still executing. Please check the task queue.
 925         '400':
 926           description: Operation exception. Please check the response body for details.
 927         '401':
 928           description: Unauthenticated access. Please login first.
 929         '403':
 930           description: Unauthorized access. Please check your permissions.
 931         '500':
 932           description: Unexpected error. Please check the response body for the stack
 933             trace.
 934       security:
 935       - jwt: []
 936       tags:
 937       - RbdSnapshot
 938   /api/block/mirroring/pool/{pool_name}:
 939     get:
 940       parameters:
 941       - description: Pool Name
 942         in: path
 943         name: pool_name
 944         required: true
 945         schema:
 946           type: string
 947       responses:
 948         '200':
 949           content:
 950             application/vnd.ceph.api.v1.0+json:
 951               schema:
 952                 properties:
 953                   mirror_mode:
 954                     description: Mirror Mode
 955                     type: string
 956                 required:
 957                 - mirror_mode
 958                 type: object
 959           description: OK
 960         '400':
 961           description: Operation exception. Please check the response body for details.
 962         '401':
 963           description: Unauthenticated access. Please login first.
 964         '403':
 965           description: Unauthorized access. Please check your permissions.
 966         '500':
 967           description: Unexpected error. Please check the response body for the stack
 968             trace.
 969       security:
 970       - jwt: []
 971       summary: Display Rbd Mirroring Summary
 972       tags:
 973       - RbdMirroringPoolMode
 974     put:
 975       parameters:
 976       - in: path
 977         name: pool_name
 978         required: true
 979         schema:
 980           type: string
 981       requestBody:
 982         content:
 983           application/json:
 984             schema:
 985               properties:
 986                 mirror_mode:
 987                   type: string
 988               type: object
 989       responses:
 990         '200':
 991           content:
 992             application/vnd.ceph.api.v1.0+json:
 993               type: object
 994           description: Resource updated.
 995         '202':
 996           content:
 997             application/vnd.ceph.api.v1.0+json:
 998               type: object
 999           description: Operation is still executing. Please check the task queue.
1000         '400':
1001           description: Operation exception. Please check the response body for details.
1002         '401':
1003           description: Unauthenticated access. Please login first.
1004         '403':
1005           description: Unauthorized access. Please check your permissions.
1006         '500':
1007           description: Unexpected error. Please check the response body for the stack
1008             trace.
1009       security:
1010       - jwt: []
1011       tags:
1012       - RbdMirroringPoolMode
1013   /api/block/mirroring/pool/{pool_name}/bootstrap/peer:
1014     post:
1015       parameters:
1016       - in: path
1017         name: pool_name
1018         required: true
1019         schema:
1020           type: string
1021       requestBody:
1022         content:
1023           application/json:
1024             schema:
1025               properties:
1026                 direction:
1027                   type: string
1028                 token:
1029                   type: string
1030               required:
1031               - direction
1032               - token
1033               type: object
1034       responses:
1035         '201':
1036           content:
1037             application/vnd.ceph.api.v1.0+json:
1038               type: object
1039           description: Resource created.
1040         '202':
1041           content:
1042             application/vnd.ceph.api.v1.0+json:
1043               type: object
1044           description: Operation is still executing. Please check the task queue.
1045         '400':
1046           description: Operation exception. Please check the response body for details.
1047         '401':
1048           description: Unauthenticated access. Please login first.
1049         '403':
1050           description: Unauthorized access. Please check your permissions.
1051         '500':
1052           description: Unexpected error. Please check the response body for the stack
1053             trace.
1054       security:
1055       - jwt: []
1056       tags:
1057       - RbdMirroringPoolBootstrap
1058   /api/block/mirroring/pool/{pool_name}/bootstrap/token:
1059     post:
1060       parameters:
1061       - in: path
1062         name: pool_name
1063         required: true
1064         schema:
1065           type: string
1066       responses:
1067         '201':
1068           content:
1069             application/vnd.ceph.api.v1.0+json:
1070               type: object
1071           description: Resource created.
1072         '202':
1073           content:
1074             application/vnd.ceph.api.v1.0+json:
1075               type: object
1076           description: Operation is still executing. Please check the task queue.
1077         '400':
1078           description: Operation exception. Please check the response body for details.
1079         '401':
1080           description: Unauthenticated access. Please login first.
1081         '403':
1082           description: Unauthorized access. Please check your permissions.
1083         '500':
1084           description: Unexpected error. Please check the response body for the stack
1085             trace.
1086       security:
1087       - jwt: []
1088       tags:
1089       - RbdMirroringPoolBootstrap
1090   /api/block/mirroring/pool/{pool_name}/peer:
1091     get:
1092       parameters:
1093       - in: path
1094         name: pool_name
1095         required: true
1096         schema:
1097           type: string
1098       responses:
1099         '200':
1100           content:
1101             application/vnd.ceph.api.v1.0+json:
1102               type: object
1103           description: OK
1104         '400':
1105           description: Operation exception. Please check the response body for details.
1106         '401':
1107           description: Unauthenticated access. Please login first.
1108         '403':
1109           description: Unauthorized access. Please check your permissions.
1110         '500':
1111           description: Unexpected error. Please check the response body for the stack
1112             trace.
1113       security:
1114       - jwt: []
1115       tags:
1116       - RbdMirroringPoolPeer
1117     post:
1118       parameters:
1119       - in: path
1120         name: pool_name
1121         required: true
1122         schema:
1123           type: string
1124       requestBody:
1125         content:
1126           application/json:
1127             schema:
1128               properties:
1129                 client_id:
1130                   type: string
1131                 cluster_name:
1132                   type: string
1133                 key:
1134                   type: string
1135                 mon_host:
1136                   type: string
1137               required:
1138               - cluster_name
1139               - client_id
1140               type: object
1141       responses:
1142         '201':
1143           content:
1144             application/vnd.ceph.api.v1.0+json:
1145               type: object
1146           description: Resource created.
1147         '202':
1148           content:
1149             application/vnd.ceph.api.v1.0+json:
1150               type: object
1151           description: Operation is still executing. Please check the task queue.
1152         '400':
1153           description: Operation exception. Please check the response body for details.
1154         '401':
1155           description: Unauthenticated access. Please login first.
1156         '403':
1157           description: Unauthorized access. Please check your permissions.
1158         '500':
1159           description: Unexpected error. Please check the response body for the stack
1160             trace.
1161       security:
1162       - jwt: []
1163       tags:
1164       - RbdMirroringPoolPeer
1165   /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}:
1166     delete:
1167       parameters:
1168       - in: path
1169         name: pool_name
1170         required: true
1171         schema:
1172           type: string
1173       - in: path
1174         name: peer_uuid
1175         required: true
1176         schema:
1177           type: string
1178       responses:
1179         '202':
1180           content:
1181             application/vnd.ceph.api.v1.0+json:
1182               type: object
1183           description: Operation is still executing. Please check the task queue.
1184         '204':
1185           content:
1186             application/vnd.ceph.api.v1.0+json:
1187               type: object
1188           description: Resource deleted.
1189         '400':
1190           description: Operation exception. Please check the response body for details.
1191         '401':
1192           description: Unauthenticated access. Please login first.
1193         '403':
1194           description: Unauthorized access. Please check your permissions.
1195         '500':
1196           description: Unexpected error. Please check the response body for the stack
1197             trace.
1198       security:
1199       - jwt: []
1200       tags:
1201       - RbdMirroringPoolPeer
1202     get:
1203       parameters:
1204       - in: path
1205         name: pool_name
1206         required: true
1207         schema:
1208           type: string
1209       - in: path
1210         name: peer_uuid
1211         required: true
1212         schema:
1213           type: string
1214       responses:
1215         '200':
1216           content:
1217             application/vnd.ceph.api.v1.0+json:
1218               type: object
1219           description: OK
1220         '400':
1221           description: Operation exception. Please check the response body for details.
1222         '401':
1223           description: Unauthenticated access. Please login first.
1224         '403':
1225           description: Unauthorized access. Please check your permissions.
1226         '500':
1227           description: Unexpected error. Please check the response body for the stack
1228             trace.
1229       security:
1230       - jwt: []
1231       tags:
1232       - RbdMirroringPoolPeer
1233     put:
1234       parameters:
1235       - in: path
1236         name: pool_name
1237         required: true
1238         schema:
1239           type: string
1240       - in: path
1241         name: peer_uuid
1242         required: true
1243         schema:
1244           type: string
1245       requestBody:
1246         content:
1247           application/json:
1248             schema:
1249               properties:
1250                 client_id:
1251                   type: string
1252                 cluster_name:
1253                   type: string
1254                 key:
1255                   type: string
1256                 mon_host:
1257                   type: string
1258               type: object
1259       responses:
1260         '200':
1261           content:
1262             application/vnd.ceph.api.v1.0+json:
1263               type: object
1264           description: Resource updated.
1265         '202':
1266           content:
1267             application/vnd.ceph.api.v1.0+json:
1268               type: object
1269           description: Operation is still executing. Please check the task queue.
1270         '400':
1271           description: Operation exception. Please check the response body for details.
1272         '401':
1273           description: Unauthenticated access. Please login first.
1274         '403':
1275           description: Unauthorized access. Please check your permissions.
1276         '500':
1277           description: Unexpected error. Please check the response body for the stack
1278             trace.
1279       security:
1280       - jwt: []
1281       tags:
1282       - RbdMirroringPoolPeer
1283   /api/block/mirroring/site_name:
1284     get:
1285       parameters: []
1286       responses:
1287         '200':
1288           content:
1289             application/vnd.ceph.api.v1.0+json:
1290               schema:
1291                 properties:
1292                   site_name:
1293                     description: Site Name
1294                     type: string
1295                 required:
1296                 - site_name
1297                 type: object
1298           description: OK
1299         '400':
1300           description: Operation exception. Please check the response body for details.
1301         '401':
1302           description: Unauthenticated access. Please login first.
1303         '403':
1304           description: Unauthorized access. Please check your permissions.
1305         '500':
1306           description: Unexpected error. Please check the response body for the stack
1307             trace.
1308       security:
1309       - jwt: []
1310       summary: Display Rbd Mirroring sitename
1311       tags:
1312       - RbdMirroring
1313     put:
1314       parameters: []
1315       requestBody:
1316         content:
1317           application/json:
1318             schema:
1319               properties:
1320                 site_name:
1321                   type: string
1322               required:
1323               - site_name
1324               type: object
1325       responses:
1326         '200':
1327           content:
1328             application/vnd.ceph.api.v1.0+json:
1329               type: object
1330           description: Resource updated.
1331         '202':
1332           content:
1333             application/vnd.ceph.api.v1.0+json:
1334               type: object
1335           description: Operation is still executing. Please check the task queue.
1336         '400':
1337           description: Operation exception. Please check the response body for details.
1338         '401':
1339           description: Unauthenticated access. Please login first.
1340         '403':
1341           description: Unauthorized access. Please check your permissions.
1342         '500':
1343           description: Unexpected error. Please check the response body for the stack
1344             trace.
1345       security:
1346       - jwt: []
1347       tags:
1348       - RbdMirroring
1349   /api/block/mirroring/summary:
1350     get:
1351       parameters: []
1352       responses:
1353         '200':
1354           content:
1355             application/vnd.ceph.api.v1.0+json:
1356               schema:
1357                 properties:
1358                   content_data:
1359                     description: ''
1360                     properties:
1361                       daemons:
1362                         description: ''
1363                         items:
1364                           type: string
1365                         type: array
1366                       image_error:
1367                         description: ''
1368                         items:
1369                           type: string
1370                         type: array
1371                       image_ready:
1372                         description: ''
1373                         items:
1374                           type: string
1375                         type: array
1376                       image_syncing:
1377                         description: ''
1378                         items:
1379                           type: string
1380                         type: array
1381                       pools:
1382                         description: Pools
1383                         items:
1384                           properties:
1385                             health:
1386                               description: pool health
1387                               type: string
1388                             health_color:
1389                               description: ''
1390                               type: string
1391                             mirror_mode:
1392                               description: status
1393                               type: string
1394                             name:
1395                               description: Pool name
1396                               type: string
1397                             peer_uuids:
1398                               description: ''
1399                               items:
1400                                 type: string
1401                               type: array
1402                           required:
1403                           - name
1404                           - health_color
1405                           - health
1406                           - mirror_mode
1407                           - peer_uuids
1408                           type: object
1409                         type: array
1410                     required:
1411                     - daemons
1412                     - pools
1413                     - image_error
1414                     - image_syncing
1415                     - image_ready
1416                     type: object
1417                   site_name:
1418                     description: site name
1419                     type: string
1420                   status:
1421                     description: ''
1422                     type: integer
1423                 required:
1424                 - site_name
1425                 - status
1426                 - content_data
1427                 type: object
1428           description: OK
1429         '400':
1430           description: Operation exception. Please check the response body for details.
1431         '401':
1432           description: Unauthenticated access. Please login first.
1433         '403':
1434           description: Unauthorized access. Please check your permissions.
1435         '500':
1436           description: Unexpected error. Please check the response body for the stack
1437             trace.
1438       security:
1439       - jwt: []
1440       summary: Display Rbd Mirroring Summary
1441       tags:
1442       - RbdMirroringSummary
1443   /api/block/pool/{pool_name}/namespace:
1444     get:
1445       parameters:
1446       - in: path
1447         name: pool_name
1448         required: true
1449         schema:
1450           type: string
1451       responses:
1452         '200':
1453           content:
1454             application/vnd.ceph.api.v1.0+json:
1455               type: object
1456           description: OK
1457         '400':
1458           description: Operation exception. Please check the response body for details.
1459         '401':
1460           description: Unauthenticated access. Please login first.
1461         '403':
1462           description: Unauthorized access. Please check your permissions.
1463         '500':
1464           description: Unexpected error. Please check the response body for the stack
1465             trace.
1466       security:
1467       - jwt: []
1468       tags:
1469       - RbdNamespace
1470     post:
1471       parameters:
1472       - in: path
1473         name: pool_name
1474         required: true
1475         schema:
1476           type: string
1477       requestBody:
1478         content:
1479           application/json:
1480             schema:
1481               properties:
1482                 namespace:
1483                   type: string
1484               required:
1485               - namespace
1486               type: object
1487       responses:
1488         '201':
1489           content:
1490             application/vnd.ceph.api.v1.0+json:
1491               type: object
1492           description: Resource created.
1493         '202':
1494           content:
1495             application/vnd.ceph.api.v1.0+json:
1496               type: object
1497           description: Operation is still executing. Please check the task queue.
1498         '400':
1499           description: Operation exception. Please check the response body for details.
1500         '401':
1501           description: Unauthenticated access. Please login first.
1502         '403':
1503           description: Unauthorized access. Please check your permissions.
1504         '500':
1505           description: Unexpected error. Please check the response body for the stack
1506             trace.
1507       security:
1508       - jwt: []
1509       tags:
1510       - RbdNamespace
1511   /api/block/pool/{pool_name}/namespace/{namespace}:
1512     delete:
1513       parameters:
1514       - in: path
1515         name: pool_name
1516         required: true
1517         schema:
1518           type: string
1519       - in: path
1520         name: namespace
1521         required: true
1522         schema:
1523           type: string
1524       responses:
1525         '202':
1526           content:
1527             application/vnd.ceph.api.v1.0+json:
1528               type: object
1529           description: Operation is still executing. Please check the task queue.
1530         '204':
1531           content:
1532             application/vnd.ceph.api.v1.0+json:
1533               type: object
1534           description: Resource deleted.
1535         '400':
1536           description: Operation exception. Please check the response body for details.
1537         '401':
1538           description: Unauthenticated access. Please login first.
1539         '403':
1540           description: Unauthorized access. Please check your permissions.
1541         '500':
1542           description: Unexpected error. Please check the response body for the stack
1543             trace.
1544       security:
1545       - jwt: []
1546       tags:
1547       - RbdNamespace
1548   /api/cephfs:
1549     get:
1550       parameters: []
1551       responses:
1552         '200':
1553           content:
1554             application/vnd.ceph.api.v1.0+json:
1555               type: object
1556           description: OK
1557         '400':
1558           description: Operation exception. Please check the response body for details.
1559         '401':
1560           description: Unauthenticated access. Please login first.
1561         '403':
1562           description: Unauthorized access. Please check your permissions.
1563         '500':
1564           description: Unexpected error. Please check the response body for the stack
1565             trace.
1566       security:
1567       - jwt: []
1568       tags:
1569       - Cephfs
1570   /api/cephfs/{fs_id}:
1571     get:
1572       parameters:
1573       - in: path
1574         name: fs_id
1575         required: true
1576         schema:
1577           type: string
1578       responses:
1579         '200':
1580           content:
1581             application/vnd.ceph.api.v1.0+json:
1582               type: object
1583           description: OK
1584         '400':
1585           description: Operation exception. Please check the response body for details.
1586         '401':
1587           description: Unauthenticated access. Please login first.
1588         '403':
1589           description: Unauthorized access. Please check your permissions.
1590         '500':
1591           description: Unexpected error. Please check the response body for the stack
1592             trace.
1593       security:
1594       - jwt: []
1595       tags:
1596       - Cephfs
1597   /api/cephfs/{fs_id}/client/{client_id}:
1598     delete:
1599       parameters:
1600       - in: path
1601         name: fs_id
1602         required: true
1603         schema:
1604           type: string
1605       - in: path
1606         name: client_id
1607         required: true
1608         schema:
1609           type: string
1610       responses:
1611         '202':
1612           content:
1613             application/vnd.ceph.api.v1.0+json:
1614               type: object
1615           description: Operation is still executing. Please check the task queue.
1616         '204':
1617           content:
1618             application/vnd.ceph.api.v1.0+json:
1619               type: object
1620           description: Resource deleted.
1621         '400':
1622           description: Operation exception. Please check the response body for details.
1623         '401':
1624           description: Unauthenticated access. Please login first.
1625         '403':
1626           description: Unauthorized access. Please check your permissions.
1627         '500':
1628           description: Unexpected error. Please check the response body for the stack
1629             trace.
1630       security:
1631       - jwt: []
1632       tags:
1633       - Cephfs
1634   /api/cephfs/{fs_id}/clients:
1635     get:
1636       parameters:
1637       - in: path
1638         name: fs_id
1639         required: true
1640         schema:
1641           type: string
1642       responses:
1643         '200':
1644           content:
1645             application/vnd.ceph.api.v1.0+json:
1646               type: object
1647           description: OK
1648         '400':
1649           description: Operation exception. Please check the response body for details.
1650         '401':
1651           description: Unauthenticated access. Please login first.
1652         '403':
1653           description: Unauthorized access. Please check your permissions.
1654         '500':
1655           description: Unexpected error. Please check the response body for the stack
1656             trace.
1657       security:
1658       - jwt: []
1659       tags:
1660       - Cephfs
1661   /api/cephfs/{fs_id}/get_root_directory:
1662     get:
1663       description: "\n        The root directory that can't be fetched using ls_dir\
1664         \ (api).\n        :param fs_id: The filesystem identifier.\n        :return:\
1665         \ The root directory\n        :rtype: dict\n        "
1666       parameters:
1667       - in: path
1668         name: fs_id
1669         required: true
1670         schema:
1671           type: string
1672       responses:
1673         '200':
1674           content:
1675             application/vnd.ceph.api.v1.0+json:
1676               type: object
1677           description: OK
1678         '400':
1679           description: Operation exception. Please check the response body for details.
1680         '401':
1681           description: Unauthenticated access. Please login first.
1682         '403':
1683           description: Unauthorized access. Please check your permissions.
1684         '500':
1685           description: Unexpected error. Please check the response body for the stack
1686             trace.
1687       security:
1688       - jwt: []
1689       tags:
1690       - Cephfs
1691   /api/cephfs/{fs_id}/ls_dir:
1692     get:
1693       description: "\n        List directories of specified path.\n        :param\
1694         \ fs_id: The filesystem identifier.\n        :param path: The path where to\
1695         \ start listing the directory content.\n        Defaults to '/' if not set.\n\
1696         \        :type path: str | bytes\n        :param depth: The number of steps\
1697         \ to go down the directory tree.\n        :type depth: int | str\n       \
1698         \ :return: The names of the directories below the specified path.\n      \
1699         \  :rtype: list\n        "
1700       parameters:
1701       - in: path
1702         name: fs_id
1703         required: true
1704         schema:
1705           type: string
1706       - allowEmptyValue: true
1707         in: query
1708         name: path
1709         schema:
1710           type: string
1711       - default: 1
1712         in: query
1713         name: depth
1714         schema:
1715           type: integer
1716       responses:
1717         '200':
1718           content:
1719             application/vnd.ceph.api.v1.0+json:
1720               type: object
1721           description: OK
1722         '400':
1723           description: Operation exception. Please check the response body for details.
1724         '401':
1725           description: Unauthenticated access. Please login first.
1726         '403':
1727           description: Unauthorized access. Please check your permissions.
1728         '500':
1729           description: Unexpected error. Please check the response body for the stack
1730             trace.
1731       security:
1732       - jwt: []
1733       tags:
1734       - Cephfs
1735   /api/cephfs/{fs_id}/mds_counters:
1736     get:
1737       parameters:
1738       - in: path
1739         name: fs_id
1740         required: true
1741         schema:
1742           type: string
1743       - allowEmptyValue: true
1744         in: query
1745         name: counters
1746         schema:
1747           type: integer
1748       responses:
1749         '200':
1750           content:
1751             application/vnd.ceph.api.v1.0+json:
1752               type: object
1753           description: OK
1754         '400':
1755           description: Operation exception. Please check the response body for details.
1756         '401':
1757           description: Unauthenticated access. Please login first.
1758         '403':
1759           description: Unauthorized access. Please check your permissions.
1760         '500':
1761           description: Unexpected error. Please check the response body for the stack
1762             trace.
1763       security:
1764       - jwt: []
1765       tags:
1766       - Cephfs
1767   /api/cephfs/{fs_id}/quota:
1768     get:
1769       description: "\n        Get the quotas of the specified path.\n        :param\
1770         \ fs_id: The filesystem identifier.\n        :param path: The path of the\
1771         \ directory/file.\n        :return: Returns a dictionary containing 'max_bytes'\n\
1772         \        and 'max_files'.\n        :rtype: dict\n        "
1773       parameters:
1774       - description: File System Identifier
1775         in: path
1776         name: fs_id
1777         required: true
1778         schema:
1779           type: string
1780       - description: File System Path
1781         in: query
1782         name: path
1783         required: true
1784         schema:
1785           type: string
1786       responses:
1787         '200':
1788           content:
1789             application/vnd.ceph.api.v1.0+json:
1790               schema:
1791                 properties:
1792                   max_bytes:
1793                     description: ''
1794                     type: integer
1795                   max_files:
1796                     description: ''
1797                     type: integer
1798                 required:
1799                 - max_bytes
1800                 - max_files
1801                 type: object
1802           description: OK
1803         '400':
1804           description: Operation exception. Please check the response body for details.
1805         '401':
1806           description: Unauthenticated access. Please login first.
1807         '403':
1808           description: Unauthorized access. Please check your permissions.
1809         '500':
1810           description: Unexpected error. Please check the response body for the stack
1811             trace.
1812       security:
1813       - jwt: []
1814       summary: Get Cephfs Quotas of the specified path
1815       tags:
1816       - Cephfs
1817     put:
1818       description: "\n        Set the quotas of the specified path.\n        :param\
1819         \ fs_id: The filesystem identifier.\n        :param path: The path of the\
1820         \ directory/file.\n        :param max_bytes: The byte limit.\n        :param\
1821         \ max_files: The file limit.\n        "
1822       parameters:
1823       - in: path
1824         name: fs_id
1825         required: true
1826         schema:
1827           type: string
1828       requestBody:
1829         content:
1830           application/json:
1831             schema:
1832               properties:
1833                 max_bytes:
1834                   type: string
1835                 max_files:
1836                   type: string
1837                 path:
1838                   type: string
1839               required:
1840               - path
1841               type: object
1842       responses:
1843         '200':
1844           content:
1845             application/vnd.ceph.api.v1.0+json:
1846               type: object
1847           description: Resource updated.
1848         '202':
1849           content:
1850             application/vnd.ceph.api.v1.0+json:
1851               type: object
1852           description: Operation is still executing. Please check the task queue.
1853         '400':
1854           description: Operation exception. Please check the response body for details.
1855         '401':
1856           description: Unauthenticated access. Please login first.
1857         '403':
1858           description: Unauthorized access. Please check your permissions.
1859         '500':
1860           description: Unexpected error. Please check the response body for the stack
1861             trace.
1862       security:
1863       - jwt: []
1864       tags:
1865       - Cephfs
1866   /api/cephfs/{fs_id}/snapshot:
1867     delete:
1868       description: "\n        Remove a snapshot.\n        :param fs_id: The filesystem\
1869         \ identifier.\n        :param path: The path of the directory.\n        :param\
1870         \ name: The name of the snapshot.\n        "
1871       parameters:
1872       - in: path
1873         name: fs_id
1874         required: true
1875         schema:
1876           type: string
1877       - in: query
1878         name: path
1879         required: true
1880         schema:
1881           type: string
1882       - in: query
1883         name: name
1884         required: true
1885         schema:
1886           type: string
1887       responses:
1888         '202':
1889           content:
1890             application/vnd.ceph.api.v1.0+json:
1891               type: object
1892           description: Operation is still executing. Please check the task queue.
1893         '204':
1894           content:
1895             application/vnd.ceph.api.v1.0+json:
1896               type: object
1897           description: Resource deleted.
1898         '400':
1899           description: Operation exception. Please check the response body for details.
1900         '401':
1901           description: Unauthenticated access. Please login first.
1902         '403':
1903           description: Unauthorized access. Please check your permissions.
1904         '500':
1905           description: Unexpected error. Please check the response body for the stack
1906             trace.
1907       security:
1908       - jwt: []
1909       tags:
1910       - Cephfs
1911     post:
1912       description: "\n        Create a snapshot.\n        :param fs_id: The filesystem\
1913         \ identifier.\n        :param path: The path of the directory.\n        :param\
1914         \ name: The name of the snapshot. If not specified, a name using the\n   \
1915         \     current time in RFC3339 UTC format will be generated.\n        :return:\
1916         \ The name of the snapshot.\n        :rtype: str\n        "
1917       parameters:
1918       - in: path
1919         name: fs_id
1920         required: true
1921         schema:
1922           type: string
1923       requestBody:
1924         content:
1925           application/json:
1926             schema:
1927               properties:
1928                 name:
1929                   type: string
1930                 path:
1931                   type: string
1932               required:
1933               - path
1934               type: object
1935       responses:
1936         '201':
1937           content:
1938             application/vnd.ceph.api.v1.0+json:
1939               type: object
1940           description: Resource created.
1941         '202':
1942           content:
1943             application/vnd.ceph.api.v1.0+json:
1944               type: object
1945           description: Operation is still executing. Please check the task queue.
1946         '400':
1947           description: Operation exception. Please check the response body for details.
1948         '401':
1949           description: Unauthenticated access. Please login first.
1950         '403':
1951           description: Unauthorized access. Please check your permissions.
1952         '500':
1953           description: Unexpected error. Please check the response body for the stack
1954             trace.
1955       security:
1956       - jwt: []
1957       tags:
1958       - Cephfs
1959   /api/cephfs/{fs_id}/tree:
1960     delete:
1961       description: "\n        Remove a directory.\n        :param fs_id: The filesystem\
1962         \ identifier.\n        :param path: The path of the directory.\n        "
1963       parameters:
1964       - in: path
1965         name: fs_id
1966         required: true
1967         schema:
1968           type: string
1969       - in: query
1970         name: path
1971         required: true
1972         schema:
1973           type: string
1974       responses:
1975         '202':
1976           content:
1977             application/vnd.ceph.api.v1.0+json:
1978               type: object
1979           description: Operation is still executing. Please check the task queue.
1980         '204':
1981           content:
1982             application/vnd.ceph.api.v1.0+json:
1983               type: object
1984           description: Resource deleted.
1985         '400':
1986           description: Operation exception. Please check the response body for details.
1987         '401':
1988           description: Unauthenticated access. Please login first.
1989         '403':
1990           description: Unauthorized access. Please check your permissions.
1991         '500':
1992           description: Unexpected error. Please check the response body for the stack
1993             trace.
1994       security:
1995       - jwt: []
1996       tags:
1997       - Cephfs
1998     post:
1999       description: "\n        Create a directory.\n        :param fs_id: The filesystem\
2000         \ identifier.\n        :param path: The path of the directory.\n        "
2001       parameters:
2002       - in: path
2003         name: fs_id
2004         required: true
2005         schema:
2006           type: string
2007       requestBody:
2008         content:
2009           application/json:
2010             schema:
2011               properties:
2012                 path:
2013                   type: string
2014               required:
2015               - path
2016               type: object
2017       responses:
2018         '201':
2019           content:
2020             application/vnd.ceph.api.v1.0+json:
2021               type: object
2022           description: Resource created.
2023         '202':
2024           content:
2025             application/vnd.ceph.api.v1.0+json:
2026               type: object
2027           description: Operation is still executing. Please check the task queue.
2028         '400':
2029           description: Operation exception. Please check the response body for details.
2030         '401':
2031           description: Unauthenticated access. Please login first.
2032         '403':
2033           description: Unauthorized access. Please check your permissions.
2034         '500':
2035           description: Unexpected error. Please check the response body for the stack
2036             trace.
2037       security:
2038       - jwt: []
2039       tags:
2040       - Cephfs
2041   /api/cluster_conf:
2042     get:
2043       parameters: []
2044       responses:
2045         '200':
2046           content:
2047             application/vnd.ceph.api.v1.0+json:
2048               type: object
2049           description: OK
2050         '400':
2051           description: Operation exception. Please check the response body for details.
2052         '401':
2053           description: Unauthenticated access. Please login first.
2054         '403':
2055           description: Unauthorized access. Please check your permissions.
2056         '500':
2057           description: Unexpected error. Please check the response body for the stack
2058             trace.
2059       security:
2060       - jwt: []
2061       tags:
2062       - ClusterConfiguration
2063     post:
2064       parameters: []
2065       requestBody:
2066         content:
2067           application/json:
2068             schema:
2069               properties:
2070                 name:
2071                   type: string
2072                 value:
2073                   type: string
2074               required:
2075               - name
2076               - value
2077               type: object
2078       responses:
2079         '201':
2080           content:
2081             application/vnd.ceph.api.v1.0+json:
2082               type: object
2083           description: Resource created.
2084         '202':
2085           content:
2086             application/vnd.ceph.api.v1.0+json:
2087               type: object
2088           description: Operation is still executing. Please check the task queue.
2089         '400':
2090           description: Operation exception. Please check the response body for details.
2091         '401':
2092           description: Unauthenticated access. Please login first.
2093         '403':
2094           description: Unauthorized access. Please check your permissions.
2095         '500':
2096           description: Unexpected error. Please check the response body for the stack
2097             trace.
2098       security:
2099       - jwt: []
2100       tags:
2101       - ClusterConfiguration
2102     put:
2103       parameters: []
2104       requestBody:
2105         content:
2106           application/json:
2107             schema:
2108               properties:
2109                 options:
2110                   type: string
2111               required:
2112               - options
2113               type: object
2114       responses:
2115         '200':
2116           content:
2117             application/vnd.ceph.api.v1.0+json:
2118               type: object
2119           description: Resource updated.
2120         '202':
2121           content:
2122             application/vnd.ceph.api.v1.0+json:
2123               type: object
2124           description: Operation is still executing. Please check the task queue.
2125         '400':
2126           description: Operation exception. Please check the response body for details.
2127         '401':
2128           description: Unauthenticated access. Please login first.
2129         '403':
2130           description: Unauthorized access. Please check your permissions.
2131         '500':
2132           description: Unexpected error. Please check the response body for the stack
2133             trace.
2134       security:
2135       - jwt: []
2136       tags:
2137       - ClusterConfiguration
2138   /api/cluster_conf/filter:
2139     get:
2140       parameters:
2141       - allowEmptyValue: true
2142         description: Config option names
2143         in: query
2144         name: names
2145         schema:
2146           type: string
2147       responses:
2148         '200':
2149           content:
2150             application/vnd.ceph.api.v1.0+json:
2151               schema:
2152                 items:
2153                   properties:
2154                     can_update_at_runtime:
2155                       description: Check if can update at runtime
2156                       type: boolean
2157                     daemon_default:
2158                       description: Daemon specific default value
2159                       type: string
2160                     default:
2161                       description: Default value for the config option
2162                       type: string
2163                     desc:
2164                       description: Description of the configuration
2165                       type: string
2166                     enum_values:
2167                       description: List of enums allowed
2168                       items:
2169                         type: string
2170                       type: array
2171                     flags:
2172                       description: List of flags associated
2173                       items:
2174                         type: string
2175                       type: array
2176                     level:
2177                       description: Config option level
2178                       type: string
2179                     long_desc:
2180                       description: Elaborated description
2181                       type: string
2182                     max:
2183                       description: Maximum value
2184                       type: string
2185                     min:
2186                       description: Minimum value
2187                       type: string
2188                     name:
2189                       description: Name of the config option
2190                       type: string
2191                     see_also:
2192                       description: Related config options
2193                       items:
2194                         type: string
2195                       type: array
2196                     services:
2197                       description: Services associated with the config option
2198                       items:
2199                         type: string
2200                       type: array
2201                     tags:
2202                       description: Tags associated with the cluster
2203                       items:
2204                         type: string
2205                       type: array
2206                     type:
2207                       description: Config option type
2208                       type: string
2209                   type: object
2210                 required:
2211                 - name
2212                 - type
2213                 - level
2214                 - desc
2215                 - long_desc
2216                 - default
2217                 - daemon_default
2218                 - tags
2219                 - services
2220                 - see_also
2221                 - enum_values
2222                 - min
2223                 - max
2224                 - can_update_at_runtime
2225                 - flags
2226                 type: array
2227           description: OK
2228         '400':
2229           description: Operation exception. Please check the response body for details.
2230         '401':
2231           description: Unauthenticated access. Please login first.
2232         '403':
2233           description: Unauthorized access. Please check your permissions.
2234         '500':
2235           description: Unexpected error. Please check the response body for the stack
2236             trace.
2237       security:
2238       - jwt: []
2239       summary: Get Cluster Configuration by name
2240       tags:
2241       - ClusterConfiguration
2242   /api/cluster_conf/{name}:
2243     delete:
2244       parameters:
2245       - in: path
2246         name: name
2247         required: true
2248         schema:
2249           type: string
2250       - in: query
2251         name: section
2252         required: true
2253         schema:
2254           type: string
2255       responses:
2256         '202':
2257           content:
2258             application/vnd.ceph.api.v1.0+json:
2259               type: object
2260           description: Operation is still executing. Please check the task queue.
2261         '204':
2262           content:
2263             application/vnd.ceph.api.v1.0+json:
2264               type: object
2265           description: Resource deleted.
2266         '400':
2267           description: Operation exception. Please check the response body for details.
2268         '401':
2269           description: Unauthenticated access. Please login first.
2270         '403':
2271           description: Unauthorized access. Please check your permissions.
2272         '500':
2273           description: Unexpected error. Please check the response body for the stack
2274             trace.
2275       security:
2276       - jwt: []
2277       tags:
2278       - ClusterConfiguration
2279     get:
2280       parameters:
2281       - in: path
2282         name: name
2283         required: true
2284         schema:
2285           type: string
2286       responses:
2287         '200':
2288           content:
2289             application/vnd.ceph.api.v1.0+json:
2290               type: object
2291           description: OK
2292         '400':
2293           description: Operation exception. Please check the response body for details.
2294         '401':
2295           description: Unauthenticated access. Please login first.
2296         '403':
2297           description: Unauthorized access. Please check your permissions.
2298         '500':
2299           description: Unexpected error. Please check the response body for the stack
2300             trace.
2301       security:
2302       - jwt: []
2303       tags:
2304       - ClusterConfiguration
2305   /api/crush_rule:
2306     get:
2307       parameters: []
2308       responses:
2309         '200':
2310           content:
2311             application/vnd.ceph.api.v1.0+json:
2312               schema:
2313                 properties:
2314                   max_size:
2315                     description: Maximum size of Rule
2316                     type: integer
2317                   min_size:
2318                     description: Minimum size of Rule
2319                     type: integer
2320                   rule_id:
2321                     description: Rule ID
2322                     type: integer
2323                   rule_name:
2324                     description: Rule Name
2325                     type: string
2326                   ruleset:
2327                     description: RuleSet related to the rule
2328                     type: integer
2329                   steps:
2330                     description: Steps included in the rule
2331                     items:
2332                       type: object
2333                     type: array
2334                   type:
2335                     description: Type of Rule
2336                     type: integer
2337                 required:
2338                 - rule_id
2339                 - rule_name
2340                 - ruleset
2341                 - type
2342                 - min_size
2343                 - max_size
2344                 - steps
2345                 type: object
2346           description: OK
2347         '400':
2348           description: Operation exception. Please check the response body for details.
2349         '401':
2350           description: Unauthenticated access. Please login first.
2351         '403':
2352           description: Unauthorized access. Please check your permissions.
2353         '500':
2354           description: Unexpected error. Please check the response body for the stack
2355             trace.
2356       security:
2357       - jwt: []
2358       summary: List Crush Rule Configuration
2359       tags:
2360       - CrushRule
2361     post:
2362       parameters: []
2363       requestBody:
2364         content:
2365           application/json:
2366             schema:
2367               properties:
2368                 device_class:
2369                   type: string
2370                 failure_domain:
2371                   type: string
2372                 name:
2373                   type: string
2374                 root:
2375                   type: string
2376               required:
2377               - name
2378               - root
2379               - failure_domain
2380               type: object
2381       responses:
2382         '201':
2383           content:
2384             application/vnd.ceph.api.v1.0+json:
2385               type: object
2386           description: Resource created.
2387         '202':
2388           content:
2389             application/vnd.ceph.api.v1.0+json:
2390               type: object
2391           description: Operation is still executing. Please check the task queue.
2392         '400':
2393           description: Operation exception. Please check the response body for details.
2394         '401':
2395           description: Unauthenticated access. Please login first.
2396         '403':
2397           description: Unauthorized access. Please check your permissions.
2398         '500':
2399           description: Unexpected error. Please check the response body for the stack
2400             trace.
2401       security:
2402       - jwt: []
2403       tags:
2404       - CrushRule
2405   /api/crush_rule/{name}:
2406     delete:
2407       parameters:
2408       - in: path
2409         name: name
2410         required: true
2411         schema:
2412           type: string
2413       responses:
2414         '202':
2415           content:
2416             application/vnd.ceph.api.v1.0+json:
2417               type: object
2418           description: Operation is still executing. Please check the task queue.
2419         '204':
2420           content:
2421             application/vnd.ceph.api.v1.0+json:
2422               type: object
2423           description: Resource deleted.
2424         '400':
2425           description: Operation exception. Please check the response body for details.
2426         '401':
2427           description: Unauthenticated access. Please login first.
2428         '403':
2429           description: Unauthorized access. Please check your permissions.
2430         '500':
2431           description: Unexpected error. Please check the response body for the stack
2432             trace.
2433       security:
2434       - jwt: []
2435       tags:
2436       - CrushRule
2437     get:
2438       parameters:
2439       - in: path
2440         name: name
2441         required: true
2442         schema:
2443           type: string
2444       responses:
2445         '200':
2446           content:
2447             application/vnd.ceph.api.v1.0+json:
2448               type: object
2449           description: OK
2450         '400':
2451           description: Operation exception. Please check the response body for details.
2452         '401':
2453           description: Unauthenticated access. Please login first.
2454         '403':
2455           description: Unauthorized access. Please check your permissions.
2456         '500':
2457           description: Unexpected error. Please check the response body for the stack
2458             trace.
2459       security:
2460       - jwt: []
2461       tags:
2462       - CrushRule
2463   /api/erasure_code_profile:
2464     get:
2465       parameters: []
2466       responses:
2467         '200':
2468           content:
2469             application/vnd.ceph.api.v1.0+json:
2470               schema:
2471                 items:
2472                   properties:
2473                     crush-failure-domain:
2474                       description: ''
2475                       type: string
2476                     k:
2477                       description: Number of data chunks
2478                       type: integer
2479                     m:
2480                       description: Number of coding chunks
2481                       type: integer
2482                     name:
2483                       description: Name of the profile
2484                       type: string
2485                     plugin:
2486                       description: Plugin Info
2487                       type: string
2488                     technique:
2489                       description: ''
2490                       type: string
2491                   type: object
2492                 required:
2493                 - crush-failure-domain
2494                 - k
2495                 - m
2496                 - plugin
2497                 - technique
2498                 - name
2499                 type: array
2500           description: OK
2501         '400':
2502           description: Operation exception. Please check the response body for details.
2503         '401':
2504           description: Unauthenticated access. Please login first.
2505         '403':
2506           description: Unauthorized access. Please check your permissions.
2507         '500':
2508           description: Unexpected error. Please check the response body for the stack
2509             trace.
2510       security:
2511       - jwt: []
2512       summary: List Erasure Code Profile Information
2513       tags:
2514       - ErasureCodeProfile
2515     post:
2516       parameters: []
2517       requestBody:
2518         content:
2519           application/json:
2520             schema:
2521               properties:
2522                 name:
2523                   type: string
2524               required:
2525               - name
2526               type: object
2527       responses:
2528         '201':
2529           content:
2530             application/vnd.ceph.api.v1.0+json:
2531               type: object
2532           description: Resource created.
2533         '202':
2534           content:
2535             application/vnd.ceph.api.v1.0+json:
2536               type: object
2537           description: Operation is still executing. Please check the task queue.
2538         '400':
2539           description: Operation exception. Please check the response body for details.
2540         '401':
2541           description: Unauthenticated access. Please login first.
2542         '403':
2543           description: Unauthorized access. Please check your permissions.
2544         '500':
2545           description: Unexpected error. Please check the response body for the stack
2546             trace.
2547       security:
2548       - jwt: []
2549       tags:
2550       - ErasureCodeProfile
2551   /api/erasure_code_profile/{name}:
2552     delete:
2553       parameters:
2554       - in: path
2555         name: name
2556         required: true
2557         schema:
2558           type: string
2559       responses:
2560         '202':
2561           content:
2562             application/vnd.ceph.api.v1.0+json:
2563               type: object
2564           description: Operation is still executing. Please check the task queue.
2565         '204':
2566           content:
2567             application/vnd.ceph.api.v1.0+json:
2568               type: object
2569           description: Resource deleted.
2570         '400':
2571           description: Operation exception. Please check the response body for details.
2572         '401':
2573           description: Unauthenticated access. Please login first.
2574         '403':
2575           description: Unauthorized access. Please check your permissions.
2576         '500':
2577           description: Unexpected error. Please check the response body for the stack
2578             trace.
2579       security:
2580       - jwt: []
2581       tags:
2582       - ErasureCodeProfile
2583     get:
2584       parameters:
2585       - in: path
2586         name: name
2587         required: true
2588         schema:
2589           type: string
2590       responses:
2591         '200':
2592           content:
2593             application/vnd.ceph.api.v1.0+json:
2594               type: object
2595           description: OK
2596         '400':
2597           description: Operation exception. Please check the response body for details.
2598         '401':
2599           description: Unauthenticated access. Please login first.
2600         '403':
2601           description: Unauthorized access. Please check your permissions.
2602         '500':
2603           description: Unexpected error. Please check the response body for the stack
2604             trace.
2605       security:
2606       - jwt: []
2607       tags:
2608       - ErasureCodeProfile
2609   /api/feature_toggles:
2610     get:
2611       parameters: []
2612       responses:
2613         '200':
2614           content:
2615             application/vnd.ceph.api.v1.0+json:
2616               schema:
2617                 properties:
2618                   cephfs:
2619                     description: ''
2620                     type: boolean
2621                   iscsi:
2622                     description: ''
2623                     type: boolean
2624                   mirroring:
2625                     description: ''
2626                     type: boolean
2627                   nfs:
2628                     description: ''
2629                     type: boolean
2630                   rbd:
2631                     description: ''
2632                     type: boolean
2633                   rgw:
2634                     description: ''
2635                     type: boolean
2636                 required:
2637                 - rbd
2638                 - mirroring
2639                 - iscsi
2640                 - cephfs
2641                 - rgw
2642                 - nfs
2643                 type: object
2644           description: OK
2645         '400':
2646           description: Operation exception. Please check the response body for details.
2647         '401':
2648           description: Unauthenticated access. Please login first.
2649         '403':
2650           description: Unauthorized access. Please check your permissions.
2651         '500':
2652           description: Unexpected error. Please check the response body for the stack
2653             trace.
2654       security:
2655       - jwt: []
2656       summary: Get List Of Features
2657       tags:
2658       - FeatureTogglesEndpoint
2659   /api/grafana/dashboards:
2660     post:
2661       parameters: []
2662       responses:
2663         '201':
2664           content:
2665             application/vnd.ceph.api.v1.0+json:
2666               type: object
2667           description: Resource created.
2668         '202':
2669           content:
2670             application/vnd.ceph.api.v1.0+json:
2671               type: object
2672           description: Operation is still executing. Please check the task queue.
2673         '400':
2674           description: Operation exception. Please check the response body for details.
2675         '401':
2676           description: Unauthenticated access. Please login first.
2677         '403':
2678           description: Unauthorized access. Please check your permissions.
2679         '500':
2680           description: Unexpected error. Please check the response body for the stack
2681             trace.
2682       security:
2683       - jwt: []
2684       tags:
2685       - Grafana
2686   /api/grafana/url:
2687     get:
2688       parameters: []
2689       responses:
2690         '200':
2691           content:
2692             application/vnd.ceph.api.v1.0+json:
2693               schema:
2694                 properties:
2695                   instance:
2696                     description: grafana instance
2697                     type: string
2698                 required:
2699                 - instance
2700                 type: object
2701           description: OK
2702         '400':
2703           description: Operation exception. Please check the response body for details.
2704         '401':
2705           description: Unauthenticated access. Please login first.
2706         '403':
2707           description: Unauthorized access. Please check your permissions.
2708         '500':
2709           description: Unexpected error. Please check the response body for the stack
2710             trace.
2711       security:
2712       - jwt: []
2713       summary: List Grafana URL Instance
2714       tags:
2715       - Grafana
2716   /api/grafana/validation/{params}:
2717     get:
2718       parameters:
2719       - in: path
2720         name: params
2721         required: true
2722         schema:
2723           type: string
2724       responses:
2725         '200':
2726           content:
2727             application/vnd.ceph.api.v1.0+json:
2728               type: object
2729           description: OK
2730         '400':
2731           description: Operation exception. Please check the response body for details.
2732         '401':
2733           description: Unauthenticated access. Please login first.
2734         '403':
2735           description: Unauthorized access. Please check your permissions.
2736         '500':
2737           description: Unexpected error. Please check the response body for the stack
2738             trace.
2739       security:
2740       - jwt: []
2741       tags:
2742       - Grafana
2743   /api/health/full:
2744     get:
2745       parameters: []
2746       responses:
2747         '200':
2748           content:
2749             application/vnd.ceph.api.v1.0+json:
2750               type: object
2751           description: OK
2752         '400':
2753           description: Operation exception. Please check the response body for details.
2754         '401':
2755           description: Unauthenticated access. Please login first.
2756         '403':
2757           description: Unauthorized access. Please check your permissions.
2758         '500':
2759           description: Unexpected error. Please check the response body for the stack
2760             trace.
2761       security:
2762       - jwt: []
2763       tags:
2764       - Health
2765   /api/health/minimal:
2766     get:
2767       parameters: []
2768       responses:
2769         '200':
2770           content:
2771             application/vnd.ceph.api.v1.0+json:
2772               schema:
2773                 properties:
2774                   client_perf:
2775                     description: ''
2776                     properties:
2777                       read_bytes_sec:
2778                         description: ''
2779                         type: integer
2780                       read_op_per_sec:
2781                         description: ''
2782                         type: integer
2783                       recovering_bytes_per_sec:
2784                         description: ''
2785                         type: integer
2786                       write_bytes_sec:
2787                         description: ''
2788                         type: integer
2789                       write_op_per_sec:
2790                         description: ''
2791                         type: integer
2792                     required:
2793                     - read_bytes_sec
2794                     - read_op_per_sec
2795                     - recovering_bytes_per_sec
2796                     - write_bytes_sec
2797                     - write_op_per_sec
2798                     type: object
2799                   df:
2800                     description: ''
2801                     properties:
2802                       stats:
2803                         description: ''
2804                         properties:
2805                           total_avail_bytes:
2806                             description: ''
2807                             type: integer
2808                           total_bytes:
2809                             description: ''
2810                             type: integer
2811                           total_used_raw_bytes:
2812                             description: ''
2813                             type: integer
2814                         required:
2815                         - total_avail_bytes
2816                         - total_bytes
2817                         - total_used_raw_bytes
2818                         type: object
2819                     required:
2820                     - stats
2821                     type: object
2822                   fs_map:
2823                     description: ''
2824                     properties:
2825                       filesystems:
2826                         description: ''
2827                         items:
2828                           properties:
2829                             mdsmap:
2830                               description: ''
2831                               properties:
2832                                 balancer:
2833                                   description: ''
2834                                   type: string
2835                                 compat:
2836                                   description: ''
2837                                   properties:
2838                                     compat:
2839                                       description: ''
2840                                       type: string
2841                                     incompat:
2842                                       description: ''
2843                                       type: string
2844                                     ro_compat:
2845                                       description: ''
2846                                       type: string
2847                                   required:
2848                                   - compat
2849                                   - ro_compat
2850                                   - incompat
2851                                   type: object
2852                                 created:
2853                                   description: ''
2854                                   type: string
2855                                 damaged:
2856                                   description: ''
2857                                   items:
2858                                     type: integer
2859                                   type: array
2860                                 data_pools:
2861                                   description: ''
2862                                   items:
2863                                     type: integer
2864                                   type: array
2865                                 enabled:
2866                                   description: ''
2867                                   type: boolean
2868                                 epoch:
2869                                   description: ''
2870                                   type: integer
2871                                 ever_allowed_features:
2872                                   description: ''
2873                                   type: integer
2874                                 explicitly_allowed_features:
2875                                   description: ''
2876                                   type: integer
2877                                 failed:
2878                                   description: ''
2879                                   items:
2880                                     type: integer
2881                                   type: array
2882                                 flags:
2883                                   description: ''
2884                                   type: integer
2885                                 fs_name:
2886                                   description: ''
2887                                   type: string
2888                                 in:
2889                                   description: ''
2890                                   items:
2891                                     type: integer
2892                                   type: array
2893                                 info:
2894                                   description: ''
2895                                   type: string
2896                                 last_failure:
2897                                   description: ''
2898                                   type: integer
2899                                 last_failure_osd_epoch:
2900                                   description: ''
2901                                   type: integer
2902                                 max_file_size:
2903                                   description: ''
2904                                   type: integer
2905                                 max_mds:
2906                                   description: ''
2907                                   type: integer
2908                                 metadata_pool:
2909                                   description: ''
2910                                   type: integer
2911                                 modified:
2912                                   description: ''
2913                                   type: string
2914                                 required_client_features:
2915                                   description: ''
2916                                   type: string
2917                                 root:
2918                                   description: ''
2919                                   type: integer
2920                                 session_autoclose:
2921                                   description: ''
2922                                   type: integer
2923                                 session_timeout:
2924                                   description: ''
2925                                   type: integer
2926                                 standby_count_wanted:
2927                                   description: ''
2928                                   type: integer
2929                                 stopped:
2930                                   description: ''
2931                                   items:
2932                                     type: integer
2933                                   type: array
2934                                 tableserver:
2935                                   description: ''
2936                                   type: integer
2937                                 up:
2938                                   description: ''
2939                                   type: string
2940                               required:
2941                               - session_autoclose
2942                               - balancer
2943                               - up
2944                               - last_failure_osd_epoch
2945                               - in
2946                               - last_failure
2947                               - max_file_size
2948                               - explicitly_allowed_features
2949                               - damaged
2950                               - tableserver
2951                               - failed
2952                               - metadata_pool
2953                               - epoch
2954                               - stopped
2955                               - max_mds
2956                               - compat
2957                               - required_client_features
2958                               - data_pools
2959                               - info
2960                               - fs_name
2961                               - created
2962                               - standby_count_wanted
2963                               - enabled
2964                               - modified
2965                               - session_timeout
2966                               - flags
2967                               - ever_allowed_features
2968                               - root
2969                               type: object
2970                             standbys:
2971                               description: ''
2972                               type: string
2973                           required:
2974                           - mdsmap
2975                           - standbys
2976                           type: object
2977                         type: array
2978                     required:
2979                     - filesystems
2980                     type: object
2981                   health:
2982                     description: ''
2983                     properties:
2984                       checks:
2985                         description: ''
2986                         type: string
2987                       mutes:
2988                         description: ''
2989                         type: string
2990                       status:
2991                         description: ''
2992                         type: string
2993                     required:
2994                     - checks
2995                     - mutes
2996                     - status
2997                     type: object
2998                   hosts:
2999                     description: ''
3000                     type: integer
3001                   iscsi_daemons:
3002                     description: ''
3003                     properties:
3004                       down:
3005                         description: ''
3006                         type: integer
3007                       up:
3008                         description: ''
3009                         type: integer
3010                     required:
3011                     - up
3012                     - down
3013                     type: object
3014                   mgr_map:
3015                     description: ''
3016                     properties:
3017                       active_name:
3018                         description: ''
3019                         type: string
3020                       standbys:
3021                         description: ''
3022                         type: string
3023                     required:
3024                     - active_name
3025                     - standbys
3026                     type: object
3027                   mon_status:
3028                     description: ''
3029                     properties:
3030                       monmap:
3031                         description: ''
3032                         properties:
3033                           mons:
3034                             description: ''
3035                             type: string
3036                         required:
3037                         - mons
3038                         type: object
3039                       quorum:
3040                         description: ''
3041                         items:
3042                           type: integer
3043                         type: array
3044                     required:
3045                     - monmap
3046                     - quorum
3047                     type: object
3048                   osd_map:
3049                     description: ''
3050                     properties:
3051                       osds:
3052                         description: ''
3053                         items:
3054                           properties:
3055                             in:
3056                               description: ''
3057                               type: integer
3058                             up:
3059                               description: ''
3060                               type: integer
3061                           required:
3062                           - in
3063                           - up
3064                           type: object
3065                         type: array
3066                     required:
3067                     - osds
3068                     type: object
3069                   pg_info:
3070                     description: ''
3071                     properties:
3072                       object_stats:
3073                         description: ''
3074                         properties:
3075                           num_object_copies:
3076                             description: ''
3077                             type: integer
3078                           num_objects:
3079                             description: ''
3080                             type: integer
3081                           num_objects_degraded:
3082                             description: ''
3083                             type: integer
3084                           num_objects_misplaced:
3085                             description: ''
3086                             type: integer
3087                           num_objects_unfound:
3088                             description: ''
3089                             type: integer
3090                         required:
3091                         - num_objects
3092                         - num_object_copies
3093                         - num_objects_degraded
3094                         - num_objects_misplaced
3095                         - num_objects_unfound
3096                         type: object
3097                       pgs_per_osd:
3098                         description: ''
3099                         type: integer
3100                       statuses:
3101                         description: ''
3102                         type: string
3103                     required:
3104                     - object_stats
3105                     - pgs_per_osd
3106                     - statuses
3107                     type: object
3108                   pools:
3109                     description: ''
3110                     type: string
3111                   rgw:
3112                     description: ''
3113                     type: integer
3114                   scrub_status:
3115                     description: ''
3116                     type: string
3117                 required:
3118                 - client_perf
3119                 - df
3120                 - fs_map
3121                 - health
3122                 - hosts
3123                 - iscsi_daemons
3124                 - mgr_map
3125                 - mon_status
3126                 - osd_map
3127                 - pg_info
3128                 - pools
3129                 - rgw
3130                 - scrub_status
3131                 type: object
3132           description: OK
3133         '400':
3134           description: Operation exception. Please check the response body for details.
3135         '401':
3136           description: Unauthenticated access. Please login first.
3137         '403':
3138           description: Unauthorized access. Please check your permissions.
3139         '500':
3140           description: Unexpected error. Please check the response body for the stack
3141             trace.
3142       security:
3143       - jwt: []
3144       summary: Get Cluster's minimal health report
3145       tags:
3146       - Health
3147   /api/host:
3148     get:
3149       parameters:
3150       - allowEmptyValue: true
3151         description: Host Sources
3152         in: query
3153         name: sources
3154         schema:
3155           type: string
3156       responses:
3157         '200':
3158           content:
3159             application/vnd.ceph.api.v1.0+json:
3160               schema:
3161                 properties:
3162                   addr:
3163                     description: Host address
3164                     type: string
3165                   ceph_version:
3166                     description: Ceph version
3167                     type: string
3168                   hostname:
3169                     description: Hostname
3170                     type: string
3171                   labels:
3172                     description: Labels related to the host
3173                     items:
3174                       type: string
3175                     type: array
3176                   service_type:
3177                     description: ''
3178                     type: string
3179                   services:
3180                     description: Services related to the host
3181                     items:
3182                       properties:
3183                         id:
3184                           description: Service Id
3185                           type: string
3186                         type:
3187                           description: type of service
3188                           type: string
3189                       required:
3190                       - type
3191                       - id
3192                       type: object
3193                     type: array
3194                   sources:
3195                     description: Host Sources
3196                     properties:
3197                       ceph:
3198                         description: ''
3199                         type: boolean
3200                       orchestrator:
3201                         description: ''
3202                         type: boolean
3203                     required:
3204                     - ceph
3205                     - orchestrator
3206                     type: object
3207                   status:
3208                     description: ''
3209                     type: string
3210                 required:
3211                 - hostname
3212                 - services
3213                 - ceph_version
3214                 - addr
3215                 - labels
3216                 - service_type
3217                 - sources
3218                 - status
3219                 type: object
3220           description: OK
3221         '400':
3222           description: Operation exception. Please check the response body for details.
3223         '401':
3224           description: Unauthenticated access. Please login first.
3225         '403':
3226           description: Unauthorized access. Please check your permissions.
3227         '500':
3228           description: Unexpected error. Please check the response body for the stack
3229             trace.
3230       security:
3231       - jwt: []
3232       summary: List Host Specifications
3233       tags:
3234       - Host
3235     post:
3236       parameters: []
3237       requestBody:
3238         content:
3239           application/json:
3240             schema:
3241               properties:
3242                 hostname:
3243                   type: string
3244               required:
3245               - hostname
3246               type: object
3247       responses:
3248         '201':
3249           content:
3250             application/vnd.ceph.api.v1.0+json:
3251               type: object
3252           description: Resource created.
3253         '202':
3254           content:
3255             application/vnd.ceph.api.v1.0+json:
3256               type: object
3257           description: Operation is still executing. Please check the task queue.
3258         '400':
3259           description: Operation exception. Please check the response body for details.
3260         '401':
3261           description: Unauthenticated access. Please login first.
3262         '403':
3263           description: Unauthorized access. Please check your permissions.
3264         '500':
3265           description: Unexpected error. Please check the response body for the stack
3266             trace.
3267       security:
3268       - jwt: []
3269       tags:
3270       - Host
3271   /api/host/{hostname}:
3272     delete:
3273       parameters:
3274       - in: path
3275         name: hostname
3276         required: true
3277         schema:
3278           type: string
3279       responses:
3280         '202':
3281           content:
3282             application/vnd.ceph.api.v1.0+json:
3283               type: object
3284           description: Operation is still executing. Please check the task queue.
3285         '204':
3286           content:
3287             application/vnd.ceph.api.v1.0+json:
3288               type: object
3289           description: Resource deleted.
3290         '400':
3291           description: Operation exception. Please check the response body for details.
3292         '401':
3293           description: Unauthenticated access. Please login first.
3294         '403':
3295           description: Unauthorized access. Please check your permissions.
3296         '500':
3297           description: Unexpected error. Please check the response body for the stack
3298             trace.
3299       security:
3300       - jwt: []
3301       tags:
3302       - Host
3303     get:
3304       description: "\n        Get the specified host.\n        :raises: cherrypy.HTTPError:\
3305         \ If host not found.\n        "
3306       parameters:
3307       - in: path
3308         name: hostname
3309         required: true
3310         schema:
3311           type: string
3312       responses:
3313         '200':
3314           content:
3315             application/vnd.ceph.api.v1.0+json:
3316               type: object
3317           description: OK
3318         '400':
3319           description: Operation exception. Please check the response body for details.
3320         '401':
3321           description: Unauthenticated access. Please login first.
3322         '403':
3323           description: Unauthorized access. Please check your permissions.
3324         '500':
3325           description: Unexpected error. Please check the response body for the stack
3326             trace.
3327       security:
3328       - jwt: []
3329       tags:
3330       - Host
3331     put:
3332       description: "\n        Update the specified host.\n        Note, this is only\
3333         \ supported when Ceph Orchestrator is enabled.\n        :param hostname: The\
3334         \ name of the host to be processed.\n        :param update_labels: To update\
3335         \ the labels.\n        :param labels: List of labels.\n        :param maintenance:\
3336         \ Enter/Exit maintenance mode.\n        :param force: Force enter maintenance\
3337         \ mode.\n        "
3338       parameters:
3339       - description: Hostname
3340         in: path
3341         name: hostname
3342         required: true
3343         schema:
3344           type: string
3345       requestBody:
3346         content:
3347           application/json:
3348             schema:
3349               properties:
3350                 force:
3351                   default: false
3352                   description: Force Enter Maintenance
3353                   type: boolean
3354                 labels:
3355                   description: Host Labels
3356                   items:
3357                     type: string
3358                   type: array
3359                 maintenance:
3360                   default: false
3361                   description: Enter/Exit Maintenance
3362                   type: boolean
3363                 update_labels:
3364                   default: false
3365                   description: Update Labels
3366                   type: boolean
3367               type: object
3368       responses:
3369         '200':
3370           content:
3371             application/vnd.ceph.api.v1.0+json:
3372               schema:
3373                 properties: {}
3374                 type: object
3375           description: Resource updated.
3376         '202':
3377           content:
3378             application/vnd.ceph.api.v1.0+json:
3379               type: object
3380           description: Operation is still executing. Please check the task queue.
3381         '400':
3382           description: Operation exception. Please check the response body for details.
3383         '401':
3384           description: Unauthenticated access. Please login first.
3385         '403':
3386           description: Unauthorized access. Please check your permissions.
3387         '500':
3388           description: Unexpected error. Please check the response body for the stack
3389             trace.
3390       security:
3391       - jwt: []
3392       tags:
3393       - Host
3394   /api/host/{hostname}/daemons:
3395     get:
3396       parameters:
3397       - in: path
3398         name: hostname
3399         required: true
3400         schema:
3401           type: string
3402       responses:
3403         '200':
3404           content:
3405             application/vnd.ceph.api.v1.0+json:
3406               type: object
3407           description: OK
3408         '400':
3409           description: Operation exception. Please check the response body for details.
3410         '401':
3411           description: Unauthenticated access. Please login first.
3412         '403':
3413           description: Unauthorized access. Please check your permissions.
3414         '500':
3415           description: Unexpected error. Please check the response body for the stack
3416             trace.
3417       security:
3418       - jwt: []
3419       tags:
3420       - Host
3421   /api/host/{hostname}/devices:
3422     get:
3423       parameters:
3424       - in: path
3425         name: hostname
3426         required: true
3427         schema:
3428           type: string
3429       responses:
3430         '200':
3431           content:
3432             application/vnd.ceph.api.v1.0+json:
3433               type: object
3434           description: OK
3435         '400':
3436           description: Operation exception. Please check the response body for details.
3437         '401':
3438           description: Unauthenticated access. Please login first.
3439         '403':
3440           description: Unauthorized access. Please check your permissions.
3441         '500':
3442           description: Unexpected error. Please check the response body for the stack
3443             trace.
3444       security:
3445       - jwt: []
3446       tags:
3447       - Host
3448   /api/host/{hostname}/identify_device:
3449     post:
3450       description: "\n        Identify a device by switching on the device light for\
3451         \ N seconds.\n        :param hostname: The hostname of the device to process.\n\
3452         \        :param device: The device identifier to process, e.g. ``/dev/dm-0``\
3453         \ or\n        ``ABC1234DEF567-1R1234_ABC8DE0Q``.\n        :param duration:\
3454         \ The duration in seconds how long the LED should flash.\n        "
3455       parameters:
3456       - in: path
3457         name: hostname
3458         required: true
3459         schema:
3460           type: string
3461       requestBody:
3462         content:
3463           application/json:
3464             schema:
3465               properties:
3466                 device:
3467                   type: string
3468                 duration:
3469                   type: string
3470               required:
3471               - device
3472               - duration
3473               type: object
3474       responses:
3475         '201':
3476           content:
3477             application/vnd.ceph.api.v1.0+json:
3478               type: object
3479           description: Resource created.
3480         '202':
3481           content:
3482             application/vnd.ceph.api.v1.0+json:
3483               type: object
3484           description: Operation is still executing. Please check the task queue.
3485         '400':
3486           description: Operation exception. Please check the response body for details.
3487         '401':
3488           description: Unauthenticated access. Please login first.
3489         '403':
3490           description: Unauthorized access. Please check your permissions.
3491         '500':
3492           description: Unexpected error. Please check the response body for the stack
3493             trace.
3494       security:
3495       - jwt: []
3496       tags:
3497       - Host
3498   /api/host/{hostname}/inventory:
3499     get:
3500       parameters:
3501       - description: Hostname
3502         in: path
3503         name: hostname
3504         required: true
3505         schema:
3506           type: string
3507       - allowEmptyValue: true
3508         description: Trigger asynchronous refresh
3509         in: query
3510         name: refresh
3511         schema:
3512           type: string
3513       responses:
3514         '200':
3515           content:
3516             application/vnd.ceph.api.v1.0+json:
3517               schema:
3518                 properties:
3519                   addr:
3520                     description: Host address
3521                     type: string
3522                   devices:
3523                     description: Host devices
3524                     items:
3525                       properties:
3526                         available:
3527                           description: If the device can be provisioned to an OSD
3528                           type: boolean
3529                         device_id:
3530                           description: Device's udev ID
3531                           type: string
3532                         human_readable_type:
3533                           description: Device type. ssd or hdd
3534                           type: string
3535                         lsm_data:
3536                           description: ''
3537                           properties:
3538                             errors:
3539                               description: ''
3540                               items:
3541                                 type: string
3542                               type: array
3543                             health:
3544                               description: ''
3545                               type: string
3546                             ledSupport:
3547                               description: ''
3548                               properties:
3549                                 FAILstatus:
3550                                   description: ''
3551                                   type: string
3552                                 FAILsupport:
3553                                   description: ''
3554                                   type: string
3555                                 IDENTstatus:
3556                                   description: ''
3557                                   type: string
3558                                 IDENTsupport:
3559                                   description: ''
3560                                   type: string
3561                               required:
3562                               - IDENTsupport
3563                               - IDENTstatus
3564                               - FAILsupport
3565                               - FAILstatus
3566                               type: object
3567                             linkSpeed:
3568                               description: ''
3569                               type: string
3570                             mediaType:
3571                               description: ''
3572                               type: string
3573                             rpm:
3574                               description: ''
3575                               type: string
3576                             serialNum:
3577                               description: ''
3578                               type: string
3579                             transport:
3580                               description: ''
3581                               type: string
3582                           required:
3583                           - serialNum
3584                           - transport
3585                           - mediaType
3586                           - rpm
3587                           - linkSpeed
3588                           - health
3589                           - ledSupport
3590                           - errors
3591                           type: object
3592                         lvs:
3593                           description: ''
3594                           items:
3595                             properties:
3596                               block_uuid:
3597                                 description: ''
3598                                 type: string
3599                               cluster_fsid:
3600                                 description: ''
3601                                 type: string
3602                               cluster_name:
3603                                 description: ''
3604                                 type: string
3605                               name:
3606                                 description: ''
3607                                 type: string
3608                               osd_fsid:
3609                                 description: ''
3610                                 type: string
3611                               osd_id:
3612                                 description: ''
3613                                 type: string
3614                               osdspec_affinity:
3615                                 description: ''
3616                                 type: string
3617                               type:
3618                                 description: ''
3619                                 type: string
3620                             required:
3621                             - name
3622                             - osd_id
3623                             - cluster_name
3624                             - type
3625                             - osd_fsid
3626                             - cluster_fsid
3627                             - osdspec_affinity
3628                             - block_uuid
3629                             type: object
3630                           type: array
3631                         osd_ids:
3632                           description: Device OSD IDs
3633                           items:
3634                             type: integer
3635                           type: array
3636                         path:
3637                           description: Device path
3638                           type: string
3639                         rejected_reasons:
3640                           description: ''
3641                           items:
3642                             type: string
3643                           type: array
3644                         sys_api:
3645                           description: ''
3646                           properties:
3647                             human_readable_size:
3648                               description: ''
3649                               type: string
3650                             locked:
3651                               description: ''
3652                               type: integer
3653                             model:
3654                               description: ''
3655                               type: string
3656                             nr_requests:
3657                               description: ''
3658                               type: string
3659                             partitions:
3660                               description: ''
3661                               properties:
3662                                 partition_name:
3663                                   description: ''
3664                                   properties:
3665                                     holders:
3666                                       description: ''
3667                                       items:
3668                                         type: string
3669                                       type: array
3670                                     human_readable_size:
3671                                       description: ''
3672                                       type: string
3673                                     sectors:
3674                                       description: ''
3675                                       type: string
3676                                     sectorsize:
3677                                       description: ''
3678                                       type: integer
3679                                     size:
3680                                       description: ''
3681                                       type: integer
3682                                     start:
3683                                       description: ''
3684                                       type: string
3685                                   required:
3686                                   - start
3687                                   - sectors
3688                                   - sectorsize
3689                                   - size
3690                                   - human_readable_size
3691                                   - holders
3692                                   type: object
3693                               required:
3694                               - partition_name
3695                               type: object
3696                             path:
3697                               description: ''
3698                               type: string
3699                             removable:
3700                               description: ''
3701                               type: string
3702                             rev:
3703                               description: ''
3704                               type: string
3705                             ro:
3706                               description: ''
3707                               type: string
3708                             rotational:
3709                               description: ''
3710                               type: string
3711                             sas_address:
3712                               description: ''
3713                               type: string
3714                             sas_device_handle:
3715                               description: ''
3716                               type: string
3717                             scheduler_mode:
3718                               description: ''
3719                               type: string
3720                             sectors:
3721                               description: ''
3722                               type: integer
3723                             sectorsize:
3724                               description: ''
3725                               type: string
3726                             size:
3727                               description: ''
3728                               type: integer
3729                             support_discard:
3730                               description: ''
3731                               type: string
3732                             vendor:
3733                               description: ''
3734                               type: string
3735                           required:
3736                           - removable
3737                           - ro
3738                           - vendor
3739                           - model
3740                           - rev
3741                           - sas_address
3742                           - sas_device_handle
3743                           - support_discard
3744                           - rotational
3745                           - nr_requests
3746                           - scheduler_mode
3747                           - partitions
3748                           - sectors
3749                           - sectorsize
3750                           - size
3751                           - human_readable_size
3752                           - path
3753                           - locked
3754                           type: object
3755                       required:
3756                       - rejected_reasons
3757                       - available
3758                       - path
3759                       - sys_api
3760                       - lvs
3761                       - human_readable_type
3762                       - device_id
3763                       - lsm_data
3764                       - osd_ids
3765                       type: object
3766                     type: array
3767                   labels:
3768                     description: Host labels
3769                     items:
3770                       type: string
3771                     type: array
3772                   name:
3773                     description: Hostname
3774                     type: string
3775                 required:
3776                 - name
3777                 - addr
3778                 - devices
3779                 - labels
3780                 type: object
3781           description: OK
3782         '400':
3783           description: Operation exception. Please check the response body for details.
3784         '401':
3785           description: Unauthenticated access. Please login first.
3786         '403':
3787           description: Unauthorized access. Please check your permissions.
3788         '500':
3789           description: Unexpected error. Please check the response body for the stack
3790             trace.
3791       security:
3792       - jwt: []
3793       summary: Get inventory of a host
3794       tags:
3795       - Host
3796   /api/host/{hostname}/smart:
3797     get:
3798       parameters:
3799       - in: path
3800         name: hostname
3801         required: true
3802         schema:
3803           type: string
3804       responses:
3805         '200':
3806           content:
3807             application/vnd.ceph.api.v1.0+json:
3808               type: object
3809           description: OK
3810         '400':
3811           description: Operation exception. Please check the response body for details.
3812         '401':
3813           description: Unauthenticated access. Please login first.
3814         '403':
3815           description: Unauthorized access. Please check your permissions.
3816         '500':
3817           description: Unexpected error. Please check the response body for the stack
3818             trace.
3819       security:
3820       - jwt: []
3821       tags:
3822       - Host
3823   /api/iscsi/discoveryauth:
3824     get:
3825       parameters: []
3826       responses:
3827         '200':
3828           content:
3829             application/vnd.ceph.api.v1.0+json:
3830               schema:
3831                 items:
3832                   properties:
3833                     mutual_password:
3834                       description: ''
3835                       type: string
3836                     mutual_user:
3837                       description: ''
3838                       type: string
3839                     password:
3840                       description: password
3841                       type: string
3842                     user:
3843                       description: username
3844                       type: string
3845                   type: object
3846                 required:
3847                 - user
3848                 - password
3849                 - mutual_user
3850                 - mutual_password
3851                 type: array
3852           description: OK
3853         '400':
3854           description: Operation exception. Please check the response body for details.
3855         '401':
3856           description: Unauthenticated access. Please login first.
3857         '403':
3858           description: Unauthorized access. Please check your permissions.
3859         '500':
3860           description: Unexpected error. Please check the response body for the stack
3861             trace.
3862       security:
3863       - jwt: []
3864       summary: Get Iscsi discoveryauth Details
3865       tags:
3866       - Iscsi
3867     put:
3868       parameters:
3869       - description: Username
3870         in: query
3871         name: user
3872         required: true
3873         schema:
3874           type: string
3875       - description: Password
3876         in: query
3877         name: password
3878         required: true
3879         schema:
3880           type: string
3881       - description: Mutual UserName
3882         in: query
3883         name: mutual_user
3884         required: true
3885         schema:
3886           type: string
3887       - description: Mutual Password
3888         in: query
3889         name: mutual_password
3890         required: true
3891         schema:
3892           type: string
3893       requestBody:
3894         content:
3895           application/json:
3896             schema:
3897               properties:
3898                 mutual_password:
3899                   description: Mutual Password
3900                   type: string
3901                 mutual_user:
3902                   description: Mutual UserName
3903                   type: string
3904                 password:
3905                   description: Password
3906                   type: string
3907                 user:
3908                   description: Username
3909                   type: string
3910               required:
3911               - user
3912               - password
3913               - mutual_user
3914               - mutual_password
3915               type: object
3916       responses:
3917         '200':
3918           content:
3919             application/vnd.ceph.api.v1.0+json:
3920               type: object
3921           description: Resource updated.
3922         '202':
3923           content:
3924             application/vnd.ceph.api.v1.0+json:
3925               type: object
3926           description: Operation is still executing. Please check the task queue.
3927         '400':
3928           description: Operation exception. Please check the response body for details.
3929         '401':
3930           description: Unauthenticated access. Please login first.
3931         '403':
3932           description: Unauthorized access. Please check your permissions.
3933         '500':
3934           description: Unexpected error. Please check the response body for the stack
3935             trace.
3936       security:
3937       - jwt: []
3938       summary: Set Iscsi discoveryauth
3939       tags:
3940       - Iscsi
3941   /api/iscsi/target:
3942     get:
3943       parameters: []
3944       responses:
3945         '200':
3946           content:
3947             application/vnd.ceph.api.v1.0+json:
3948               type: object
3949           description: OK
3950         '400':
3951           description: Operation exception. Please check the response body for details.
3952         '401':
3953           description: Unauthenticated access. Please login first.
3954         '403':
3955           description: Unauthorized access. Please check your permissions.
3956         '500':
3957           description: Unexpected error. Please check the response body for the stack
3958             trace.
3959       security:
3960       - jwt: []
3961       tags:
3962       - IscsiTarget
3963     post:
3964       parameters: []
3965       requestBody:
3966         content:
3967           application/json:
3968             schema:
3969               properties:
3970                 acl_enabled:
3971                   type: string
3972                 auth:
3973                   type: string
3974                 clients:
3975                   type: string
3976                 disks:
3977                   type: string
3978                 groups:
3979                   type: string
3980                 portals:
3981                   type: string
3982                 target_controls:
3983                   type: string
3984                 target_iqn:
3985                   type: string
3986               type: object
3987       responses:
3988         '201':
3989           content:
3990             application/vnd.ceph.api.v1.0+json:
3991               type: object
3992           description: Resource created.
3993         '202':
3994           content:
3995             application/vnd.ceph.api.v1.0+json:
3996               type: object
3997           description: Operation is still executing. Please check the task queue.
3998         '400':
3999           description: Operation exception. Please check the response body for details.
4000         '401':
4001           description: Unauthenticated access. Please login first.
4002         '403':
4003           description: Unauthorized access. Please check your permissions.
4004         '500':
4005           description: Unexpected error. Please check the response body for the stack
4006             trace.
4007       security:
4008       - jwt: []
4009       tags:
4010       - IscsiTarget
4011   /api/iscsi/target/{target_iqn}:
4012     delete:
4013       parameters:
4014       - in: path
4015         name: target_iqn
4016         required: true
4017         schema:
4018           type: string
4019       responses:
4020         '202':
4021           content:
4022             application/vnd.ceph.api.v1.0+json:
4023               type: object
4024           description: Operation is still executing. Please check the task queue.
4025         '204':
4026           content:
4027             application/vnd.ceph.api.v1.0+json:
4028               type: object
4029           description: Resource deleted.
4030         '400':
4031           description: Operation exception. Please check the response body for details.
4032         '401':
4033           description: Unauthenticated access. Please login first.
4034         '403':
4035           description: Unauthorized access. Please check your permissions.
4036         '500':
4037           description: Unexpected error. Please check the response body for the stack
4038             trace.
4039       security:
4040       - jwt: []
4041       tags:
4042       - IscsiTarget
4043     get:
4044       parameters:
4045       - in: path
4046         name: target_iqn
4047         required: true
4048         schema:
4049           type: string
4050       responses:
4051         '200':
4052           content:
4053             application/vnd.ceph.api.v1.0+json:
4054               type: object
4055           description: OK
4056         '400':
4057           description: Operation exception. Please check the response body for details.
4058         '401':
4059           description: Unauthenticated access. Please login first.
4060         '403':
4061           description: Unauthorized access. Please check your permissions.
4062         '500':
4063           description: Unexpected error. Please check the response body for the stack
4064             trace.
4065       security:
4066       - jwt: []
4067       tags:
4068       - IscsiTarget
4069     put:
4070       parameters:
4071       - in: path
4072         name: target_iqn
4073         required: true
4074         schema:
4075           type: string
4076       requestBody:
4077         content:
4078           application/json:
4079             schema:
4080               properties:
4081                 acl_enabled:
4082                   type: string
4083                 auth:
4084                   type: string
4085                 clients:
4086                   type: string
4087                 disks:
4088                   type: string
4089                 groups:
4090                   type: string
4091                 new_target_iqn:
4092                   type: string
4093                 portals:
4094                   type: string
4095                 target_controls:
4096                   type: string
4097               type: object
4098       responses:
4099         '200':
4100           content:
4101             application/vnd.ceph.api.v1.0+json:
4102               type: object
4103           description: Resource updated.
4104         '202':
4105           content:
4106             application/vnd.ceph.api.v1.0+json:
4107               type: object
4108           description: Operation is still executing. Please check the task queue.
4109         '400':
4110           description: Operation exception. Please check the response body for details.
4111         '401':
4112           description: Unauthenticated access. Please login first.
4113         '403':
4114           description: Unauthorized access. Please check your permissions.
4115         '500':
4116           description: Unexpected error. Please check the response body for the stack
4117             trace.
4118       security:
4119       - jwt: []
4120       tags:
4121       - IscsiTarget
4122   /api/logs/all:
4123     get:
4124       parameters: []
4125       responses:
4126         '200':
4127           content:
4128             application/vnd.ceph.api.v1.0+json:
4129               schema:
4130                 properties:
4131                   audit_log:
4132                     description: Audit log
4133                     items:
4134                       properties:
4135                         addrs:
4136                           description: ''
4137                           properties:
4138                             addrvec:
4139                               description: ''
4140                               items:
4141                                 properties:
4142                                   addr:
4143                                     description: IP Address
4144                                     type: string
4145                                   nonce:
4146                                     description: ''
4147                                     type: integer
4148                                   type:
4149                                     description: ''
4150                                     type: string
4151                                 required:
4152                                 - type
4153                                 - addr
4154                                 - nonce
4155                                 type: object
4156                               type: array
4157                           required:
4158                           - addrvec
4159                           type: object
4160                         channel:
4161                           description: ''
4162                           type: string
4163                         message:
4164                           description: ''
4165                           type: string
4166                         name:
4167                           description: ''
4168                           type: string
4169                         priority:
4170                           description: ''
4171                           type: string
4172                         rank:
4173                           description: ''
4174                           type: string
4175                         seq:
4176                           description: ''
4177                           type: integer
4178                         stamp:
4179                           description: ''
4180                           type: string
4181                       required:
4182                       - name
4183                       - rank
4184                       - addrs
4185                       - stamp
4186                       - seq
4187                       - channel
4188                       - priority
4189                       - message
4190                       type: object
4191                     type: array
4192                   clog:
4193                     description: ''
4194                     items:
4195                       type: string
4196                     type: array
4197                 required:
4198                 - clog
4199                 - audit_log
4200                 type: object
4201           description: OK
4202         '400':
4203           description: Operation exception. Please check the response body for details.
4204         '401':
4205           description: Unauthenticated access. Please login first.
4206         '403':
4207           description: Unauthorized access. Please check your permissions.
4208         '500':
4209           description: Unexpected error. Please check the response body for the stack
4210             trace.
4211       security:
4212       - jwt: []
4213       summary: Display Logs Configuration
4214       tags:
4215       - Logs
4216   /api/mgr/module:
4217     get:
4218       description: "\n        Get the list of managed modules.\n        :return: A\
4219         \ list of objects with the fields 'enabled', 'name' and 'options'.\n     \
4220         \   :rtype: list\n        "
4221       parameters: []
4222       responses:
4223         '200':
4224           content:
4225             application/vnd.ceph.api.v1.0+json:
4226               schema:
4227                 items:
4228                   properties:
4229                     always_on:
4230                       description: Is it an always on module?
4231                       type: boolean
4232                     enabled:
4233                       description: Is Module Enabled
4234                       type: boolean
4235                     name:
4236                       description: Module Name
4237                       type: string
4238                     options:
4239                       description: Module Options
4240                       properties:
4241                         Option_name:
4242                           description: Options
4243                           properties:
4244                             default_value:
4245                               description: Default value for the option
4246                               type: integer
4247                             desc:
4248                               description: Description of the option
4249                               type: string
4250                             enum_allowed:
4251                               description: ''
4252                               items:
4253                                 type: string
4254                               type: array
4255                             flags:
4256                               description: List of flags associated
4257                               type: integer
4258                             level:
4259                               description: Option level
4260                               type: string
4261                             long_desc:
4262                               description: Elaborated description
4263                               type: string
4264                             max:
4265                               description: Maximum value
4266                               type: string
4267                             min:
4268                               description: Minimum value
4269                               type: string
4270                             name:
4271                               description: Name of the option
4272                               type: string
4273                             see_also:
4274                               description: Related options
4275                               items:
4276                                 type: string
4277                               type: array
4278                             tags:
4279                               description: Tags associated with the option
4280                               items:
4281                                 type: string
4282                               type: array
4283                             type:
4284                               description: Type of the option
4285                               type: string
4286                           required:
4287                           - name
4288                           - type
4289                           - level
4290                           - flags
4291                           - default_value
4292                           - min
4293                           - max
4294                           - enum_allowed
4295                           - desc
4296                           - long_desc
4297                           - tags
4298                           - see_also
4299                           type: object
4300                       required:
4301                       - Option_name
4302                       type: object
4303                   type: object
4304                 required:
4305                 - name
4306                 - enabled
4307                 - always_on
4308                 - options
4309                 type: array
4310           description: OK
4311         '400':
4312           description: Operation exception. Please check the response body for details.
4313         '401':
4314           description: Unauthenticated access. Please login first.
4315         '403':
4316           description: Unauthorized access. Please check your permissions.
4317         '500':
4318           description: Unexpected error. Please check the response body for the stack
4319             trace.
4320       security:
4321       - jwt: []
4322       summary: List Mgr modules
4323       tags:
4324       - MgrModule
4325   /api/mgr/module/{module_name}:
4326     get:
4327       description: "\n        Retrieve the values of the persistent configuration\
4328         \ settings.\n        :param module_name: The name of the Ceph Mgr module.\n\
4329         \        :type module_name: str\n        :return: The values of the module\
4330         \ options.\n        :rtype: dict\n        "
4331       parameters:
4332       - in: path
4333         name: module_name
4334         required: true
4335         schema:
4336           type: string
4337       responses:
4338         '200':
4339           content:
4340             application/vnd.ceph.api.v1.0+json:
4341               type: object
4342           description: OK
4343         '400':
4344           description: Operation exception. Please check the response body for details.
4345         '401':
4346           description: Unauthenticated access. Please login first.
4347         '403':
4348           description: Unauthorized access. Please check your permissions.
4349         '500':
4350           description: Unexpected error. Please check the response body for the stack
4351             trace.
4352       security:
4353       - jwt: []
4354       tags:
4355       - MgrModule
4356     put:
4357       description: "\n        Set the values of the persistent configuration settings.\n\
4358         \        :param module_name: The name of the Ceph Mgr module.\n        :type\
4359         \ module_name: str\n        :param config: The values of the module options\
4360         \ to be stored.\n        :type config: dict\n        "
4361       parameters:
4362       - in: path
4363         name: module_name
4364         required: true
4365         schema:
4366           type: string
4367       requestBody:
4368         content:
4369           application/json:
4370             schema:
4371               properties:
4372                 config:
4373                   type: string
4374               required:
4375               - config
4376               type: object
4377       responses:
4378         '200':
4379           content:
4380             application/vnd.ceph.api.v1.0+json:
4381               type: object
4382           description: Resource updated.
4383         '202':
4384           content:
4385             application/vnd.ceph.api.v1.0+json:
4386               type: object
4387           description: Operation is still executing. Please check the task queue.
4388         '400':
4389           description: Operation exception. Please check the response body for details.
4390         '401':
4391           description: Unauthenticated access. Please login first.
4392         '403':
4393           description: Unauthorized access. Please check your permissions.
4394         '500':
4395           description: Unexpected error. Please check the response body for the stack
4396             trace.
4397       security:
4398       - jwt: []
4399       tags:
4400       - MgrModule
4401   /api/mgr/module/{module_name}/disable:
4402     post:
4403       description: "\n        Disable the specified Ceph Mgr module.\n        :param\
4404         \ module_name: The name of the Ceph Mgr module.\n        :type module_name:\
4405         \ str\n        "
4406       parameters:
4407       - in: path
4408         name: module_name
4409         required: true
4410         schema:
4411           type: string
4412       responses:
4413         '201':
4414           content:
4415             application/vnd.ceph.api.v1.0+json:
4416               type: object
4417           description: Resource created.
4418         '202':
4419           content:
4420             application/vnd.ceph.api.v1.0+json:
4421               type: object
4422           description: Operation is still executing. Please check the task queue.
4423         '400':
4424           description: Operation exception. Please check the response body for details.
4425         '401':
4426           description: Unauthenticated access. Please login first.
4427         '403':
4428           description: Unauthorized access. Please check your permissions.
4429         '500':
4430           description: Unexpected error. Please check the response body for the stack
4431             trace.
4432       security:
4433       - jwt: []
4434       tags:
4435       - MgrModule
4436   /api/mgr/module/{module_name}/enable:
4437     post:
4438       description: "\n        Enable the specified Ceph Mgr module.\n        :param\
4439         \ module_name: The name of the Ceph Mgr module.\n        :type module_name:\
4440         \ str\n        "
4441       parameters:
4442       - in: path
4443         name: module_name
4444         required: true
4445         schema:
4446           type: string
4447       responses:
4448         '201':
4449           content:
4450             application/vnd.ceph.api.v1.0+json:
4451               type: object
4452           description: Resource created.
4453         '202':
4454           content:
4455             application/vnd.ceph.api.v1.0+json:
4456               type: object
4457           description: Operation is still executing. Please check the task queue.
4458         '400':
4459           description: Operation exception. Please check the response body for details.
4460         '401':
4461           description: Unauthenticated access. Please login first.
4462         '403':
4463           description: Unauthorized access. Please check your permissions.
4464         '500':
4465           description: Unexpected error. Please check the response body for the stack
4466             trace.
4467       security:
4468       - jwt: []
4469       tags:
4470       - MgrModule
4471   /api/mgr/module/{module_name}/options:
4472     get:
4473       description: "\n        Get the module options of the specified Ceph Mgr module.\n\
4474         \        :param module_name: The name of the Ceph Mgr module.\n        :type\
4475         \ module_name: str\n        :return: The module options as list of dicts.\n\
4476         \        :rtype: list\n        "
4477       parameters:
4478       - in: path
4479         name: module_name
4480         required: true
4481         schema:
4482           type: string
4483       responses:
4484         '200':
4485           content:
4486             application/vnd.ceph.api.v1.0+json:
4487               type: object
4488           description: OK
4489         '400':
4490           description: Operation exception. Please check the response body for details.
4491         '401':
4492           description: Unauthenticated access. Please login first.
4493         '403':
4494           description: Unauthorized access. Please check your permissions.
4495         '500':
4496           description: Unexpected error. Please check the response body for the stack
4497             trace.
4498       security:
4499       - jwt: []
4500       tags:
4501       - MgrModule
4502   /api/monitor:
4503     get:
4504       parameters: []
4505       responses:
4506         '200':
4507           content:
4508             application/vnd.ceph.api.v1.0+json:
4509               schema:
4510                 properties:
4511                   in_quorum:
4512                     description: ''
4513                     items:
4514                       properties:
4515                         addr:
4516                           description: ''
4517                           type: string
4518                         name:
4519                           description: ''
4520                           type: string
4521                         priority:
4522                           description: ''
4523                           type: integer
4524                         public_addr:
4525                           description: ''
4526                           type: string
4527                         public_addrs:
4528                           description: ''
4529                           properties:
4530                             addrvec:
4531                               description: ''
4532                               items:
4533                                 properties:
4534                                   addr:
4535                                     description: ''
4536                                     type: string
4537                                   nonce:
4538                                     description: ''
4539                                     type: integer
4540                                   type:
4541                                     description: ''
4542                                     type: string
4543                                 required:
4544                                 - type
4545                                 - addr
4546                                 - nonce
4547                                 type: object
4548                               type: array
4549                           required:
4550                           - addrvec
4551                           type: object
4552                         rank:
4553                           description: ''
4554                           type: integer
4555                         stats:
4556                           description: ''
4557                           properties:
4558                             num_sessions:
4559                               description: ''
4560                               items:
4561                                 type: integer
4562                               type: array
4563                           required:
4564                           - num_sessions
4565                           type: object
4566                         weight:
4567                           description: ''
4568                           type: integer
4569                       required:
4570                       - rank
4571                       - name
4572                       - public_addrs
4573                       - addr
4574                       - public_addr
4575                       - priority
4576                       - weight
4577                       - stats
4578                       type: object
4579                     type: array
4580                   mon_status:
4581                     description: ''
4582                     properties:
4583                       election_epoch:
4584                         description: ''
4585                         type: integer
4586                       extra_probe_peers:
4587                         description: ''
4588                         items:
4589                           type: string
4590                         type: array
4591                       feature_map:
4592                         description: ''
4593                         properties:
4594                           client:
4595                             description: ''
4596                             items:
4597                               properties:
4598                                 features:
4599                                   description: ''
4600                                   type: string
4601                                 num:
4602                                   description: ''
4603                                   type: integer
4604                                 release:
4605                                   description: ''
4606                                   type: string
4607                               required:
4608                               - features
4609                               - release
4610                               - num
4611                               type: object
4612                             type: array
4613                           mds:
4614                             description: ''
4615                             items:
4616                               properties:
4617                                 features:
4618                                   description: ''
4619                                   type: string
4620                                 num:
4621                                   description: ''
4622                                   type: integer
4623                                 release:
4624                                   description: ''
4625                                   type: string
4626                               required:
4627                               - features
4628                               - release
4629                               - num
4630                               type: object
4631                             type: array
4632                           mgr:
4633                             description: ''
4634                             items:
4635                               properties:
4636                                 features:
4637                                   description: ''
4638                                   type: string
4639                                 num:
4640                                   description: ''
4641                                   type: integer
4642                                 release:
4643                                   description: ''
4644                                   type: string
4645                               required:
4646                               - features
4647                               - release
4648                               - num
4649                               type: object
4650                             type: array
4651                           mon:
4652                             description: ''
4653                             items:
4654                               properties:
4655                                 features:
4656                                   description: ''
4657                                   type: string
4658                                 num:
4659                                   description: ''
4660                                   type: integer
4661                                 release:
4662                                   description: ''
4663                                   type: string
4664                               required:
4665                               - features
4666                               - release
4667                               - num
4668                               type: object
4669                             type: array
4670                         required:
4671                         - mon
4672                         - mds
4673                         - client
4674                         - mgr
4675                         type: object
4676                       features:
4677                         description: ''
4678                         properties:
4679                           quorum_con:
4680                             description: ''
4681                             type: string
4682                           quorum_mon:
4683                             description: ''
4684                             items:
4685                               type: string
4686                             type: array
4687                           required_con:
4688                             description: ''
4689                             type: string
4690                           required_mon:
4691                             description: ''
4692                             items:
4693                               type: integer
4694                             type: array
4695                         required:
4696                         - required_con
4697                         - required_mon
4698                         - quorum_con
4699                         - quorum_mon
4700                         type: object
4701                       monmap:
4702                         description: ''
4703                         properties:
4704                           created:
4705                             description: ''
4706                             type: string
4707                           epoch:
4708                             description: ''
4709                             type: integer
4710                           features:
4711                             description: ''
4712                             properties:
4713                               optional:
4714                                 description: ''
4715                                 items:
4716                                   type: string
4717                                 type: array
4718                               persistent:
4719                                 description: ''
4720                                 items:
4721                                   type: string
4722                                 type: array
4723                             required:
4724                             - persistent
4725                             - optional
4726                             type: object
4727                           fsid:
4728                             description: ''
4729                             type: string
4730                           min_mon_release:
4731                             description: ''
4732                             type: integer
4733                           min_mon_release_name:
4734                             description: ''
4735                             type: string
4736                           modified:
4737                             description: ''
4738                             type: string
4739                           mons:
4740                             description: ''
4741                             items:
4742                               properties:
4743                                 addr:
4744                                   description: ''
4745                                   type: string
4746                                 name:
4747                                   description: ''
4748                                   type: string
4749                                 priority:
4750                                   description: ''
4751                                   type: integer
4752                                 public_addr:
4753                                   description: ''
4754                                   type: string
4755                                 public_addrs:
4756                                   description: ''
4757                                   properties:
4758                                     addrvec:
4759                                       description: ''
4760                                       items:
4761                                         properties:
4762                                           addr:
4763                                             description: ''
4764                                             type: string
4765                                           nonce:
4766                                             description: ''
4767                                             type: integer
4768                                           type:
4769                                             description: ''
4770                                             type: string
4771                                         required:
4772                                         - type
4773                                         - addr
4774                                         - nonce
4775                                         type: object
4776                                       type: array
4777                                   required:
4778                                   - addrvec
4779                                   type: object
4780                                 rank:
4781                                   description: ''
4782                                   type: integer
4783                                 stats:
4784                                   description: ''
4785                                   properties:
4786                                     num_sessions:
4787                                       description: ''
4788                                       items:
4789                                         type: integer
4790                                       type: array
4791                                   required:
4792                                   - num_sessions
4793                                   type: object
4794                                 weight:
4795                                   description: ''
4796                                   type: integer
4797                               required:
4798                               - rank
4799                               - name
4800                               - public_addrs
4801                               - addr
4802                               - public_addr
4803                               - priority
4804                               - weight
4805                               - stats
4806                               type: object
4807                             type: array
4808                         required:
4809                         - epoch
4810                         - fsid
4811                         - modified
4812                         - created
4813                         - min_mon_release
4814                         - min_mon_release_name
4815                         - features
4816                         - mons
4817                         type: object
4818                       name:
4819                         description: ''
4820                         type: string
4821                       outside_quorum:
4822                         description: ''
4823                         items:
4824                           type: string
4825                         type: array
4826                       quorum:
4827                         description: ''
4828                         items:
4829                           type: integer
4830                         type: array
4831                       quorum_age:
4832                         description: ''
4833                         type: integer
4834                       rank:
4835                         description: ''
4836                         type: integer
4837                       state:
4838                         description: ''
4839                         type: string
4840                       sync_provider:
4841                         description: ''
4842                         items:
4843                           type: string
4844                         type: array
4845                     required:
4846                     - name
4847                     - rank
4848                     - state
4849                     - election_epoch
4850                     - quorum
4851                     - quorum_age
4852                     - features
4853                     - outside_quorum
4854                     - extra_probe_peers
4855                     - sync_provider
4856                     - monmap
4857                     - feature_map
4858                     type: object
4859                   out_quorum:
4860                     description: ''
4861                     items:
4862                       type: integer
4863                     type: array
4864                 required:
4865                 - mon_status
4866                 - in_quorum
4867                 - out_quorum
4868                 type: object
4869           description: OK
4870         '400':
4871           description: Operation exception. Please check the response body for details.
4872         '401':
4873           description: Unauthenticated access. Please login first.
4874         '403':
4875           description: Unauthorized access. Please check your permissions.
4876         '500':
4877           description: Unexpected error. Please check the response body for the stack
4878             trace.
4879       security:
4880       - jwt: []
4881       summary: Get Monitor Details
4882       tags:
4883       - Monitor
4884   /api/nfs-ganesha/daemon:
4885     get:
4886       parameters: []
4887       responses:
4888         '200':
4889           content:
4890             application/vnd.ceph.api.v1.0+json:
4891               schema:
4892                 items:
4893                   properties:
4894                     cluster_id:
4895                       description: Cluster identifier
4896                       type: string
4897                     cluster_type:
4898                       description: Cluster type
4899                       type: string
4900                     daemon_id:
4901                       description: Daemon identifier
4902                       type: string
4903                     desc:
4904                       description: Status description
4905                       type: string
4906                     status:
4907                       description: Status of daemon
4908                       type: integer
4909                   type: object
4910                 required:
4911                 - daemon_id
4912                 - cluster_id
4913                 - cluster_type
4914                 type: array
4915           description: OK
4916         '400':
4917           description: Operation exception. Please check the response body for details.
4918         '401':
4919           description: Unauthenticated access. Please login first.
4920         '403':
4921           description: Unauthorized access. Please check your permissions.
4922         '500':
4923           description: Unexpected error. Please check the response body for the stack
4924             trace.
4925       security:
4926       - jwt: []
4927       summary: List NFS-Ganesha daemons information
4928       tags:
4929       - NFS-Ganesha
4930   /api/nfs-ganesha/export:
4931     get:
4932       parameters: []
4933       responses:
4934         '200':
4935           content:
4936             application/vnd.ceph.api.v1.0+json:
4937               schema:
4938                 items:
4939                   properties:
4940                     access_type:
4941                       description: Export access type
4942                       type: string
4943                     clients:
4944                       description: List of client configurations
4945                       items:
4946                         properties:
4947                           access_type:
4948                             description: Client access type
4949                             type: string
4950                           addresses:
4951                             description: list of IP addresses
4952                             items:
4953                               type: string
4954                             type: array
4955                           squash:
4956                             description: Client squash policy
4957                             type: string
4958                         required:
4959                         - addresses
4960                         - access_type
4961                         - squash
4962                         type: object
4963                       type: array
4964                     cluster_id:
4965                       description: Cluster identifier
4966                       type: string
4967                     daemons:
4968                       description: List of NFS Ganesha daemons identifiers
4969                       items:
4970                         type: string
4971                       type: array
4972                     export_id:
4973                       description: Export ID
4974                       type: integer
4975                     fsal:
4976                       description: FSAL configuration
4977                       properties:
4978                         filesystem:
4979                           description: CephFS filesystem ID
4980                           type: string
4981                         name:
4982                           description: name of FSAL
4983                           type: string
4984                         rgw_user_id:
4985                           description: RGW user id
4986                           type: string
4987                         sec_label_xattr:
4988                           description: Name of xattr for security label
4989                           type: string
4990                         user_id:
4991                           description: CephX user id
4992                           type: string
4993                       required:
4994                       - name
4995                       type: object
4996                     path:
4997                       description: Export path
4998                       type: string
4999                     protocols:
5000                       description: List of protocol types
5001                       items:
5002                         type: integer
5003                       type: array
5004                     pseudo:
5005                       description: Pseudo FS path
5006                       type: string
5007                     security_label:
5008                       description: Security label
5009                       type: string
5010                     squash:
5011                       description: Export squash policy
5012                       type: string
5013                     tag:
5014                       description: NFSv3 export tag
5015                       type: string
5016                     transports:
5017                       description: List of transport types
5018                       items:
5019                         type: string
5020                       type: array
5021                   type: object
5022                 required:
5023                 - export_id
5024                 - path
5025                 - cluster_id
5026                 - daemons
5027                 - pseudo
5028                 - tag
5029                 - access_type
5030                 - squash
5031                 - security_label
5032                 - protocols
5033                 - transports
5034                 - fsal
5035                 - clients
5036                 type: array
5037           description: OK
5038         '400':
5039           description: Operation exception. Please check the response body for details.
5040         '401':
5041           description: Unauthenticated access. Please login first.
5042         '403':
5043           description: Unauthorized access. Please check your permissions.
5044         '500':
5045           description: Unexpected error. Please check the response body for the stack
5046             trace.
5047       security:
5048       - jwt: []
5049       summary: List all NFS-Ganesha exports
5050       tags:
5051       - NFS-Ganesha
5052     post:
5053       parameters: []
5054       requestBody:
5055         content:
5056           application/json:
5057             schema:
5058               properties:
5059                 access_type:
5060                   description: Export access type
5061                   type: string
5062                 clients:
5063                   description: List of client configurations
5064                   items:
5065                     properties:
5066                       access_type:
5067                         description: Client access type
5068                         type: string
5069                       addresses:
5070                         description: list of IP addresses
5071                         items:
5072                           type: string
5073                         type: array
5074                       squash:
5075                         description: Client squash policy
5076                         type: string
5077                     required:
5078                     - addresses
5079                     - access_type
5080                     - squash
5081                     type: object
5082                   type: array
5083                 cluster_id:
5084                   description: Cluster identifier
5085                   type: string
5086                 daemons:
5087                   description: List of NFS Ganesha daemons identifiers
5088                   items:
5089                     type: string
5090                   type: array
5091                 fsal:
5092                   description: FSAL configuration
5093                   properties:
5094                     filesystem:
5095                       description: CephFS filesystem ID
5096                       type: string
5097                     name:
5098                       description: name of FSAL
5099                       type: string
5100                     rgw_user_id:
5101                       description: RGW user id
5102                       type: string
5103                     sec_label_xattr:
5104                       description: Name of xattr for security label
5105                       type: string
5106                     user_id:
5107                       description: CephX user id
5108                       type: string
5109                   required:
5110                   - name
5111                   type: object
5112                 path:
5113                   description: Export path
5114                   type: string
5115                 protocols:
5116                   description: List of protocol types
5117                   items:
5118                     type: integer
5119                   type: array
5120                 pseudo:
5121                   description: Pseudo FS path
5122                   type: string
5123                 reload_daemons:
5124                   default: true
5125                   description: Trigger reload of NFS-Ganesha daemons configuration
5126                   type: boolean
5127                 security_label:
5128                   description: Security label
5129                   type: string
5130                 squash:
5131                   description: Export squash policy
5132                   type: string
5133                 tag:
5134                   description: NFSv3 export tag
5135                   type: string
5136                 transports:
5137                   description: List of transport types
5138                   items:
5139                     type: string
5140                   type: array
5141               required:
5142               - path
5143               - cluster_id
5144               - daemons
5145               - pseudo
5146               - tag
5147               - access_type
5148               - squash
5149               - security_label
5150               - protocols
5151               - transports
5152               - fsal
5153               - clients
5154               type: object
5155       responses:
5156         '201':
5157           content:
5158             application/vnd.ceph.api.v1.0+json:
5159               schema:
5160                 properties:
5161                   access_type:
5162                     description: Export access type
5163                     type: string
5164                   clients:
5165                     description: List of client configurations
5166                     items:
5167                       properties:
5168                         access_type:
5169                           description: Client access type
5170                           type: string
5171                         addresses:
5172                           description: list of IP addresses
5173                           items:
5174                             type: string
5175                           type: array
5176                         squash:
5177                           description: Client squash policy
5178                           type: string
5179                       required:
5180                       - addresses
5181                       - access_type
5182                       - squash
5183                       type: object
5184                     type: array
5185                   cluster_id:
5186                     description: Cluster identifier
5187                     type: string
5188                   daemons:
5189                     description: List of NFS Ganesha daemons identifiers
5190                     items:
5191                       type: string
5192                     type: array
5193                   export_id:
5194                     description: Export ID
5195                     type: integer
5196                   fsal:
5197                     description: FSAL configuration
5198                     properties:
5199                       filesystem:
5200                         description: CephFS filesystem ID
5201                         type: string
5202                       name:
5203                         description: name of FSAL
5204                         type: string
5205                       rgw_user_id:
5206                         description: RGW user id
5207                         type: string
5208                       sec_label_xattr:
5209                         description: Name of xattr for security label
5210                         type: string
5211                       user_id:
5212                         description: CephX user id
5213                         type: string
5214                     required:
5215                     - name
5216                     type: object
5217                   path:
5218                     description: Export path
5219                     type: string
5220                   protocols:
5221                     description: List of protocol types
5222                     items:
5223                       type: integer
5224                     type: array
5225                   pseudo:
5226                     description: Pseudo FS path
5227                     type: string
5228                   security_label:
5229                     description: Security label
5230                     type: string
5231                   squash:
5232                     description: Export squash policy
5233                     type: string
5234                   tag:
5235                     description: NFSv3 export tag
5236                     type: string
5237                   transports:
5238                     description: List of transport types
5239                     items:
5240                       type: string
5241                     type: array
5242                 required:
5243                 - export_id
5244                 - path
5245                 - cluster_id
5246                 - daemons
5247                 - pseudo
5248                 - tag
5249                 - access_type
5250                 - squash
5251                 - security_label
5252                 - protocols
5253                 - transports
5254                 - fsal
5255                 - clients
5256                 type: object
5257           description: Resource created.
5258         '202':
5259           content:
5260             application/vnd.ceph.api.v1.0+json:
5261               type: object
5262           description: Operation is still executing. Please check the task queue.
5263         '400':
5264           description: Operation exception. Please check the response body for details.
5265         '401':
5266           description: Unauthenticated access. Please login first.
5267         '403':
5268           description: Unauthorized access. Please check your permissions.
5269         '500':
5270           description: Unexpected error. Please check the response body for the stack
5271             trace.
5272       security:
5273       - jwt: []
5274       summary: Creates a new NFS-Ganesha export
5275       tags:
5276       - NFS-Ganesha
5277   /api/nfs-ganesha/export/{cluster_id}/{export_id}:
5278     delete:
5279       parameters:
5280       - description: Cluster identifier
5281         in: path
5282         name: cluster_id
5283         required: true
5284         schema:
5285           type: string
5286       - description: Export ID
5287         in: path
5288         name: export_id
5289         required: true
5290         schema:
5291           type: integer
5292       - default: true
5293         description: Trigger reload of NFS-Ganesha daemons configuration
5294         in: query
5295         name: reload_daemons
5296         schema:
5297           type: boolean
5298       responses:
5299         '202':
5300           content:
5301             application/vnd.ceph.api.v1.0+json:
5302               type: object
5303           description: Operation is still executing. Please check the task queue.
5304         '204':
5305           content:
5306             application/vnd.ceph.api.v1.0+json:
5307               type: object
5308           description: Resource deleted.
5309         '400':
5310           description: Operation exception. Please check the response body for details.
5311         '401':
5312           description: Unauthenticated access. Please login first.
5313         '403':
5314           description: Unauthorized access. Please check your permissions.
5315         '500':
5316           description: Unexpected error. Please check the response body for the stack
5317             trace.
5318       security:
5319       - jwt: []
5320       summary: Deletes an NFS-Ganesha export
5321       tags:
5322       - NFS-Ganesha
5323     get:
5324       parameters:
5325       - description: Cluster identifier
5326         in: path
5327         name: cluster_id
5328         required: true
5329         schema:
5330           type: string
5331       - description: Export ID
5332         in: path
5333         name: export_id
5334         required: true
5335         schema:
5336           type: integer
5337       responses:
5338         '200':
5339           content:
5340             application/vnd.ceph.api.v1.0+json:
5341               schema:
5342                 properties:
5343                   access_type:
5344                     description: Export access type
5345                     type: string
5346                   clients:
5347                     description: List of client configurations
5348                     items:
5349                       properties:
5350                         access_type:
5351                           description: Client access type
5352                           type: string
5353                         addresses:
5354                           description: list of IP addresses
5355                           items:
5356                             type: string
5357                           type: array
5358                         squash:
5359                           description: Client squash policy
5360                           type: string
5361                       required:
5362                       - addresses
5363                       - access_type
5364                       - squash
5365                       type: object
5366                     type: array
5367                   cluster_id:
5368                     description: Cluster identifier
5369                     type: string
5370                   daemons:
5371                     description: List of NFS Ganesha daemons identifiers
5372                     items:
5373                       type: string
5374                     type: array
5375                   export_id:
5376                     description: Export ID
5377                     type: integer
5378                   fsal:
5379                     description: FSAL configuration
5380                     properties:
5381                       filesystem:
5382                         description: CephFS filesystem ID
5383                         type: string
5384                       name:
5385                         description: name of FSAL
5386                         type: string
5387                       rgw_user_id:
5388                         description: RGW user id
5389                         type: string
5390                       sec_label_xattr:
5391                         description: Name of xattr for security label
5392                         type: string
5393                       user_id:
5394                         description: CephX user id
5395                         type: string
5396                     required:
5397                     - name
5398                     type: object
5399                   path:
5400                     description: Export path
5401                     type: string
5402                   protocols:
5403                     description: List of protocol types
5404                     items:
5405                       type: integer
5406                     type: array
5407                   pseudo:
5408                     description: Pseudo FS path
5409                     type: string
5410                   security_label:
5411                     description: Security label
5412                     type: string
5413                   squash:
5414                     description: Export squash policy
5415                     type: string
5416                   tag:
5417                     description: NFSv3 export tag
5418                     type: string
5419                   transports:
5420                     description: List of transport types
5421                     items:
5422                       type: string
5423                     type: array
5424                 required:
5425                 - export_id
5426                 - path
5427                 - cluster_id
5428                 - daemons
5429                 - pseudo
5430                 - tag
5431                 - access_type
5432                 - squash
5433                 - security_label
5434                 - protocols
5435                 - transports
5436                 - fsal
5437                 - clients
5438                 type: object
5439           description: OK
5440         '400':
5441           description: Operation exception. Please check the response body for details.
5442         '401':
5443           description: Unauthenticated access. Please login first.
5444         '403':
5445           description: Unauthorized access. Please check your permissions.
5446         '500':
5447           description: Unexpected error. Please check the response body for the stack
5448             trace.
5449       security:
5450       - jwt: []
5451       summary: Get an NFS-Ganesha export
5452       tags:
5453       - NFS-Ganesha
5454     put:
5455       parameters:
5456       - description: Cluster identifier
5457         in: path
5458         name: cluster_id
5459         required: true
5460         schema:
5461           type: string
5462       - description: Export ID
5463         in: path
5464         name: export_id
5465         required: true
5466         schema:
5467           type: integer
5468       requestBody:
5469         content:
5470           application/json:
5471             schema:
5472               properties:
5473                 access_type:
5474                   description: Export access type
5475                   type: string
5476                 clients:
5477                   description: List of client configurations
5478                   items:
5479                     properties:
5480                       access_type:
5481                         description: Client access type
5482                         type: string
5483                       addresses:
5484                         description: list of IP addresses
5485                         items:
5486                           type: string
5487                         type: array
5488                       squash:
5489                         description: Client squash policy
5490                         type: string
5491                     required:
5492                     - addresses
5493                     - access_type
5494                     - squash
5495                     type: object
5496                   type: array
5497                 daemons:
5498                   description: List of NFS Ganesha daemons identifiers
5499                   items:
5500                     type: string
5501                   type: array
5502                 fsal:
5503                   description: FSAL configuration
5504                   properties:
5505                     filesystem:
5506                       description: CephFS filesystem ID
5507                       type: string
5508                     name:
5509                       description: name of FSAL
5510                       type: string
5511                     rgw_user_id:
5512                       description: RGW user id
5513                       type: string
5514                     sec_label_xattr:
5515                       description: Name of xattr for security label
5516                       type: string
5517                     user_id:
5518                       description: CephX user id
5519                       type: string
5520                   required:
5521                   - name
5522                   type: object
5523                 path:
5524                   description: Export path
5525                   type: string
5526                 protocols:
5527                   description: List of protocol types
5528                   items:
5529                     type: integer
5530                   type: array
5531                 pseudo:
5532                   description: Pseudo FS path
5533                   type: string
5534                 reload_daemons:
5535                   default: true
5536                   description: Trigger reload of NFS-Ganesha daemons configuration
5537                   type: boolean
5538                 security_label:
5539                   description: Security label
5540                   type: string
5541                 squash:
5542                   description: Export squash policy
5543                   type: string
5544                 tag:
5545                   description: NFSv3 export tag
5546                   type: string
5547                 transports:
5548                   description: List of transport types
5549                   items:
5550                     type: string
5551                   type: array
5552               required:
5553               - path
5554               - daemons
5555               - pseudo
5556               - tag
5557               - access_type
5558               - squash
5559               - security_label
5560               - protocols
5561               - transports
5562               - fsal
5563               - clients
5564               type: object
5565       responses:
5566         '200':
5567           content:
5568             application/vnd.ceph.api.v1.0+json:
5569               schema:
5570                 properties:
5571                   access_type:
5572                     description: Export access type
5573                     type: string
5574                   clients:
5575                     description: List of client configurations
5576                     items:
5577                       properties:
5578                         access_type:
5579                           description: Client access type
5580                           type: string
5581                         addresses:
5582                           description: list of IP addresses
5583                           items:
5584                             type: string
5585                           type: array
5586                         squash:
5587                           description: Client squash policy
5588                           type: string
5589                       required:
5590                       - addresses
5591                       - access_type
5592                       - squash
5593                       type: object
5594                     type: array
5595                   cluster_id:
5596                     description: Cluster identifier
5597                     type: string
5598                   daemons:
5599                     description: List of NFS Ganesha daemons identifiers
5600                     items:
5601                       type: string
5602                     type: array
5603                   export_id:
5604                     description: Export ID
5605                     type: integer
5606                   fsal:
5607                     description: FSAL configuration
5608                     properties:
5609                       filesystem:
5610                         description: CephFS filesystem ID
5611                         type: string
5612                       name:
5613                         description: name of FSAL
5614                         type: string
5615                       rgw_user_id:
5616                         description: RGW user id
5617                         type: string
5618                       sec_label_xattr:
5619                         description: Name of xattr for security label
5620                         type: string
5621                       user_id:
5622                         description: CephX user id
5623                         type: string
5624                     required:
5625                     - name
5626                     type: object
5627                   path:
5628                     description: Export path
5629                     type: string
5630                   protocols:
5631                     description: List of protocol types
5632                     items:
5633                       type: integer
5634                     type: array
5635                   pseudo:
5636                     description: Pseudo FS path
5637                     type: string
5638                   security_label:
5639                     description: Security label
5640                     type: string
5641                   squash:
5642                     description: Export squash policy
5643                     type: string
5644                   tag:
5645                     description: NFSv3 export tag
5646                     type: string
5647                   transports:
5648                     description: List of transport types
5649                     items:
5650                       type: string
5651                     type: array
5652                 required:
5653                 - export_id
5654                 - path
5655                 - cluster_id
5656                 - daemons
5657                 - pseudo
5658                 - tag
5659                 - access_type
5660                 - squash
5661                 - security_label
5662                 - protocols
5663                 - transports
5664                 - fsal
5665                 - clients
5666                 type: object
5667           description: Resource updated.
5668         '202':
5669           content:
5670             application/vnd.ceph.api.v1.0+json:
5671               type: object
5672           description: Operation is still executing. Please check the task queue.
5673         '400':
5674           description: Operation exception. Please check the response body for details.
5675         '401':
5676           description: Unauthenticated access. Please login first.
5677         '403':
5678           description: Unauthorized access. Please check your permissions.
5679         '500':
5680           description: Unexpected error. Please check the response body for the stack
5681             trace.
5682       security:
5683       - jwt: []
5684       summary: Updates an NFS-Ganesha export
5685       tags:
5686       - NFS-Ganesha
5687   /api/nfs-ganesha/status:
5688     get:
5689       parameters: []
5690       responses:
5691         '200':
5692           content:
5693             application/vnd.ceph.api.v1.0+json:
5694               schema:
5695                 properties:
5696                   available:
5697                     description: Is API available?
5698                     type: boolean
5699                   message:
5700                     description: Error message
5701                     type: string
5702                 required:
5703                 - available
5704                 - message
5705                 type: object
5706           description: OK
5707         '400':
5708           description: Operation exception. Please check the response body for details.
5709         '401':
5710           description: Unauthenticated access. Please login first.
5711         '403':
5712           description: Unauthorized access. Please check your permissions.
5713         '500':
5714           description: Unexpected error. Please check the response body for the stack
5715             trace.
5716       security:
5717       - jwt: []
5718       summary: Status of NFS-Ganesha management feature
5719       tags:
5720       - NFS-Ganesha
5721   /api/orchestrator/status:
5722     get:
5723       parameters: []
5724       responses:
5725         '200':
5726           content:
5727             application/vnd.ceph.api.v1.0+json:
5728               schema:
5729                 properties:
5730                   available:
5731                     description: Orchestrator status
5732                     type: boolean
5733                   message:
5734                     description: Error message
5735                     type: string
5736                 required:
5737                 - available
5738                 - message
5739                 type: object
5740           description: OK
5741         '400':
5742           description: Operation exception. Please check the response body for details.
5743         '401':
5744           description: Unauthenticated access. Please login first.
5745         '403':
5746           description: Unauthorized access. Please check your permissions.
5747         '500':
5748           description: Unexpected error. Please check the response body for the stack
5749             trace.
5750       security:
5751       - jwt: []
5752       summary: Display Orchestrator Status
5753       tags:
5754       - Orchestrator
5755   /api/osd:
5756     get:
5757       parameters: []
5758       responses:
5759         '200':
5760           content:
5761             application/vnd.ceph.api.v1.0+json:
5762               type: object
5763           description: OK
5764         '400':
5765           description: Operation exception. Please check the response body for details.
5766         '401':
5767           description: Unauthenticated access. Please login first.
5768         '403':
5769           description: Unauthorized access. Please check your permissions.
5770         '500':
5771           description: Unexpected error. Please check the response body for the stack
5772             trace.
5773       security:
5774       - jwt: []
5775       tags:
5776       - OSD
5777     post:
5778       parameters: []
5779       requestBody:
5780         content:
5781           application/json:
5782             schema:
5783               properties:
5784                 data:
5785                   type: string
5786                 method:
5787                   type: string
5788                 tracking_id:
5789                   type: string
5790               required:
5791               - method
5792               - data
5793               - tracking_id
5794               type: object
5795       responses:
5796         '201':
5797           content:
5798             application/vnd.ceph.api.v1.0+json:
5799               type: object
5800           description: Resource created.
5801         '202':
5802           content:
5803             application/vnd.ceph.api.v1.0+json:
5804               type: object
5805           description: Operation is still executing. Please check the task queue.
5806         '400':
5807           description: Operation exception. Please check the response body for details.
5808         '401':
5809           description: Unauthenticated access. Please login first.
5810         '403':
5811           description: Unauthorized access. Please check your permissions.
5812         '500':
5813           description: Unexpected error. Please check the response body for the stack
5814             trace.
5815       security:
5816       - jwt: []
5817       tags:
5818       - OSD
5819   /api/osd/flags:
5820     get:
5821       parameters: []
5822       responses:
5823         '200':
5824           content:
5825             application/vnd.ceph.api.v1.0+json:
5826               schema:
5827                 properties:
5828                   list_of_flags:
5829                     description: ''
5830                     items:
5831                       type: string
5832                     type: array
5833                 required:
5834                 - list_of_flags
5835                 type: object
5836           description: OK
5837         '400':
5838           description: Operation exception. Please check the response body for details.
5839         '401':
5840           description: Unauthenticated access. Please login first.
5841         '403':
5842           description: Unauthorized access. Please check your permissions.
5843         '500':
5844           description: Unexpected error. Please check the response body for the stack
5845             trace.
5846       security:
5847       - jwt: []
5848       summary: Display OSD Flags
5849       tags:
5850       - OSD
5851     put:
5852       description: "\n        The `recovery_deletes`, `sortbitwise` and `pglog_hardlimit`\
5853         \ flags cannot be unset.\n        `purged_snapshots` cannot even be set. It\
5854         \ is therefore required to at\n        least include those four flags for\
5855         \ a successful operation.\n        "
5856       parameters: []
5857       requestBody:
5858         content:
5859           application/json:
5860             schema:
5861               properties:
5862                 flags:
5863                   description: List of flags to set. The flags `recovery_deletes`,
5864                     `sortbitwise` and `pglog_hardlimit` cannot be unset. Additionally
5865                     `purged_snapshots` cannot even be set.
5866                   items:
5867                     type: string
5868                   type: array
5869               required:
5870               - flags
5871               type: object
5872       responses:
5873         '200':
5874           content:
5875             application/vnd.ceph.api.v1.0+json:
5876               schema:
5877                 properties:
5878                   list_of_flags:
5879                     description: ''
5880                     items:
5881                       type: string
5882                     type: array
5883                 required:
5884                 - list_of_flags
5885                 type: object
5886           description: Resource updated.
5887         '202':
5888           content:
5889             application/vnd.ceph.api.v1.0+json:
5890               type: object
5891           description: Operation is still executing. Please check the task queue.
5892         '400':
5893           description: Operation exception. Please check the response body for details.
5894         '401':
5895           description: Unauthenticated access. Please login first.
5896         '403':
5897           description: Unauthorized access. Please check your permissions.
5898         '500':
5899           description: Unexpected error. Please check the response body for the stack
5900             trace.
5901       security:
5902       - jwt: []
5903       summary: Sets OSD flags for the entire cluster.
5904       tags:
5905       - OSD
5906   /api/osd/flags/individual:
5907     get:
5908       parameters: []
5909       responses:
5910         '200':
5911           content:
5912             application/vnd.ceph.api.v1.0+json:
5913               schema:
5914                 properties:
5915                   flags:
5916                     description: List of active flags
5917                     items:
5918                       type: string
5919                     type: array
5920                   osd:
5921                     description: OSD ID
5922                     type: integer
5923                 required:
5924                 - osd
5925                 - flags
5926                 type: object
5927           description: OK
5928         '400':
5929           description: Operation exception. Please check the response body for details.
5930         '401':
5931           description: Unauthenticated access. Please login first.
5932         '403':
5933           description: Unauthorized access. Please check your permissions.
5934         '500':
5935           description: Unexpected error. Please check the response body for the stack
5936             trace.
5937       security:
5938       - jwt: []
5939       summary: Displays individual OSD flags
5940       tags:
5941       - OSD
5942     put:
5943       description: "\n        Updates flags (`noout`, `noin`, `nodown`, `noup`) for\
5944         \ an individual\n        subset of OSDs.\n        "
5945       parameters: []
5946       requestBody:
5947         content:
5948           application/json:
5949             schema:
5950               properties:
5951                 flags:
5952                   description: Directory of flags to set or unset. The flags `noin`,
5953                     `noout`, `noup` and `nodown` are going to be considered only.
5954                   properties:
5955                     nodown:
5956                       description: Sets/unsets `nodown`
5957                       type: boolean
5958                     noin:
5959                       description: Sets/unsets `noin`
5960                       type: boolean
5961                     noout:
5962                       description: Sets/unsets `noout`
5963                       type: boolean
5964                     noup:
5965                       description: Sets/unsets `noup`
5966                       type: boolean
5967                   type: object
5968                 ids:
5969                   description: List of OSD ids the flags should be applied to.
5970                   items:
5971                     type: integer
5972                   type: array
5973               required:
5974               - flags
5975               - ids
5976               type: object
5977       responses:
5978         '200':
5979           content:
5980             application/vnd.ceph.api.v1.0+json:
5981               schema:
5982                 properties:
5983                   added:
5984                     description: List of added flags
5985                     items:
5986                       type: string
5987                     type: array
5988                   ids:
5989                     description: List of updated OSDs
5990                     items:
5991                       type: integer
5992                     type: array
5993                   removed:
5994                     description: List of removed flags
5995                     items:
5996                       type: string
5997                     type: array
5998                 required:
5999                 - added
6000                 - removed
6001                 - ids
6002                 type: object
6003           description: Resource updated.
6004         '202':
6005           content:
6006             application/vnd.ceph.api.v1.0+json:
6007               type: object
6008           description: Operation is still executing. Please check the task queue.
6009         '400':
6010           description: Operation exception. Please check the response body for details.
6011         '401':
6012           description: Unauthenticated access. Please login first.
6013         '403':
6014           description: Unauthorized access. Please check your permissions.
6015         '500':
6016           description: Unexpected error. Please check the response body for the stack
6017             trace.
6018       security:
6019       - jwt: []
6020       summary: Sets OSD flags for a subset of individual OSDs.
6021       tags:
6022       - OSD
6023   /api/osd/safe_to_delete:
6024     get:
6025       description: "\n        :type ids: int|[int]\n        "
6026       parameters:
6027       - in: query
6028         name: svc_ids
6029         required: true
6030         schema:
6031           type: string
6032       responses:
6033         '200':
6034           content:
6035             application/vnd.ceph.api.v1.0+json:
6036               type: object
6037           description: OK
6038         '400':
6039           description: Operation exception. Please check the response body for details.
6040         '401':
6041           description: Unauthenticated access. Please login first.
6042         '403':
6043           description: Unauthorized access. Please check your permissions.
6044         '500':
6045           description: Unexpected error. Please check the response body for the stack
6046             trace.
6047       security:
6048       - jwt: []
6049       tags:
6050       - OSD
6051   /api/osd/safe_to_destroy:
6052     get:
6053       description: "\n        :type ids: int|[int]\n        "
6054       parameters:
6055       - description: OSD Service Identifier
6056         in: query
6057         name: ids
6058         required: true
6059         schema:
6060           type: string
6061       responses:
6062         '200':
6063           content:
6064             application/vnd.ceph.api.v1.0+json:
6065               schema:
6066                 properties:
6067                   active:
6068                     description: ''
6069                     items:
6070                       type: integer
6071                     type: array
6072                   is_safe_to_destroy:
6073                     description: Is OSD safe to destroy?
6074                     type: boolean
6075                   missing_stats:
6076                     description: ''
6077                     items:
6078                       type: string
6079                     type: array
6080                   safe_to_destroy:
6081                     description: Is OSD safe to destroy?
6082                     items:
6083                       type: string
6084                     type: array
6085                   stored_pgs:
6086                     description: Stored Pool groups in Osd
6087                     items:
6088                       type: string
6089                     type: array
6090                 required:
6091                 - safe_to_destroy
6092                 - active
6093                 - missing_stats
6094                 - stored_pgs
6095                 - is_safe_to_destroy
6096                 type: object
6097           description: OK
6098         '400':
6099           description: Operation exception. Please check the response body for details.
6100         '401':
6101           description: Unauthenticated access. Please login first.
6102         '403':
6103           description: Unauthorized access. Please check your permissions.
6104         '500':
6105           description: Unexpected error. Please check the response body for the stack
6106             trace.
6107       security:
6108       - jwt: []
6109       summary: Check If OSD is Safe to Destroy
6110       tags:
6111       - OSD
6112   /api/osd/{svc_id}:
6113     delete:
6114       parameters:
6115       - in: path
6116         name: svc_id
6117         required: true
6118         schema:
6119           type: string
6120       - allowEmptyValue: true
6121         in: query
6122         name: preserve_id
6123         schema:
6124           type: string
6125       - allowEmptyValue: true
6126         in: query
6127         name: force
6128         schema:
6129           type: string
6130       responses:
6131         '202':
6132           content:
6133             application/vnd.ceph.api.v1.0+json:
6134               type: object
6135           description: Operation is still executing. Please check the task queue.
6136         '204':
6137           content:
6138             application/vnd.ceph.api.v1.0+json:
6139               type: object
6140           description: Resource deleted.
6141         '400':
6142           description: Operation exception. Please check the response body for details.
6143         '401':
6144           description: Unauthenticated access. Please login first.
6145         '403':
6146           description: Unauthorized access. Please check your permissions.
6147         '500':
6148           description: Unexpected error. Please check the response body for the stack
6149             trace.
6150       security:
6151       - jwt: []
6152       tags:
6153       - OSD
6154     get:
6155       description: "\n        Returns collected data about an OSD.\n\n        :return:\
6156         \ Returns the requested data.\n        "
6157       parameters:
6158       - in: path
6159         name: svc_id
6160         required: true
6161         schema:
6162           type: string
6163       responses:
6164         '200':
6165           content:
6166             application/vnd.ceph.api.v1.0+json:
6167               type: object
6168           description: OK
6169         '400':
6170           description: Operation exception. Please check the response body for details.
6171         '401':
6172           description: Unauthenticated access. Please login first.
6173         '403':
6174           description: Unauthorized access. Please check your permissions.
6175         '500':
6176           description: Unexpected error. Please check the response body for the stack
6177             trace.
6178       security:
6179       - jwt: []
6180       tags:
6181       - OSD
6182     put:
6183       parameters:
6184       - in: path
6185         name: svc_id
6186         required: true
6187         schema:
6188           type: string
6189       requestBody:
6190         content:
6191           application/json:
6192             schema:
6193               properties:
6194                 device_class:
6195                   type: string
6196               required:
6197               - device_class
6198               type: object
6199       responses:
6200         '200':
6201           content:
6202             application/vnd.ceph.api.v1.0+json:
6203               type: object
6204           description: Resource updated.
6205         '202':
6206           content:
6207             application/vnd.ceph.api.v1.0+json:
6208               type: object
6209           description: Operation is still executing. Please check the task queue.
6210         '400':
6211           description: Operation exception. Please check the response body for details.
6212         '401':
6213           description: Unauthenticated access. Please login first.
6214         '403':
6215           description: Unauthorized access. Please check your permissions.
6216         '500':
6217           description: Unexpected error. Please check the response body for the stack
6218             trace.
6219       security:
6220       - jwt: []
6221       tags:
6222       - OSD
6223   /api/osd/{svc_id}/destroy:
6224     post:
6225       description: "\n        Mark osd as being destroyed. Keeps the ID intact (allowing\
6226         \ reuse), but\n        removes cephx keys, config-key data and lockbox keys,\
6227         \ rendering data\n        permanently unreadable.\n\n        The osd must\
6228         \ be marked down before being destroyed.\n        "
6229       parameters:
6230       - in: path
6231         name: svc_id
6232         required: true
6233         schema:
6234           type: string
6235       responses:
6236         '201':
6237           content:
6238             application/vnd.ceph.api.v1.0+json:
6239               type: object
6240           description: Resource created.
6241         '202':
6242           content:
6243             application/vnd.ceph.api.v1.0+json:
6244               type: object
6245           description: Operation is still executing. Please check the task queue.
6246         '400':
6247           description: Operation exception. Please check the response body for details.
6248         '401':
6249           description: Unauthenticated access. Please login first.
6250         '403':
6251           description: Unauthorized access. Please check your permissions.
6252         '500':
6253           description: Unexpected error. Please check the response body for the stack
6254             trace.
6255       security:
6256       - jwt: []
6257       tags:
6258       - OSD
6259   /api/osd/{svc_id}/devices:
6260     get:
6261       parameters:
6262       - in: path
6263         name: svc_id
6264         required: true
6265         schema:
6266           type: string
6267       responses:
6268         '200':
6269           content:
6270             application/vnd.ceph.api.v1.0+json:
6271               type: object
6272           description: OK
6273         '400':
6274           description: Operation exception. Please check the response body for details.
6275         '401':
6276           description: Unauthenticated access. Please login first.
6277         '403':
6278           description: Unauthorized access. Please check your permissions.
6279         '500':
6280           description: Unexpected error. Please check the response body for the stack
6281             trace.
6282       security:
6283       - jwt: []
6284       tags:
6285       - OSD
6286   /api/osd/{svc_id}/histogram:
6287     get:
6288       description: "\n        :return: Returns the histogram data.\n        "
6289       parameters:
6290       - in: path
6291         name: svc_id
6292         required: true
6293         schema:
6294           type: string
6295       responses:
6296         '200':
6297           content:
6298             application/vnd.ceph.api.v1.0+json:
6299               type: object
6300           description: OK
6301         '400':
6302           description: Operation exception. Please check the response body for details.
6303         '401':
6304           description: Unauthenticated access. Please login first.
6305         '403':
6306           description: Unauthorized access. Please check your permissions.
6307         '500':
6308           description: Unexpected error. Please check the response body for the stack
6309             trace.
6310       security:
6311       - jwt: []
6312       tags:
6313       - OSD
6314   /api/osd/{svc_id}/mark:
6315     put:
6316       description: "\n        Note: osd must be marked `down` before marking lost.\n\
6317         \        "
6318       parameters:
6319       - description: SVC ID
6320         in: path
6321         name: svc_id
6322         required: true
6323         schema:
6324           type: string
6325       requestBody:
6326         content:
6327           application/json:
6328             schema:
6329               properties:
6330                 action:
6331                   type: string
6332               required:
6333               - action
6334               type: object
6335       responses:
6336         '200':
6337           content:
6338             application/vnd.ceph.api.v1.0+json:
6339               type: object
6340           description: Resource updated.
6341         '202':
6342           content:
6343             application/vnd.ceph.api.v1.0+json:
6344               type: object
6345           description: Operation is still executing. Please check the task queue.
6346         '400':
6347           description: Operation exception. Please check the response body for details.
6348         '401':
6349           description: Unauthenticated access. Please login first.
6350         '403':
6351           description: Unauthorized access. Please check your permissions.
6352         '500':
6353           description: Unexpected error. Please check the response body for the stack
6354             trace.
6355       security:
6356       - jwt: []
6357       summary: Mark OSD flags (out, in, down, lost, ...)
6358       tags:
6359       - OSD
6360   /api/osd/{svc_id}/purge:
6361     post:
6362       description: "\n        Note: osd must be marked `down` before removal.\n  \
6363         \      "
6364       parameters:
6365       - in: path
6366         name: svc_id
6367         required: true
6368         schema:
6369           type: string
6370       responses:
6371         '201':
6372           content:
6373             application/vnd.ceph.api.v1.0+json:
6374               type: object
6375           description: Resource created.
6376         '202':
6377           content:
6378             application/vnd.ceph.api.v1.0+json:
6379               type: object
6380           description: Operation is still executing. Please check the task queue.
6381         '400':
6382           description: Operation exception. Please check the response body for details.
6383         '401':
6384           description: Unauthenticated access. Please login first.
6385         '403':
6386           description: Unauthorized access. Please check your permissions.
6387         '500':
6388           description: Unexpected error. Please check the response body for the stack
6389             trace.
6390       security:
6391       - jwt: []
6392       tags:
6393       - OSD
6394   /api/osd/{svc_id}/reweight:
6395     post:
6396       description: "\n        Reweights the OSD temporarily.\n\n        Note that\
6397         \ \u2018ceph osd reweight\u2019 is not a persistent setting. When an OSD\n\
6398         \        gets marked out, the osd weight will be set to 0. When it gets marked\n\
6399         \        in again, the weight will be changed to 1.\n\n        Because of\
6400         \ this \u2018ceph osd reweight\u2019 is a temporary solution. You should\n\
6401         \        only use it to keep your cluster running while you\u2019re ordering\
6402         \ more\n        hardware.\n\n        - Craig Lewis (http://lists.ceph.com/pipermail/ceph-users-ceph.com/2014-June/040967.html)\n\
6403         \        "
6404       parameters:
6405       - in: path
6406         name: svc_id
6407         required: true
6408         schema:
6409           type: string
6410       requestBody:
6411         content:
6412           application/json:
6413             schema:
6414               properties:
6415                 weight:
6416                   type: string
6417               required:
6418               - weight
6419               type: object
6420       responses:
6421         '201':
6422           content:
6423             application/vnd.ceph.api.v1.0+json:
6424               type: object
6425           description: Resource created.
6426         '202':
6427           content:
6428             application/vnd.ceph.api.v1.0+json:
6429               type: object
6430           description: Operation is still executing. Please check the task queue.
6431         '400':
6432           description: Operation exception. Please check the response body for details.
6433         '401':
6434           description: Unauthenticated access. Please login first.
6435         '403':
6436           description: Unauthorized access. Please check your permissions.
6437         '500':
6438           description: Unexpected error. Please check the response body for the stack
6439             trace.
6440       security:
6441       - jwt: []
6442       tags:
6443       - OSD
6444   /api/osd/{svc_id}/scrub:
6445     post:
6446       parameters:
6447       - in: path
6448         name: svc_id
6449         required: true
6450         schema:
6451           type: string
6452       - default: false
6453         in: query
6454         name: deep
6455         schema:
6456           type: boolean
6457       requestBody:
6458         content:
6459           application/json:
6460             schema:
6461               properties:
6462                 deep:
6463                   default: false
6464                   type: boolean
6465               type: object
6466       responses:
6467         '201':
6468           content:
6469             application/vnd.ceph.api.v1.0+json:
6470               type: object
6471           description: Resource created.
6472         '202':
6473           content:
6474             application/vnd.ceph.api.v1.0+json:
6475               type: object
6476           description: Operation is still executing. Please check the task queue.
6477         '400':
6478           description: Operation exception. Please check the response body for details.
6479         '401':
6480           description: Unauthenticated access. Please login first.
6481         '403':
6482           description: Unauthorized access. Please check your permissions.
6483         '500':
6484           description: Unexpected error. Please check the response body for the stack
6485             trace.
6486       security:
6487       - jwt: []
6488       tags:
6489       - OSD
6490   /api/osd/{svc_id}/smart:
6491     get:
6492       parameters:
6493       - in: path
6494         name: svc_id
6495         required: true
6496         schema:
6497           type: string
6498       responses:
6499         '200':
6500           content:
6501             application/vnd.ceph.api.v1.0+json:
6502               type: object
6503           description: OK
6504         '400':
6505           description: Operation exception. Please check the response body for details.
6506         '401':
6507           description: Unauthenticated access. Please login first.
6508         '403':
6509           description: Unauthorized access. Please check your permissions.
6510         '500':
6511           description: Unexpected error. Please check the response body for the stack
6512             trace.
6513       security:
6514       - jwt: []
6515       tags:
6516       - OSD
6517   /api/perf_counters:
6518     get:
6519       parameters: []
6520       responses:
6521         '200':
6522           content:
6523             application/vnd.ceph.api.v1.0+json:
6524               schema:
6525                 properties:
6526                   mon.a:
6527                     description: Service ID
6528                     properties:
6529                       .cache_bytes:
6530                         description: ''
6531                         properties:
6532                           description:
6533                             description: ''
6534                             type: string
6535                           nick:
6536                             description: ''
6537                             type: string
6538                           priority:
6539                             description: ''
6540                             type: integer
6541                           type:
6542                             description: ''
6543                             type: integer
6544                           units:
6545                             description: ''
6546                             type: integer
6547                           value:
6548                             description: ''
6549                             type: integer
6550                         required:
6551                         - description
6552                         - nick
6553                         - type
6554                         - priority
6555                         - units
6556                         - value
6557                         type: object
6558                     required:
6559                     - .cache_bytes
6560                     type: object
6561                 required:
6562                 - mon.a
6563                 type: object
6564           description: OK
6565         '400':
6566           description: Operation exception. Please check the response body for details.
6567         '401':
6568           description: Unauthenticated access. Please login first.
6569         '403':
6570           description: Unauthorized access. Please check your permissions.
6571         '500':
6572           description: Unexpected error. Please check the response body for the stack
6573             trace.
6574       security:
6575       - jwt: []
6576       summary: Display Perf Counters
6577       tags:
6578       - PerfCounters
6579   /api/perf_counters/mds/{service_id}:
6580     get:
6581       parameters:
6582       - in: path
6583         name: service_id
6584         required: true
6585         schema:
6586           type: string
6587       responses:
6588         '200':
6589           content:
6590             application/vnd.ceph.api.v1.0+json:
6591               type: object
6592           description: OK
6593         '400':
6594           description: Operation exception. Please check the response body for details.
6595         '401':
6596           description: Unauthenticated access. Please login first.
6597         '403':
6598           description: Unauthorized access. Please check your permissions.
6599         '500':
6600           description: Unexpected error. Please check the response body for the stack
6601             trace.
6602       security:
6603       - jwt: []
6604       tags:
6605       - MdsPerfCounter
6606   /api/perf_counters/mgr/{service_id}:
6607     get:
6608       parameters:
6609       - in: path
6610         name: service_id
6611         required: true
6612         schema:
6613           type: string
6614       responses:
6615         '200':
6616           content:
6617             application/vnd.ceph.api.v1.0+json:
6618               type: object
6619           description: OK
6620         '400':
6621           description: Operation exception. Please check the response body for details.
6622         '401':
6623           description: Unauthenticated access. Please login first.
6624         '403':
6625           description: Unauthorized access. Please check your permissions.
6626         '500':
6627           description: Unexpected error. Please check the response body for the stack
6628             trace.
6629       security:
6630       - jwt: []
6631       tags:
6632       - MgrPerfCounter
6633   /api/perf_counters/mon/{service_id}:
6634     get:
6635       parameters:
6636       - in: path
6637         name: service_id
6638         required: true
6639         schema:
6640           type: string
6641       responses:
6642         '200':
6643           content:
6644             application/vnd.ceph.api.v1.0+json:
6645               type: object
6646           description: OK
6647         '400':
6648           description: Operation exception. Please check the response body for details.
6649         '401':
6650           description: Unauthenticated access. Please login first.
6651         '403':
6652           description: Unauthorized access. Please check your permissions.
6653         '500':
6654           description: Unexpected error. Please check the response body for the stack
6655             trace.
6656       security:
6657       - jwt: []
6658       tags:
6659       - MonPerfCounter
6660   /api/perf_counters/osd/{service_id}:
6661     get:
6662       parameters:
6663       - in: path
6664         name: service_id
6665         required: true
6666         schema:
6667           type: string
6668       responses:
6669         '200':
6670           content:
6671             application/vnd.ceph.api.v1.0+json:
6672               type: object
6673           description: OK
6674         '400':
6675           description: Operation exception. Please check the response body for details.
6676         '401':
6677           description: Unauthenticated access. Please login first.
6678         '403':
6679           description: Unauthorized access. Please check your permissions.
6680         '500':
6681           description: Unexpected error. Please check the response body for the stack
6682             trace.
6683       security:
6684       - jwt: []
6685       tags:
6686       - OsdPerfCounter
6687   /api/perf_counters/rbd-mirror/{service_id}:
6688     get:
6689       parameters:
6690       - in: path
6691         name: service_id
6692         required: true
6693         schema:
6694           type: string
6695       responses:
6696         '200':
6697           content:
6698             application/vnd.ceph.api.v1.0+json:
6699               type: object
6700           description: OK
6701         '400':
6702           description: Operation exception. Please check the response body for details.
6703         '401':
6704           description: Unauthenticated access. Please login first.
6705         '403':
6706           description: Unauthorized access. Please check your permissions.
6707         '500':
6708           description: Unexpected error. Please check the response body for the stack
6709             trace.
6710       security:
6711       - jwt: []
6712       tags:
6713       - RgwMirrorPerfCounter
6714   /api/perf_counters/rgw/{service_id}:
6715     get:
6716       parameters:
6717       - in: path
6718         name: service_id
6719         required: true
6720         schema:
6721           type: string
6722       responses:
6723         '200':
6724           content:
6725             application/vnd.ceph.api.v1.0+json:
6726               type: object
6727           description: OK
6728         '400':
6729           description: Operation exception. Please check the response body for details.
6730         '401':
6731           description: Unauthenticated access. Please login first.
6732         '403':
6733           description: Unauthorized access. Please check your permissions.
6734         '500':
6735           description: Unexpected error. Please check the response body for the stack
6736             trace.
6737       security:
6738       - jwt: []
6739       tags:
6740       - RgwPerfCounter
6741   /api/perf_counters/tcmu-runner/{service_id}:
6742     get:
6743       parameters:
6744       - in: path
6745         name: service_id
6746         required: true
6747         schema:
6748           type: string
6749       responses:
6750         '200':
6751           content:
6752             application/vnd.ceph.api.v1.0+json:
6753               type: object
6754           description: OK
6755         '400':
6756           description: Operation exception. Please check the response body for details.
6757         '401':
6758           description: Unauthenticated access. Please login first.
6759         '403':
6760           description: Unauthorized access. Please check your permissions.
6761         '500':
6762           description: Unexpected error. Please check the response body for the stack
6763             trace.
6764       security:
6765       - jwt: []
6766       tags:
6767       - TcmuRunnerPerfCounter
6768   /api/pool:
6769     get:
6770       parameters:
6771       - allowEmptyValue: true
6772         description: Pool Attributes
6773         in: query
6774         name: attrs
6775         schema:
6776           type: string
6777       - default: false
6778         description: Pool Stats
6779         in: query
6780         name: stats
6781         schema:
6782           type: boolean
6783       responses:
6784         '200':
6785           content:
6786             application/vnd.ceph.api.v1.0+json:
6787               schema:
6788                 items:
6789                   properties:
6790                     application_metadata:
6791                       description: ''
6792                       items:
6793                         type: string
6794                       type: array
6795                     auid:
6796                       description: ''
6797                       type: integer
6798                     cache_min_evict_age:
6799                       description: ''
6800                       type: integer
6801                     cache_min_flush_age:
6802                       description: ''
6803                       type: integer
6804                     cache_mode:
6805                       description: ''
6806                       type: string
6807                     cache_target_dirty_high_ratio_micro:
6808                       description: ''
6809                       type: integer
6810                     cache_target_dirty_ratio_micro:
6811                       description: ''
6812                       type: integer
6813                     cache_target_full_ratio_micro:
6814                       description: ''
6815                       type: integer
6816                     create_time:
6817                       description: ''
6818                       type: string
6819                     crush_rule:
6820                       description: ''
6821                       type: string
6822                     erasure_code_profile:
6823                       description: ''
6824                       type: string
6825                     expected_num_objects:
6826                       description: ''
6827                       type: integer
6828                     fast_read:
6829                       description: ''
6830                       type: boolean
6831                     flags:
6832                       description: ''
6833                       type: integer
6834                     flags_names:
6835                       description: flags name
6836                       type: string
6837                     grade_table:
6838                       description: ''
6839                       items:
6840                         type: string
6841                       type: array
6842                     hit_set_count:
6843                       description: ''
6844                       type: integer
6845                     hit_set_grade_decay_rate:
6846                       description: ''
6847                       type: integer
6848                     hit_set_params:
6849                       description: ''
6850                       properties:
6851                         type:
6852                           description: ''
6853                           type: string
6854                       required:
6855                       - type
6856                       type: object
6857                     hit_set_period:
6858                       description: ''
6859                       type: integer
6860                     hit_set_search_last_n:
6861                       description: ''
6862                       type: integer
6863                     last_change:
6864                       description: ''
6865                       type: string
6866                     last_force_op_resend:
6867                       description: ''
6868                       type: string
6869                     last_force_op_resend_preluminous:
6870                       description: ''
6871                       type: string
6872                     last_force_op_resend_prenautilus:
6873                       description: ''
6874                       type: string
6875                     last_pg_merge_meta:
6876                       description: ''
6877                       properties:
6878                         last_epoch_clean:
6879                           description: ''
6880                           type: integer
6881                         last_epoch_started:
6882                           description: ''
6883                           type: integer
6884                         ready_epoch:
6885                           description: ''
6886                           type: integer
6887                         source_pgid:
6888                           description: ''
6889                           type: string
6890                         source_version:
6891                           description: ''
6892                           type: string
6893                         target_version:
6894                           description: ''
6895                           type: string
6896                       required:
6897                       - ready_epoch
6898                       - last_epoch_started
6899                       - last_epoch_clean
6900                       - source_pgid
6901                       - source_version
6902                       - target_version
6903                       type: object
6904                     min_read_recency_for_promote:
6905                       description: ''
6906                       type: integer
6907                     min_size:
6908                       description: ''
6909                       type: integer
6910                     min_write_recency_for_promote:
6911                       description: ''
6912                       type: integer
6913                     object_hash:
6914                       description: ''
6915                       type: integer
6916                     options:
6917                       description: ''
6918                       properties:
6919                         pg_num_min:
6920                           description: ''
6921                           type: integer
6922                       required:
6923                       - pg_num_min
6924                       type: object
6925                     pg_autoscale_mode:
6926                       description: ''
6927                       type: string
6928                     pg_num:
6929                       description: ''
6930                       type: integer
6931                     pg_num_pending:
6932                       description: ''
6933                       type: integer
6934                     pg_num_target:
6935                       description: ''
6936                       type: integer
6937                     pg_placement_num:
6938                       description: ''
6939                       type: integer
6940                     pg_placement_num_target:
6941                       description: ''
6942                       type: integer
6943                     pool:
6944                       description: pool id
6945                       type: integer
6946                     pool_name:
6947                       description: pool name
6948                       type: string
6949                     pool_snaps:
6950                       description: ''
6951                       items:
6952                         type: string
6953                       type: array
6954                     quota_max_bytes:
6955                       description: ''
6956                       type: integer
6957                     quota_max_objects:
6958                       description: ''
6959                       type: integer
6960                     read_tier:
6961                       description: ''
6962                       type: integer
6963                     removed_snaps:
6964                       description: ''
6965                       items:
6966                         type: string
6967                       type: array
6968                     size:
6969                       description: pool size
6970                       type: integer
6971                     snap_epoch:
6972                       description: ''
6973                       type: integer
6974                     snap_mode:
6975                       description: ''
6976                       type: string
6977                     snap_seq:
6978                       description: ''
6979                       type: integer
6980                     stripe_width:
6981                       description: ''
6982                       type: integer
6983                     target_max_bytes:
6984                       description: ''
6985                       type: integer
6986                     target_max_objects:
6987                       description: ''
6988                       type: integer
6989                     tier_of:
6990                       description: ''
6991                       type: integer
6992                     tiers:
6993                       description: ''
6994                       items:
6995                         type: string
6996                       type: array
6997                     type:
6998                       description: type of pool
6999                       type: string
7000                     use_gmt_hitset:
7001                       description: ''
7002                       type: boolean
7003                     write_tier:
7004                       description: ''
7005                       type: integer
7006                   type: object
7007                 required:
7008                 - pool
7009                 - pool_name
7010                 - flags
7011                 - flags_names
7012                 - type
7013                 - size
7014                 - min_size
7015                 - crush_rule
7016                 - object_hash
7017                 - pg_autoscale_mode
7018                 - pg_num
7019                 - pg_placement_num
7020                 - pg_placement_num_target
7021                 - pg_num_target
7022                 - pg_num_pending
7023                 - last_pg_merge_meta
7024                 - auid
7025                 - snap_mode
7026                 - snap_seq
7027                 - snap_epoch
7028                 - pool_snaps
7029                 - quota_max_bytes
7030                 - quota_max_objects
7031                 - tiers
7032                 - tier_of
7033                 - read_tier
7034                 - write_tier
7035                 - cache_mode
7036                 - target_max_bytes
7037                 - target_max_objects
7038                 - cache_target_dirty_ratio_micro
7039                 - cache_target_dirty_high_ratio_micro
7040                 - cache_target_full_ratio_micro
7041                 - cache_min_flush_age
7042                 - cache_min_evict_age
7043                 - erasure_code_profile
7044                 - hit_set_params
7045                 - hit_set_period
7046                 - hit_set_count
7047                 - use_gmt_hitset
7048                 - min_read_recency_for_promote
7049                 - min_write_recency_for_promote
7050                 - hit_set_grade_decay_rate
7051                 - hit_set_search_last_n
7052                 - grade_table
7053                 - stripe_width
7054                 - expected_num_objects
7055                 - fast_read
7056                 - options
7057                 - application_metadata
7058                 - create_time
7059                 - last_change
7060                 - last_force_op_resend
7061                 - last_force_op_resend_prenautilus
7062                 - last_force_op_resend_preluminous
7063                 - removed_snaps
7064                 type: array
7065           description: OK
7066         '400':
7067           description: Operation exception. Please check the response body for details.
7068         '401':
7069           description: Unauthenticated access. Please login first.
7070         '403':
7071           description: Unauthorized access. Please check your permissions.
7072         '500':
7073           description: Unexpected error. Please check the response body for the stack
7074             trace.
7075       security:
7076       - jwt: []
7077       summary: Display Pool List
7078       tags:
7079       - Pool
7080     post:
7081       parameters: []
7082       requestBody:
7083         content:
7084           application/json:
7085             schema:
7086               properties:
7087                 application_metadata:
7088                   type: string
7089                 configuration:
7090                   type: string
7091                 erasure_code_profile:
7092                   type: string
7093                 flags:
7094                   type: string
7095                 pg_num:
7096                   type: integer
7097                 pool:
7098                   type: string
7099                 pool_type:
7100                   type: string
7101                 rule_name:
7102                   type: string
7103               required:
7104               - pool
7105               - pg_num
7106               - pool_type
7107               type: object
7108       responses:
7109         '201':
7110           content:
7111             application/vnd.ceph.api.v1.0+json:
7112               type: object
7113           description: Resource created.
7114         '202':
7115           content:
7116             application/vnd.ceph.api.v1.0+json:
7117               type: object
7118           description: Operation is still executing. Please check the task queue.
7119         '400':
7120           description: Operation exception. Please check the response body for details.
7121         '401':
7122           description: Unauthenticated access. Please login first.
7123         '403':
7124           description: Unauthorized access. Please check your permissions.
7125         '500':
7126           description: Unexpected error. Please check the response body for the stack
7127             trace.
7128       security:
7129       - jwt: []
7130       tags:
7131       - Pool
7132   /api/pool/{pool_name}:
7133     delete:
7134       parameters:
7135       - in: path
7136         name: pool_name
7137         required: true
7138         schema:
7139           type: string
7140       responses:
7141         '202':
7142           content:
7143             application/vnd.ceph.api.v1.0+json:
7144               type: object
7145           description: Operation is still executing. Please check the task queue.
7146         '204':
7147           content:
7148             application/vnd.ceph.api.v1.0+json:
7149               type: object
7150           description: Resource deleted.
7151         '400':
7152           description: Operation exception. Please check the response body for details.
7153         '401':
7154           description: Unauthenticated access. Please login first.
7155         '403':
7156           description: Unauthorized access. Please check your permissions.
7157         '500':
7158           description: Unexpected error. Please check the response body for the stack
7159             trace.
7160       security:
7161       - jwt: []
7162       tags:
7163       - Pool
7164     get:
7165       parameters:
7166       - in: path
7167         name: pool_name
7168         required: true
7169         schema:
7170           type: string
7171       - allowEmptyValue: true
7172         in: query
7173         name: attrs
7174         schema:
7175           type: string
7176       - default: false
7177         in: query
7178         name: stats
7179         schema:
7180           type: boolean
7181       responses:
7182         '200':
7183           content:
7184             application/vnd.ceph.api.v1.0+json:
7185               type: object
7186           description: OK
7187         '400':
7188           description: Operation exception. Please check the response body for details.
7189         '401':
7190           description: Unauthenticated access. Please login first.
7191         '403':
7192           description: Unauthorized access. Please check your permissions.
7193         '500':
7194           description: Unexpected error. Please check the response body for the stack
7195             trace.
7196       security:
7197       - jwt: []
7198       tags:
7199       - Pool
7200     put:
7201       parameters:
7202       - in: path
7203         name: pool_name
7204         required: true
7205         schema:
7206           type: string
7207       requestBody:
7208         content:
7209           application/json:
7210             schema:
7211               properties:
7212                 application_metadata:
7213                   type: string
7214                 configuration:
7215                   type: string
7216                 flags:
7217                   type: string
7218               type: object
7219       responses:
7220         '200':
7221           content:
7222             application/vnd.ceph.api.v1.0+json:
7223               type: object
7224           description: Resource updated.
7225         '202':
7226           content:
7227             application/vnd.ceph.api.v1.0+json:
7228               type: object
7229           description: Operation is still executing. Please check the task queue.
7230         '400':
7231           description: Operation exception. Please check the response body for details.
7232         '401':
7233           description: Unauthenticated access. Please login first.
7234         '403':
7235           description: Unauthorized access. Please check your permissions.
7236         '500':
7237           description: Unexpected error. Please check the response body for the stack
7238             trace.
7239       security:
7240       - jwt: []
7241       tags:
7242       - Pool
7243   /api/pool/{pool_name}/configuration:
7244     get:
7245       parameters:
7246       - in: path
7247         name: pool_name
7248         required: true
7249         schema:
7250           type: string
7251       responses:
7252         '200':
7253           content:
7254             application/vnd.ceph.api.v1.0+json:
7255               type: object
7256           description: OK
7257         '400':
7258           description: Operation exception. Please check the response body for details.
7259         '401':
7260           description: Unauthenticated access. Please login first.
7261         '403':
7262           description: Unauthorized access. Please check your permissions.
7263         '500':
7264           description: Unexpected error. Please check the response body for the stack
7265             trace.
7266       security:
7267       - jwt: []
7268       tags:
7269       - Pool
7270   /api/prometheus:
7271     get:
7272       parameters: []
7273       responses:
7274         '200':
7275           content:
7276             application/vnd.ceph.api.v1.0+json:
7277               type: object
7278           description: OK
7279         '400':
7280           description: Operation exception. Please check the response body for details.
7281         '401':
7282           description: Unauthenticated access. Please login first.
7283         '403':
7284           description: Unauthorized access. Please check your permissions.
7285         '500':
7286           description: Unexpected error. Please check the response body for the stack
7287             trace.
7288       security:
7289       - jwt: []
7290       tags:
7291       - Prometheus
7292   /api/prometheus/notifications:
7293     get:
7294       parameters: []
7295       responses:
7296         '200':
7297           content:
7298             application/vnd.ceph.api.v1.0+json:
7299               type: object
7300           description: OK
7301         '400':
7302           description: Operation exception. Please check the response body for details.
7303         '401':
7304           description: Unauthenticated access. Please login first.
7305         '403':
7306           description: Unauthorized access. Please check your permissions.
7307         '500':
7308           description: Unexpected error. Please check the response body for the stack
7309             trace.
7310       security:
7311       - jwt: []
7312       tags:
7313       - PrometheusNotifications
7314   /api/prometheus/rules:
7315     get:
7316       parameters: []
7317       responses:
7318         '200':
7319           content:
7320             application/vnd.ceph.api.v1.0+json:
7321               type: object
7322           description: OK
7323         '400':
7324           description: Operation exception. Please check the response body for details.
7325         '401':
7326           description: Unauthenticated access. Please login first.
7327         '403':
7328           description: Unauthorized access. Please check your permissions.
7329         '500':
7330           description: Unexpected error. Please check the response body for the stack
7331             trace.
7332       security:
7333       - jwt: []
7334       tags:
7335       - Prometheus
7336   /api/prometheus/silence:
7337     post:
7338       parameters: []
7339       responses:
7340         '201':
7341           content:
7342             application/vnd.ceph.api.v1.0+json:
7343               type: object
7344           description: Resource created.
7345         '202':
7346           content:
7347             application/vnd.ceph.api.v1.0+json:
7348               type: object
7349           description: Operation is still executing. Please check the task queue.
7350         '400':
7351           description: Operation exception. Please check the response body for details.
7352         '401':
7353           description: Unauthenticated access. Please login first.
7354         '403':
7355           description: Unauthorized access. Please check your permissions.
7356         '500':
7357           description: Unexpected error. Please check the response body for the stack
7358             trace.
7359       security:
7360       - jwt: []
7361       tags:
7362       - Prometheus
7363   /api/prometheus/silence/{s_id}:
7364     delete:
7365       parameters:
7366       - in: path
7367         name: s_id
7368         required: true
7369         schema:
7370           type: string
7371       responses:
7372         '202':
7373           content:
7374             application/vnd.ceph.api.v1.0+json:
7375               type: object
7376           description: Operation is still executing. Please check the task queue.
7377         '204':
7378           content:
7379             application/vnd.ceph.api.v1.0+json:
7380               type: object
7381           description: Resource deleted.
7382         '400':
7383           description: Operation exception. Please check the response body for details.
7384         '401':
7385           description: Unauthenticated access. Please login first.
7386         '403':
7387           description: Unauthorized access. Please check your permissions.
7388         '500':
7389           description: Unexpected error. Please check the response body for the stack
7390             trace.
7391       security:
7392       - jwt: []
7393       tags:
7394       - Prometheus
7395   /api/prometheus/silences:
7396     get:
7397       parameters: []
7398       responses:
7399         '200':
7400           content:
7401             application/vnd.ceph.api.v1.0+json:
7402               type: object
7403           description: OK
7404         '400':
7405           description: Operation exception. Please check the response body for details.
7406         '401':
7407           description: Unauthenticated access. Please login first.
7408         '403':
7409           description: Unauthorized access. Please check your permissions.
7410         '500':
7411           description: Unexpected error. Please check the response body for the stack
7412             trace.
7413       security:
7414       - jwt: []
7415       tags:
7416       - Prometheus
7417   /api/rgw/bucket:
7418     get:
7419       parameters:
7420       - default: false
7421         in: query
7422         name: stats
7423         schema:
7424           type: boolean
7425       - allowEmptyValue: true
7426         in: query
7427         name: daemon_name
7428         schema:
7429           type: string
7430       responses:
7431         '200':
7432           content:
7433             application/vnd.ceph.api.v1.0+json:
7434               type: object
7435           description: OK
7436         '400':
7437           description: Operation exception. Please check the response body for details.
7438         '401':
7439           description: Unauthenticated access. Please login first.
7440         '403':
7441           description: Unauthorized access. Please check your permissions.
7442         '500':
7443           description: Unexpected error. Please check the response body for the stack
7444             trace.
7445       security:
7446       - jwt: []
7447       tags:
7448       - RgwBucket
7449     post:
7450       parameters: []
7451       requestBody:
7452         content:
7453           application/json:
7454             schema:
7455               properties:
7456                 bucket:
7457                   type: string
7458                 daemon_name:
7459                   type: string
7460                 lock_enabled:
7461                   default: 'false'
7462                   type: string
7463                 lock_mode:
7464                   type: string
7465                 lock_retention_period_days:
7466                   type: string
7467                 lock_retention_period_years:
7468                   type: string
7469                 placement_target:
7470                   type: string
7471                 uid:
7472                   type: string
7473                 zonegroup:
7474                   type: string
7475               required:
7476               - bucket
7477               - uid
7478               type: object
7479       responses:
7480         '201':
7481           content:
7482             application/vnd.ceph.api.v1.0+json:
7483               type: object
7484           description: Resource created.
7485         '202':
7486           content:
7487             application/vnd.ceph.api.v1.0+json:
7488               type: object
7489           description: Operation is still executing. Please check the task queue.
7490         '400':
7491           description: Operation exception. Please check the response body for details.
7492         '401':
7493           description: Unauthenticated access. Please login first.
7494         '403':
7495           description: Unauthorized access. Please check your permissions.
7496         '500':
7497           description: Unexpected error. Please check the response body for the stack
7498             trace.
7499       security:
7500       - jwt: []
7501       tags:
7502       - RgwBucket
7503   /api/rgw/bucket/{bucket}:
7504     delete:
7505       parameters:
7506       - in: path
7507         name: bucket
7508         required: true
7509         schema:
7510           type: string
7511       - default: 'true'
7512         in: query
7513         name: purge_objects
7514         schema:
7515           type: string
7516       - allowEmptyValue: true
7517         in: query
7518         name: daemon_name
7519         schema:
7520           type: string
7521       responses:
7522         '202':
7523           content:
7524             application/vnd.ceph.api.v1.0+json:
7525               type: object
7526           description: Operation is still executing. Please check the task queue.
7527         '204':
7528           content:
7529             application/vnd.ceph.api.v1.0+json:
7530               type: object
7531           description: Resource deleted.
7532         '400':
7533           description: Operation exception. Please check the response body for details.
7534         '401':
7535           description: Unauthenticated access. Please login first.
7536         '403':
7537           description: Unauthorized access. Please check your permissions.
7538         '500':
7539           description: Unexpected error. Please check the response body for the stack
7540             trace.
7541       security:
7542       - jwt: []
7543       tags:
7544       - RgwBucket
7545     get:
7546       parameters:
7547       - in: path
7548         name: bucket
7549         required: true
7550         schema:
7551           type: string
7552       - allowEmptyValue: true
7553         in: query
7554         name: daemon_name
7555         schema:
7556           type: string
7557       responses:
7558         '200':
7559           content:
7560             application/vnd.ceph.api.v1.0+json:
7561               type: object
7562           description: OK
7563         '400':
7564           description: Operation exception. Please check the response body for details.
7565         '401':
7566           description: Unauthenticated access. Please login first.
7567         '403':
7568           description: Unauthorized access. Please check your permissions.
7569         '500':
7570           description: Unexpected error. Please check the response body for the stack
7571             trace.
7572       security:
7573       - jwt: []
7574       tags:
7575       - RgwBucket
7576     put:
7577       parameters:
7578       - in: path
7579         name: bucket
7580         required: true
7581         schema:
7582           type: string
7583       requestBody:
7584         content:
7585           application/json:
7586             schema:
7587               properties:
7588                 bucket_id:
7589                   type: string
7590                 daemon_name:
7591                   type: string
7592                 lock_mode:
7593                   type: string
7594                 lock_retention_period_days:
7595                   type: string
7596                 lock_retention_period_years:
7597                   type: string
7598                 mfa_delete:
7599                   type: string
7600                 mfa_token_pin:
7601                   type: string
7602                 mfa_token_serial:
7603                   type: string
7604                 uid:
7605                   type: string
7606                 versioning_state:
7607                   type: string
7608               required:
7609               - bucket_id
7610               - uid
7611               type: object
7612       responses:
7613         '200':
7614           content:
7615             application/vnd.ceph.api.v1.0+json:
7616               type: object
7617           description: Resource updated.
7618         '202':
7619           content:
7620             application/vnd.ceph.api.v1.0+json:
7621               type: object
7622           description: Operation is still executing. Please check the task queue.
7623         '400':
7624           description: Operation exception. Please check the response body for details.
7625         '401':
7626           description: Unauthenticated access. Please login first.
7627         '403':
7628           description: Unauthorized access. Please check your permissions.
7629         '500':
7630           description: Unexpected error. Please check the response body for the stack
7631             trace.
7632       security:
7633       - jwt: []
7634       tags:
7635       - RgwBucket
7636   /api/rgw/daemon:
7637     get:
7638       parameters: []
7639       responses:
7640         '200':
7641           content:
7642             application/vnd.ceph.api.v1.0+json:
7643               schema:
7644                 items:
7645                   properties:
7646                     id:
7647                       description: Daemon ID
7648                       type: string
7649                     server_hostname:
7650                       description: ''
7651                       type: string
7652                     version:
7653                       description: Ceph Version
7654                       type: string
7655                     zone_name:
7656                       description: Zone
7657                       type: string
7658                     zonegroup_name:
7659                       description: Zone Group
7660                       type: string
7661                   type: object
7662                 required:
7663                 - id
7664                 - version
7665                 - server_hostname
7666                 - zonegroup_name
7667                 - zone_name
7668                 type: array
7669           description: OK
7670         '400':
7671           description: Operation exception. Please check the response body for details.
7672         '401':
7673           description: Unauthenticated access. Please login first.
7674         '403':
7675           description: Unauthorized access. Please check your permissions.
7676         '500':
7677           description: Unexpected error. Please check the response body for the stack
7678             trace.
7679       security:
7680       - jwt: []
7681       summary: Display RGW Daemons
7682       tags:
7683       - RgwDaemon
7684   /api/rgw/daemon/{svc_id}:
7685     get:
7686       parameters:
7687       - in: path
7688         name: svc_id
7689         required: true
7690         schema:
7691           type: string
7692       responses:
7693         '200':
7694           content:
7695             application/vnd.ceph.api.v1.0+json:
7696               type: object
7697           description: OK
7698         '400':
7699           description: Operation exception. Please check the response body for details.
7700         '401':
7701           description: Unauthenticated access. Please login first.
7702         '403':
7703           description: Unauthorized access. Please check your permissions.
7704         '500':
7705           description: Unexpected error. Please check the response body for the stack
7706             trace.
7707       security:
7708       - jwt: []
7709       tags:
7710       - RgwDaemon
7711   /api/rgw/site:
7712     get:
7713       parameters:
7714       - allowEmptyValue: true
7715         in: query
7716         name: query
7717         schema:
7718           type: string
7719       - allowEmptyValue: true
7720         in: query
7721         name: daemon_name
7722         schema:
7723           type: string
7724       responses:
7725         '200':
7726           content:
7727             application/vnd.ceph.api.v1.0+json:
7728               type: object
7729           description: OK
7730         '400':
7731           description: Operation exception. Please check the response body for details.
7732         '401':
7733           description: Unauthenticated access. Please login first.
7734         '403':
7735           description: Unauthorized access. Please check your permissions.
7736         '500':
7737           description: Unexpected error. Please check the response body for the stack
7738             trace.
7739       security:
7740       - jwt: []
7741       tags:
7742       - RgwSite
7743   /api/rgw/status:
7744     get:
7745       parameters: []
7746       responses:
7747         '200':
7748           content:
7749             application/vnd.ceph.api.v1.0+json:
7750               schema:
7751                 properties:
7752                   available:
7753                     description: Is RGW available?
7754                     type: boolean
7755                   message:
7756                     description: Descriptions
7757                     type: string
7758                 required:
7759                 - available
7760                 - message
7761                 type: object
7762           description: OK
7763         '400':
7764           description: Operation exception. Please check the response body for details.
7765         '401':
7766           description: Unauthenticated access. Please login first.
7767         '403':
7768           description: Unauthorized access. Please check your permissions.
7769         '500':
7770           description: Unexpected error. Please check the response body for the stack
7771             trace.
7772       security:
7773       - jwt: []
7774       summary: Display RGW Status
7775       tags:
7776       - Rgw
7777   /api/rgw/user:
7778     get:
7779       parameters:
7780       - allowEmptyValue: true
7781         in: query
7782         name: daemon_name
7783         schema:
7784           type: string
7785       responses:
7786         '200':
7787           content:
7788             application/vnd.ceph.api.v1.0+json:
7789               schema:
7790                 properties:
7791                   list_of_users:
7792                     description: list of rgw users
7793                     items:
7794                       type: string
7795                     type: array
7796                 required:
7797                 - list_of_users
7798                 type: object
7799           description: OK
7800         '400':
7801           description: Operation exception. Please check the response body for details.
7802         '401':
7803           description: Unauthenticated access. Please login first.
7804         '403':
7805           description: Unauthorized access. Please check your permissions.
7806         '500':
7807           description: Unexpected error. Please check the response body for the stack
7808             trace.
7809       security:
7810       - jwt: []
7811       summary: Display RGW Users
7812       tags:
7813       - RgwUser
7814     post:
7815       parameters: []
7816       requestBody:
7817         content:
7818           application/json:
7819             schema:
7820               properties:
7821                 access_key:
7822                   type: string
7823                 daemon_name:
7824                   type: string
7825                 display_name:
7826                   type: string
7827                 email:
7828                   type: string
7829                 generate_key:
7830                   type: string
7831                 max_buckets:
7832                   type: string
7833                 secret_key:
7834                   type: string
7835                 suspended:
7836                   type: string
7837                 uid:
7838                   type: string
7839               required:
7840               - uid
7841               - display_name
7842               type: object
7843       responses:
7844         '201':
7845           content:
7846             application/vnd.ceph.api.v1.0+json:
7847               type: object
7848           description: Resource created.
7849         '202':
7850           content:
7851             application/vnd.ceph.api.v1.0+json:
7852               type: object
7853           description: Operation is still executing. Please check the task queue.
7854         '400':
7855           description: Operation exception. Please check the response body for details.
7856         '401':
7857           description: Unauthenticated access. Please login first.
7858         '403':
7859           description: Unauthorized access. Please check your permissions.
7860         '500':
7861           description: Unexpected error. Please check the response body for the stack
7862             trace.
7863       security:
7864       - jwt: []
7865       tags:
7866       - RgwUser
7867   /api/rgw/user/get_emails:
7868     get:
7869       parameters:
7870       - allowEmptyValue: true
7871         in: query
7872         name: daemon_name
7873         schema:
7874           type: string
7875       responses:
7876         '200':
7877           content:
7878             application/vnd.ceph.api.v1.0+json:
7879               type: object
7880           description: OK
7881         '400':
7882           description: Operation exception. Please check the response body for details.
7883         '401':
7884           description: Unauthenticated access. Please login first.
7885         '403':
7886           description: Unauthorized access. Please check your permissions.
7887         '500':
7888           description: Unexpected error. Please check the response body for the stack
7889             trace.
7890       security:
7891       - jwt: []
7892       tags:
7893       - RgwUser
7894   /api/rgw/user/{uid}:
7895     delete:
7896       parameters:
7897       - in: path
7898         name: uid
7899         required: true
7900         schema:
7901           type: string
7902       - allowEmptyValue: true
7903         in: query
7904         name: daemon_name
7905         schema:
7906           type: string
7907       responses:
7908         '202':
7909           content:
7910             application/vnd.ceph.api.v1.0+json:
7911               type: object
7912           description: Operation is still executing. Please check the task queue.
7913         '204':
7914           content:
7915             application/vnd.ceph.api.v1.0+json:
7916               type: object
7917           description: Resource deleted.
7918         '400':
7919           description: Operation exception. Please check the response body for details.
7920         '401':
7921           description: Unauthenticated access. Please login first.
7922         '403':
7923           description: Unauthorized access. Please check your permissions.
7924         '500':
7925           description: Unexpected error. Please check the response body for the stack
7926             trace.
7927       security:
7928       - jwt: []
7929       tags:
7930       - RgwUser
7931     get:
7932       parameters:
7933       - in: path
7934         name: uid
7935         required: true
7936         schema:
7937           type: string
7938       - allowEmptyValue: true
7939         in: query
7940         name: daemon_name
7941         schema:
7942           type: string
7943       - default: true
7944         in: query
7945         name: stats
7946         schema:
7947           type: boolean
7948       responses:
7949         '200':
7950           content:
7951             application/vnd.ceph.api.v1.0+json:
7952               type: object
7953           description: OK
7954         '400':
7955           description: Operation exception. Please check the response body for details.
7956         '401':
7957           description: Unauthenticated access. Please login first.
7958         '403':
7959           description: Unauthorized access. Please check your permissions.
7960         '500':
7961           description: Unexpected error. Please check the response body for the stack
7962             trace.
7963       security:
7964       - jwt: []
7965       tags:
7966       - RgwUser
7967     put:
7968       parameters:
7969       - in: path
7970         name: uid
7971         required: true
7972         schema:
7973           type: string
7974       requestBody:
7975         content:
7976           application/json:
7977             schema:
7978               properties:
7979                 daemon_name:
7980                   type: string
7981                 display_name:
7982                   type: string
7983                 email:
7984                   type: string
7985                 max_buckets:
7986                   type: string
7987                 suspended:
7988                   type: string
7989               type: object
7990       responses:
7991         '200':
7992           content:
7993             application/vnd.ceph.api.v1.0+json:
7994               type: object
7995           description: Resource updated.
7996         '202':
7997           content:
7998             application/vnd.ceph.api.v1.0+json:
7999               type: object
8000           description: Operation is still executing. Please check the task queue.
8001         '400':
8002           description: Operation exception. Please check the response body for details.
8003         '401':
8004           description: Unauthenticated access. Please login first.
8005         '403':
8006           description: Unauthorized access. Please check your permissions.
8007         '500':
8008           description: Unexpected error. Please check the response body for the stack
8009             trace.
8010       security:
8011       - jwt: []
8012       tags:
8013       - RgwUser
8014   /api/rgw/user/{uid}/capability:
8015     delete:
8016       parameters:
8017       - in: path
8018         name: uid
8019         required: true
8020         schema:
8021           type: string
8022       - in: query
8023         name: type
8024         required: true
8025         schema:
8026           type: string
8027       - in: query
8028         name: perm
8029         required: true
8030         schema:
8031           type: string
8032       - allowEmptyValue: true
8033         in: query
8034         name: daemon_name
8035         schema:
8036           type: string
8037       responses:
8038         '202':
8039           content:
8040             application/vnd.ceph.api.v1.0+json:
8041               type: object
8042           description: Operation is still executing. Please check the task queue.
8043         '204':
8044           content:
8045             application/vnd.ceph.api.v1.0+json:
8046               type: object
8047           description: Resource deleted.
8048         '400':
8049           description: Operation exception. Please check the response body for details.
8050         '401':
8051           description: Unauthenticated access. Please login first.
8052         '403':
8053           description: Unauthorized access. Please check your permissions.
8054         '500':
8055           description: Unexpected error. Please check the response body for the stack
8056             trace.
8057       security:
8058       - jwt: []
8059       tags:
8060       - RgwUser
8061     post:
8062       parameters:
8063       - in: path
8064         name: uid
8065         required: true
8066         schema:
8067           type: string
8068       requestBody:
8069         content:
8070           application/json:
8071             schema:
8072               properties:
8073                 daemon_name:
8074                   type: string
8075                 perm:
8076                   type: string
8077                 type:
8078                   type: string
8079               required:
8080               - type
8081               - perm
8082               type: object
8083       responses:
8084         '201':
8085           content:
8086             application/vnd.ceph.api.v1.0+json:
8087               type: object
8088           description: Resource created.
8089         '202':
8090           content:
8091             application/vnd.ceph.api.v1.0+json:
8092               type: object
8093           description: Operation is still executing. Please check the task queue.
8094         '400':
8095           description: Operation exception. Please check the response body for details.
8096         '401':
8097           description: Unauthenticated access. Please login first.
8098         '403':
8099           description: Unauthorized access. Please check your permissions.
8100         '500':
8101           description: Unexpected error. Please check the response body for the stack
8102             trace.
8103       security:
8104       - jwt: []
8105       tags:
8106       - RgwUser
8107   /api/rgw/user/{uid}/key:
8108     delete:
8109       parameters:
8110       - in: path
8111         name: uid
8112         required: true
8113         schema:
8114           type: string
8115       - default: s3
8116         in: query
8117         name: key_type
8118         schema:
8119           type: string
8120       - allowEmptyValue: true
8121         in: query
8122         name: subuser
8123         schema:
8124           type: string
8125       - allowEmptyValue: true
8126         in: query
8127         name: access_key
8128         schema:
8129           type: string
8130       - allowEmptyValue: true
8131         in: query
8132         name: daemon_name
8133         schema:
8134           type: string
8135       responses:
8136         '202':
8137           content:
8138             application/vnd.ceph.api.v1.0+json:
8139               type: object
8140           description: Operation is still executing. Please check the task queue.
8141         '204':
8142           content:
8143             application/vnd.ceph.api.v1.0+json:
8144               type: object
8145           description: Resource deleted.
8146         '400':
8147           description: Operation exception. Please check the response body for details.
8148         '401':
8149           description: Unauthenticated access. Please login first.
8150         '403':
8151           description: Unauthorized access. Please check your permissions.
8152         '500':
8153           description: Unexpected error. Please check the response body for the stack
8154             trace.
8155       security:
8156       - jwt: []
8157       tags:
8158       - RgwUser
8159     post:
8160       parameters:
8161       - in: path
8162         name: uid
8163         required: true
8164         schema:
8165           type: string
8166       requestBody:
8167         content:
8168           application/json:
8169             schema:
8170               properties:
8171                 access_key:
8172                   type: string
8173                 daemon_name:
8174                   type: string
8175                 generate_key:
8176                   default: 'true'
8177                   type: string
8178                 key_type:
8179                   default: s3
8180                   type: string
8181                 secret_key:
8182                   type: string
8183                 subuser:
8184                   type: string
8185               type: object
8186       responses:
8187         '201':
8188           content:
8189             application/vnd.ceph.api.v1.0+json:
8190               type: object
8191           description: Resource created.
8192         '202':
8193           content:
8194             application/vnd.ceph.api.v1.0+json:
8195               type: object
8196           description: Operation is still executing. Please check the task queue.
8197         '400':
8198           description: Operation exception. Please check the response body for details.
8199         '401':
8200           description: Unauthenticated access. Please login first.
8201         '403':
8202           description: Unauthorized access. Please check your permissions.
8203         '500':
8204           description: Unexpected error. Please check the response body for the stack
8205             trace.
8206       security:
8207       - jwt: []
8208       tags:
8209       - RgwUser
8210   /api/rgw/user/{uid}/quota:
8211     get:
8212       parameters:
8213       - in: path
8214         name: uid
8215         required: true
8216         schema:
8217           type: string
8218       - allowEmptyValue: true
8219         in: query
8220         name: daemon_name
8221         schema:
8222           type: string
8223       responses:
8224         '200':
8225           content:
8226             application/vnd.ceph.api.v1.0+json:
8227               type: object
8228           description: OK
8229         '400':
8230           description: Operation exception. Please check the response body for details.
8231         '401':
8232           description: Unauthenticated access. Please login first.
8233         '403':
8234           description: Unauthorized access. Please check your permissions.
8235         '500':
8236           description: Unexpected error. Please check the response body for the stack
8237             trace.
8238       security:
8239       - jwt: []
8240       tags:
8241       - RgwUser
8242     put:
8243       parameters:
8244       - in: path
8245         name: uid
8246         required: true
8247         schema:
8248           type: string
8249       requestBody:
8250         content:
8251           application/json:
8252             schema:
8253               properties:
8254                 daemon_name:
8255                   type: string
8256                 enabled:
8257                   type: string
8258                 max_objects:
8259                   type: string
8260                 max_size_kb:
8261                   type: integer
8262                 quota_type:
8263                   type: string
8264               required:
8265               - quota_type
8266               - enabled
8267               - max_size_kb
8268               - max_objects
8269               type: object
8270       responses:
8271         '200':
8272           content:
8273             application/vnd.ceph.api.v1.0+json:
8274               type: object
8275           description: Resource updated.
8276         '202':
8277           content:
8278             application/vnd.ceph.api.v1.0+json:
8279               type: object
8280           description: Operation is still executing. Please check the task queue.
8281         '400':
8282           description: Operation exception. Please check the response body for details.
8283         '401':
8284           description: Unauthenticated access. Please login first.
8285         '403':
8286           description: Unauthorized access. Please check your permissions.
8287         '500':
8288           description: Unexpected error. Please check the response body for the stack
8289             trace.
8290       security:
8291       - jwt: []
8292       tags:
8293       - RgwUser
8294   /api/rgw/user/{uid}/subuser:
8295     post:
8296       parameters:
8297       - in: path
8298         name: uid
8299         required: true
8300         schema:
8301           type: string
8302       requestBody:
8303         content:
8304           application/json:
8305             schema:
8306               properties:
8307                 access:
8308                   type: string
8309                 access_key:
8310                   type: string
8311                 daemon_name:
8312                   type: string
8313                 generate_secret:
8314                   default: 'true'
8315                   type: string
8316                 key_type:
8317                   default: s3
8318                   type: string
8319                 secret_key:
8320                   type: string
8321                 subuser:
8322                   type: string
8323               required:
8324               - subuser
8325               - access
8326               type: object
8327       responses:
8328         '201':
8329           content:
8330             application/vnd.ceph.api.v1.0+json:
8331               type: object
8332           description: Resource created.
8333         '202':
8334           content:
8335             application/vnd.ceph.api.v1.0+json:
8336               type: object
8337           description: Operation is still executing. Please check the task queue.
8338         '400':
8339           description: Operation exception. Please check the response body for details.
8340         '401':
8341           description: Unauthenticated access. Please login first.
8342         '403':
8343           description: Unauthorized access. Please check your permissions.
8344         '500':
8345           description: Unexpected error. Please check the response body for the stack
8346             trace.
8347       security:
8348       - jwt: []
8349       tags:
8350       - RgwUser
8351   /api/rgw/user/{uid}/subuser/{subuser}:
8352     delete:
8353       description: "\n        :param purge_keys: Set to False to do not purge the\
8354         \ keys.\n                           Note, this only works for s3 subusers.\n\
8355         \        "
8356       parameters:
8357       - in: path
8358         name: uid
8359         required: true
8360         schema:
8361           type: string
8362       - in: path
8363         name: subuser
8364         required: true
8365         schema:
8366           type: string
8367       - default: 'true'
8368         in: query
8369         name: purge_keys
8370         schema:
8371           type: string
8372       - allowEmptyValue: true
8373         in: query
8374         name: daemon_name
8375         schema:
8376           type: string
8377       responses:
8378         '202':
8379           content:
8380             application/vnd.ceph.api.v1.0+json:
8381               type: object
8382           description: Operation is still executing. Please check the task queue.
8383         '204':
8384           content:
8385             application/vnd.ceph.api.v1.0+json:
8386               type: object
8387           description: Resource deleted.
8388         '400':
8389           description: Operation exception. Please check the response body for details.
8390         '401':
8391           description: Unauthenticated access. Please login first.
8392         '403':
8393           description: Unauthorized access. Please check your permissions.
8394         '500':
8395           description: Unexpected error. Please check the response body for the stack
8396             trace.
8397       security:
8398       - jwt: []
8399       tags:
8400       - RgwUser
8401   /api/role:
8402     get:
8403       parameters: []
8404       responses:
8405         '200':
8406           content:
8407             application/vnd.ceph.api.v1.0+json:
8408               schema:
8409                 items:
8410                   properties:
8411                     description:
8412                       description: Role Descriptions
8413                       type: string
8414                     name:
8415                       description: Role Name
8416                       type: string
8417                     scopes_permissions:
8418                       description: ''
8419                       properties:
8420                         cephfs:
8421                           description: ''
8422                           items:
8423                             type: string
8424                           type: array
8425                       required:
8426                       - cephfs
8427                       type: object
8428                     system:
8429                       description: ''
8430                       type: boolean
8431                   type: object
8432                 required:
8433                 - name
8434                 - description
8435                 - scopes_permissions
8436                 - system
8437                 type: array
8438           description: OK
8439         '400':
8440           description: Operation exception. Please check the response body for details.
8441         '401':
8442           description: Unauthenticated access. Please login first.
8443         '403':
8444           description: Unauthorized access. Please check your permissions.
8445         '500':
8446           description: Unexpected error. Please check the response body for the stack
8447             trace.
8448       security:
8449       - jwt: []
8450       summary: Display Role list
8451       tags:
8452       - Role
8453     post:
8454       parameters: []
8455       requestBody:
8456         content:
8457           application/json:
8458             schema:
8459               properties:
8460                 description:
8461                   type: string
8462                 name:
8463                   type: string
8464                 scopes_permissions:
8465                   type: string
8466               type: object
8467       responses:
8468         '201':
8469           content:
8470             application/vnd.ceph.api.v1.0+json:
8471               type: object
8472           description: Resource created.
8473         '202':
8474           content:
8475             application/vnd.ceph.api.v1.0+json:
8476               type: object
8477           description: Operation is still executing. Please check the task queue.
8478         '400':
8479           description: Operation exception. Please check the response body for details.
8480         '401':
8481           description: Unauthenticated access. Please login first.
8482         '403':
8483           description: Unauthorized access. Please check your permissions.
8484         '500':
8485           description: Unexpected error. Please check the response body for the stack
8486             trace.
8487       security:
8488       - jwt: []
8489       tags:
8490       - Role
8491   /api/role/{name}:
8492     delete:
8493       parameters:
8494       - in: path
8495         name: name
8496         required: true
8497         schema:
8498           type: string
8499       responses:
8500         '202':
8501           content:
8502             application/vnd.ceph.api.v1.0+json:
8503               type: object
8504           description: Operation is still executing. Please check the task queue.
8505         '204':
8506           content:
8507             application/vnd.ceph.api.v1.0+json:
8508               type: object
8509           description: Resource deleted.
8510         '400':
8511           description: Operation exception. Please check the response body for details.
8512         '401':
8513           description: Unauthenticated access. Please login first.
8514         '403':
8515           description: Unauthorized access. Please check your permissions.
8516         '500':
8517           description: Unexpected error. Please check the response body for the stack
8518             trace.
8519       security:
8520       - jwt: []
8521       tags:
8522       - Role
8523     get:
8524       parameters:
8525       - in: path
8526         name: name
8527         required: true
8528         schema:
8529           type: string
8530       responses:
8531         '200':
8532           content:
8533             application/vnd.ceph.api.v1.0+json:
8534               type: object
8535           description: OK
8536         '400':
8537           description: Operation exception. Please check the response body for details.
8538         '401':
8539           description: Unauthenticated access. Please login first.
8540         '403':
8541           description: Unauthorized access. Please check your permissions.
8542         '500':
8543           description: Unexpected error. Please check the response body for the stack
8544             trace.
8545       security:
8546       - jwt: []
8547       tags:
8548       - Role
8549     put:
8550       parameters:
8551       - in: path
8552         name: name
8553         required: true
8554         schema:
8555           type: string
8556       requestBody:
8557         content:
8558           application/json:
8559             schema:
8560               properties:
8561                 description:
8562                   type: string
8563                 scopes_permissions:
8564                   type: string
8565               type: object
8566       responses:
8567         '200':
8568           content:
8569             application/vnd.ceph.api.v1.0+json:
8570               type: object
8571           description: Resource updated.
8572         '202':
8573           content:
8574             application/vnd.ceph.api.v1.0+json:
8575               type: object
8576           description: Operation is still executing. Please check the task queue.
8577         '400':
8578           description: Operation exception. Please check the response body for details.
8579         '401':
8580           description: Unauthenticated access. Please login first.
8581         '403':
8582           description: Unauthorized access. Please check your permissions.
8583         '500':
8584           description: Unexpected error. Please check the response body for the stack
8585             trace.
8586       security:
8587       - jwt: []
8588       tags:
8589       - Role
8590   /api/role/{name}/clone:
8591     post:
8592       parameters:
8593       - in: path
8594         name: name
8595         required: true
8596         schema:
8597           type: string
8598       requestBody:
8599         content:
8600           application/json:
8601             schema:
8602               properties:
8603                 new_name:
8604                   type: string
8605               required:
8606               - new_name
8607               type: object
8608       responses:
8609         '201':
8610           content:
8611             application/vnd.ceph.api.v1.0+json:
8612               type: object
8613           description: Resource created.
8614         '202':
8615           content:
8616             application/vnd.ceph.api.v1.0+json:
8617               type: object
8618           description: Operation is still executing. Please check the task queue.
8619         '400':
8620           description: Operation exception. Please check the response body for details.
8621         '401':
8622           description: Unauthenticated access. Please login first.
8623         '403':
8624           description: Unauthorized access. Please check your permissions.
8625         '500':
8626           description: Unexpected error. Please check the response body for the stack
8627             trace.
8628       security:
8629       - jwt: []
8630       tags:
8631       - Role
8632   /api/service:
8633     get:
8634       parameters:
8635       - allowEmptyValue: true
8636         in: query
8637         name: service_name
8638         schema:
8639           type: string
8640       responses:
8641         '200':
8642           content:
8643             application/vnd.ceph.api.v1.0+json:
8644               type: object
8645           description: OK
8646         '400':
8647           description: Operation exception. Please check the response body for details.
8648         '401':
8649           description: Unauthenticated access. Please login first.
8650         '403':
8651           description: Unauthorized access. Please check your permissions.
8652         '500':
8653           description: Unexpected error. Please check the response body for the stack
8654             trace.
8655       security:
8656       - jwt: []
8657       tags:
8658       - Service
8659     post:
8660       description: "\n        :param service_spec: The service specification as JSON.\n\
8661         \        :param service_name: The service name, e.g. 'alertmanager'.\n   \
8662         \     :return: None\n        "
8663       parameters: []
8664       requestBody:
8665         content:
8666           application/json:
8667             schema:
8668               properties:
8669                 service_name:
8670                   type: string
8671                 service_spec:
8672                   type: string
8673               required:
8674               - service_spec
8675               - service_name
8676               type: object
8677       responses:
8678         '201':
8679           content:
8680             application/vnd.ceph.api.v1.0+json:
8681               type: object
8682           description: Resource created.
8683         '202':
8684           content:
8685             application/vnd.ceph.api.v1.0+json:
8686               type: object
8687           description: Operation is still executing. Please check the task queue.
8688         '400':
8689           description: Operation exception. Please check the response body for details.
8690         '401':
8691           description: Unauthenticated access. Please login first.
8692         '403':
8693           description: Unauthorized access. Please check your permissions.
8694         '500':
8695           description: Unexpected error. Please check the response body for the stack
8696             trace.
8697       security:
8698       - jwt: []
8699       tags:
8700       - Service
8701   /api/service/known_types:
8702     get:
8703       description: "\n        Get a list of known service types, e.g. 'alertmanager',\n\
8704         \        'node-exporter', 'osd' or 'rgw'.\n        "
8705       parameters: []
8706       responses:
8707         '200':
8708           content:
8709             application/vnd.ceph.api.v1.0+json:
8710               type: object
8711           description: OK
8712         '400':
8713           description: Operation exception. Please check the response body for details.
8714         '401':
8715           description: Unauthenticated access. Please login first.
8716         '403':
8717           description: Unauthorized access. Please check your permissions.
8718         '500':
8719           description: Unexpected error. Please check the response body for the stack
8720             trace.
8721       security:
8722       - jwt: []
8723       tags:
8724       - Service
8725   /api/service/{service_name}:
8726     delete:
8727       description: "\n        :param service_name: The service name, e.g. 'mds' or\
8728         \ 'crash.foo'.\n        :return: None\n        "
8729       parameters:
8730       - in: path
8731         name: service_name
8732         required: true
8733         schema:
8734           type: string
8735       responses:
8736         '202':
8737           content:
8738             application/vnd.ceph.api.v1.0+json:
8739               type: object
8740           description: Operation is still executing. Please check the task queue.
8741         '204':
8742           content:
8743             application/vnd.ceph.api.v1.0+json:
8744               type: object
8745           description: Resource deleted.
8746         '400':
8747           description: Operation exception. Please check the response body for details.
8748         '401':
8749           description: Unauthenticated access. Please login first.
8750         '403':
8751           description: Unauthorized access. Please check your permissions.
8752         '500':
8753           description: Unexpected error. Please check the response body for the stack
8754             trace.
8755       security:
8756       - jwt: []
8757       tags:
8758       - Service
8759     get:
8760       parameters:
8761       - in: path
8762         name: service_name
8763         required: true
8764         schema:
8765           type: string
8766       responses:
8767         '200':
8768           content:
8769             application/vnd.ceph.api.v1.0+json:
8770               type: object
8771           description: OK
8772         '400':
8773           description: Operation exception. Please check the response body for details.
8774         '401':
8775           description: Unauthenticated access. Please login first.
8776         '403':
8777           description: Unauthorized access. Please check your permissions.
8778         '500':
8779           description: Unexpected error. Please check the response body for the stack
8780             trace.
8781       security:
8782       - jwt: []
8783       tags:
8784       - Service
8785   /api/service/{service_name}/daemons:
8786     get:
8787       parameters:
8788       - in: path
8789         name: service_name
8790         required: true
8791         schema:
8792           type: string
8793       responses:
8794         '200':
8795           content:
8796             application/vnd.ceph.api.v1.0+json:
8797               type: object
8798           description: OK
8799         '400':
8800           description: Operation exception. Please check the response body for details.
8801         '401':
8802           description: Unauthenticated access. Please login first.
8803         '403':
8804           description: Unauthorized access. Please check your permissions.
8805         '500':
8806           description: Unexpected error. Please check the response body for the stack
8807             trace.
8808       security:
8809       - jwt: []
8810       tags:
8811       - Service
8812   /api/settings:
8813     get:
8814       description: "\n        Get the list of available options.\n        :param names:\
8815         \ A comma separated list of option names that should\n        be processed.\
8816         \ Defaults to ``None``.\n        :type names: None|str\n        :return: A\
8817         \ list of available options.\n        :rtype: list[dict]\n        "
8818       parameters:
8819       - allowEmptyValue: true
8820         description: Name of Settings
8821         in: query
8822         name: names
8823         schema:
8824           type: string
8825       responses:
8826         '200':
8827           content:
8828             application/vnd.ceph.api.v1.0+json:
8829               schema:
8830                 items:
8831                   properties:
8832                     default:
8833                       description: Default Settings
8834                       type: boolean
8835                     name:
8836                       description: Settings Name
8837                       type: string
8838                     type:
8839                       description: Type of Settings
8840                       type: string
8841                     value:
8842                       description: Settings Value
8843                       type: boolean
8844                   type: object
8845                 required:
8846                 - name
8847                 - default
8848                 - type
8849                 - value
8850                 type: array
8851           description: OK
8852         '400':
8853           description: Operation exception. Please check the response body for details.
8854         '401':
8855           description: Unauthenticated access. Please login first.
8856         '403':
8857           description: Unauthorized access. Please check your permissions.
8858         '500':
8859           description: Unexpected error. Please check the response body for the stack
8860             trace.
8861       security:
8862       - jwt: []
8863       summary: Display Settings Information
8864       tags:
8865       - Settings
8866     put:
8867       parameters: []
8868       responses:
8869         '200':
8870           content:
8871             application/vnd.ceph.api.v1.0+json:
8872               type: object
8873           description: Resource updated.
8874         '202':
8875           content:
8876             application/vnd.ceph.api.v1.0+json:
8877               type: object
8878           description: Operation is still executing. Please check the task queue.
8879         '400':
8880           description: Operation exception. Please check the response body for details.
8881         '401':
8882           description: Unauthenticated access. Please login first.
8883         '403':
8884           description: Unauthorized access. Please check your permissions.
8885         '500':
8886           description: Unexpected error. Please check the response body for the stack
8887             trace.
8888       security:
8889       - jwt: []
8890       tags:
8891       - Settings
8892   /api/settings/{name}:
8893     delete:
8894       parameters:
8895       - in: path
8896         name: name
8897         required: true
8898         schema:
8899           type: string
8900       responses:
8901         '202':
8902           content:
8903             application/vnd.ceph.api.v1.0+json:
8904               type: object
8905           description: Operation is still executing. Please check the task queue.
8906         '204':
8907           content:
8908             application/vnd.ceph.api.v1.0+json:
8909               type: object
8910           description: Resource deleted.
8911         '400':
8912           description: Operation exception. Please check the response body for details.
8913         '401':
8914           description: Unauthenticated access. Please login first.
8915         '403':
8916           description: Unauthorized access. Please check your permissions.
8917         '500':
8918           description: Unexpected error. Please check the response body for the stack
8919             trace.
8920       security:
8921       - jwt: []
8922       tags:
8923       - Settings
8924     get:
8925       description: "\n        Get the given option.\n        :param name: The name\
8926         \ of the option.\n        :return: Returns a dict containing the name, type,\n\
8927         \        default value and current value of the given option.\n        :rtype:\
8928         \ dict\n        "
8929       parameters:
8930       - in: path
8931         name: name
8932         required: true
8933         schema:
8934           type: string
8935       responses:
8936         '200':
8937           content:
8938             application/vnd.ceph.api.v1.0+json:
8939               type: object
8940           description: OK
8941         '400':
8942           description: Operation exception. Please check the response body for details.
8943         '401':
8944           description: Unauthenticated access. Please login first.
8945         '403':
8946           description: Unauthorized access. Please check your permissions.
8947         '500':
8948           description: Unexpected error. Please check the response body for the stack
8949             trace.
8950       security:
8951       - jwt: []
8952       tags:
8953       - Settings
8954     put:
8955       parameters:
8956       - in: path
8957         name: name
8958         required: true
8959         schema:
8960           type: string
8961       requestBody:
8962         content:
8963           application/json:
8964             schema:
8965               properties:
8966                 value:
8967                   type: string
8968               required:
8969               - value
8970               type: object
8971       responses:
8972         '200':
8973           content:
8974             application/vnd.ceph.api.v1.0+json:
8975               type: object
8976           description: Resource updated.
8977         '202':
8978           content:
8979             application/vnd.ceph.api.v1.0+json:
8980               type: object
8981           description: Operation is still executing. Please check the task queue.
8982         '400':
8983           description: Operation exception. Please check the response body for details.
8984         '401':
8985           description: Unauthenticated access. Please login first.
8986         '403':
8987           description: Unauthorized access. Please check your permissions.
8988         '500':
8989           description: Unexpected error. Please check the response body for the stack
8990             trace.
8991       security:
8992       - jwt: []
8993       tags:
8994       - Settings
8995   /api/summary:
8996     get:
8997       parameters: []
8998       responses:
8999         '200':
9000           content:
9001             application/vnd.ceph.api.v1.0+json:
9002               schema:
9003                 properties:
9004                   executing_tasks:
9005                     description: ''
9006                     items:
9007                       type: string
9008                     type: array
9009                   finished_tasks:
9010                     description: ''
9011                     items:
9012                       properties:
9013                         begin_time:
9014                           description: ''
9015                           type: string
9016                         duration:
9017                           description: ''
9018                           type: integer
9019                         end_time:
9020                           description: ''
9021                           type: string
9022                         exception:
9023                           description: ''
9024                           type: string
9025                         metadata:
9026                           description: ''
9027                           properties:
9028                             pool:
9029                               description: ''
9030                               type: integer
9031                           required:
9032                           - pool
9033                           type: object
9034                         name:
9035                           description: ''
9036                           type: string
9037                         progress:
9038                           description: ''
9039                           type: integer
9040                         ret_value:
9041                           description: ''
9042                           type: string
9043                         success:
9044                           description: ''
9045                           type: boolean
9046                       required:
9047                       - name
9048                       - metadata
9049                       - begin_time
9050                       - end_time
9051                       - duration
9052                       - progress
9053                       - success
9054                       - ret_value
9055                       - exception
9056                       type: object
9057                     type: array
9058                   have_mon_connection:
9059                     description: ''
9060                     type: string
9061                   health_status:
9062                     description: ''
9063                     type: string
9064                   mgr_host:
9065                     description: ''
9066                     type: string
9067                   mgr_id:
9068                     description: ''
9069                     type: string
9070                   rbd_mirroring:
9071                     description: ''
9072                     properties:
9073                       errors:
9074                         description: ''
9075                         type: integer
9076                       warnings:
9077                         description: ''
9078                         type: integer
9079                     required:
9080                     - warnings
9081                     - errors
9082                     type: object
9083                   version:
9084                     description: ''
9085                     type: string
9086                 required:
9087                 - health_status
9088                 - mgr_id
9089                 - mgr_host
9090                 - have_mon_connection
9091                 - executing_tasks
9092                 - finished_tasks
9093                 - version
9094                 - rbd_mirroring
9095                 type: object
9096           description: OK
9097         '400':
9098           description: Operation exception. Please check the response body for details.
9099         '401':
9100           description: Unauthenticated access. Please login first.
9101         '403':
9102           description: Unauthorized access. Please check your permissions.
9103         '500':
9104           description: Unexpected error. Please check the response body for the stack
9105             trace.
9106       security:
9107       - jwt: []
9108       summary: Display Summary
9109       tags:
9110       - Summary
9111   /api/task:
9112     get:
9113       parameters:
9114       - allowEmptyValue: true
9115         description: Task Name
9116         in: query
9117         name: name
9118         schema:
9119           type: string
9120       responses:
9121         '200':
9122           content:
9123             application/vnd.ceph.api.v1.0+json:
9124               schema:
9125                 properties:
9126                   executing_tasks:
9127                     description: ongoing executing tasks
9128                     type: string
9129                   finished_tasks:
9130                     description: ''
9131                     items:
9132                       properties:
9133                         begin_time:
9134                           description: Task begin time
9135                           type: string
9136                         duration:
9137                           description: ''
9138                           type: integer
9139                         end_time:
9140                           description: Task end time
9141                           type: string
9142                         exception:
9143                           description: ''
9144                           type: boolean
9145                         metadata:
9146                           description: ''
9147                           properties:
9148                             pool:
9149                               description: ''
9150                               type: integer
9151                           required:
9152                           - pool
9153                           type: object
9154                         name:
9155                           description: finished tasks name
9156                           type: string
9157                         progress:
9158                           description: Progress of tasks
9159                           type: integer
9160                         ret_value:
9161                           description: ''
9162                           type: boolean
9163                         success:
9164                           description: ''
9165                           type: boolean
9166                       required:
9167                       - name
9168                       - metadata
9169                       - begin_time
9170                       - end_time
9171                       - duration
9172                       - progress
9173                       - success
9174                       - ret_value
9175                       - exception
9176                       type: object
9177                     type: array
9178                 required:
9179                 - executing_tasks
9180                 - finished_tasks
9181                 type: object
9182           description: OK
9183         '400':
9184           description: Operation exception. Please check the response body for details.
9185         '401':
9186           description: Unauthenticated access. Please login first.
9187         '403':
9188           description: Unauthorized access. Please check your permissions.
9189         '500':
9190           description: Unexpected error. Please check the response body for the stack
9191             trace.
9192       security:
9193       - jwt: []
9194       summary: Display Tasks
9195       tags:
9196       - Task
9197   /api/telemetry:
9198     put:
9199       description: "\n        Enables or disables sending data collected by the Telemetry\n\
9200         \        module.\n        :param enable: Enable or disable sending data\n\
9201         \        :type enable: bool\n        :param license_name: License string e.g.\
9202         \ 'sharing-1-0' to\n        make sure the user is aware of and accepts the\
9203         \ license\n        for sharing Telemetry data.\n        :type license_name:\
9204         \ string\n        "
9205       parameters: []
9206       requestBody:
9207         content:
9208           application/json:
9209             schema:
9210               properties:
9211                 enable:
9212                   default: true
9213                   type: boolean
9214                 license_name:
9215                   type: string
9216               type: object
9217       responses:
9218         '200':
9219           content:
9220             application/vnd.ceph.api.v1.0+json:
9221               type: object
9222           description: Resource updated.
9223         '202':
9224           content:
9225             application/vnd.ceph.api.v1.0+json:
9226               type: object
9227           description: Operation is still executing. Please check the task queue.
9228         '400':
9229           description: Operation exception. Please check the response body for details.
9230         '401':
9231           description: Unauthenticated access. Please login first.
9232         '403':
9233           description: Unauthorized access. Please check your permissions.
9234         '500':
9235           description: Unexpected error. Please check the response body for the stack
9236             trace.
9237       security:
9238       - jwt: []
9239       tags:
9240       - Telemetry
9241   /api/telemetry/report:
9242     get:
9243       description: "\n        Get Ceph and device report data\n        :return: Ceph\
9244         \ and device report data\n        :rtype: dict\n        "
9245       parameters: []
9246       responses:
9247         '200':
9248           content:
9249             application/vnd.ceph.api.v1.0+json:
9250               schema:
9251                 properties:
9252                   device_report:
9253                     description: ''
9254                     type: string
9255                   report:
9256                     description: ''
9257                     properties:
9258                       balancer:
9259                         description: ''
9260                         properties:
9261                           active:
9262                             description: ''
9263                             type: boolean
9264                           mode:
9265                             description: ''
9266                             type: string
9267                         required:
9268                         - active
9269                         - mode
9270                         type: object
9271                       channels:
9272                         description: ''
9273                         items:
9274                           type: string
9275                         type: array
9276                       channels_available:
9277                         description: ''
9278                         items:
9279                           type: string
9280                         type: array
9281                       config:
9282                         description: ''
9283                         properties:
9284                           active_changed:
9285                             description: ''
9286                             items:
9287                               type: string
9288                             type: array
9289                           cluster_changed:
9290                             description: ''
9291                             items:
9292                               type: string
9293                             type: array
9294                         required:
9295                         - cluster_changed
9296                         - active_changed
9297                         type: object
9298                       crashes:
9299                         description: ''
9300                         items:
9301                           type: integer
9302                         type: array
9303                       created:
9304                         description: ''
9305                         type: string
9306                       crush:
9307                         description: ''
9308                         properties:
9309                           bucket_algs:
9310                             description: ''
9311                             properties:
9312                               straw2:
9313                                 description: ''
9314                                 type: integer
9315                             required:
9316                             - straw2
9317                             type: object
9318                           bucket_sizes:
9319                             description: ''
9320                             properties:
9321                               '1':
9322                                 description: ''
9323                                 type: integer
9324                               '3':
9325                                 description: ''
9326                                 type: integer
9327                             required:
9328                             - '1'
9329                             - '3'
9330                             type: object
9331                           bucket_types:
9332                             description: ''
9333                             properties:
9334                               '1':
9335                                 description: ''
9336                                 type: integer
9337                               '11':
9338                                 description: ''
9339                                 type: integer
9340                             required:
9341                             - '1'
9342                             - '11'
9343                             type: object
9344                           compat_weight_set:
9345                             description: ''
9346                             type: boolean
9347                           device_classes:
9348                             description: ''
9349                             items:
9350                               type: integer
9351                             type: array
9352                           num_buckets:
9353                             description: ''
9354                             type: integer
9355                           num_devices:
9356                             description: ''
9357                             type: integer
9358                           num_rules:
9359                             description: ''
9360                             type: integer
9361                           num_types:
9362                             description: ''
9363                             type: integer
9364                           num_weight_sets:
9365                             description: ''
9366                             type: integer
9367                           tunables:
9368                             description: ''
9369                             properties:
9370                               allowed_bucket_algs:
9371                                 description: ''
9372                                 type: integer
9373                               choose_local_fallback_tries:
9374                                 description: ''
9375                                 type: integer
9376                               choose_local_tries:
9377                                 description: ''
9378                                 type: integer
9379                               choose_total_tries:
9380                                 description: ''
9381                                 type: integer
9382                               chooseleaf_descend_once:
9383                                 description: ''
9384                                 type: integer
9385                               chooseleaf_stable:
9386                                 description: ''
9387                                 type: integer
9388                               chooseleaf_vary_r:
9389                                 description: ''
9390                                 type: integer
9391                               has_v2_rules:
9392                                 description: ''
9393                                 type: integer
9394                               has_v3_rules:
9395                                 description: ''
9396                                 type: integer
9397                               has_v4_buckets:
9398                                 description: ''
9399                                 type: integer
9400                               has_v5_rules:
9401                                 description: ''
9402                                 type: integer
9403                               legacy_tunables:
9404                                 description: ''
9405                                 type: integer
9406                               minimum_required_version:
9407                                 description: ''
9408                                 type: string
9409                               optimal_tunables:
9410                                 description: ''
9411                                 type: integer
9412                               profile:
9413                                 description: ''
9414                                 type: string
9415                               require_feature_tunables:
9416                                 description: ''
9417                                 type: integer
9418                               require_feature_tunables2:
9419                                 description: ''
9420                                 type: integer
9421                               require_feature_tunables3:
9422                                 description: ''
9423                                 type: integer
9424                               require_feature_tunables5:
9425                                 description: ''
9426                                 type: integer
9427                               straw_calc_version:
9428                                 description: ''
9429                                 type: integer
9430                             required:
9431                             - choose_local_tries
9432                             - choose_local_fallback_tries
9433                             - choose_total_tries
9434                             - chooseleaf_descend_once
9435                             - chooseleaf_vary_r
9436                             - chooseleaf_stable
9437                             - straw_calc_version
9438                             - allowed_bucket_algs
9439                             - profile
9440                             - optimal_tunables
9441                             - legacy_tunables
9442                             - minimum_required_version
9443                             - require_feature_tunables
9444                             - require_feature_tunables2
9445                             - has_v2_rules
9446                             - require_feature_tunables3
9447                             - has_v3_rules
9448                             - has_v4_buckets
9449                             - require_feature_tunables5
9450                             - has_v5_rules
9451                             type: object
9452                         required:
9453                         - num_devices
9454                         - num_types
9455                         - num_buckets
9456                         - num_rules
9457                         - device_classes
9458                         - tunables
9459                         - compat_weight_set
9460                         - num_weight_sets
9461                         - bucket_algs
9462                         - bucket_sizes
9463                         - bucket_types
9464                         type: object
9465                       fs:
9466                         description: ''
9467                         properties:
9468                           count:
9469                             description: ''
9470                             type: integer
9471                           feature_flags:
9472                             description: ''
9473                             properties:
9474                               enable_multiple:
9475                                 description: ''
9476                                 type: boolean
9477                               ever_enabled_multiple:
9478                                 description: ''
9479                                 type: boolean
9480                             required:
9481                             - enable_multiple
9482                             - ever_enabled_multiple
9483                             type: object
9484                           filesystems:
9485                             description: ''
9486                             items:
9487                               type: integer
9488                             type: array
9489                           num_standby_mds:
9490                             description: ''
9491                             type: integer
9492                           total_num_mds:
9493                             description: ''
9494                             type: integer
9495                         required:
9496                         - count
9497                         - feature_flags
9498                         - num_standby_mds
9499                         - filesystems
9500                         - total_num_mds
9501                         type: object
9502                       hosts:
9503                         description: ''
9504                         properties:
9505                           num:
9506                             description: ''
9507                             type: integer
9508                           num_with_mds:
9509                             description: ''
9510                             type: integer
9511                           num_with_mgr:
9512                             description: ''
9513                             type: integer
9514                           num_with_mon:
9515                             description: ''
9516                             type: integer
9517                           num_with_osd:
9518                             description: ''
9519                             type: integer
9520                         required:
9521                         - num
9522                         - num_with_mon
9523                         - num_with_mds
9524                         - num_with_osd
9525                         - num_with_mgr
9526                         type: object
9527                       leaderboard:
9528                         description: ''
9529                         type: boolean
9530                       license:
9531                         description: ''
9532                         type: string
9533                       metadata:
9534                         description: ''
9535                         properties:
9536                           mon:
9537                             description: ''
9538                             properties:
9539                               arch:
9540                                 description: ''
9541                                 properties:
9542                                   x86_64:
9543                                     description: ''
9544                                     type: integer
9545                                 required:
9546                                 - x86_64
9547                                 type: object
9548                               ceph_version:
9549                                 description: ''
9550                                 properties:
9551                                   ceph version 16.0.0-3151-gf202994fcf:
9552                                     description: ''
9553                                     type: integer
9554                                 required:
9555                                 - ceph version 16.0.0-3151-gf202994fcf
9556                                 type: object
9557                               cpu:
9558                                 description: ''
9559                                 properties:
9560                                   Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
9561                                     description: ''
9562                                     type: integer
9563                                 required:
9564                                 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
9565                                 type: object
9566                               distro:
9567                                 description: ''
9568                                 properties:
9569                                   centos:
9570                                     description: ''
9571                                     type: integer
9572                                 required:
9573                                 - centos
9574                                 type: object
9575                               distro_description:
9576                                 description: ''
9577                                 properties:
9578                                   CentOS Linux 8 (Core):
9579                                     description: ''
9580                                     type: integer
9581                                 required:
9582                                 - CentOS Linux 8 (Core)
9583                                 type: object
9584                               kernel_description:
9585                                 description: ''
9586                                 properties:
9587                                   '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
9588                                     description: ''
9589                                     type: integer
9590                                 required:
9591                                 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
9592                                 type: object
9593                               kernel_version:
9594                                 description: ''
9595                                 properties:
9596                                   5.7.7-200.fc32.x86_64:
9597                                     description: ''
9598                                     type: integer
9599                                 required:
9600                                 - 5.7.7-200.fc32.x86_64
9601                                 type: object
9602                               os:
9603                                 description: ''
9604                                 properties:
9605                                   Linux:
9606                                     description: ''
9607                                     type: integer
9608                                 required:
9609                                 - Linux
9610                                 type: object
9611                             required:
9612                             - arch
9613                             - ceph_version
9614                             - os
9615                             - cpu
9616                             - kernel_description
9617                             - kernel_version
9618                             - distro_description
9619                             - distro
9620                             type: object
9621                           osd:
9622                             description: ''
9623                             properties:
9624                               arch:
9625                                 description: ''
9626                                 properties:
9627                                   x86_64:
9628                                     description: ''
9629                                     type: integer
9630                                 required:
9631                                 - x86_64
9632                                 type: object
9633                               ceph_version:
9634                                 description: ''
9635                                 properties:
9636                                   ceph version 16.0.0-3151-gf202994fcf:
9637                                     description: ''
9638                                     type: integer
9639                                 required:
9640                                 - ceph version 16.0.0-3151-gf202994fcf
9641                                 type: object
9642                               cpu:
9643                                 description: ''
9644                                 properties:
9645                                   Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
9646                                     description: ''
9647                                     type: integer
9648                                 required:
9649                                 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
9650                                 type: object
9651                               distro:
9652                                 description: ''
9653                                 properties:
9654                                   centos:
9655                                     description: ''
9656                                     type: integer
9657                                 required:
9658                                 - centos
9659                                 type: object
9660                               distro_description:
9661                                 description: ''
9662                                 properties:
9663                                   CentOS Linux 8 (Core):
9664                                     description: ''
9665                                     type: integer
9666                                 required:
9667                                 - CentOS Linux 8 (Core)
9668                                 type: object
9669                               kernel_description:
9670                                 description: ''
9671                                 properties:
9672                                   '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
9673                                     description: ''
9674                                     type: integer
9675                                 required:
9676                                 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
9677                                 type: object
9678                               kernel_version:
9679                                 description: ''
9680                                 properties:
9681                                   5.7.7-200.fc32.x86_64:
9682                                     description: ''
9683                                     type: integer
9684                                 required:
9685                                 - 5.7.7-200.fc32.x86_64
9686                                 type: object
9687                               os:
9688                                 description: ''
9689                                 properties:
9690                                   Linux:
9691                                     description: ''
9692                                     type: integer
9693                                 required:
9694                                 - Linux
9695                                 type: object
9696                               osd_objectstore:
9697                                 description: ''
9698                                 properties:
9699                                   bluestore:
9700                                     description: ''
9701                                     type: integer
9702                                 required:
9703                                 - bluestore
9704                                 type: object
9705                               rotational:
9706                                 description: ''
9707                                 properties:
9708                                   '1':
9709                                     description: ''
9710                                     type: integer
9711                                 required:
9712                                 - '1'
9713                                 type: object
9714                             required:
9715                             - osd_objectstore
9716                             - rotational
9717                             - arch
9718                             - ceph_version
9719                             - os
9720                             - cpu
9721                             - kernel_description
9722                             - kernel_version
9723                             - distro_description
9724                             - distro
9725                             type: object
9726                         required:
9727                         - osd
9728                         - mon
9729                         type: object
9730                       mon:
9731                         description: ''
9732                         properties:
9733                           count:
9734                             description: ''
9735                             type: integer
9736                           features:
9737                             description: ''
9738                             properties:
9739                               optional:
9740                                 description: ''
9741                                 items:
9742                                   type: integer
9743                                 type: array
9744                               persistent:
9745                                 description: ''
9746                                 items:
9747                                   type: string
9748                                 type: array
9749                             required:
9750                             - persistent
9751                             - optional
9752                             type: object
9753                           ipv4_addr_mons:
9754                             description: ''
9755                             type: integer
9756                           ipv6_addr_mons:
9757                             description: ''
9758                             type: integer
9759                           min_mon_release:
9760                             description: ''
9761                             type: integer
9762                           v1_addr_mons:
9763                             description: ''
9764                             type: integer
9765                           v2_addr_mons:
9766                             description: ''
9767                             type: integer
9768                         required:
9769                         - count
9770                         - features
9771                         - min_mon_release
9772                         - v1_addr_mons
9773                         - v2_addr_mons
9774                         - ipv4_addr_mons
9775                         - ipv6_addr_mons
9776                         type: object
9777                       osd:
9778                         description: ''
9779                         properties:
9780                           cluster_network:
9781                             description: ''
9782                             type: boolean
9783                           count:
9784                             description: ''
9785                             type: integer
9786                           require_min_compat_client:
9787                             description: ''
9788                             type: string
9789                           require_osd_release:
9790                             description: ''
9791                             type: string
9792                         required:
9793                         - count
9794                         - require_osd_release
9795                         - require_min_compat_client
9796                         - cluster_network
9797                         type: object
9798                       pools:
9799                         description: ''
9800                         items:
9801                           properties:
9802                             cache_mode:
9803                               description: ''
9804                               type: string
9805                             erasure_code_profile:
9806                               description: ''
9807                               type: string
9808                             min_size:
9809                               description: ''
9810                               type: integer
9811                             pg_autoscale_mode:
9812                               description: ''
9813                               type: string
9814                             pg_num:
9815                               description: ''
9816                               type: integer
9817                             pgp_num:
9818                               description: ''
9819                               type: integer
9820                             pool:
9821                               description: ''
9822                               type: integer
9823                             size:
9824                               description: ''
9825                               type: integer
9826                             target_max_bytes:
9827                               description: ''
9828                               type: integer
9829                             target_max_objects:
9830                               description: ''
9831                               type: integer
9832                             type:
9833                               description: ''
9834                               type: string
9835                           required:
9836                           - pool
9837                           - type
9838                           - pg_num
9839                           - pgp_num
9840                           - size
9841                           - min_size
9842                           - pg_autoscale_mode
9843                           - target_max_bytes
9844                           - target_max_objects
9845                           - erasure_code_profile
9846                           - cache_mode
9847                           type: object
9848                         type: array
9849                       rbd:
9850                         description: ''
9851                         properties:
9852                           mirroring_by_pool:
9853                             description: ''
9854                             items:
9855                               type: boolean
9856                             type: array
9857                           num_images_by_pool:
9858                             description: ''
9859                             items:
9860                               type: integer
9861                             type: array
9862                           num_pools:
9863                             description: ''
9864                             type: integer
9865                         required:
9866                         - num_pools
9867                         - num_images_by_pool
9868                         - mirroring_by_pool
9869                         type: object
9870                       report_id:
9871                         description: ''
9872                         type: string
9873                       report_timestamp:
9874                         description: ''
9875                         type: string
9876                       report_version:
9877                         description: ''
9878                         type: integer
9879                       rgw:
9880                         description: ''
9881                         properties:
9882                           count:
9883                             description: ''
9884                             type: integer
9885                           frontends:
9886                             description: ''
9887                             items:
9888                               type: string
9889                             type: array
9890                           zonegroups:
9891                             description: ''
9892                             type: integer
9893                           zones:
9894                             description: ''
9895                             type: integer
9896                         required:
9897                         - count
9898                         - zones
9899                         - zonegroups
9900                         - frontends
9901                         type: object
9902                       services:
9903                         description: ''
9904                         properties:
9905                           rgw:
9906                             description: ''
9907                             type: integer
9908                         required:
9909                         - rgw
9910                         type: object
9911                       usage:
9912                         description: ''
9913                         properties:
9914                           pg_num:
9915                             description: ''
9916                             type: integer
9917                           pools:
9918                             description: ''
9919                             type: integer
9920                           total_avail_bytes:
9921                             description: ''
9922                             type: integer
9923                           total_bytes:
9924                             description: ''
9925                             type: integer
9926                           total_used_bytes:
9927                             description: ''
9928                             type: integer
9929                         required:
9930                         - pools
9931                         - pg_num
9932                         - total_used_bytes
9933                         - total_bytes
9934                         - total_avail_bytes
9935                         type: object
9936                     required:
9937                     - leaderboard
9938                     - report_version
9939                     - report_timestamp
9940                     - report_id
9941                     - channels
9942                     - channels_available
9943                     - license
9944                     - created
9945                     - mon
9946                     - config
9947                     - rbd
9948                     - pools
9949                     - osd
9950                     - crush
9951                     - fs
9952                     - metadata
9953                     - hosts
9954                     - usage
9955                     - services
9956                     - rgw
9957                     - balancer
9958                     - crashes
9959                     type: object
9960                 required:
9961                 - report
9962                 - device_report
9963                 type: object
9964           description: OK
9965         '400':
9966           description: Operation exception. Please check the response body for details.
9967         '401':
9968           description: Unauthenticated access. Please login first.
9969         '403':
9970           description: Unauthorized access. Please check your permissions.
9971         '500':
9972           description: Unexpected error. Please check the response body for the stack
9973             trace.
9974       security:
9975       - jwt: []
9976       summary: Get Detailed Telemetry report
9977       tags:
9978       - Telemetry
9979   /api/user:
9980     get:
9981       parameters: []
9982       responses:
9983         '200':
9984           content:
9985             application/vnd.ceph.api.v1.0+json:
9986               schema:
9987                 properties:
9988                   email:
9989                     description: User email address
9990                     type: string
9991                   enabled:
9992                     description: Is the user enabled?
9993                     type: boolean
9994                   lastUpdate:
9995                     description: Details last updated
9996                     type: integer
9997                   name:
9998                     description: User Name
9999                     type: string
10000                   pwdExpirationDate:
10001                     description: Password Expiration date
10002                     type: string
10003                   pwdUpdateRequired:
10004                     description: Is Password Update Required?
10005                     type: boolean
10006                   roles:
10007                     description: User Roles
10008                     items:
10009                       type: string
10010                     type: array
10011                   username:
10012                     description: Username of the user
10013                     type: string
10014                 required:
10015                 - username
10016                 - roles
10017                 - name
10018                 - email
10019                 - lastUpdate
10020                 - enabled
10021                 - pwdExpirationDate
10022                 - pwdUpdateRequired
10023                 type: object
10024           description: OK
10025         '400':
10026           description: Operation exception. Please check the response body for details.
10027         '401':
10028           description: Unauthenticated access. Please login first.
10029         '403':
10030           description: Unauthorized access. Please check your permissions.
10031         '500':
10032           description: Unexpected error. Please check the response body for the stack
10033             trace.
10034       security:
10035       - jwt: []
10036       summary: Get List Of Users
10037       tags:
10038       - User
10039     post:
10040       parameters: []
10041       requestBody:
10042         content:
10043           application/json:
10044             schema:
10045               properties:
10046                 email:
10047                   type: string
10048                 enabled:
10049                   default: true
10050                   type: boolean
10051                 name:
10052                   type: string
10053                 password:
10054                   type: string
10055                 pwdExpirationDate:
10056                   type: string
10057                 pwdUpdateRequired:
10058                   default: true
10059                   type: boolean
10060                 roles:
10061                   type: string
10062                 username:
10063                   type: string
10064               type: object
10065       responses:
10066         '201':
10067           content:
10068             application/vnd.ceph.api.v1.0+json:
10069               type: object
10070           description: Resource created.
10071         '202':
10072           content:
10073             application/vnd.ceph.api.v1.0+json:
10074               type: object
10075           description: Operation is still executing. Please check the task queue.
10076         '400':
10077           description: Operation exception. Please check the response body for details.
10078         '401':
10079           description: Unauthenticated access. Please login first.
10080         '403':
10081           description: Unauthorized access. Please check your permissions.
10082         '500':
10083           description: Unexpected error. Please check the response body for the stack
10084             trace.
10085       security:
10086       - jwt: []
10087       tags:
10088       - User
10089   /api/user/validate_password:
10090     post:
10091       description: "\n        Check if the password meets the password policy.\n \
10092         \       :param password: The password to validate.\n        :param username:\
10093         \ The name of the user (optional).\n        :param old_password: The old password\
10094         \ (optional).\n        :return: An object with properties valid, credits and\
10095         \ valuation.\n        'credits' contains the password complexity credits and\n\
10096         \        'valuation' the textual summary of the validation.\n        "
10097       parameters: []
10098       requestBody:
10099         content:
10100           application/json:
10101             schema:
10102               properties:
10103                 old_password:
10104                   type: string
10105                 password:
10106                   type: string
10107                 username:
10108                   type: string
10109               required:
10110               - password
10111               type: object
10112       responses:
10113         '201':
10114           content:
10115             application/vnd.ceph.api.v1.0+json:
10116               type: object
10117           description: Resource created.
10118         '202':
10119           content:
10120             application/vnd.ceph.api.v1.0+json:
10121               type: object
10122           description: Operation is still executing. Please check the task queue.
10123         '400':
10124           description: Operation exception. Please check the response body for details.
10125         '401':
10126           description: Unauthenticated access. Please login first.
10127         '403':
10128           description: Unauthorized access. Please check your permissions.
10129         '500':
10130           description: Unexpected error. Please check the response body for the stack
10131             trace.
10132       security:
10133       - jwt: []
10134       tags:
10135       - UserPasswordPolicy
10136   /api/user/{username}:
10137     delete:
10138       parameters:
10139       - in: path
10140         name: username
10141         required: true
10142         schema:
10143           type: string
10144       responses:
10145         '202':
10146           content:
10147             application/vnd.ceph.api.v1.0+json:
10148               type: object
10149           description: Operation is still executing. Please check the task queue.
10150         '204':
10151           content:
10152             application/vnd.ceph.api.v1.0+json:
10153               type: object
10154           description: Resource deleted.
10155         '400':
10156           description: Operation exception. Please check the response body for details.
10157         '401':
10158           description: Unauthenticated access. Please login first.
10159         '403':
10160           description: Unauthorized access. Please check your permissions.
10161         '500':
10162           description: Unexpected error. Please check the response body for the stack
10163             trace.
10164       security:
10165       - jwt: []
10166       tags:
10167       - User
10168     get:
10169       parameters:
10170       - in: path
10171         name: username
10172         required: true
10173         schema:
10174           type: string
10175       responses:
10176         '200':
10177           content:
10178             application/vnd.ceph.api.v1.0+json:
10179               type: object
10180           description: OK
10181         '400':
10182           description: Operation exception. Please check the response body for details.
10183         '401':
10184           description: Unauthenticated access. Please login first.
10185         '403':
10186           description: Unauthorized access. Please check your permissions.
10187         '500':
10188           description: Unexpected error. Please check the response body for the stack
10189             trace.
10190       security:
10191       - jwt: []
10192       tags:
10193       - User
10194     put:
10195       parameters:
10196       - in: path
10197         name: username
10198         required: true
10199         schema:
10200           type: string
10201       requestBody:
10202         content:
10203           application/json:
10204             schema:
10205               properties:
10206                 email:
10207                   type: string
10208                 enabled:
10209                   type: string
10210                 name:
10211                   type: string
10212                 password:
10213                   type: string
10214                 pwdExpirationDate:
10215                   type: string
10216                 pwdUpdateRequired:
10217                   default: false
10218                   type: boolean
10219                 roles:
10220                   type: string
10221               type: object
10222       responses:
10223         '200':
10224           content:
10225             application/vnd.ceph.api.v1.0+json:
10226               type: object
10227           description: Resource updated.
10228         '202':
10229           content:
10230             application/vnd.ceph.api.v1.0+json:
10231               type: object
10232           description: Operation is still executing. Please check the task queue.
10233         '400':
10234           description: Operation exception. Please check the response body for details.
10235         '401':
10236           description: Unauthenticated access. Please login first.
10237         '403':
10238           description: Unauthorized access. Please check your permissions.
10239         '500':
10240           description: Unexpected error. Please check the response body for the stack
10241             trace.
10242       security:
10243       - jwt: []
10244       tags:
10245       - User
10246   /api/user/{username}/change_password:
10247     post:
10248       parameters:
10249       - in: path
10250         name: username
10251         required: true
10252         schema:
10253           type: string
10254       requestBody:
10255         content:
10256           application/json:
10257             schema:
10258               properties:
10259                 new_password:
10260                   type: string
10261                 old_password:
10262                   type: string
10263               required:
10264               - old_password
10265               - new_password
10266               type: object
10267       responses:
10268         '201':
10269           content:
10270             application/vnd.ceph.api.v1.0+json:
10271               type: object
10272           description: Resource created.
10273         '202':
10274           content:
10275             application/vnd.ceph.api.v1.0+json:
10276               type: object
10277           description: Operation is still executing. Please check the task queue.
10278         '400':
10279           description: Operation exception. Please check the response body for details.
10280         '401':
10281           description: Unauthenticated access. Please login first.
10282         '403':
10283           description: Unauthorized access. Please check your permissions.
10284         '500':
10285           description: Unexpected error. Please check the response body for the stack
10286             trace.
10287       security:
10288       - jwt: []
10289       tags:
10290       - UserChangePassword
10291 schemes:
10292 - https
10293 servers:
10294 - url: /
10295 tags:
10296 - description: Initiate a session with Ceph
10297   name: Auth
10298 - description: Cephfs Management API
10299   name: Cephfs
10300 - description: Manage Cluster Configurations
10301   name: ClusterConfiguration
10302 - description: Crush Rule Management API
10303   name: CrushRule
10304 - description: Erasure Code Profile Management API
10305   name: ErasureCodeProfile
10306 - description: Manage Features API
10307   name: FeatureTogglesEndpoint
10308 - description: Grafana Management API
10309   name: Grafana
10310 - description: Display Detailed Cluster health Status
10311   name: Health
10312 - description: Get Host Details
10313   name: Host
10314 - description: Iscsi Management API
10315   name: Iscsi
10316 - description: Get Iscsi Target Details
10317   name: IscsiTarget
10318 - description: Logs Management API
10319   name: Logs
10320 - description: Mds Perf Counters Management API
10321   name: MdsPerfCounter
10322 - description: Get details of MGR Module
10323   name: MgrModule
10324 - description: Mgr Perf Counters Management API
10325   name: MgrPerfCounter
10326 - description: Mon Perf Counters Management API
10327   name: MonPerfCounter
10328 - description: Get Monitor Details
10329   name: Monitor
10330 - description: NFS-Ganesha Management API
10331   name: NFS-Ganesha
10332 - description: OSD management API
10333   name: OSD
10334 - description: Orchestrator Management API
10335   name: Orchestrator
10336 - description: OSD Perf Counters Management API
10337   name: OsdPerfCounter
10338 - description: Perf Counters Management API
10339   name: PerfCounters
10340 - description: Get pool details by pool name
10341   name: Pool
10342 - description: Prometheus Management API
10343   name: Prometheus
10344 - description: Prometheus Notifications Management API
10345   name: PrometheusNotifications
10346 - description: RBD Management API
10347   name: Rbd
10348 - description: RBD Mirroring Management API
10349   name: RbdMirroring
10350 - description: RBD Mirroring Pool Bootstrap Management API
10351   name: RbdMirroringPoolBootstrap
10352 - description: RBD Mirroring Pool Mode Management API
10353   name: RbdMirroringPoolMode
10354 - description: RBD Mirroring Pool Peer Management API
10355   name: RbdMirroringPoolPeer
10356 - description: RBD Mirroring Summary Management API
10357   name: RbdMirroringSummary
10358 - description: RBD Namespace Management API
10359   name: RbdNamespace
10360 - description: RBD Snapshot Management API
10361   name: RbdSnapshot
10362 - description: RBD Trash Management API
10363   name: RbdTrash
10364 - description: RGW Management API
10365   name: Rgw
10366 - description: RGW Bucket Management API
10367   name: RgwBucket
10368 - description: RGW Daemon Management API
10369   name: RgwDaemon
10370 - description: Rgw Mirroring Perf Counters Management API
10371   name: RgwMirrorPerfCounter
10372 - description: Rgw Perf Counters Management API
10373   name: RgwPerfCounter
10374 - description: RGW Site Management API
10375   name: RgwSite
10376 - description: RGW User Management API
10377   name: RgwUser
10378 - description: Role Management API
10379   name: Role
10380 - description: Service Management API
10381   name: Service
10382 - description: Settings Management API
10383   name: Settings
10384 - description: Get Ceph Summary Details
10385   name: Summary
10386 - description: Task Management API
10387   name: Task
10388 - description: Tcmu Runner Perf Counters Management API
10389   name: TcmuRunnerPerfCounter
10390 - description: Display Telemetry Report
10391   name: Telemetry
10392 - description: Display User Details
10393   name: User
10394 - description: Change User Password
10395   name: UserChangePassword
10396 - description: Get User Password Policy Details
10397   name: UserPasswordPolicy