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:
2042     get:
2043       parameters: []
2044       responses:
2045         '200':
2046           content:
2047             application/vnd.ceph.api.v0.1+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       summary: Get the cluster status
2062       tags:
2063       - Cluster
2064     put:
2065       parameters: []
2066       requestBody:
2067         content:
2068           application/json:
2069             schema:
2070               properties:
2071                 status:
2072                   description: Cluster Status
2073                   type: string
2074               required:
2075               - status
2076               type: object
2077       responses:
2078         '200':
2079           content:
2080             application/vnd.ceph.api.v0.1+json:
2081               type: object
2082           description: Resource updated.
2083         '202':
2084           content:
2085             application/vnd.ceph.api.v0.1+json:
2086               type: object
2087           description: Operation is still executing. Please check the task queue.
2088         '400':
2089           description: Operation exception. Please check the response body for details.
2090         '401':
2091           description: Unauthenticated access. Please login first.
2092         '403':
2093           description: Unauthorized access. Please check your permissions.
2094         '500':
2095           description: Unexpected error. Please check the response body for the stack
2096             trace.
2097       security:
2098       - jwt: []
2099       summary: Update the cluster status
2100       tags:
2101       - Cluster
2102   /api/cluster_conf:
2103     get:
2104       parameters: []
2105       responses:
2106         '200':
2107           content:
2108             application/vnd.ceph.api.v1.0+json:
2109               type: object
2110           description: OK
2111         '400':
2112           description: Operation exception. Please check the response body for details.
2113         '401':
2114           description: Unauthenticated access. Please login first.
2115         '403':
2116           description: Unauthorized access. Please check your permissions.
2117         '500':
2118           description: Unexpected error. Please check the response body for the stack
2119             trace.
2120       security:
2121       - jwt: []
2122       tags:
2123       - ClusterConfiguration
2124     post:
2125       parameters: []
2126       requestBody:
2127         content:
2128           application/json:
2129             schema:
2130               properties:
2131                 name:
2132                   type: string
2133                 value:
2134                   type: string
2135               required:
2136               - name
2137               - value
2138               type: object
2139       responses:
2140         '201':
2141           content:
2142             application/vnd.ceph.api.v1.0+json:
2143               type: object
2144           description: Resource created.
2145         '202':
2146           content:
2147             application/vnd.ceph.api.v1.0+json:
2148               type: object
2149           description: Operation is still executing. Please check the task queue.
2150         '400':
2151           description: Operation exception. Please check the response body for details.
2152         '401':
2153           description: Unauthenticated access. Please login first.
2154         '403':
2155           description: Unauthorized access. Please check your permissions.
2156         '500':
2157           description: Unexpected error. Please check the response body for the stack
2158             trace.
2159       security:
2160       - jwt: []
2161       tags:
2162       - ClusterConfiguration
2163     put:
2164       parameters: []
2165       requestBody:
2166         content:
2167           application/json:
2168             schema:
2169               properties:
2170                 options:
2171                   type: string
2172               required:
2173               - options
2174               type: object
2175       responses:
2176         '200':
2177           content:
2178             application/vnd.ceph.api.v1.0+json:
2179               type: object
2180           description: Resource updated.
2181         '202':
2182           content:
2183             application/vnd.ceph.api.v1.0+json:
2184               type: object
2185           description: Operation is still executing. Please check the task queue.
2186         '400':
2187           description: Operation exception. Please check the response body for details.
2188         '401':
2189           description: Unauthenticated access. Please login first.
2190         '403':
2191           description: Unauthorized access. Please check your permissions.
2192         '500':
2193           description: Unexpected error. Please check the response body for the stack
2194             trace.
2195       security:
2196       - jwt: []
2197       tags:
2198       - ClusterConfiguration
2199   /api/cluster_conf/filter:
2200     get:
2201       parameters:
2202       - allowEmptyValue: true
2203         description: Config option names
2204         in: query
2205         name: names
2206         schema:
2207           type: string
2208       responses:
2209         '200':
2210           content:
2211             application/vnd.ceph.api.v1.0+json:
2212               schema:
2213                 items:
2214                   properties:
2215                     can_update_at_runtime:
2216                       description: Check if can update at runtime
2217                       type: boolean
2218                     daemon_default:
2219                       description: Daemon specific default value
2220                       type: string
2221                     default:
2222                       description: Default value for the config option
2223                       type: string
2224                     desc:
2225                       description: Description of the configuration
2226                       type: string
2227                     enum_values:
2228                       description: List of enums allowed
2229                       items:
2230                         type: string
2231                       type: array
2232                     flags:
2233                       description: List of flags associated
2234                       items:
2235                         type: string
2236                       type: array
2237                     level:
2238                       description: Config option level
2239                       type: string
2240                     long_desc:
2241                       description: Elaborated description
2242                       type: string
2243                     max:
2244                       description: Maximum value
2245                       type: string
2246                     min:
2247                       description: Minimum value
2248                       type: string
2249                     name:
2250                       description: Name of the config option
2251                       type: string
2252                     see_also:
2253                       description: Related config options
2254                       items:
2255                         type: string
2256                       type: array
2257                     services:
2258                       description: Services associated with the config option
2259                       items:
2260                         type: string
2261                       type: array
2262                     tags:
2263                       description: Tags associated with the cluster
2264                       items:
2265                         type: string
2266                       type: array
2267                     type:
2268                       description: Config option type
2269                       type: string
2270                   type: object
2271                 required:
2272                 - name
2273                 - type
2274                 - level
2275                 - desc
2276                 - long_desc
2277                 - default
2278                 - daemon_default
2279                 - tags
2280                 - services
2281                 - see_also
2282                 - enum_values
2283                 - min
2284                 - max
2285                 - can_update_at_runtime
2286                 - flags
2287                 type: array
2288           description: OK
2289         '400':
2290           description: Operation exception. Please check the response body for details.
2291         '401':
2292           description: Unauthenticated access. Please login first.
2293         '403':
2294           description: Unauthorized access. Please check your permissions.
2295         '500':
2296           description: Unexpected error. Please check the response body for the stack
2297             trace.
2298       security:
2299       - jwt: []
2300       summary: Get Cluster Configuration by name
2301       tags:
2302       - ClusterConfiguration
2303   /api/cluster_conf/{name}:
2304     delete:
2305       parameters:
2306       - in: path
2307         name: name
2308         required: true
2309         schema:
2310           type: string
2311       - in: query
2312         name: section
2313         required: true
2314         schema:
2315           type: string
2316       responses:
2317         '202':
2318           content:
2319             application/vnd.ceph.api.v1.0+json:
2320               type: object
2321           description: Operation is still executing. Please check the task queue.
2322         '204':
2323           content:
2324             application/vnd.ceph.api.v1.0+json:
2325               type: object
2326           description: Resource deleted.
2327         '400':
2328           description: Operation exception. Please check the response body for details.
2329         '401':
2330           description: Unauthenticated access. Please login first.
2331         '403':
2332           description: Unauthorized access. Please check your permissions.
2333         '500':
2334           description: Unexpected error. Please check the response body for the stack
2335             trace.
2336       security:
2337       - jwt: []
2338       tags:
2339       - ClusterConfiguration
2340     get:
2341       parameters:
2342       - in: path
2343         name: name
2344         required: true
2345         schema:
2346           type: string
2347       responses:
2348         '200':
2349           content:
2350             application/vnd.ceph.api.v1.0+json:
2351               type: object
2352           description: OK
2353         '400':
2354           description: Operation exception. Please check the response body for details.
2355         '401':
2356           description: Unauthenticated access. Please login first.
2357         '403':
2358           description: Unauthorized access. Please check your permissions.
2359         '500':
2360           description: Unexpected error. Please check the response body for the stack
2361             trace.
2362       security:
2363       - jwt: []
2364       tags:
2365       - ClusterConfiguration
2366   /api/crush_rule:
2367     get:
2368       parameters: []
2369       responses:
2370         '200':
2371           content:
2372             application/vnd.ceph.api.v2.0+json:
2373               schema:
2374                 properties:
2375                   max_size:
2376                     description: Maximum size of Rule
2377                     type: integer
2378                   min_size:
2379                     description: Minimum size of Rule
2380                     type: integer
2381                   rule_id:
2382                     description: Rule ID
2383                     type: integer
2384                   rule_name:
2385                     description: Rule Name
2386                     type: string
2387                   ruleset:
2388                     description: RuleSet related to the rule
2389                     type: integer
2390                   steps:
2391                     description: Steps included in the rule
2392                     items:
2393                       type: object
2394                     type: array
2395                   type:
2396                     description: Type of Rule
2397                     type: integer
2398                 required:
2399                 - rule_id
2400                 - rule_name
2401                 - ruleset
2402                 - type
2403                 - min_size
2404                 - max_size
2405                 - steps
2406                 type: object
2407           description: OK
2408         '400':
2409           description: Operation exception. Please check the response body for details.
2410         '401':
2411           description: Unauthenticated access. Please login first.
2412         '403':
2413           description: Unauthorized access. Please check your permissions.
2414         '500':
2415           description: Unexpected error. Please check the response body for the stack
2416             trace.
2417       security:
2418       - jwt: []
2419       summary: List Crush Rule Configuration
2420       tags:
2421       - CrushRule
2422     post:
2423       parameters: []
2424       requestBody:
2425         content:
2426           application/json:
2427             schema:
2428               properties:
2429                 device_class:
2430                   type: string
2431                 failure_domain:
2432                   type: string
2433                 name:
2434                   type: string
2435                 root:
2436                   type: string
2437               required:
2438               - name
2439               - root
2440               - failure_domain
2441               type: object
2442       responses:
2443         '201':
2444           content:
2445             application/vnd.ceph.api.v1.0+json:
2446               type: object
2447           description: Resource created.
2448         '202':
2449           content:
2450             application/vnd.ceph.api.v1.0+json:
2451               type: object
2452           description: Operation is still executing. Please check the task queue.
2453         '400':
2454           description: Operation exception. Please check the response body for details.
2455         '401':
2456           description: Unauthenticated access. Please login first.
2457         '403':
2458           description: Unauthorized access. Please check your permissions.
2459         '500':
2460           description: Unexpected error. Please check the response body for the stack
2461             trace.
2462       security:
2463       - jwt: []
2464       tags:
2465       - CrushRule
2466   /api/crush_rule/{name}:
2467     delete:
2468       parameters:
2469       - in: path
2470         name: name
2471         required: true
2472         schema:
2473           type: string
2474       responses:
2475         '202':
2476           content:
2477             application/vnd.ceph.api.v1.0+json:
2478               type: object
2479           description: Operation is still executing. Please check the task queue.
2480         '204':
2481           content:
2482             application/vnd.ceph.api.v1.0+json:
2483               type: object
2484           description: Resource deleted.
2485         '400':
2486           description: Operation exception. Please check the response body for details.
2487         '401':
2488           description: Unauthenticated access. Please login first.
2489         '403':
2490           description: Unauthorized access. Please check your permissions.
2491         '500':
2492           description: Unexpected error. Please check the response body for the stack
2493             trace.
2494       security:
2495       - jwt: []
2496       tags:
2497       - CrushRule
2498     get:
2499       parameters:
2500       - in: path
2501         name: name
2502         required: true
2503         schema:
2504           type: string
2505       responses:
2506         '200':
2507           content:
2508             application/vnd.ceph.api.v2.0+json:
2509               type: object
2510           description: OK
2511         '400':
2512           description: Operation exception. Please check the response body for details.
2513         '401':
2514           description: Unauthenticated access. Please login first.
2515         '403':
2516           description: Unauthorized access. Please check your permissions.
2517         '500':
2518           description: Unexpected error. Please check the response body for the stack
2519             trace.
2520       security:
2521       - jwt: []
2522       tags:
2523       - CrushRule
2524   /api/daemon/{daemon_name}:
2525     put:
2526       parameters:
2527       - in: path
2528         name: daemon_name
2529         required: true
2530         schema:
2531           type: string
2532       requestBody:
2533         content:
2534           application/json:
2535             schema:
2536               properties:
2537                 action:
2538                   default: ''
2539                   type: string
2540                 container_image:
2541                   type: string
2542               type: object
2543       responses:
2544         '200':
2545           content:
2546             application/vnd.ceph.api.v0.1+json:
2547               type: object
2548           description: Resource updated.
2549         '202':
2550           content:
2551             application/vnd.ceph.api.v0.1+json:
2552               type: object
2553           description: Operation is still executing. Please check the task queue.
2554         '400':
2555           description: Operation exception. Please check the response body for details.
2556         '401':
2557           description: Unauthenticated access. Please login first.
2558         '403':
2559           description: Unauthorized access. Please check your permissions.
2560         '500':
2561           description: Unexpected error. Please check the response body for the stack
2562             trace.
2563       security:
2564       - jwt: []
2565       tags:
2566       - Daemon
2567   /api/erasure_code_profile:
2568     get:
2569       parameters: []
2570       responses:
2571         '200':
2572           content:
2573             application/vnd.ceph.api.v1.0+json:
2574               schema:
2575                 items:
2576                   properties:
2577                     crush-failure-domain:
2578                       description: ''
2579                       type: string
2580                     k:
2581                       description: Number of data chunks
2582                       type: integer
2583                     m:
2584                       description: Number of coding chunks
2585                       type: integer
2586                     name:
2587                       description: Name of the profile
2588                       type: string
2589                     plugin:
2590                       description: Plugin Info
2591                       type: string
2592                     technique:
2593                       description: ''
2594                       type: string
2595                   type: object
2596                 required:
2597                 - crush-failure-domain
2598                 - k
2599                 - m
2600                 - plugin
2601                 - technique
2602                 - name
2603                 type: array
2604           description: OK
2605         '400':
2606           description: Operation exception. Please check the response body for details.
2607         '401':
2608           description: Unauthenticated access. Please login first.
2609         '403':
2610           description: Unauthorized access. Please check your permissions.
2611         '500':
2612           description: Unexpected error. Please check the response body for the stack
2613             trace.
2614       security:
2615       - jwt: []
2616       summary: List Erasure Code Profile Information
2617       tags:
2618       - ErasureCodeProfile
2619     post:
2620       parameters: []
2621       requestBody:
2622         content:
2623           application/json:
2624             schema:
2625               properties:
2626                 name:
2627                   type: string
2628               required:
2629               - name
2630               type: object
2631       responses:
2632         '201':
2633           content:
2634             application/vnd.ceph.api.v1.0+json:
2635               type: object
2636           description: Resource created.
2637         '202':
2638           content:
2639             application/vnd.ceph.api.v1.0+json:
2640               type: object
2641           description: Operation is still executing. Please check the task queue.
2642         '400':
2643           description: Operation exception. Please check the response body for details.
2644         '401':
2645           description: Unauthenticated access. Please login first.
2646         '403':
2647           description: Unauthorized access. Please check your permissions.
2648         '500':
2649           description: Unexpected error. Please check the response body for the stack
2650             trace.
2651       security:
2652       - jwt: []
2653       tags:
2654       - ErasureCodeProfile
2655   /api/erasure_code_profile/{name}:
2656     delete:
2657       parameters:
2658       - in: path
2659         name: name
2660         required: true
2661         schema:
2662           type: string
2663       responses:
2664         '202':
2665           content:
2666             application/vnd.ceph.api.v1.0+json:
2667               type: object
2668           description: Operation is still executing. Please check the task queue.
2669         '204':
2670           content:
2671             application/vnd.ceph.api.v1.0+json:
2672               type: object
2673           description: Resource deleted.
2674         '400':
2675           description: Operation exception. Please check the response body for details.
2676         '401':
2677           description: Unauthenticated access. Please login first.
2678         '403':
2679           description: Unauthorized access. Please check your permissions.
2680         '500':
2681           description: Unexpected error. Please check the response body for the stack
2682             trace.
2683       security:
2684       - jwt: []
2685       tags:
2686       - ErasureCodeProfile
2687     get:
2688       parameters:
2689       - in: path
2690         name: name
2691         required: true
2692         schema:
2693           type: string
2694       responses:
2695         '200':
2696           content:
2697             application/vnd.ceph.api.v1.0+json:
2698               type: object
2699           description: OK
2700         '400':
2701           description: Operation exception. Please check the response body for details.
2702         '401':
2703           description: Unauthenticated access. Please login first.
2704         '403':
2705           description: Unauthorized access. Please check your permissions.
2706         '500':
2707           description: Unexpected error. Please check the response body for the stack
2708             trace.
2709       security:
2710       - jwt: []
2711       tags:
2712       - ErasureCodeProfile
2713   /api/feature_toggles:
2714     get:
2715       parameters: []
2716       responses:
2717         '200':
2718           content:
2719             application/vnd.ceph.api.v1.0+json:
2720               schema:
2721                 properties:
2722                   cephfs:
2723                     description: ''
2724                     type: boolean
2725                   iscsi:
2726                     description: ''
2727                     type: boolean
2728                   mirroring:
2729                     description: ''
2730                     type: boolean
2731                   nfs:
2732                     description: ''
2733                     type: boolean
2734                   rbd:
2735                     description: ''
2736                     type: boolean
2737                   rgw:
2738                     description: ''
2739                     type: boolean
2740                 required:
2741                 - rbd
2742                 - mirroring
2743                 - iscsi
2744                 - cephfs
2745                 - rgw
2746                 - nfs
2747                 type: object
2748           description: OK
2749         '400':
2750           description: Operation exception. Please check the response body for details.
2751         '401':
2752           description: Unauthenticated access. Please login first.
2753         '403':
2754           description: Unauthorized access. Please check your permissions.
2755         '500':
2756           description: Unexpected error. Please check the response body for the stack
2757             trace.
2758       security:
2759       - jwt: []
2760       summary: Get List Of Features
2761       tags:
2762       - FeatureTogglesEndpoint
2763   /api/feedback:
2764     get:
2765       description: "\n        List all issues details.\n        "
2766       parameters: []
2767       responses:
2768         '200':
2769           content:
2770             application/vnd.ceph.api.v0.1+json:
2771               type: object
2772           description: OK
2773         '400':
2774           description: Operation exception. Please check the response body for details.
2775         '401':
2776           description: Unauthenticated access. Please login first.
2777         '403':
2778           description: Unauthorized access. Please check your permissions.
2779         '500':
2780           description: Unexpected error. Please check the response body for the stack
2781             trace.
2782       security:
2783       - jwt: []
2784       tags:
2785       - Report
2786     post:
2787       description: "\n        Create an issue.\n        :param project: The affected\
2788         \ ceph component.\n        :param tracker: The tracker type.\n        :param\
2789         \ subject: The title of the issue.\n        :param description: The description\
2790         \ of the issue.\n        :param api_key: Ceph tracker api key.\n        "
2791       parameters: []
2792       requestBody:
2793         content:
2794           application/json:
2795             schema:
2796               properties:
2797                 api_key:
2798                   type: string
2799                 description:
2800                   type: string
2801                 project:
2802                   type: string
2803                 subject:
2804                   type: string
2805                 tracker:
2806                   type: string
2807               required:
2808               - project
2809               - tracker
2810               - subject
2811               - description
2812               type: object
2813       responses:
2814         '201':
2815           content:
2816             application/vnd.ceph.api.v0.1+json:
2817               type: object
2818           description: Resource created.
2819         '202':
2820           content:
2821             application/vnd.ceph.api.v0.1+json:
2822               type: object
2823           description: Operation is still executing. Please check the task queue.
2824         '400':
2825           description: Operation exception. Please check the response body for details.
2826         '401':
2827           description: Unauthenticated access. Please login first.
2828         '403':
2829           description: Unauthorized access. Please check your permissions.
2830         '500':
2831           description: Unexpected error. Please check the response body for the stack
2832             trace.
2833       security:
2834       - jwt: []
2835       tags:
2836       - Report
2837   /api/feedback/api_key:
2838     delete:
2839       description: "\n        Deletes Ceph tracker API key.\n        "
2840       parameters: []
2841       responses:
2842         '202':
2843           content:
2844             application/vnd.ceph.api.v0.1+json:
2845               type: object
2846           description: Operation is still executing. Please check the task queue.
2847         '204':
2848           content:
2849             application/vnd.ceph.api.v0.1+json:
2850               type: object
2851           description: Resource deleted.
2852         '400':
2853           description: Operation exception. Please check the response body for details.
2854         '401':
2855           description: Unauthenticated access. Please login first.
2856         '403':
2857           description: Unauthorized access. Please check your permissions.
2858         '500':
2859           description: Unexpected error. Please check the response body for the stack
2860             trace.
2861       security:
2862       - jwt: []
2863       tags:
2864       - Report
2865     get:
2866       description: "\n        Returns Ceph tracker API key.\n        "
2867       parameters: []
2868       responses:
2869         '200':
2870           content:
2871             application/vnd.ceph.api.v0.1+json:
2872               type: object
2873           description: OK
2874         '400':
2875           description: Operation exception. Please check the response body for details.
2876         '401':
2877           description: Unauthenticated access. Please login first.
2878         '403':
2879           description: Unauthorized access. Please check your permissions.
2880         '500':
2881           description: Unexpected error. Please check the response body for the stack
2882             trace.
2883       security:
2884       - jwt: []
2885       tags:
2886       - Report
2887     post:
2888       description: "\n        Sets Ceph tracker API key.\n        :param api_key:\
2889         \ The Ceph tracker API key.\n        "
2890       parameters: []
2891       requestBody:
2892         content:
2893           application/json:
2894             schema:
2895               properties:
2896                 api_key:
2897                   type: string
2898               required:
2899               - api_key
2900               type: object
2901       responses:
2902         '201':
2903           content:
2904             application/vnd.ceph.api.v0.1+json:
2905               type: object
2906           description: Resource created.
2907         '202':
2908           content:
2909             application/vnd.ceph.api.v0.1+json:
2910               type: object
2911           description: Operation is still executing. Please check the task queue.
2912         '400':
2913           description: Operation exception. Please check the response body for details.
2914         '401':
2915           description: Unauthenticated access. Please login first.
2916         '403':
2917           description: Unauthorized access. Please check your permissions.
2918         '500':
2919           description: Unexpected error. Please check the response body for the stack
2920             trace.
2921       security:
2922       - jwt: []
2923       tags:
2924       - Report
2925   /api/grafana/dashboards:
2926     post:
2927       parameters: []
2928       responses:
2929         '201':
2930           content:
2931             application/vnd.ceph.api.v1.0+json:
2932               type: object
2933           description: Resource created.
2934         '202':
2935           content:
2936             application/vnd.ceph.api.v1.0+json:
2937               type: object
2938           description: Operation is still executing. Please check the task queue.
2939         '400':
2940           description: Operation exception. Please check the response body for details.
2941         '401':
2942           description: Unauthenticated access. Please login first.
2943         '403':
2944           description: Unauthorized access. Please check your permissions.
2945         '500':
2946           description: Unexpected error. Please check the response body for the stack
2947             trace.
2948       security:
2949       - jwt: []
2950       tags:
2951       - Grafana
2952   /api/grafana/url:
2953     get:
2954       parameters: []
2955       responses:
2956         '200':
2957           content:
2958             application/vnd.ceph.api.v1.0+json:
2959               schema:
2960                 properties:
2961                   instance:
2962                     description: grafana instance
2963                     type: string
2964                 required:
2965                 - instance
2966                 type: object
2967           description: OK
2968         '400':
2969           description: Operation exception. Please check the response body for details.
2970         '401':
2971           description: Unauthenticated access. Please login first.
2972         '403':
2973           description: Unauthorized access. Please check your permissions.
2974         '500':
2975           description: Unexpected error. Please check the response body for the stack
2976             trace.
2977       security:
2978       - jwt: []
2979       summary: List Grafana URL Instance
2980       tags:
2981       - Grafana
2982   /api/grafana/validation/{params}:
2983     get:
2984       parameters:
2985       - in: path
2986         name: params
2987         required: true
2988         schema:
2989           type: string
2990       responses:
2991         '200':
2992           content:
2993             application/vnd.ceph.api.v1.0+json:
2994               type: object
2995           description: OK
2996         '400':
2997           description: Operation exception. Please check the response body for details.
2998         '401':
2999           description: Unauthenticated access. Please login first.
3000         '403':
3001           description: Unauthorized access. Please check your permissions.
3002         '500':
3003           description: Unexpected error. Please check the response body for the stack
3004             trace.
3005       security:
3006       - jwt: []
3007       tags:
3008       - Grafana
3009   /api/health/full:
3010     get:
3011       parameters: []
3012       responses:
3013         '200':
3014           content:
3015             application/vnd.ceph.api.v1.0+json:
3016               type: object
3017           description: OK
3018         '400':
3019           description: Operation exception. Please check the response body for details.
3020         '401':
3021           description: Unauthenticated access. Please login first.
3022         '403':
3023           description: Unauthorized access. Please check your permissions.
3024         '500':
3025           description: Unexpected error. Please check the response body for the stack
3026             trace.
3027       security:
3028       - jwt: []
3029       tags:
3030       - Health
3031   /api/health/minimal:
3032     get:
3033       parameters: []
3034       responses:
3035         '200':
3036           content:
3037             application/vnd.ceph.api.v1.0+json:
3038               schema:
3039                 properties:
3040                   client_perf:
3041                     description: ''
3042                     properties:
3043                       read_bytes_sec:
3044                         description: ''
3045                         type: integer
3046                       read_op_per_sec:
3047                         description: ''
3048                         type: integer
3049                       recovering_bytes_per_sec:
3050                         description: ''
3051                         type: integer
3052                       write_bytes_sec:
3053                         description: ''
3054                         type: integer
3055                       write_op_per_sec:
3056                         description: ''
3057                         type: integer
3058                     required:
3059                     - read_bytes_sec
3060                     - read_op_per_sec
3061                     - recovering_bytes_per_sec
3062                     - write_bytes_sec
3063                     - write_op_per_sec
3064                     type: object
3065                   df:
3066                     description: ''
3067                     properties:
3068                       stats:
3069                         description: ''
3070                         properties:
3071                           total_avail_bytes:
3072                             description: ''
3073                             type: integer
3074                           total_bytes:
3075                             description: ''
3076                             type: integer
3077                           total_used_raw_bytes:
3078                             description: ''
3079                             type: integer
3080                         required:
3081                         - total_avail_bytes
3082                         - total_bytes
3083                         - total_used_raw_bytes
3084                         type: object
3085                     required:
3086                     - stats
3087                     type: object
3088                   fs_map:
3089                     description: ''
3090                     properties:
3091                       filesystems:
3092                         description: ''
3093                         items:
3094                           properties:
3095                             mdsmap:
3096                               description: ''
3097                               properties:
3098                                 balancer:
3099                                   description: ''
3100                                   type: string
3101                                 compat:
3102                                   description: ''
3103                                   properties:
3104                                     compat:
3105                                       description: ''
3106                                       type: string
3107                                     incompat:
3108                                       description: ''
3109                                       type: string
3110                                     ro_compat:
3111                                       description: ''
3112                                       type: string
3113                                   required:
3114                                   - compat
3115                                   - ro_compat
3116                                   - incompat
3117                                   type: object
3118                                 created:
3119                                   description: ''
3120                                   type: string
3121                                 damaged:
3122                                   description: ''
3123                                   items:
3124                                     type: integer
3125                                   type: array
3126                                 data_pools:
3127                                   description: ''
3128                                   items:
3129                                     type: integer
3130                                   type: array
3131                                 enabled:
3132                                   description: ''
3133                                   type: boolean
3134                                 epoch:
3135                                   description: ''
3136                                   type: integer
3137                                 ever_allowed_features:
3138                                   description: ''
3139                                   type: integer
3140                                 explicitly_allowed_features:
3141                                   description: ''
3142                                   type: integer
3143                                 failed:
3144                                   description: ''
3145                                   items:
3146                                     type: integer
3147                                   type: array
3148                                 flags:
3149                                   description: ''
3150                                   type: integer
3151                                 fs_name:
3152                                   description: ''
3153                                   type: string
3154                                 in:
3155                                   description: ''
3156                                   items:
3157                                     type: integer
3158                                   type: array
3159                                 info:
3160                                   description: ''
3161                                   type: string
3162                                 last_failure:
3163                                   description: ''
3164                                   type: integer
3165                                 last_failure_osd_epoch:
3166                                   description: ''
3167                                   type: integer
3168                                 max_file_size:
3169                                   description: ''
3170                                   type: integer
3171                                 max_mds:
3172                                   description: ''
3173                                   type: integer
3174                                 metadata_pool:
3175                                   description: ''
3176                                   type: integer
3177                                 modified:
3178                                   description: ''
3179                                   type: string
3180                                 required_client_features:
3181                                   description: ''
3182                                   type: string
3183                                 root:
3184                                   description: ''
3185                                   type: integer
3186                                 session_autoclose:
3187                                   description: ''
3188                                   type: integer
3189                                 session_timeout:
3190                                   description: ''
3191                                   type: integer
3192                                 standby_count_wanted:
3193                                   description: ''
3194                                   type: integer
3195                                 stopped:
3196                                   description: ''
3197                                   items:
3198                                     type: integer
3199                                   type: array
3200                                 tableserver:
3201                                   description: ''
3202                                   type: integer
3203                                 up:
3204                                   description: ''
3205                                   type: string
3206                               required:
3207                               - session_autoclose
3208                               - balancer
3209                               - up
3210                               - last_failure_osd_epoch
3211                               - in
3212                               - last_failure
3213                               - max_file_size
3214                               - explicitly_allowed_features
3215                               - damaged
3216                               - tableserver
3217                               - failed
3218                               - metadata_pool
3219                               - epoch
3220                               - stopped
3221                               - max_mds
3222                               - compat
3223                               - required_client_features
3224                               - data_pools
3225                               - info
3226                               - fs_name
3227                               - created
3228                               - standby_count_wanted
3229                               - enabled
3230                               - modified
3231                               - session_timeout
3232                               - flags
3233                               - ever_allowed_features
3234                               - root
3235                               type: object
3236                             standbys:
3237                               description: ''
3238                               type: string
3239                           required:
3240                           - mdsmap
3241                           - standbys
3242                           type: object
3243                         type: array
3244                     required:
3245                     - filesystems
3246                     type: object
3247                   health:
3248                     description: ''
3249                     properties:
3250                       checks:
3251                         description: ''
3252                         type: string
3253                       mutes:
3254                         description: ''
3255                         type: string
3256                       status:
3257                         description: ''
3258                         type: string
3259                     required:
3260                     - checks
3261                     - mutes
3262                     - status
3263                     type: object
3264                   hosts:
3265                     description: ''
3266                     type: integer
3267                   iscsi_daemons:
3268                     description: ''
3269                     properties:
3270                       down:
3271                         description: ''
3272                         type: integer
3273                       up:
3274                         description: ''
3275                         type: integer
3276                     required:
3277                     - up
3278                     - down
3279                     type: object
3280                   mgr_map:
3281                     description: ''
3282                     properties:
3283                       active_name:
3284                         description: ''
3285                         type: string
3286                       standbys:
3287                         description: ''
3288                         type: string
3289                     required:
3290                     - active_name
3291                     - standbys
3292                     type: object
3293                   mon_status:
3294                     description: ''
3295                     properties:
3296                       monmap:
3297                         description: ''
3298                         properties:
3299                           mons:
3300                             description: ''
3301                             type: string
3302                         required:
3303                         - mons
3304                         type: object
3305                       quorum:
3306                         description: ''
3307                         items:
3308                           type: integer
3309                         type: array
3310                     required:
3311                     - monmap
3312                     - quorum
3313                     type: object
3314                   osd_map:
3315                     description: ''
3316                     properties:
3317                       osds:
3318                         description: ''
3319                         items:
3320                           properties:
3321                             in:
3322                               description: ''
3323                               type: integer
3324                             up:
3325                               description: ''
3326                               type: integer
3327                           required:
3328                           - in
3329                           - up
3330                           type: object
3331                         type: array
3332                     required:
3333                     - osds
3334                     type: object
3335                   pg_info:
3336                     description: ''
3337                     properties:
3338                       object_stats:
3339                         description: ''
3340                         properties:
3341                           num_object_copies:
3342                             description: ''
3343                             type: integer
3344                           num_objects:
3345                             description: ''
3346                             type: integer
3347                           num_objects_degraded:
3348                             description: ''
3349                             type: integer
3350                           num_objects_misplaced:
3351                             description: ''
3352                             type: integer
3353                           num_objects_unfound:
3354                             description: ''
3355                             type: integer
3356                         required:
3357                         - num_objects
3358                         - num_object_copies
3359                         - num_objects_degraded
3360                         - num_objects_misplaced
3361                         - num_objects_unfound
3362                         type: object
3363                       pgs_per_osd:
3364                         description: ''
3365                         type: integer
3366                       statuses:
3367                         description: ''
3368                         type: string
3369                     required:
3370                     - object_stats
3371                     - pgs_per_osd
3372                     - statuses
3373                     type: object
3374                   pools:
3375                     description: ''
3376                     type: string
3377                   rgw:
3378                     description: ''
3379                     type: integer
3380                   scrub_status:
3381                     description: ''
3382                     type: string
3383                 required:
3384                 - client_perf
3385                 - df
3386                 - fs_map
3387                 - health
3388                 - hosts
3389                 - iscsi_daemons
3390                 - mgr_map
3391                 - mon_status
3392                 - osd_map
3393                 - pg_info
3394                 - pools
3395                 - rgw
3396                 - scrub_status
3397                 type: object
3398           description: OK
3399         '400':
3400           description: Operation exception. Please check the response body for details.
3401         '401':
3402           description: Unauthenticated access. Please login first.
3403         '403':
3404           description: Unauthorized access. Please check your permissions.
3405         '500':
3406           description: Unexpected error. Please check the response body for the stack
3407             trace.
3408       security:
3409       - jwt: []
3410       summary: Get Cluster's minimal health report
3411       tags:
3412       - Health
3413   /api/host:
3414     get:
3415       parameters:
3416       - allowEmptyValue: true
3417         description: Host Sources
3418         in: query
3419         name: sources
3420         schema:
3421           type: string
3422       - default: false
3423         description: Host Facts
3424         in: query
3425         name: facts
3426         schema:
3427           type: boolean
3428       responses:
3429         '200':
3430           content:
3431             application/vnd.ceph.api.v1.1+json:
3432               schema:
3433                 properties:
3434                   addr:
3435                     description: Host address
3436                     type: string
3437                   ceph_version:
3438                     description: Ceph version
3439                     type: string
3440                   hostname:
3441                     description: Hostname
3442                     type: string
3443                   labels:
3444                     description: Labels related to the host
3445                     items:
3446                       type: string
3447                     type: array
3448                   service_type:
3449                     description: ''
3450                     type: string
3451                   services:
3452                     description: Services related to the host
3453                     items:
3454                       properties:
3455                         id:
3456                           description: Service Id
3457                           type: string
3458                         type:
3459                           description: type of service
3460                           type: string
3461                       required:
3462                       - type
3463                       - id
3464                       type: object
3465                     type: array
3466                   sources:
3467                     description: Host Sources
3468                     properties:
3469                       ceph:
3470                         description: ''
3471                         type: boolean
3472                       orchestrator:
3473                         description: ''
3474                         type: boolean
3475                     required:
3476                     - ceph
3477                     - orchestrator
3478                     type: object
3479                   status:
3480                     description: ''
3481                     type: string
3482                 required:
3483                 - hostname
3484                 - services
3485                 - ceph_version
3486                 - addr
3487                 - labels
3488                 - service_type
3489                 - sources
3490                 - status
3491                 type: object
3492           description: OK
3493         '400':
3494           description: Operation exception. Please check the response body for details.
3495         '401':
3496           description: Unauthenticated access. Please login first.
3497         '403':
3498           description: Unauthorized access. Please check your permissions.
3499         '500':
3500           description: Unexpected error. Please check the response body for the stack
3501             trace.
3502       security:
3503       - jwt: []
3504       summary: List Host Specifications
3505       tags:
3506       - Host
3507     post:
3508       parameters: []
3509       requestBody:
3510         content:
3511           application/json:
3512             schema:
3513               properties:
3514                 addr:
3515                   description: Network Address
3516                   type: string
3517                 hostname:
3518                   description: Hostname
3519                   type: string
3520                 labels:
3521                   description: Host Labels
3522                   items:
3523                     type: string
3524                   type: array
3525                 status:
3526                   description: Host Status
3527                   type: string
3528               required:
3529               - hostname
3530               type: object
3531       responses:
3532         '201':
3533           content:
3534             application/vnd.ceph.api.v0.1+json:
3535               type: object
3536           description: Resource created.
3537         '202':
3538           content:
3539             application/vnd.ceph.api.v0.1+json:
3540               type: object
3541           description: Operation is still executing. Please check the task queue.
3542         '400':
3543           description: Operation exception. Please check the response body for details.
3544         '401':
3545           description: Unauthenticated access. Please login first.
3546         '403':
3547           description: Unauthorized access. Please check your permissions.
3548         '500':
3549           description: Unexpected error. Please check the response body for the stack
3550             trace.
3551       security:
3552       - jwt: []
3553       tags:
3554       - Host
3555   /api/host/{hostname}:
3556     delete:
3557       parameters:
3558       - in: path
3559         name: hostname
3560         required: true
3561         schema:
3562           type: string
3563       responses:
3564         '202':
3565           content:
3566             application/vnd.ceph.api.v1.0+json:
3567               type: object
3568           description: Operation is still executing. Please check the task queue.
3569         '204':
3570           content:
3571             application/vnd.ceph.api.v1.0+json:
3572               type: object
3573           description: Resource deleted.
3574         '400':
3575           description: Operation exception. Please check the response body for details.
3576         '401':
3577           description: Unauthenticated access. Please login first.
3578         '403':
3579           description: Unauthorized access. Please check your permissions.
3580         '500':
3581           description: Unexpected error. Please check the response body for the stack
3582             trace.
3583       security:
3584       - jwt: []
3585       tags:
3586       - Host
3587     get:
3588       description: "\n        Get the specified host.\n        :raises: cherrypy.HTTPError:\
3589         \ If host not found.\n        "
3590       parameters:
3591       - in: path
3592         name: hostname
3593         required: true
3594         schema:
3595           type: string
3596       responses:
3597         '200':
3598           content:
3599             application/vnd.ceph.api.v1.0+json:
3600               type: object
3601           description: OK
3602         '400':
3603           description: Operation exception. Please check the response body for details.
3604         '401':
3605           description: Unauthenticated access. Please login first.
3606         '403':
3607           description: Unauthorized access. Please check your permissions.
3608         '500':
3609           description: Unexpected error. Please check the response body for the stack
3610             trace.
3611       security:
3612       - jwt: []
3613       tags:
3614       - Host
3615     put:
3616       description: "\n        Update the specified host.\n        Note, this is only\
3617         \ supported when Ceph Orchestrator is enabled.\n        :param hostname: The\
3618         \ name of the host to be processed.\n        :param update_labels: To update\
3619         \ the labels.\n        :param labels: List of labels.\n        :param maintenance:\
3620         \ Enter/Exit maintenance mode.\n        :param force: Force enter maintenance\
3621         \ mode.\n        :param drain: Drain host\n        "
3622       parameters:
3623       - description: Hostname
3624         in: path
3625         name: hostname
3626         required: true
3627         schema:
3628           type: string
3629       requestBody:
3630         content:
3631           application/json:
3632             schema:
3633               properties:
3634                 drain:
3635                   default: false
3636                   description: Drain Host
3637                   type: boolean
3638                 force:
3639                   default: false
3640                   description: Force Enter Maintenance
3641                   type: boolean
3642                 labels:
3643                   description: Host Labels
3644                   items:
3645                     type: string
3646                   type: array
3647                 maintenance:
3648                   default: false
3649                   description: Enter/Exit Maintenance
3650                   type: boolean
3651                 update_labels:
3652                   default: false
3653                   description: Update Labels
3654                   type: boolean
3655               type: object
3656       responses:
3657         '200':
3658           content:
3659             application/vnd.ceph.api.v0.1+json:
3660               schema:
3661                 properties: {}
3662                 type: object
3663           description: Resource updated.
3664         '202':
3665           content:
3666             application/vnd.ceph.api.v0.1+json:
3667               type: object
3668           description: Operation is still executing. Please check the task queue.
3669         '400':
3670           description: Operation exception. Please check the response body for details.
3671         '401':
3672           description: Unauthenticated access. Please login first.
3673         '403':
3674           description: Unauthorized access. Please check your permissions.
3675         '500':
3676           description: Unexpected error. Please check the response body for the stack
3677             trace.
3678       security:
3679       - jwt: []
3680       tags:
3681       - Host
3682   /api/host/{hostname}/daemons:
3683     get:
3684       parameters:
3685       - in: path
3686         name: hostname
3687         required: true
3688         schema:
3689           type: string
3690       responses:
3691         '200':
3692           content:
3693             application/vnd.ceph.api.v1.0+json:
3694               type: object
3695           description: OK
3696         '400':
3697           description: Operation exception. Please check the response body for details.
3698         '401':
3699           description: Unauthenticated access. Please login first.
3700         '403':
3701           description: Unauthorized access. Please check your permissions.
3702         '500':
3703           description: Unexpected error. Please check the response body for the stack
3704             trace.
3705       security:
3706       - jwt: []
3707       tags:
3708       - Host
3709   /api/host/{hostname}/devices:
3710     get:
3711       parameters:
3712       - in: path
3713         name: hostname
3714         required: true
3715         schema:
3716           type: string
3717       responses:
3718         '200':
3719           content:
3720             application/vnd.ceph.api.v1.0+json:
3721               type: object
3722           description: OK
3723         '400':
3724           description: Operation exception. Please check the response body for details.
3725         '401':
3726           description: Unauthenticated access. Please login first.
3727         '403':
3728           description: Unauthorized access. Please check your permissions.
3729         '500':
3730           description: Unexpected error. Please check the response body for the stack
3731             trace.
3732       security:
3733       - jwt: []
3734       tags:
3735       - Host
3736   /api/host/{hostname}/identify_device:
3737     post:
3738       description: "\n        Identify a device by switching on the device light for\
3739         \ N seconds.\n        :param hostname: The hostname of the device to process.\n\
3740         \        :param device: The device identifier to process, e.g. ``/dev/dm-0``\
3741         \ or\n        ``ABC1234DEF567-1R1234_ABC8DE0Q``.\n        :param duration:\
3742         \ The duration in seconds how long the LED should flash.\n        "
3743       parameters:
3744       - in: path
3745         name: hostname
3746         required: true
3747         schema:
3748           type: string
3749       requestBody:
3750         content:
3751           application/json:
3752             schema:
3753               properties:
3754                 device:
3755                   type: string
3756                 duration:
3757                   type: string
3758               required:
3759               - device
3760               - duration
3761               type: object
3762       responses:
3763         '201':
3764           content:
3765             application/vnd.ceph.api.v1.0+json:
3766               type: object
3767           description: Resource created.
3768         '202':
3769           content:
3770             application/vnd.ceph.api.v1.0+json:
3771               type: object
3772           description: Operation is still executing. Please check the task queue.
3773         '400':
3774           description: Operation exception. Please check the response body for details.
3775         '401':
3776           description: Unauthenticated access. Please login first.
3777         '403':
3778           description: Unauthorized access. Please check your permissions.
3779         '500':
3780           description: Unexpected error. Please check the response body for the stack
3781             trace.
3782       security:
3783       - jwt: []
3784       tags:
3785       - Host
3786   /api/host/{hostname}/inventory:
3787     get:
3788       parameters:
3789       - description: Hostname
3790         in: path
3791         name: hostname
3792         required: true
3793         schema:
3794           type: string
3795       - allowEmptyValue: true
3796         description: Trigger asynchronous refresh
3797         in: query
3798         name: refresh
3799         schema:
3800           type: string
3801       responses:
3802         '200':
3803           content:
3804             application/vnd.ceph.api.v1.0+json:
3805               schema:
3806                 properties:
3807                   addr:
3808                     description: Host address
3809                     type: string
3810                   devices:
3811                     description: Host devices
3812                     items:
3813                       properties:
3814                         available:
3815                           description: If the device can be provisioned to an OSD
3816                           type: boolean
3817                         device_id:
3818                           description: Device's udev ID
3819                           type: string
3820                         human_readable_type:
3821                           description: Device type. ssd or hdd
3822                           type: string
3823                         lsm_data:
3824                           description: ''
3825                           properties:
3826                             errors:
3827                               description: ''
3828                               items:
3829                                 type: string
3830                               type: array
3831                             health:
3832                               description: ''
3833                               type: string
3834                             ledSupport:
3835                               description: ''
3836                               properties:
3837                                 FAILstatus:
3838                                   description: ''
3839                                   type: string
3840                                 FAILsupport:
3841                                   description: ''
3842                                   type: string
3843                                 IDENTstatus:
3844                                   description: ''
3845                                   type: string
3846                                 IDENTsupport:
3847                                   description: ''
3848                                   type: string
3849                               required:
3850                               - IDENTsupport
3851                               - IDENTstatus
3852                               - FAILsupport
3853                               - FAILstatus
3854                               type: object
3855                             linkSpeed:
3856                               description: ''
3857                               type: string
3858                             mediaType:
3859                               description: ''
3860                               type: string
3861                             rpm:
3862                               description: ''
3863                               type: string
3864                             serialNum:
3865                               description: ''
3866                               type: string
3867                             transport:
3868                               description: ''
3869                               type: string
3870                           required:
3871                           - serialNum
3872                           - transport
3873                           - mediaType
3874                           - rpm
3875                           - linkSpeed
3876                           - health
3877                           - ledSupport
3878                           - errors
3879                           type: object
3880                         lvs:
3881                           description: ''
3882                           items:
3883                             properties:
3884                               block_uuid:
3885                                 description: ''
3886                                 type: string
3887                               cluster_fsid:
3888                                 description: ''
3889                                 type: string
3890                               cluster_name:
3891                                 description: ''
3892                                 type: string
3893                               name:
3894                                 description: ''
3895                                 type: string
3896                               osd_fsid:
3897                                 description: ''
3898                                 type: string
3899                               osd_id:
3900                                 description: ''
3901                                 type: string
3902                               osdspec_affinity:
3903                                 description: ''
3904                                 type: string
3905                               type:
3906                                 description: ''
3907                                 type: string
3908                             required:
3909                             - name
3910                             - osd_id
3911                             - cluster_name
3912                             - type
3913                             - osd_fsid
3914                             - cluster_fsid
3915                             - osdspec_affinity
3916                             - block_uuid
3917                             type: object
3918                           type: array
3919                         osd_ids:
3920                           description: Device OSD IDs
3921                           items:
3922                             type: integer
3923                           type: array
3924                         path:
3925                           description: Device path
3926                           type: string
3927                         rejected_reasons:
3928                           description: ''
3929                           items:
3930                             type: string
3931                           type: array
3932                         sys_api:
3933                           description: ''
3934                           properties:
3935                             human_readable_size:
3936                               description: ''
3937                               type: string
3938                             locked:
3939                               description: ''
3940                               type: integer
3941                             model:
3942                               description: ''
3943                               type: string
3944                             nr_requests:
3945                               description: ''
3946                               type: string
3947                             partitions:
3948                               description: ''
3949                               properties:
3950                                 partition_name:
3951                                   description: ''
3952                                   properties:
3953                                     holders:
3954                                       description: ''
3955                                       items:
3956                                         type: string
3957                                       type: array
3958                                     human_readable_size:
3959                                       description: ''
3960                                       type: string
3961                                     sectors:
3962                                       description: ''
3963                                       type: string
3964                                     sectorsize:
3965                                       description: ''
3966                                       type: integer
3967                                     size:
3968                                       description: ''
3969                                       type: integer
3970                                     start:
3971                                       description: ''
3972                                       type: string
3973                                   required:
3974                                   - start
3975                                   - sectors
3976                                   - sectorsize
3977                                   - size
3978                                   - human_readable_size
3979                                   - holders
3980                                   type: object
3981                               required:
3982                               - partition_name
3983                               type: object
3984                             path:
3985                               description: ''
3986                               type: string
3987                             removable:
3988                               description: ''
3989                               type: string
3990                             rev:
3991                               description: ''
3992                               type: string
3993                             ro:
3994                               description: ''
3995                               type: string
3996                             rotational:
3997                               description: ''
3998                               type: string
3999                             sas_address:
4000                               description: ''
4001                               type: string
4002                             sas_device_handle:
4003                               description: ''
4004                               type: string
4005                             scheduler_mode:
4006                               description: ''
4007                               type: string
4008                             sectors:
4009                               description: ''
4010                               type: integer
4011                             sectorsize:
4012                               description: ''
4013                               type: string
4014                             size:
4015                               description: ''
4016                               type: integer
4017                             support_discard:
4018                               description: ''
4019                               type: string
4020                             vendor:
4021                               description: ''
4022                               type: string
4023                           required:
4024                           - removable
4025                           - ro
4026                           - vendor
4027                           - model
4028                           - rev
4029                           - sas_address
4030                           - sas_device_handle
4031                           - support_discard
4032                           - rotational
4033                           - nr_requests
4034                           - scheduler_mode
4035                           - partitions
4036                           - sectors
4037                           - sectorsize
4038                           - size
4039                           - human_readable_size
4040                           - path
4041                           - locked
4042                           type: object
4043                       required:
4044                       - rejected_reasons
4045                       - available
4046                       - path
4047                       - sys_api
4048                       - lvs
4049                       - human_readable_type
4050                       - device_id
4051                       - lsm_data
4052                       - osd_ids
4053                       type: object
4054                     type: array
4055                   labels:
4056                     description: Host labels
4057                     items:
4058                       type: string
4059                     type: array
4060                   name:
4061                     description: Hostname
4062                     type: string
4063                 required:
4064                 - name
4065                 - addr
4066                 - devices
4067                 - labels
4068                 type: object
4069           description: OK
4070         '400':
4071           description: Operation exception. Please check the response body for details.
4072         '401':
4073           description: Unauthenticated access. Please login first.
4074         '403':
4075           description: Unauthorized access. Please check your permissions.
4076         '500':
4077           description: Unexpected error. Please check the response body for the stack
4078             trace.
4079       security:
4080       - jwt: []
4081       summary: Get inventory of a host
4082       tags:
4083       - Host
4084   /api/host/{hostname}/smart:
4085     get:
4086       parameters:
4087       - in: path
4088         name: hostname
4089         required: true
4090         schema:
4091           type: string
4092       responses:
4093         '200':
4094           content:
4095             application/vnd.ceph.api.v1.0+json:
4096               type: object
4097           description: OK
4098         '400':
4099           description: Operation exception. Please check the response body for details.
4100         '401':
4101           description: Unauthenticated access. Please login first.
4102         '403':
4103           description: Unauthorized access. Please check your permissions.
4104         '500':
4105           description: Unexpected error. Please check the response body for the stack
4106             trace.
4107       security:
4108       - jwt: []
4109       tags:
4110       - Host
4111   /api/iscsi/discoveryauth:
4112     get:
4113       parameters: []
4114       responses:
4115         '200':
4116           content:
4117             application/vnd.ceph.api.v1.0+json:
4118               schema:
4119                 items:
4120                   properties:
4121                     mutual_password:
4122                       description: ''
4123                       type: string
4124                     mutual_user:
4125                       description: ''
4126                       type: string
4127                     password:
4128                       description: password
4129                       type: string
4130                     user:
4131                       description: username
4132                       type: string
4133                   type: object
4134                 required:
4135                 - user
4136                 - password
4137                 - mutual_user
4138                 - mutual_password
4139                 type: array
4140           description: OK
4141         '400':
4142           description: Operation exception. Please check the response body for details.
4143         '401':
4144           description: Unauthenticated access. Please login first.
4145         '403':
4146           description: Unauthorized access. Please check your permissions.
4147         '500':
4148           description: Unexpected error. Please check the response body for the stack
4149             trace.
4150       security:
4151       - jwt: []
4152       summary: Get Iscsi discoveryauth Details
4153       tags:
4154       - Iscsi
4155     put:
4156       parameters:
4157       - description: Username
4158         in: query
4159         name: user
4160         required: true
4161         schema:
4162           type: string
4163       - description: Password
4164         in: query
4165         name: password
4166         required: true
4167         schema:
4168           type: string
4169       - description: Mutual UserName
4170         in: query
4171         name: mutual_user
4172         required: true
4173         schema:
4174           type: string
4175       - description: Mutual Password
4176         in: query
4177         name: mutual_password
4178         required: true
4179         schema:
4180           type: string
4181       requestBody:
4182         content:
4183           application/json:
4184             schema:
4185               properties:
4186                 mutual_password:
4187                   description: Mutual Password
4188                   type: string
4189                 mutual_user:
4190                   description: Mutual UserName
4191                   type: string
4192                 password:
4193                   description: Password
4194                   type: string
4195                 user:
4196                   description: Username
4197                   type: string
4198               required:
4199               - user
4200               - password
4201               - mutual_user
4202               - mutual_password
4203               type: object
4204       responses:
4205         '200':
4206           content:
4207             application/vnd.ceph.api.v1.0+json:
4208               type: object
4209           description: Resource updated.
4210         '202':
4211           content:
4212             application/vnd.ceph.api.v1.0+json:
4213               type: object
4214           description: Operation is still executing. Please check the task queue.
4215         '400':
4216           description: Operation exception. Please check the response body for details.
4217         '401':
4218           description: Unauthenticated access. Please login first.
4219         '403':
4220           description: Unauthorized access. Please check your permissions.
4221         '500':
4222           description: Unexpected error. Please check the response body for the stack
4223             trace.
4224       security:
4225       - jwt: []
4226       summary: Set Iscsi discoveryauth
4227       tags:
4228       - Iscsi
4229   /api/iscsi/target:
4230     get:
4231       parameters: []
4232       responses:
4233         '200':
4234           content:
4235             application/vnd.ceph.api.v1.0+json:
4236               type: object
4237           description: OK
4238         '400':
4239           description: Operation exception. Please check the response body for details.
4240         '401':
4241           description: Unauthenticated access. Please login first.
4242         '403':
4243           description: Unauthorized access. Please check your permissions.
4244         '500':
4245           description: Unexpected error. Please check the response body for the stack
4246             trace.
4247       security:
4248       - jwt: []
4249       tags:
4250       - IscsiTarget
4251     post:
4252       parameters: []
4253       requestBody:
4254         content:
4255           application/json:
4256             schema:
4257               properties:
4258                 acl_enabled:
4259                   type: string
4260                 auth:
4261                   type: string
4262                 clients:
4263                   type: string
4264                 disks:
4265                   type: string
4266                 groups:
4267                   type: string
4268                 portals:
4269                   type: string
4270                 target_controls:
4271                   type: string
4272                 target_iqn:
4273                   type: string
4274               type: object
4275       responses:
4276         '201':
4277           content:
4278             application/vnd.ceph.api.v1.0+json:
4279               type: object
4280           description: Resource created.
4281         '202':
4282           content:
4283             application/vnd.ceph.api.v1.0+json:
4284               type: object
4285           description: Operation is still executing. Please check the task queue.
4286         '400':
4287           description: Operation exception. Please check the response body for details.
4288         '401':
4289           description: Unauthenticated access. Please login first.
4290         '403':
4291           description: Unauthorized access. Please check your permissions.
4292         '500':
4293           description: Unexpected error. Please check the response body for the stack
4294             trace.
4295       security:
4296       - jwt: []
4297       tags:
4298       - IscsiTarget
4299   /api/iscsi/target/{target_iqn}:
4300     delete:
4301       parameters:
4302       - in: path
4303         name: target_iqn
4304         required: true
4305         schema:
4306           type: string
4307       responses:
4308         '202':
4309           content:
4310             application/vnd.ceph.api.v1.0+json:
4311               type: object
4312           description: Operation is still executing. Please check the task queue.
4313         '204':
4314           content:
4315             application/vnd.ceph.api.v1.0+json:
4316               type: object
4317           description: Resource deleted.
4318         '400':
4319           description: Operation exception. Please check the response body for details.
4320         '401':
4321           description: Unauthenticated access. Please login first.
4322         '403':
4323           description: Unauthorized access. Please check your permissions.
4324         '500':
4325           description: Unexpected error. Please check the response body for the stack
4326             trace.
4327       security:
4328       - jwt: []
4329       tags:
4330       - IscsiTarget
4331     get:
4332       parameters:
4333       - in: path
4334         name: target_iqn
4335         required: true
4336         schema:
4337           type: string
4338       responses:
4339         '200':
4340           content:
4341             application/vnd.ceph.api.v1.0+json:
4342               type: object
4343           description: OK
4344         '400':
4345           description: Operation exception. Please check the response body for details.
4346         '401':
4347           description: Unauthenticated access. Please login first.
4348         '403':
4349           description: Unauthorized access. Please check your permissions.
4350         '500':
4351           description: Unexpected error. Please check the response body for the stack
4352             trace.
4353       security:
4354       - jwt: []
4355       tags:
4356       - IscsiTarget
4357     put:
4358       parameters:
4359       - in: path
4360         name: target_iqn
4361         required: true
4362         schema:
4363           type: string
4364       requestBody:
4365         content:
4366           application/json:
4367             schema:
4368               properties:
4369                 acl_enabled:
4370                   type: string
4371                 auth:
4372                   type: string
4373                 clients:
4374                   type: string
4375                 disks:
4376                   type: string
4377                 groups:
4378                   type: string
4379                 new_target_iqn:
4380                   type: string
4381                 portals:
4382                   type: string
4383                 target_controls:
4384                   type: string
4385               type: object
4386       responses:
4387         '200':
4388           content:
4389             application/vnd.ceph.api.v1.0+json:
4390               type: object
4391           description: Resource updated.
4392         '202':
4393           content:
4394             application/vnd.ceph.api.v1.0+json:
4395               type: object
4396           description: Operation is still executing. Please check the task queue.
4397         '400':
4398           description: Operation exception. Please check the response body for details.
4399         '401':
4400           description: Unauthenticated access. Please login first.
4401         '403':
4402           description: Unauthorized access. Please check your permissions.
4403         '500':
4404           description: Unexpected error. Please check the response body for the stack
4405             trace.
4406       security:
4407       - jwt: []
4408       tags:
4409       - IscsiTarget
4410   /api/logs/all:
4411     get:
4412       parameters: []
4413       responses:
4414         '200':
4415           content:
4416             application/vnd.ceph.api.v1.0+json:
4417               schema:
4418                 properties:
4419                   audit_log:
4420                     description: Audit log
4421                     items:
4422                       properties:
4423                         addrs:
4424                           description: ''
4425                           properties:
4426                             addrvec:
4427                               description: ''
4428                               items:
4429                                 properties:
4430                                   addr:
4431                                     description: IP Address
4432                                     type: string
4433                                   nonce:
4434                                     description: ''
4435                                     type: integer
4436                                   type:
4437                                     description: ''
4438                                     type: string
4439                                 required:
4440                                 - type
4441                                 - addr
4442                                 - nonce
4443                                 type: object
4444                               type: array
4445                           required:
4446                           - addrvec
4447                           type: object
4448                         channel:
4449                           description: ''
4450                           type: string
4451                         message:
4452                           description: ''
4453                           type: string
4454                         name:
4455                           description: ''
4456                           type: string
4457                         priority:
4458                           description: ''
4459                           type: string
4460                         rank:
4461                           description: ''
4462                           type: string
4463                         seq:
4464                           description: ''
4465                           type: integer
4466                         stamp:
4467                           description: ''
4468                           type: string
4469                       required:
4470                       - name
4471                       - rank
4472                       - addrs
4473                       - stamp
4474                       - seq
4475                       - channel
4476                       - priority
4477                       - message
4478                       type: object
4479                     type: array
4480                   clog:
4481                     description: ''
4482                     items:
4483                       type: string
4484                     type: array
4485                 required:
4486                 - clog
4487                 - audit_log
4488                 type: object
4489           description: OK
4490         '400':
4491           description: Operation exception. Please check the response body for details.
4492         '401':
4493           description: Unauthenticated access. Please login first.
4494         '403':
4495           description: Unauthorized access. Please check your permissions.
4496         '500':
4497           description: Unexpected error. Please check the response body for the stack
4498             trace.
4499       security:
4500       - jwt: []
4501       summary: Display Logs Configuration
4502       tags:
4503       - Logs
4504   /api/mgr/module:
4505     get:
4506       description: "\n        Get the list of managed modules.\n        :return: A\
4507         \ list of objects with the fields 'enabled', 'name' and 'options'.\n     \
4508         \   :rtype: list\n        "
4509       parameters: []
4510       responses:
4511         '200':
4512           content:
4513             application/vnd.ceph.api.v1.0+json:
4514               schema:
4515                 items:
4516                   properties:
4517                     always_on:
4518                       description: Is it an always on module?
4519                       type: boolean
4520                     enabled:
4521                       description: Is Module Enabled
4522                       type: boolean
4523                     name:
4524                       description: Module Name
4525                       type: string
4526                     options:
4527                       description: Module Options
4528                       properties:
4529                         Option_name:
4530                           description: Options
4531                           properties:
4532                             default_value:
4533                               description: Default value for the option
4534                               type: integer
4535                             desc:
4536                               description: Description of the option
4537                               type: string
4538                             enum_allowed:
4539                               description: ''
4540                               items:
4541                                 type: string
4542                               type: array
4543                             flags:
4544                               description: List of flags associated
4545                               type: integer
4546                             level:
4547                               description: Option level
4548                               type: string
4549                             long_desc:
4550                               description: Elaborated description
4551                               type: string
4552                             max:
4553                               description: Maximum value
4554                               type: string
4555                             min:
4556                               description: Minimum value
4557                               type: string
4558                             name:
4559                               description: Name of the option
4560                               type: string
4561                             see_also:
4562                               description: Related options
4563                               items:
4564                                 type: string
4565                               type: array
4566                             tags:
4567                               description: Tags associated with the option
4568                               items:
4569                                 type: string
4570                               type: array
4571                             type:
4572                               description: Type of the option
4573                               type: string
4574                           required:
4575                           - name
4576                           - type
4577                           - level
4578                           - flags
4579                           - default_value
4580                           - min
4581                           - max
4582                           - enum_allowed
4583                           - desc
4584                           - long_desc
4585                           - tags
4586                           - see_also
4587                           type: object
4588                       required:
4589                       - Option_name
4590                       type: object
4591                   type: object
4592                 required:
4593                 - name
4594                 - enabled
4595                 - always_on
4596                 - options
4597                 type: array
4598           description: OK
4599         '400':
4600           description: Operation exception. Please check the response body for details.
4601         '401':
4602           description: Unauthenticated access. Please login first.
4603         '403':
4604           description: Unauthorized access. Please check your permissions.
4605         '500':
4606           description: Unexpected error. Please check the response body for the stack
4607             trace.
4608       security:
4609       - jwt: []
4610       summary: List Mgr modules
4611       tags:
4612       - MgrModule
4613   /api/mgr/module/{module_name}:
4614     get:
4615       description: "\n        Retrieve the values of the persistent configuration\
4616         \ settings.\n        :param module_name: The name of the Ceph Mgr module.\n\
4617         \        :type module_name: str\n        :return: The values of the module\
4618         \ options.\n        :rtype: dict\n        "
4619       parameters:
4620       - in: path
4621         name: module_name
4622         required: true
4623         schema:
4624           type: string
4625       responses:
4626         '200':
4627           content:
4628             application/vnd.ceph.api.v1.0+json:
4629               type: object
4630           description: OK
4631         '400':
4632           description: Operation exception. Please check the response body for details.
4633         '401':
4634           description: Unauthenticated access. Please login first.
4635         '403':
4636           description: Unauthorized access. Please check your permissions.
4637         '500':
4638           description: Unexpected error. Please check the response body for the stack
4639             trace.
4640       security:
4641       - jwt: []
4642       tags:
4643       - MgrModule
4644     put:
4645       description: "\n        Set the values of the persistent configuration settings.\n\
4646         \        :param module_name: The name of the Ceph Mgr module.\n        :type\
4647         \ module_name: str\n        :param config: The values of the module options\
4648         \ to be stored.\n        :type config: dict\n        "
4649       parameters:
4650       - in: path
4651         name: module_name
4652         required: true
4653         schema:
4654           type: string
4655       requestBody:
4656         content:
4657           application/json:
4658             schema:
4659               properties:
4660                 config:
4661                   type: string
4662               required:
4663               - config
4664               type: object
4665       responses:
4666         '200':
4667           content:
4668             application/vnd.ceph.api.v1.0+json:
4669               type: object
4670           description: Resource updated.
4671         '202':
4672           content:
4673             application/vnd.ceph.api.v1.0+json:
4674               type: object
4675           description: Operation is still executing. Please check the task queue.
4676         '400':
4677           description: Operation exception. Please check the response body for details.
4678         '401':
4679           description: Unauthenticated access. Please login first.
4680         '403':
4681           description: Unauthorized access. Please check your permissions.
4682         '500':
4683           description: Unexpected error. Please check the response body for the stack
4684             trace.
4685       security:
4686       - jwt: []
4687       tags:
4688       - MgrModule
4689   /api/mgr/module/{module_name}/disable:
4690     post:
4691       description: "\n        Disable the specified Ceph Mgr module.\n        :param\
4692         \ module_name: The name of the Ceph Mgr module.\n        :type module_name:\
4693         \ str\n        "
4694       parameters:
4695       - in: path
4696         name: module_name
4697         required: true
4698         schema:
4699           type: string
4700       responses:
4701         '201':
4702           content:
4703             application/vnd.ceph.api.v1.0+json:
4704               type: object
4705           description: Resource created.
4706         '202':
4707           content:
4708             application/vnd.ceph.api.v1.0+json:
4709               type: object
4710           description: Operation is still executing. Please check the task queue.
4711         '400':
4712           description: Operation exception. Please check the response body for details.
4713         '401':
4714           description: Unauthenticated access. Please login first.
4715         '403':
4716           description: Unauthorized access. Please check your permissions.
4717         '500':
4718           description: Unexpected error. Please check the response body for the stack
4719             trace.
4720       security:
4721       - jwt: []
4722       tags:
4723       - MgrModule
4724   /api/mgr/module/{module_name}/enable:
4725     post:
4726       description: "\n        Enable the specified Ceph Mgr module.\n        :param\
4727         \ module_name: The name of the Ceph Mgr module.\n        :type module_name:\
4728         \ str\n        "
4729       parameters:
4730       - in: path
4731         name: module_name
4732         required: true
4733         schema:
4734           type: string
4735       responses:
4736         '201':
4737           content:
4738             application/vnd.ceph.api.v1.0+json:
4739               type: object
4740           description: Resource created.
4741         '202':
4742           content:
4743             application/vnd.ceph.api.v1.0+json:
4744               type: object
4745           description: Operation is still executing. Please check the task queue.
4746         '400':
4747           description: Operation exception. Please check the response body for details.
4748         '401':
4749           description: Unauthenticated access. Please login first.
4750         '403':
4751           description: Unauthorized access. Please check your permissions.
4752         '500':
4753           description: Unexpected error. Please check the response body for the stack
4754             trace.
4755       security:
4756       - jwt: []
4757       tags:
4758       - MgrModule
4759   /api/mgr/module/{module_name}/options:
4760     get:
4761       description: "\n        Get the module options of the specified Ceph Mgr module.\n\
4762         \        :param module_name: The name of the Ceph Mgr module.\n        :type\
4763         \ module_name: str\n        :return: The module options as list of dicts.\n\
4764         \        :rtype: list\n        "
4765       parameters:
4766       - in: path
4767         name: module_name
4768         required: true
4769         schema:
4770           type: string
4771       responses:
4772         '200':
4773           content:
4774             application/vnd.ceph.api.v1.0+json:
4775               type: object
4776           description: OK
4777         '400':
4778           description: Operation exception. Please check the response body for details.
4779         '401':
4780           description: Unauthenticated access. Please login first.
4781         '403':
4782           description: Unauthorized access. Please check your permissions.
4783         '500':
4784           description: Unexpected error. Please check the response body for the stack
4785             trace.
4786       security:
4787       - jwt: []
4788       tags:
4789       - MgrModule
4790   /api/monitor:
4791     get:
4792       parameters: []
4793       responses:
4794         '200':
4795           content:
4796             application/vnd.ceph.api.v1.0+json:
4797               schema:
4798                 properties:
4799                   in_quorum:
4800                     description: ''
4801                     items:
4802                       properties:
4803                         addr:
4804                           description: ''
4805                           type: string
4806                         name:
4807                           description: ''
4808                           type: string
4809                         priority:
4810                           description: ''
4811                           type: integer
4812                         public_addr:
4813                           description: ''
4814                           type: string
4815                         public_addrs:
4816                           description: ''
4817                           properties:
4818                             addrvec:
4819                               description: ''
4820                               items:
4821                                 properties:
4822                                   addr:
4823                                     description: ''
4824                                     type: string
4825                                   nonce:
4826                                     description: ''
4827                                     type: integer
4828                                   type:
4829                                     description: ''
4830                                     type: string
4831                                 required:
4832                                 - type
4833                                 - addr
4834                                 - nonce
4835                                 type: object
4836                               type: array
4837                           required:
4838                           - addrvec
4839                           type: object
4840                         rank:
4841                           description: ''
4842                           type: integer
4843                         stats:
4844                           description: ''
4845                           properties:
4846                             num_sessions:
4847                               description: ''
4848                               items:
4849                                 type: integer
4850                               type: array
4851                           required:
4852                           - num_sessions
4853                           type: object
4854                         weight:
4855                           description: ''
4856                           type: integer
4857                       required:
4858                       - rank
4859                       - name
4860                       - public_addrs
4861                       - addr
4862                       - public_addr
4863                       - priority
4864                       - weight
4865                       - stats
4866                       type: object
4867                     type: array
4868                   mon_status:
4869                     description: ''
4870                     properties:
4871                       election_epoch:
4872                         description: ''
4873                         type: integer
4874                       extra_probe_peers:
4875                         description: ''
4876                         items:
4877                           type: string
4878                         type: array
4879                       feature_map:
4880                         description: ''
4881                         properties:
4882                           client:
4883                             description: ''
4884                             items:
4885                               properties:
4886                                 features:
4887                                   description: ''
4888                                   type: string
4889                                 num:
4890                                   description: ''
4891                                   type: integer
4892                                 release:
4893                                   description: ''
4894                                   type: string
4895                               required:
4896                               - features
4897                               - release
4898                               - num
4899                               type: object
4900                             type: array
4901                           mds:
4902                             description: ''
4903                             items:
4904                               properties:
4905                                 features:
4906                                   description: ''
4907                                   type: string
4908                                 num:
4909                                   description: ''
4910                                   type: integer
4911                                 release:
4912                                   description: ''
4913                                   type: string
4914                               required:
4915                               - features
4916                               - release
4917                               - num
4918                               type: object
4919                             type: array
4920                           mgr:
4921                             description: ''
4922                             items:
4923                               properties:
4924                                 features:
4925                                   description: ''
4926                                   type: string
4927                                 num:
4928                                   description: ''
4929                                   type: integer
4930                                 release:
4931                                   description: ''
4932                                   type: string
4933                               required:
4934                               - features
4935                               - release
4936                               - num
4937                               type: object
4938                             type: array
4939                           mon:
4940                             description: ''
4941                             items:
4942                               properties:
4943                                 features:
4944                                   description: ''
4945                                   type: string
4946                                 num:
4947                                   description: ''
4948                                   type: integer
4949                                 release:
4950                                   description: ''
4951                                   type: string
4952                               required:
4953                               - features
4954                               - release
4955                               - num
4956                               type: object
4957                             type: array
4958                         required:
4959                         - mon
4960                         - mds
4961                         - client
4962                         - mgr
4963                         type: object
4964                       features:
4965                         description: ''
4966                         properties:
4967                           quorum_con:
4968                             description: ''
4969                             type: string
4970                           quorum_mon:
4971                             description: ''
4972                             items:
4973                               type: string
4974                             type: array
4975                           required_con:
4976                             description: ''
4977                             type: string
4978                           required_mon:
4979                             description: ''
4980                             items:
4981                               type: integer
4982                             type: array
4983                         required:
4984                         - required_con
4985                         - required_mon
4986                         - quorum_con
4987                         - quorum_mon
4988                         type: object
4989                       monmap:
4990                         description: ''
4991                         properties:
4992                           created:
4993                             description: ''
4994                             type: string
4995                           epoch:
4996                             description: ''
4997                             type: integer
4998                           features:
4999                             description: ''
5000                             properties:
5001                               optional:
5002                                 description: ''
5003                                 items:
5004                                   type: string
5005                                 type: array
5006                               persistent:
5007                                 description: ''
5008                                 items:
5009                                   type: string
5010                                 type: array
5011                             required:
5012                             - persistent
5013                             - optional
5014                             type: object
5015                           fsid:
5016                             description: ''
5017                             type: string
5018                           min_mon_release:
5019                             description: ''
5020                             type: integer
5021                           min_mon_release_name:
5022                             description: ''
5023                             type: string
5024                           modified:
5025                             description: ''
5026                             type: string
5027                           mons:
5028                             description: ''
5029                             items:
5030                               properties:
5031                                 addr:
5032                                   description: ''
5033                                   type: string
5034                                 name:
5035                                   description: ''
5036                                   type: string
5037                                 priority:
5038                                   description: ''
5039                                   type: integer
5040                                 public_addr:
5041                                   description: ''
5042                                   type: string
5043                                 public_addrs:
5044                                   description: ''
5045                                   properties:
5046                                     addrvec:
5047                                       description: ''
5048                                       items:
5049                                         properties:
5050                                           addr:
5051                                             description: ''
5052                                             type: string
5053                                           nonce:
5054                                             description: ''
5055                                             type: integer
5056                                           type:
5057                                             description: ''
5058                                             type: string
5059                                         required:
5060                                         - type
5061                                         - addr
5062                                         - nonce
5063                                         type: object
5064                                       type: array
5065                                   required:
5066                                   - addrvec
5067                                   type: object
5068                                 rank:
5069                                   description: ''
5070                                   type: integer
5071                                 stats:
5072                                   description: ''
5073                                   properties:
5074                                     num_sessions:
5075                                       description: ''
5076                                       items:
5077                                         type: integer
5078                                       type: array
5079                                   required:
5080                                   - num_sessions
5081                                   type: object
5082                                 weight:
5083                                   description: ''
5084                                   type: integer
5085                               required:
5086                               - rank
5087                               - name
5088                               - public_addrs
5089                               - addr
5090                               - public_addr
5091                               - priority
5092                               - weight
5093                               - stats
5094                               type: object
5095                             type: array
5096                         required:
5097                         - epoch
5098                         - fsid
5099                         - modified
5100                         - created
5101                         - min_mon_release
5102                         - min_mon_release_name
5103                         - features
5104                         - mons
5105                         type: object
5106                       name:
5107                         description: ''
5108                         type: string
5109                       outside_quorum:
5110                         description: ''
5111                         items:
5112                           type: string
5113                         type: array
5114                       quorum:
5115                         description: ''
5116                         items:
5117                           type: integer
5118                         type: array
5119                       quorum_age:
5120                         description: ''
5121                         type: integer
5122                       rank:
5123                         description: ''
5124                         type: integer
5125                       state:
5126                         description: ''
5127                         type: string
5128                       sync_provider:
5129                         description: ''
5130                         items:
5131                           type: string
5132                         type: array
5133                     required:
5134                     - name
5135                     - rank
5136                     - state
5137                     - election_epoch
5138                     - quorum
5139                     - quorum_age
5140                     - features
5141                     - outside_quorum
5142                     - extra_probe_peers
5143                     - sync_provider
5144                     - monmap
5145                     - feature_map
5146                     type: object
5147                   out_quorum:
5148                     description: ''
5149                     items:
5150                       type: integer
5151                     type: array
5152                 required:
5153                 - mon_status
5154                 - in_quorum
5155                 - out_quorum
5156                 type: object
5157           description: OK
5158         '400':
5159           description: Operation exception. Please check the response body for details.
5160         '401':
5161           description: Unauthenticated access. Please login first.
5162         '403':
5163           description: Unauthorized access. Please check your permissions.
5164         '500':
5165           description: Unexpected error. Please check the response body for the stack
5166             trace.
5167       security:
5168       - jwt: []
5169       summary: Get Monitor Details
5170       tags:
5171       - Monitor
5172   /api/nfs-ganesha/cluster:
5173     get:
5174       parameters: []
5175       responses:
5176         '200':
5177           content:
5178             application/vnd.ceph.api.v0.1+json:
5179               type: object
5180           description: OK
5181         '400':
5182           description: Operation exception. Please check the response body for details.
5183         '401':
5184           description: Unauthenticated access. Please login first.
5185         '403':
5186           description: Unauthorized access. Please check your permissions.
5187         '500':
5188           description: Unexpected error. Please check the response body for the stack
5189             trace.
5190       security:
5191       - jwt: []
5192       tags:
5193       - NFS-Ganesha
5194   /api/nfs-ganesha/export:
5195     get:
5196       parameters: []
5197       responses:
5198         '200':
5199           content:
5200             application/vnd.ceph.api.v1.0+json:
5201               schema:
5202                 items:
5203                   properties:
5204                     access_type:
5205                       description: Export access type
5206                       type: string
5207                     clients:
5208                       description: List of client configurations
5209                       items:
5210                         properties:
5211                           access_type:
5212                             description: Client access type
5213                             type: string
5214                           addresses:
5215                             description: list of IP addresses
5216                             items:
5217                               type: string
5218                             type: array
5219                           squash:
5220                             description: Client squash policy
5221                             type: string
5222                         required:
5223                         - addresses
5224                         - access_type
5225                         - squash
5226                         type: object
5227                       type: array
5228                     cluster_id:
5229                       description: Cluster identifier
5230                       type: string
5231                     export_id:
5232                       description: Export ID
5233                       type: integer
5234                     fsal:
5235                       description: FSAL configuration
5236                       properties:
5237                         fs_name:
5238                           description: CephFS filesystem name
5239                           type: string
5240                         name:
5241                           description: name of FSAL
5242                           type: string
5243                         sec_label_xattr:
5244                           description: Name of xattr for security label
5245                           type: string
5246                         user_id:
5247                           description: User id
5248                           type: string
5249                       required:
5250                       - name
5251                       type: object
5252                     path:
5253                       description: Export path
5254                       type: string
5255                     protocols:
5256                       description: List of protocol types
5257                       items:
5258                         type: integer
5259                       type: array
5260                     pseudo:
5261                       description: Pseudo FS path
5262                       type: string
5263                     security_label:
5264                       description: Security label
5265                       type: string
5266                     squash:
5267                       description: Export squash policy
5268                       type: string
5269                     transports:
5270                       description: List of transport types
5271                       items:
5272                         type: string
5273                       type: array
5274                   type: object
5275                 required:
5276                 - export_id
5277                 - path
5278                 - cluster_id
5279                 - pseudo
5280                 - access_type
5281                 - squash
5282                 - security_label
5283                 - protocols
5284                 - transports
5285                 - fsal
5286                 - clients
5287                 type: array
5288           description: OK
5289         '400':
5290           description: Operation exception. Please check the response body for details.
5291         '401':
5292           description: Unauthenticated access. Please login first.
5293         '403':
5294           description: Unauthorized access. Please check your permissions.
5295         '500':
5296           description: Unexpected error. Please check the response body for the stack
5297             trace.
5298       security:
5299       - jwt: []
5300       summary: List all NFS-Ganesha exports
5301       tags:
5302       - NFS-Ganesha
5303     post:
5304       parameters: []
5305       requestBody:
5306         content:
5307           application/json:
5308             schema:
5309               properties:
5310                 access_type:
5311                   description: Export access type
5312                   type: string
5313                 clients:
5314                   description: List of client configurations
5315                   items:
5316                     properties:
5317                       access_type:
5318                         description: Client access type
5319                         type: string
5320                       addresses:
5321                         description: list of IP addresses
5322                         items:
5323                           type: string
5324                         type: array
5325                       squash:
5326                         description: Client squash policy
5327                         type: string
5328                     required:
5329                     - addresses
5330                     - access_type
5331                     - squash
5332                     type: object
5333                   type: array
5334                 cluster_id:
5335                   description: Cluster identifier
5336                   type: string
5337                 fsal:
5338                   description: FSAL configuration
5339                   properties:
5340                     fs_name:
5341                       description: CephFS filesystem name
5342                       type: string
5343                     name:
5344                       description: name of FSAL
5345                       type: string
5346                     sec_label_xattr:
5347                       description: Name of xattr for security label
5348                       type: string
5349                   required:
5350                   - name
5351                   type: object
5352                 path:
5353                   description: Export path
5354                   type: string
5355                 protocols:
5356                   description: List of protocol types
5357                   items:
5358                     type: integer
5359                   type: array
5360                 pseudo:
5361                   description: Pseudo FS path
5362                   type: string
5363                 security_label:
5364                   description: Security label
5365                   type: string
5366                 squash:
5367                   description: Export squash policy
5368                   type: string
5369                 transports:
5370                   description: List of transport types
5371                   items:
5372                     type: string
5373                   type: array
5374               required:
5375               - path
5376               - cluster_id
5377               - pseudo
5378               - access_type
5379               - squash
5380               - security_label
5381               - protocols
5382               - transports
5383               - fsal
5384               - clients
5385               type: object
5386       responses:
5387         '201':
5388           content:
5389             application/vnd.ceph.api.v2.0+json:
5390               schema:
5391                 properties:
5392                   access_type:
5393                     description: Export access type
5394                     type: string
5395                   clients:
5396                     description: List of client configurations
5397                     items:
5398                       properties:
5399                         access_type:
5400                           description: Client access type
5401                           type: string
5402                         addresses:
5403                           description: list of IP addresses
5404                           items:
5405                             type: string
5406                           type: array
5407                         squash:
5408                           description: Client squash policy
5409                           type: string
5410                       required:
5411                       - addresses
5412                       - access_type
5413                       - squash
5414                       type: object
5415                     type: array
5416                   cluster_id:
5417                     description: Cluster identifier
5418                     type: string
5419                   export_id:
5420                     description: Export ID
5421                     type: integer
5422                   fsal:
5423                     description: FSAL configuration
5424                     properties:
5425                       fs_name:
5426                         description: CephFS filesystem name
5427                         type: string
5428                       name:
5429                         description: name of FSAL
5430                         type: string
5431                       sec_label_xattr:
5432                         description: Name of xattr for security label
5433                         type: string
5434                       user_id:
5435                         description: User id
5436                         type: string
5437                     required:
5438                     - name
5439                     type: object
5440                   path:
5441                     description: Export path
5442                     type: string
5443                   protocols:
5444                     description: List of protocol types
5445                     items:
5446                       type: integer
5447                     type: array
5448                   pseudo:
5449                     description: Pseudo FS path
5450                     type: string
5451                   security_label:
5452                     description: Security label
5453                     type: string
5454                   squash:
5455                     description: Export squash policy
5456                     type: string
5457                   transports:
5458                     description: List of transport types
5459                     items:
5460                       type: string
5461                     type: array
5462                 required:
5463                 - export_id
5464                 - path
5465                 - cluster_id
5466                 - pseudo
5467                 - access_type
5468                 - squash
5469                 - security_label
5470                 - protocols
5471                 - transports
5472                 - fsal
5473                 - clients
5474                 type: object
5475           description: Resource created.
5476         '202':
5477           content:
5478             application/vnd.ceph.api.v2.0+json:
5479               type: object
5480           description: Operation is still executing. Please check the task queue.
5481         '400':
5482           description: Operation exception. Please check the response body for details.
5483         '401':
5484           description: Unauthenticated access. Please login first.
5485         '403':
5486           description: Unauthorized access. Please check your permissions.
5487         '500':
5488           description: Unexpected error. Please check the response body for the stack
5489             trace.
5490       security:
5491       - jwt: []
5492       summary: Creates a new NFS-Ganesha export
5493       tags:
5494       - NFS-Ganesha
5495   /api/nfs-ganesha/export/{cluster_id}/{export_id}:
5496     delete:
5497       parameters:
5498       - description: Cluster identifier
5499         in: path
5500         name: cluster_id
5501         required: true
5502         schema:
5503           type: string
5504       - description: Export ID
5505         in: path
5506         name: export_id
5507         required: true
5508         schema:
5509           type: integer
5510       responses:
5511         '202':
5512           content:
5513             application/vnd.ceph.api.v2.0+json:
5514               type: object
5515           description: Operation is still executing. Please check the task queue.
5516         '204':
5517           content:
5518             application/vnd.ceph.api.v2.0+json:
5519               type: object
5520           description: Resource deleted.
5521         '400':
5522           description: Operation exception. Please check the response body for details.
5523         '401':
5524           description: Unauthenticated access. Please login first.
5525         '403':
5526           description: Unauthorized access. Please check your permissions.
5527         '500':
5528           description: Unexpected error. Please check the response body for the stack
5529             trace.
5530       security:
5531       - jwt: []
5532       summary: Deletes an NFS-Ganesha export
5533       tags:
5534       - NFS-Ganesha
5535     get:
5536       parameters:
5537       - description: Cluster identifier
5538         in: path
5539         name: cluster_id
5540         required: true
5541         schema:
5542           type: string
5543       - description: Export ID
5544         in: path
5545         name: export_id
5546         required: true
5547         schema:
5548           type: string
5549       responses:
5550         '200':
5551           content:
5552             application/vnd.ceph.api.v1.0+json:
5553               schema:
5554                 properties:
5555                   access_type:
5556                     description: Export access type
5557                     type: string
5558                   clients:
5559                     description: List of client configurations
5560                     items:
5561                       properties:
5562                         access_type:
5563                           description: Client access type
5564                           type: string
5565                         addresses:
5566                           description: list of IP addresses
5567                           items:
5568                             type: string
5569                           type: array
5570                         squash:
5571                           description: Client squash policy
5572                           type: string
5573                       required:
5574                       - addresses
5575                       - access_type
5576                       - squash
5577                       type: object
5578                     type: array
5579                   cluster_id:
5580                     description: Cluster identifier
5581                     type: string
5582                   export_id:
5583                     description: Export ID
5584                     type: integer
5585                   fsal:
5586                     description: FSAL configuration
5587                     properties:
5588                       fs_name:
5589                         description: CephFS filesystem name
5590                         type: string
5591                       name:
5592                         description: name of FSAL
5593                         type: string
5594                       sec_label_xattr:
5595                         description: Name of xattr for security label
5596                         type: string
5597                       user_id:
5598                         description: User id
5599                         type: string
5600                     required:
5601                     - name
5602                     type: object
5603                   path:
5604                     description: Export path
5605                     type: string
5606                   protocols:
5607                     description: List of protocol types
5608                     items:
5609                       type: integer
5610                     type: array
5611                   pseudo:
5612                     description: Pseudo FS path
5613                     type: string
5614                   security_label:
5615                     description: Security label
5616                     type: string
5617                   squash:
5618                     description: Export squash policy
5619                     type: string
5620                   transports:
5621                     description: List of transport types
5622                     items:
5623                       type: string
5624                     type: array
5625                 required:
5626                 - export_id
5627                 - path
5628                 - cluster_id
5629                 - pseudo
5630                 - access_type
5631                 - squash
5632                 - security_label
5633                 - protocols
5634                 - transports
5635                 - fsal
5636                 - clients
5637                 type: object
5638           description: OK
5639         '400':
5640           description: Operation exception. Please check the response body for details.
5641         '401':
5642           description: Unauthenticated access. Please login first.
5643         '403':
5644           description: Unauthorized access. Please check your permissions.
5645         '500':
5646           description: Unexpected error. Please check the response body for the stack
5647             trace.
5648       security:
5649       - jwt: []
5650       summary: Get an NFS-Ganesha export
5651       tags:
5652       - NFS-Ganesha
5653     put:
5654       parameters:
5655       - description: Cluster identifier
5656         in: path
5657         name: cluster_id
5658         required: true
5659         schema:
5660           type: string
5661       - description: Export ID
5662         in: path
5663         name: export_id
5664         required: true
5665         schema:
5666           type: integer
5667       requestBody:
5668         content:
5669           application/json:
5670             schema:
5671               properties:
5672                 access_type:
5673                   description: Export access type
5674                   type: string
5675                 clients:
5676                   description: List of client configurations
5677                   items:
5678                     properties:
5679                       access_type:
5680                         description: Client access type
5681                         type: string
5682                       addresses:
5683                         description: list of IP addresses
5684                         items:
5685                           type: string
5686                         type: array
5687                       squash:
5688                         description: Client squash policy
5689                         type: string
5690                     required:
5691                     - addresses
5692                     - access_type
5693                     - squash
5694                     type: object
5695                   type: array
5696                 fsal:
5697                   description: FSAL configuration
5698                   properties:
5699                     fs_name:
5700                       description: CephFS filesystem name
5701                       type: string
5702                     name:
5703                       description: name of FSAL
5704                       type: string
5705                     sec_label_xattr:
5706                       description: Name of xattr for security label
5707                       type: string
5708                   required:
5709                   - name
5710                   type: object
5711                 path:
5712                   description: Export path
5713                   type: string
5714                 protocols:
5715                   description: List of protocol types
5716                   items:
5717                     type: integer
5718                   type: array
5719                 pseudo:
5720                   description: Pseudo FS path
5721                   type: string
5722                 security_label:
5723                   description: Security label
5724                   type: string
5725                 squash:
5726                   description: Export squash policy
5727                   type: string
5728                 transports:
5729                   description: List of transport types
5730                   items:
5731                     type: string
5732                   type: array
5733               required:
5734               - path
5735               - pseudo
5736               - access_type
5737               - squash
5738               - security_label
5739               - protocols
5740               - transports
5741               - fsal
5742               - clients
5743               type: object
5744       responses:
5745         '200':
5746           content:
5747             application/vnd.ceph.api.v2.0+json:
5748               schema:
5749                 properties:
5750                   access_type:
5751                     description: Export access type
5752                     type: string
5753                   clients:
5754                     description: List of client configurations
5755                     items:
5756                       properties:
5757                         access_type:
5758                           description: Client access type
5759                           type: string
5760                         addresses:
5761                           description: list of IP addresses
5762                           items:
5763                             type: string
5764                           type: array
5765                         squash:
5766                           description: Client squash policy
5767                           type: string
5768                       required:
5769                       - addresses
5770                       - access_type
5771                       - squash
5772                       type: object
5773                     type: array
5774                   cluster_id:
5775                     description: Cluster identifier
5776                     type: string
5777                   export_id:
5778                     description: Export ID
5779                     type: integer
5780                   fsal:
5781                     description: FSAL configuration
5782                     properties:
5783                       fs_name:
5784                         description: CephFS filesystem name
5785                         type: string
5786                       name:
5787                         description: name of FSAL
5788                         type: string
5789                       sec_label_xattr:
5790                         description: Name of xattr for security label
5791                         type: string
5792                       user_id:
5793                         description: User id
5794                         type: string
5795                     required:
5796                     - name
5797                     type: object
5798                   path:
5799                     description: Export path
5800                     type: string
5801                   protocols:
5802                     description: List of protocol types
5803                     items:
5804                       type: integer
5805                     type: array
5806                   pseudo:
5807                     description: Pseudo FS path
5808                     type: string
5809                   security_label:
5810                     description: Security label
5811                     type: string
5812                   squash:
5813                     description: Export squash policy
5814                     type: string
5815                   transports:
5816                     description: List of transport types
5817                     items:
5818                       type: string
5819                     type: array
5820                 required:
5821                 - export_id
5822                 - path
5823                 - cluster_id
5824                 - pseudo
5825                 - access_type
5826                 - squash
5827                 - security_label
5828                 - protocols
5829                 - transports
5830                 - fsal
5831                 - clients
5832                 type: object
5833           description: Resource updated.
5834         '202':
5835           content:
5836             application/vnd.ceph.api.v2.0+json:
5837               type: object
5838           description: Operation is still executing. Please check the task queue.
5839         '400':
5840           description: Operation exception. Please check the response body for details.
5841         '401':
5842           description: Unauthenticated access. Please login first.
5843         '403':
5844           description: Unauthorized access. Please check your permissions.
5845         '500':
5846           description: Unexpected error. Please check the response body for the stack
5847             trace.
5848       security:
5849       - jwt: []
5850       summary: Updates an NFS-Ganesha export
5851       tags:
5852       - NFS-Ganesha
5853   /api/nfs-ganesha/status:
5854     get:
5855       parameters: []
5856       responses:
5857         '200':
5858           content:
5859             application/vnd.ceph.api.v1.0+json:
5860               schema:
5861                 properties:
5862                   available:
5863                     description: Is API available?
5864                     type: boolean
5865                   message:
5866                     description: Error message
5867                     type: string
5868                 required:
5869                 - available
5870                 - message
5871                 type: object
5872           description: OK
5873         '400':
5874           description: Operation exception. Please check the response body for details.
5875         '401':
5876           description: Unauthenticated access. Please login first.
5877         '403':
5878           description: Unauthorized access. Please check your permissions.
5879         '500':
5880           description: Unexpected error. Please check the response body for the stack
5881             trace.
5882       security:
5883       - jwt: []
5884       summary: Status of NFS-Ganesha management feature
5885       tags:
5886       - NFS-Ganesha
5887   /api/orchestrator/status:
5888     get:
5889       parameters: []
5890       responses:
5891         '200':
5892           content:
5893             application/vnd.ceph.api.v1.0+json:
5894               schema:
5895                 properties:
5896                   available:
5897                     description: Orchestrator status
5898                     type: boolean
5899                   message:
5900                     description: Error message
5901                     type: string
5902                 required:
5903                 - available
5904                 - message
5905                 type: object
5906           description: OK
5907         '400':
5908           description: Operation exception. Please check the response body for details.
5909         '401':
5910           description: Unauthenticated access. Please login first.
5911         '403':
5912           description: Unauthorized access. Please check your permissions.
5913         '500':
5914           description: Unexpected error. Please check the response body for the stack
5915             trace.
5916       security:
5917       - jwt: []
5918       summary: Display Orchestrator Status
5919       tags:
5920       - Orchestrator
5921   /api/osd:
5922     get:
5923       parameters: []
5924       responses:
5925         '200':
5926           content:
5927             application/vnd.ceph.api.v1.0+json:
5928               type: object
5929           description: OK
5930         '400':
5931           description: Operation exception. Please check the response body for details.
5932         '401':
5933           description: Unauthenticated access. Please login first.
5934         '403':
5935           description: Unauthorized access. Please check your permissions.
5936         '500':
5937           description: Unexpected error. Please check the response body for the stack
5938             trace.
5939       security:
5940       - jwt: []
5941       tags:
5942       - OSD
5943     post:
5944       parameters: []
5945       requestBody:
5946         content:
5947           application/json:
5948             schema:
5949               properties:
5950                 data:
5951                   type: string
5952                 method:
5953                   type: string
5954                 tracking_id:
5955                   type: string
5956               required:
5957               - method
5958               - data
5959               - tracking_id
5960               type: object
5961       responses:
5962         '201':
5963           content:
5964             application/vnd.ceph.api.v1.0+json:
5965               type: object
5966           description: Resource created.
5967         '202':
5968           content:
5969             application/vnd.ceph.api.v1.0+json:
5970               type: object
5971           description: Operation is still executing. Please check the task queue.
5972         '400':
5973           description: Operation exception. Please check the response body for details.
5974         '401':
5975           description: Unauthenticated access. Please login first.
5976         '403':
5977           description: Unauthorized access. Please check your permissions.
5978         '500':
5979           description: Unexpected error. Please check the response body for the stack
5980             trace.
5981       security:
5982       - jwt: []
5983       tags:
5984       - OSD
5985   /api/osd/flags:
5986     get:
5987       parameters: []
5988       responses:
5989         '200':
5990           content:
5991             application/vnd.ceph.api.v1.0+json:
5992               schema:
5993                 properties:
5994                   list_of_flags:
5995                     description: ''
5996                     items:
5997                       type: string
5998                     type: array
5999                 required:
6000                 - list_of_flags
6001                 type: object
6002           description: OK
6003         '400':
6004           description: Operation exception. Please check the response body for details.
6005         '401':
6006           description: Unauthenticated access. Please login first.
6007         '403':
6008           description: Unauthorized access. Please check your permissions.
6009         '500':
6010           description: Unexpected error. Please check the response body for the stack
6011             trace.
6012       security:
6013       - jwt: []
6014       summary: Display OSD Flags
6015       tags:
6016       - OSD
6017     put:
6018       description: "\n        The `recovery_deletes`, `sortbitwise` and `pglog_hardlimit`\
6019         \ flags cannot be unset.\n        `purged_snapshots` cannot even be set. It\
6020         \ is therefore required to at\n        least include those four flags for\
6021         \ a successful operation.\n        "
6022       parameters: []
6023       requestBody:
6024         content:
6025           application/json:
6026             schema:
6027               properties:
6028                 flags:
6029                   description: List of flags to set. The flags `recovery_deletes`,
6030                     `sortbitwise` and `pglog_hardlimit` cannot be unset. Additionally
6031                     `purged_snapshots` cannot even be set.
6032                   items:
6033                     type: string
6034                   type: array
6035               required:
6036               - flags
6037               type: object
6038       responses:
6039         '200':
6040           content:
6041             application/vnd.ceph.api.v1.0+json:
6042               schema:
6043                 properties:
6044                   list_of_flags:
6045                     description: ''
6046                     items:
6047                       type: string
6048                     type: array
6049                 required:
6050                 - list_of_flags
6051                 type: object
6052           description: Resource updated.
6053         '202':
6054           content:
6055             application/vnd.ceph.api.v1.0+json:
6056               type: object
6057           description: Operation is still executing. Please check the task queue.
6058         '400':
6059           description: Operation exception. Please check the response body for details.
6060         '401':
6061           description: Unauthenticated access. Please login first.
6062         '403':
6063           description: Unauthorized access. Please check your permissions.
6064         '500':
6065           description: Unexpected error. Please check the response body for the stack
6066             trace.
6067       security:
6068       - jwt: []
6069       summary: Sets OSD flags for the entire cluster.
6070       tags:
6071       - OSD
6072   /api/osd/flags/individual:
6073     get:
6074       parameters: []
6075       responses:
6076         '200':
6077           content:
6078             application/vnd.ceph.api.v1.0+json:
6079               schema:
6080                 properties:
6081                   flags:
6082                     description: List of active flags
6083                     items:
6084                       type: string
6085                     type: array
6086                   osd:
6087                     description: OSD ID
6088                     type: integer
6089                 required:
6090                 - osd
6091                 - flags
6092                 type: object
6093           description: OK
6094         '400':
6095           description: Operation exception. Please check the response body for details.
6096         '401':
6097           description: Unauthenticated access. Please login first.
6098         '403':
6099           description: Unauthorized access. Please check your permissions.
6100         '500':
6101           description: Unexpected error. Please check the response body for the stack
6102             trace.
6103       security:
6104       - jwt: []
6105       summary: Displays individual OSD flags
6106       tags:
6107       - OSD
6108     put:
6109       description: "\n        Updates flags (`noout`, `noin`, `nodown`, `noup`) for\
6110         \ an individual\n        subset of OSDs.\n        "
6111       parameters: []
6112       requestBody:
6113         content:
6114           application/json:
6115             schema:
6116               properties:
6117                 flags:
6118                   description: Directory of flags to set or unset. The flags `noin`,
6119                     `noout`, `noup` and `nodown` are going to be considered only.
6120                   properties:
6121                     nodown:
6122                       description: Sets/unsets `nodown`
6123                       type: boolean
6124                     noin:
6125                       description: Sets/unsets `noin`
6126                       type: boolean
6127                     noout:
6128                       description: Sets/unsets `noout`
6129                       type: boolean
6130                     noup:
6131                       description: Sets/unsets `noup`
6132                       type: boolean
6133                   type: object
6134                 ids:
6135                   description: List of OSD ids the flags should be applied to.
6136                   items:
6137                     type: integer
6138                   type: array
6139               required:
6140               - flags
6141               - ids
6142               type: object
6143       responses:
6144         '200':
6145           content:
6146             application/vnd.ceph.api.v1.0+json:
6147               schema:
6148                 properties:
6149                   added:
6150                     description: List of added flags
6151                     items:
6152                       type: string
6153                     type: array
6154                   ids:
6155                     description: List of updated OSDs
6156                     items:
6157                       type: integer
6158                     type: array
6159                   removed:
6160                     description: List of removed flags
6161                     items:
6162                       type: string
6163                     type: array
6164                 required:
6165                 - added
6166                 - removed
6167                 - ids
6168                 type: object
6169           description: Resource updated.
6170         '202':
6171           content:
6172             application/vnd.ceph.api.v1.0+json:
6173               type: object
6174           description: Operation is still executing. Please check the task queue.
6175         '400':
6176           description: Operation exception. Please check the response body for details.
6177         '401':
6178           description: Unauthenticated access. Please login first.
6179         '403':
6180           description: Unauthorized access. Please check your permissions.
6181         '500':
6182           description: Unexpected error. Please check the response body for the stack
6183             trace.
6184       security:
6185       - jwt: []
6186       summary: Sets OSD flags for a subset of individual OSDs.
6187       tags:
6188       - OSD
6189   /api/osd/safe_to_delete:
6190     get:
6191       description: "\n        :type ids: int|[int]\n        "
6192       parameters:
6193       - in: query
6194         name: svc_ids
6195         required: true
6196         schema:
6197           type: string
6198       responses:
6199         '200':
6200           content:
6201             application/vnd.ceph.api.v1.0+json:
6202               type: object
6203           description: OK
6204         '400':
6205           description: Operation exception. Please check the response body for details.
6206         '401':
6207           description: Unauthenticated access. Please login first.
6208         '403':
6209           description: Unauthorized access. Please check your permissions.
6210         '500':
6211           description: Unexpected error. Please check the response body for the stack
6212             trace.
6213       security:
6214       - jwt: []
6215       tags:
6216       - OSD
6217   /api/osd/safe_to_destroy:
6218     get:
6219       description: "\n        :type ids: int|[int]\n        "
6220       parameters:
6221       - description: OSD Service Identifier
6222         in: query
6223         name: ids
6224         required: true
6225         schema:
6226           type: string
6227       responses:
6228         '200':
6229           content:
6230             application/vnd.ceph.api.v1.0+json:
6231               schema:
6232                 properties:
6233                   active:
6234                     description: ''
6235                     items:
6236                       type: integer
6237                     type: array
6238                   is_safe_to_destroy:
6239                     description: Is OSD safe to destroy?
6240                     type: boolean
6241                   missing_stats:
6242                     description: ''
6243                     items:
6244                       type: string
6245                     type: array
6246                   safe_to_destroy:
6247                     description: Is OSD safe to destroy?
6248                     items:
6249                       type: string
6250                     type: array
6251                   stored_pgs:
6252                     description: Stored Pool groups in Osd
6253                     items:
6254                       type: string
6255                     type: array
6256                 required:
6257                 - safe_to_destroy
6258                 - active
6259                 - missing_stats
6260                 - stored_pgs
6261                 - is_safe_to_destroy
6262                 type: object
6263           description: OK
6264         '400':
6265           description: Operation exception. Please check the response body for details.
6266         '401':
6267           description: Unauthenticated access. Please login first.
6268         '403':
6269           description: Unauthorized access. Please check your permissions.
6270         '500':
6271           description: Unexpected error. Please check the response body for the stack
6272             trace.
6273       security:
6274       - jwt: []
6275       summary: Check If OSD is Safe to Destroy
6276       tags:
6277       - OSD
6278   /api/osd/settings:
6279     get:
6280       parameters: []
6281       responses:
6282         '200':
6283           content:
6284             application/vnd.ceph.api.v0.1+json:
6285               type: object
6286           description: OK
6287         '400':
6288           description: Operation exception. Please check the response body for details.
6289         '401':
6290           description: Unauthenticated access. Please login first.
6291         '403':
6292           description: Unauthorized access. Please check your permissions.
6293         '500':
6294           description: Unexpected error. Please check the response body for the stack
6295             trace.
6296       security:
6297       - jwt: []
6298       tags:
6299       - OSD
6300   /api/osd/{svc_id}:
6301     delete:
6302       parameters:
6303       - in: path
6304         name: svc_id
6305         required: true
6306         schema:
6307           type: string
6308       - allowEmptyValue: true
6309         in: query
6310         name: preserve_id
6311         schema:
6312           type: string
6313       - allowEmptyValue: true
6314         in: query
6315         name: force
6316         schema:
6317           type: string
6318       responses:
6319         '202':
6320           content:
6321             application/vnd.ceph.api.v1.0+json:
6322               type: object
6323           description: Operation is still executing. Please check the task queue.
6324         '204':
6325           content:
6326             application/vnd.ceph.api.v1.0+json:
6327               type: object
6328           description: Resource deleted.
6329         '400':
6330           description: Operation exception. Please check the response body for details.
6331         '401':
6332           description: Unauthenticated access. Please login first.
6333         '403':
6334           description: Unauthorized access. Please check your permissions.
6335         '500':
6336           description: Unexpected error. Please check the response body for the stack
6337             trace.
6338       security:
6339       - jwt: []
6340       tags:
6341       - OSD
6342     get:
6343       description: "\n        Returns collected data about an OSD.\n\n        :return:\
6344         \ Returns the requested data.\n        "
6345       parameters:
6346       - in: path
6347         name: svc_id
6348         required: true
6349         schema:
6350           type: string
6351       responses:
6352         '200':
6353           content:
6354             application/vnd.ceph.api.v1.0+json:
6355               type: object
6356           description: OK
6357         '400':
6358           description: Operation exception. Please check the response body for details.
6359         '401':
6360           description: Unauthenticated access. Please login first.
6361         '403':
6362           description: Unauthorized access. Please check your permissions.
6363         '500':
6364           description: Unexpected error. Please check the response body for the stack
6365             trace.
6366       security:
6367       - jwt: []
6368       tags:
6369       - OSD
6370     put:
6371       parameters:
6372       - in: path
6373         name: svc_id
6374         required: true
6375         schema:
6376           type: string
6377       requestBody:
6378         content:
6379           application/json:
6380             schema:
6381               properties:
6382                 device_class:
6383                   type: string
6384               required:
6385               - device_class
6386               type: object
6387       responses:
6388         '200':
6389           content:
6390             application/vnd.ceph.api.v1.0+json:
6391               type: object
6392           description: Resource updated.
6393         '202':
6394           content:
6395             application/vnd.ceph.api.v1.0+json:
6396               type: object
6397           description: Operation is still executing. Please check the task queue.
6398         '400':
6399           description: Operation exception. Please check the response body for details.
6400         '401':
6401           description: Unauthenticated access. Please login first.
6402         '403':
6403           description: Unauthorized access. Please check your permissions.
6404         '500':
6405           description: Unexpected error. Please check the response body for the stack
6406             trace.
6407       security:
6408       - jwt: []
6409       tags:
6410       - OSD
6411   /api/osd/{svc_id}/destroy:
6412     post:
6413       description: "\n        Mark osd as being destroyed. Keeps the ID intact (allowing\
6414         \ reuse), but\n        removes cephx keys, config-key data and lockbox keys,\
6415         \ rendering data\n        permanently unreadable.\n\n        The osd must\
6416         \ be marked down before being destroyed.\n        "
6417       parameters:
6418       - in: path
6419         name: svc_id
6420         required: true
6421         schema:
6422           type: string
6423       responses:
6424         '201':
6425           content:
6426             application/vnd.ceph.api.v1.0+json:
6427               type: object
6428           description: Resource created.
6429         '202':
6430           content:
6431             application/vnd.ceph.api.v1.0+json:
6432               type: object
6433           description: Operation is still executing. Please check the task queue.
6434         '400':
6435           description: Operation exception. Please check the response body for details.
6436         '401':
6437           description: Unauthenticated access. Please login first.
6438         '403':
6439           description: Unauthorized access. Please check your permissions.
6440         '500':
6441           description: Unexpected error. Please check the response body for the stack
6442             trace.
6443       security:
6444       - jwt: []
6445       tags:
6446       - OSD
6447   /api/osd/{svc_id}/devices:
6448     get:
6449       parameters:
6450       - in: path
6451         name: svc_id
6452         required: true
6453         schema:
6454           type: string
6455       responses:
6456         '200':
6457           content:
6458             application/vnd.ceph.api.v1.0+json:
6459               type: object
6460           description: OK
6461         '400':
6462           description: Operation exception. Please check the response body for details.
6463         '401':
6464           description: Unauthenticated access. Please login first.
6465         '403':
6466           description: Unauthorized access. Please check your permissions.
6467         '500':
6468           description: Unexpected error. Please check the response body for the stack
6469             trace.
6470       security:
6471       - jwt: []
6472       tags:
6473       - OSD
6474   /api/osd/{svc_id}/histogram:
6475     get:
6476       description: "\n        :return: Returns the histogram data.\n        "
6477       parameters:
6478       - in: path
6479         name: svc_id
6480         required: true
6481         schema:
6482           type: string
6483       responses:
6484         '200':
6485           content:
6486             application/vnd.ceph.api.v1.0+json:
6487               type: object
6488           description: OK
6489         '400':
6490           description: Operation exception. Please check the response body for details.
6491         '401':
6492           description: Unauthenticated access. Please login first.
6493         '403':
6494           description: Unauthorized access. Please check your permissions.
6495         '500':
6496           description: Unexpected error. Please check the response body for the stack
6497             trace.
6498       security:
6499       - jwt: []
6500       tags:
6501       - OSD
6502   /api/osd/{svc_id}/mark:
6503     put:
6504       description: "\n        Note: osd must be marked `down` before marking lost.\n\
6505         \        "
6506       parameters:
6507       - description: SVC ID
6508         in: path
6509         name: svc_id
6510         required: true
6511         schema:
6512           type: string
6513       requestBody:
6514         content:
6515           application/json:
6516             schema:
6517               properties:
6518                 action:
6519                   type: string
6520               required:
6521               - action
6522               type: object
6523       responses:
6524         '200':
6525           content:
6526             application/vnd.ceph.api.v1.0+json:
6527               type: object
6528           description: Resource updated.
6529         '202':
6530           content:
6531             application/vnd.ceph.api.v1.0+json:
6532               type: object
6533           description: Operation is still executing. Please check the task queue.
6534         '400':
6535           description: Operation exception. Please check the response body for details.
6536         '401':
6537           description: Unauthenticated access. Please login first.
6538         '403':
6539           description: Unauthorized access. Please check your permissions.
6540         '500':
6541           description: Unexpected error. Please check the response body for the stack
6542             trace.
6543       security:
6544       - jwt: []
6545       summary: Mark OSD flags (out, in, down, lost, ...)
6546       tags:
6547       - OSD
6548   /api/osd/{svc_id}/purge:
6549     post:
6550       description: "\n        Note: osd must be marked `down` before removal.\n  \
6551         \      "
6552       parameters:
6553       - in: path
6554         name: svc_id
6555         required: true
6556         schema:
6557           type: string
6558       responses:
6559         '201':
6560           content:
6561             application/vnd.ceph.api.v1.0+json:
6562               type: object
6563           description: Resource created.
6564         '202':
6565           content:
6566             application/vnd.ceph.api.v1.0+json:
6567               type: object
6568           description: Operation is still executing. Please check the task queue.
6569         '400':
6570           description: Operation exception. Please check the response body for details.
6571         '401':
6572           description: Unauthenticated access. Please login first.
6573         '403':
6574           description: Unauthorized access. Please check your permissions.
6575         '500':
6576           description: Unexpected error. Please check the response body for the stack
6577             trace.
6578       security:
6579       - jwt: []
6580       tags:
6581       - OSD
6582   /api/osd/{svc_id}/reweight:
6583     post:
6584       description: "\n        Reweights the OSD temporarily.\n\n        Note that\
6585         \ \u2018ceph osd reweight\u2019 is not a persistent setting. When an OSD\n\
6586         \        gets marked out, the osd weight will be set to 0. When it gets marked\n\
6587         \        in again, the weight will be changed to 1.\n\n        Because of\
6588         \ this \u2018ceph osd reweight\u2019 is a temporary solution. You should\n\
6589         \        only use it to keep your cluster running while you\u2019re ordering\
6590         \ more\n        hardware.\n\n        - Craig Lewis (http://lists.ceph.com/pipermail/ceph-users-ceph.com/2014-June/040967.html)\n\
6591         \        "
6592       parameters:
6593       - in: path
6594         name: svc_id
6595         required: true
6596         schema:
6597           type: string
6598       requestBody:
6599         content:
6600           application/json:
6601             schema:
6602               properties:
6603                 weight:
6604                   type: string
6605               required:
6606               - weight
6607               type: object
6608       responses:
6609         '201':
6610           content:
6611             application/vnd.ceph.api.v1.0+json:
6612               type: object
6613           description: Resource created.
6614         '202':
6615           content:
6616             application/vnd.ceph.api.v1.0+json:
6617               type: object
6618           description: Operation is still executing. Please check the task queue.
6619         '400':
6620           description: Operation exception. Please check the response body for details.
6621         '401':
6622           description: Unauthenticated access. Please login first.
6623         '403':
6624           description: Unauthorized access. Please check your permissions.
6625         '500':
6626           description: Unexpected error. Please check the response body for the stack
6627             trace.
6628       security:
6629       - jwt: []
6630       tags:
6631       - OSD
6632   /api/osd/{svc_id}/scrub:
6633     post:
6634       parameters:
6635       - in: path
6636         name: svc_id
6637         required: true
6638         schema:
6639           type: string
6640       - default: false
6641         in: query
6642         name: deep
6643         schema:
6644           type: boolean
6645       requestBody:
6646         content:
6647           application/json:
6648             schema:
6649               properties:
6650                 deep:
6651                   default: false
6652                   type: boolean
6653               type: object
6654       responses:
6655         '201':
6656           content:
6657             application/vnd.ceph.api.v1.0+json:
6658               type: object
6659           description: Resource created.
6660         '202':
6661           content:
6662             application/vnd.ceph.api.v1.0+json:
6663               type: object
6664           description: Operation is still executing. Please check the task queue.
6665         '400':
6666           description: Operation exception. Please check the response body for details.
6667         '401':
6668           description: Unauthenticated access. Please login first.
6669         '403':
6670           description: Unauthorized access. Please check your permissions.
6671         '500':
6672           description: Unexpected error. Please check the response body for the stack
6673             trace.
6674       security:
6675       - jwt: []
6676       tags:
6677       - OSD
6678   /api/osd/{svc_id}/smart:
6679     get:
6680       parameters:
6681       - in: path
6682         name: svc_id
6683         required: true
6684         schema:
6685           type: string
6686       responses:
6687         '200':
6688           content:
6689             application/vnd.ceph.api.v1.0+json:
6690               type: object
6691           description: OK
6692         '400':
6693           description: Operation exception. Please check the response body for details.
6694         '401':
6695           description: Unauthenticated access. Please login first.
6696         '403':
6697           description: Unauthorized access. Please check your permissions.
6698         '500':
6699           description: Unexpected error. Please check the response body for the stack
6700             trace.
6701       security:
6702       - jwt: []
6703       tags:
6704       - OSD
6705   /api/perf_counters:
6706     get:
6707       parameters: []
6708       responses:
6709         '200':
6710           content:
6711             application/vnd.ceph.api.v1.0+json:
6712               schema:
6713                 properties:
6714                   mon.a:
6715                     description: Service ID
6716                     properties:
6717                       .cache_bytes:
6718                         description: ''
6719                         properties:
6720                           description:
6721                             description: ''
6722                             type: string
6723                           nick:
6724                             description: ''
6725                             type: string
6726                           priority:
6727                             description: ''
6728                             type: integer
6729                           type:
6730                             description: ''
6731                             type: integer
6732                           units:
6733                             description: ''
6734                             type: integer
6735                           value:
6736                             description: ''
6737                             type: integer
6738                         required:
6739                         - description
6740                         - nick
6741                         - type
6742                         - priority
6743                         - units
6744                         - value
6745                         type: object
6746                     required:
6747                     - .cache_bytes
6748                     type: object
6749                 required:
6750                 - mon.a
6751                 type: object
6752           description: OK
6753         '400':
6754           description: Operation exception. Please check the response body for details.
6755         '401':
6756           description: Unauthenticated access. Please login first.
6757         '403':
6758           description: Unauthorized access. Please check your permissions.
6759         '500':
6760           description: Unexpected error. Please check the response body for the stack
6761             trace.
6762       security:
6763       - jwt: []
6764       summary: Display Perf Counters
6765       tags:
6766       - PerfCounters
6767   /api/perf_counters/mds/{service_id}:
6768     get:
6769       parameters:
6770       - in: path
6771         name: service_id
6772         required: true
6773         schema:
6774           type: string
6775       responses:
6776         '200':
6777           content:
6778             application/vnd.ceph.api.v1.0+json:
6779               type: object
6780           description: OK
6781         '400':
6782           description: Operation exception. Please check the response body for details.
6783         '401':
6784           description: Unauthenticated access. Please login first.
6785         '403':
6786           description: Unauthorized access. Please check your permissions.
6787         '500':
6788           description: Unexpected error. Please check the response body for the stack
6789             trace.
6790       security:
6791       - jwt: []
6792       tags:
6793       - MdsPerfCounter
6794   /api/perf_counters/mgr/{service_id}:
6795     get:
6796       parameters:
6797       - in: path
6798         name: service_id
6799         required: true
6800         schema:
6801           type: string
6802       responses:
6803         '200':
6804           content:
6805             application/vnd.ceph.api.v1.0+json:
6806               type: object
6807           description: OK
6808         '400':
6809           description: Operation exception. Please check the response body for details.
6810         '401':
6811           description: Unauthenticated access. Please login first.
6812         '403':
6813           description: Unauthorized access. Please check your permissions.
6814         '500':
6815           description: Unexpected error. Please check the response body for the stack
6816             trace.
6817       security:
6818       - jwt: []
6819       tags:
6820       - MgrPerfCounter
6821   /api/perf_counters/mon/{service_id}:
6822     get:
6823       parameters:
6824       - in: path
6825         name: service_id
6826         required: true
6827         schema:
6828           type: string
6829       responses:
6830         '200':
6831           content:
6832             application/vnd.ceph.api.v1.0+json:
6833               type: object
6834           description: OK
6835         '400':
6836           description: Operation exception. Please check the response body for details.
6837         '401':
6838           description: Unauthenticated access. Please login first.
6839         '403':
6840           description: Unauthorized access. Please check your permissions.
6841         '500':
6842           description: Unexpected error. Please check the response body for the stack
6843             trace.
6844       security:
6845       - jwt: []
6846       tags:
6847       - MonPerfCounter
6848   /api/perf_counters/osd/{service_id}:
6849     get:
6850       parameters:
6851       - in: path
6852         name: service_id
6853         required: true
6854         schema:
6855           type: string
6856       responses:
6857         '200':
6858           content:
6859             application/vnd.ceph.api.v1.0+json:
6860               type: object
6861           description: OK
6862         '400':
6863           description: Operation exception. Please check the response body for details.
6864         '401':
6865           description: Unauthenticated access. Please login first.
6866         '403':
6867           description: Unauthorized access. Please check your permissions.
6868         '500':
6869           description: Unexpected error. Please check the response body for the stack
6870             trace.
6871       security:
6872       - jwt: []
6873       tags:
6874       - OsdPerfCounter
6875   /api/perf_counters/rbd-mirror/{service_id}:
6876     get:
6877       parameters:
6878       - in: path
6879         name: service_id
6880         required: true
6881         schema:
6882           type: string
6883       responses:
6884         '200':
6885           content:
6886             application/vnd.ceph.api.v1.0+json:
6887               type: object
6888           description: OK
6889         '400':
6890           description: Operation exception. Please check the response body for details.
6891         '401':
6892           description: Unauthenticated access. Please login first.
6893         '403':
6894           description: Unauthorized access. Please check your permissions.
6895         '500':
6896           description: Unexpected error. Please check the response body for the stack
6897             trace.
6898       security:
6899       - jwt: []
6900       tags:
6901       - RgwMirrorPerfCounter
6902   /api/perf_counters/rgw/{service_id}:
6903     get:
6904       parameters:
6905       - in: path
6906         name: service_id
6907         required: true
6908         schema:
6909           type: string
6910       responses:
6911         '200':
6912           content:
6913             application/vnd.ceph.api.v1.0+json:
6914               type: object
6915           description: OK
6916         '400':
6917           description: Operation exception. Please check the response body for details.
6918         '401':
6919           description: Unauthenticated access. Please login first.
6920         '403':
6921           description: Unauthorized access. Please check your permissions.
6922         '500':
6923           description: Unexpected error. Please check the response body for the stack
6924             trace.
6925       security:
6926       - jwt: []
6927       tags:
6928       - RgwPerfCounter
6929   /api/perf_counters/tcmu-runner/{service_id}:
6930     get:
6931       parameters:
6932       - in: path
6933         name: service_id
6934         required: true
6935         schema:
6936           type: string
6937       responses:
6938         '200':
6939           content:
6940             application/vnd.ceph.api.v1.0+json:
6941               type: object
6942           description: OK
6943         '400':
6944           description: Operation exception. Please check the response body for details.
6945         '401':
6946           description: Unauthenticated access. Please login first.
6947         '403':
6948           description: Unauthorized access. Please check your permissions.
6949         '500':
6950           description: Unexpected error. Please check the response body for the stack
6951             trace.
6952       security:
6953       - jwt: []
6954       tags:
6955       - TcmuRunnerPerfCounter
6956   /api/pool:
6957     get:
6958       parameters:
6959       - allowEmptyValue: true
6960         description: Pool Attributes
6961         in: query
6962         name: attrs
6963         schema:
6964           type: string
6965       - default: false
6966         description: Pool Stats
6967         in: query
6968         name: stats
6969         schema:
6970           type: boolean
6971       responses:
6972         '200':
6973           content:
6974             application/vnd.ceph.api.v1.0+json:
6975               schema:
6976                 items:
6977                   properties:
6978                     application_metadata:
6979                       description: ''
6980                       items:
6981                         type: string
6982                       type: array
6983                     auid:
6984                       description: ''
6985                       type: integer
6986                     cache_min_evict_age:
6987                       description: ''
6988                       type: integer
6989                     cache_min_flush_age:
6990                       description: ''
6991                       type: integer
6992                     cache_mode:
6993                       description: ''
6994                       type: string
6995                     cache_target_dirty_high_ratio_micro:
6996                       description: ''
6997                       type: integer
6998                     cache_target_dirty_ratio_micro:
6999                       description: ''
7000                       type: integer
7001                     cache_target_full_ratio_micro:
7002                       description: ''
7003                       type: integer
7004                     create_time:
7005                       description: ''
7006                       type: string
7007                     crush_rule:
7008                       description: ''
7009                       type: string
7010                     erasure_code_profile:
7011                       description: ''
7012                       type: string
7013                     expected_num_objects:
7014                       description: ''
7015                       type: integer
7016                     fast_read:
7017                       description: ''
7018                       type: boolean
7019                     flags:
7020                       description: ''
7021                       type: integer
7022                     flags_names:
7023                       description: flags name
7024                       type: string
7025                     grade_table:
7026                       description: ''
7027                       items:
7028                         type: string
7029                       type: array
7030                     hit_set_count:
7031                       description: ''
7032                       type: integer
7033                     hit_set_grade_decay_rate:
7034                       description: ''
7035                       type: integer
7036                     hit_set_params:
7037                       description: ''
7038                       properties:
7039                         type:
7040                           description: ''
7041                           type: string
7042                       required:
7043                       - type
7044                       type: object
7045                     hit_set_period:
7046                       description: ''
7047                       type: integer
7048                     hit_set_search_last_n:
7049                       description: ''
7050                       type: integer
7051                     last_change:
7052                       description: ''
7053                       type: string
7054                     last_force_op_resend:
7055                       description: ''
7056                       type: string
7057                     last_force_op_resend_preluminous:
7058                       description: ''
7059                       type: string
7060                     last_force_op_resend_prenautilus:
7061                       description: ''
7062                       type: string
7063                     last_pg_merge_meta:
7064                       description: ''
7065                       properties:
7066                         last_epoch_clean:
7067                           description: ''
7068                           type: integer
7069                         last_epoch_started:
7070                           description: ''
7071                           type: integer
7072                         ready_epoch:
7073                           description: ''
7074                           type: integer
7075                         source_pgid:
7076                           description: ''
7077                           type: string
7078                         source_version:
7079                           description: ''
7080                           type: string
7081                         target_version:
7082                           description: ''
7083                           type: string
7084                       required:
7085                       - ready_epoch
7086                       - last_epoch_started
7087                       - last_epoch_clean
7088                       - source_pgid
7089                       - source_version
7090                       - target_version
7091                       type: object
7092                     min_read_recency_for_promote:
7093                       description: ''
7094                       type: integer
7095                     min_size:
7096                       description: ''
7097                       type: integer
7098                     min_write_recency_for_promote:
7099                       description: ''
7100                       type: integer
7101                     object_hash:
7102                       description: ''
7103                       type: integer
7104                     options:
7105                       description: ''
7106                       properties:
7107                         pg_num_max:
7108                           description: ''
7109                           type: integer
7110                         pg_num_min:
7111                           description: ''
7112                           type: integer
7113                       required:
7114                       - pg_num_min
7115                       - pg_num_max
7116                       type: object
7117                     pg_autoscale_mode:
7118                       description: ''
7119                       type: string
7120                     pg_num:
7121                       description: ''
7122                       type: integer
7123                     pg_num_pending:
7124                       description: ''
7125                       type: integer
7126                     pg_num_target:
7127                       description: ''
7128                       type: integer
7129                     pg_placement_num:
7130                       description: ''
7131                       type: integer
7132                     pg_placement_num_target:
7133                       description: ''
7134                       type: integer
7135                     pool:
7136                       description: pool id
7137                       type: integer
7138                     pool_name:
7139                       description: pool name
7140                       type: string
7141                     pool_snaps:
7142                       description: ''
7143                       items:
7144                         type: string
7145                       type: array
7146                     quota_max_bytes:
7147                       description: ''
7148                       type: integer
7149                     quota_max_objects:
7150                       description: ''
7151                       type: integer
7152                     read_tier:
7153                       description: ''
7154                       type: integer
7155                     removed_snaps:
7156                       description: ''
7157                       items:
7158                         type: string
7159                       type: array
7160                     size:
7161                       description: pool size
7162                       type: integer
7163                     snap_epoch:
7164                       description: ''
7165                       type: integer
7166                     snap_mode:
7167                       description: ''
7168                       type: string
7169                     snap_seq:
7170                       description: ''
7171                       type: integer
7172                     stripe_width:
7173                       description: ''
7174                       type: integer
7175                     target_max_bytes:
7176                       description: ''
7177                       type: integer
7178                     target_max_objects:
7179                       description: ''
7180                       type: integer
7181                     tier_of:
7182                       description: ''
7183                       type: integer
7184                     tiers:
7185                       description: ''
7186                       items:
7187                         type: string
7188                       type: array
7189                     type:
7190                       description: type of pool
7191                       type: string
7192                     use_gmt_hitset:
7193                       description: ''
7194                       type: boolean
7195                     write_tier:
7196                       description: ''
7197                       type: integer
7198                   type: object
7199                 required:
7200                 - pool
7201                 - pool_name
7202                 - flags
7203                 - flags_names
7204                 - type
7205                 - size
7206                 - min_size
7207                 - crush_rule
7208                 - object_hash
7209                 - pg_autoscale_mode
7210                 - pg_num
7211                 - pg_placement_num
7212                 - pg_placement_num_target
7213                 - pg_num_target
7214                 - pg_num_pending
7215                 - last_pg_merge_meta
7216                 - auid
7217                 - snap_mode
7218                 - snap_seq
7219                 - snap_epoch
7220                 - pool_snaps
7221                 - quota_max_bytes
7222                 - quota_max_objects
7223                 - tiers
7224                 - tier_of
7225                 - read_tier
7226                 - write_tier
7227                 - cache_mode
7228                 - target_max_bytes
7229                 - target_max_objects
7230                 - cache_target_dirty_ratio_micro
7231                 - cache_target_dirty_high_ratio_micro
7232                 - cache_target_full_ratio_micro
7233                 - cache_min_flush_age
7234                 - cache_min_evict_age
7235                 - erasure_code_profile
7236                 - hit_set_params
7237                 - hit_set_period
7238                 - hit_set_count
7239                 - use_gmt_hitset
7240                 - min_read_recency_for_promote
7241                 - min_write_recency_for_promote
7242                 - hit_set_grade_decay_rate
7243                 - hit_set_search_last_n
7244                 - grade_table
7245                 - stripe_width
7246                 - expected_num_objects
7247                 - fast_read
7248                 - options
7249                 - application_metadata
7250                 - create_time
7251                 - last_change
7252                 - last_force_op_resend
7253                 - last_force_op_resend_prenautilus
7254                 - last_force_op_resend_preluminous
7255                 - removed_snaps
7256                 type: array
7257           description: OK
7258         '400':
7259           description: Operation exception. Please check the response body for details.
7260         '401':
7261           description: Unauthenticated access. Please login first.
7262         '403':
7263           description: Unauthorized access. Please check your permissions.
7264         '500':
7265           description: Unexpected error. Please check the response body for the stack
7266             trace.
7267       security:
7268       - jwt: []
7269       summary: Display Pool List
7270       tags:
7271       - Pool
7272     post:
7273       parameters: []
7274       requestBody:
7275         content:
7276           application/json:
7277             schema:
7278               properties:
7279                 application_metadata:
7280                   type: string
7281                 configuration:
7282                   type: string
7283                 erasure_code_profile:
7284                   type: string
7285                 flags:
7286                   type: string
7287                 pg_num:
7288                   type: integer
7289                 pool:
7290                   type: string
7291                 pool_type:
7292                   type: string
7293                 rule_name:
7294                   type: string
7295               required:
7296               - pool
7297               - pg_num
7298               - pool_type
7299               type: object
7300       responses:
7301         '201':
7302           content:
7303             application/vnd.ceph.api.v1.0+json:
7304               type: object
7305           description: Resource created.
7306         '202':
7307           content:
7308             application/vnd.ceph.api.v1.0+json:
7309               type: object
7310           description: Operation is still executing. Please check the task queue.
7311         '400':
7312           description: Operation exception. Please check the response body for details.
7313         '401':
7314           description: Unauthenticated access. Please login first.
7315         '403':
7316           description: Unauthorized access. Please check your permissions.
7317         '500':
7318           description: Unexpected error. Please check the response body for the stack
7319             trace.
7320       security:
7321       - jwt: []
7322       tags:
7323       - Pool
7324   /api/pool/{pool_name}:
7325     delete:
7326       parameters:
7327       - in: path
7328         name: pool_name
7329         required: true
7330         schema:
7331           type: string
7332       responses:
7333         '202':
7334           content:
7335             application/vnd.ceph.api.v1.0+json:
7336               type: object
7337           description: Operation is still executing. Please check the task queue.
7338         '204':
7339           content:
7340             application/vnd.ceph.api.v1.0+json:
7341               type: object
7342           description: Resource deleted.
7343         '400':
7344           description: Operation exception. Please check the response body for details.
7345         '401':
7346           description: Unauthenticated access. Please login first.
7347         '403':
7348           description: Unauthorized access. Please check your permissions.
7349         '500':
7350           description: Unexpected error. Please check the response body for the stack
7351             trace.
7352       security:
7353       - jwt: []
7354       tags:
7355       - Pool
7356     get:
7357       parameters:
7358       - in: path
7359         name: pool_name
7360         required: true
7361         schema:
7362           type: string
7363       - allowEmptyValue: true
7364         in: query
7365         name: attrs
7366         schema:
7367           type: string
7368       - default: false
7369         in: query
7370         name: stats
7371         schema:
7372           type: boolean
7373       responses:
7374         '200':
7375           content:
7376             application/vnd.ceph.api.v1.0+json:
7377               type: object
7378           description: OK
7379         '400':
7380           description: Operation exception. Please check the response body for details.
7381         '401':
7382           description: Unauthenticated access. Please login first.
7383         '403':
7384           description: Unauthorized access. Please check your permissions.
7385         '500':
7386           description: Unexpected error. Please check the response body for the stack
7387             trace.
7388       security:
7389       - jwt: []
7390       tags:
7391       - Pool
7392     put:
7393       parameters:
7394       - in: path
7395         name: pool_name
7396         required: true
7397         schema:
7398           type: string
7399       requestBody:
7400         content:
7401           application/json:
7402             schema:
7403               properties:
7404                 application_metadata:
7405                   type: string
7406                 configuration:
7407                   type: string
7408                 flags:
7409                   type: string
7410               type: object
7411       responses:
7412         '200':
7413           content:
7414             application/vnd.ceph.api.v1.0+json:
7415               type: object
7416           description: Resource updated.
7417         '202':
7418           content:
7419             application/vnd.ceph.api.v1.0+json:
7420               type: object
7421           description: Operation is still executing. Please check the task queue.
7422         '400':
7423           description: Operation exception. Please check the response body for details.
7424         '401':
7425           description: Unauthenticated access. Please login first.
7426         '403':
7427           description: Unauthorized access. Please check your permissions.
7428         '500':
7429           description: Unexpected error. Please check the response body for the stack
7430             trace.
7431       security:
7432       - jwt: []
7433       tags:
7434       - Pool
7435   /api/pool/{pool_name}/configuration:
7436     get:
7437       parameters:
7438       - in: path
7439         name: pool_name
7440         required: true
7441         schema:
7442           type: string
7443       responses:
7444         '200':
7445           content:
7446             application/vnd.ceph.api.v1.0+json:
7447               type: object
7448           description: OK
7449         '400':
7450           description: Operation exception. Please check the response body for details.
7451         '401':
7452           description: Unauthenticated access. Please login first.
7453         '403':
7454           description: Unauthorized access. Please check your permissions.
7455         '500':
7456           description: Unexpected error. Please check the response body for the stack
7457             trace.
7458       security:
7459       - jwt: []
7460       tags:
7461       - Pool
7462   /api/prometheus:
7463     get:
7464       parameters: []
7465       responses:
7466         '200':
7467           content:
7468             application/vnd.ceph.api.v1.0+json:
7469               type: object
7470           description: OK
7471         '400':
7472           description: Operation exception. Please check the response body for details.
7473         '401':
7474           description: Unauthenticated access. Please login first.
7475         '403':
7476           description: Unauthorized access. Please check your permissions.
7477         '500':
7478           description: Unexpected error. Please check the response body for the stack
7479             trace.
7480       security:
7481       - jwt: []
7482       tags:
7483       - Prometheus
7484   /api/prometheus/notifications:
7485     get:
7486       parameters: []
7487       responses:
7488         '200':
7489           content:
7490             application/vnd.ceph.api.v1.0+json:
7491               type: object
7492           description: OK
7493         '400':
7494           description: Operation exception. Please check the response body for details.
7495         '401':
7496           description: Unauthenticated access. Please login first.
7497         '403':
7498           description: Unauthorized access. Please check your permissions.
7499         '500':
7500           description: Unexpected error. Please check the response body for the stack
7501             trace.
7502       security:
7503       - jwt: []
7504       tags:
7505       - PrometheusNotifications
7506   /api/prometheus/rules:
7507     get:
7508       parameters: []
7509       responses:
7510         '200':
7511           content:
7512             application/vnd.ceph.api.v1.0+json:
7513               type: object
7514           description: OK
7515         '400':
7516           description: Operation exception. Please check the response body for details.
7517         '401':
7518           description: Unauthenticated access. Please login first.
7519         '403':
7520           description: Unauthorized access. Please check your permissions.
7521         '500':
7522           description: Unexpected error. Please check the response body for the stack
7523             trace.
7524       security:
7525       - jwt: []
7526       tags:
7527       - Prometheus
7528   /api/prometheus/silence:
7529     post:
7530       parameters: []
7531       responses:
7532         '201':
7533           content:
7534             application/vnd.ceph.api.v1.0+json:
7535               type: object
7536           description: Resource created.
7537         '202':
7538           content:
7539             application/vnd.ceph.api.v1.0+json:
7540               type: object
7541           description: Operation is still executing. Please check the task queue.
7542         '400':
7543           description: Operation exception. Please check the response body for details.
7544         '401':
7545           description: Unauthenticated access. Please login first.
7546         '403':
7547           description: Unauthorized access. Please check your permissions.
7548         '500':
7549           description: Unexpected error. Please check the response body for the stack
7550             trace.
7551       security:
7552       - jwt: []
7553       tags:
7554       - Prometheus
7555   /api/prometheus/silence/{s_id}:
7556     delete:
7557       parameters:
7558       - in: path
7559         name: s_id
7560         required: true
7561         schema:
7562           type: string
7563       responses:
7564         '202':
7565           content:
7566             application/vnd.ceph.api.v1.0+json:
7567               type: object
7568           description: Operation is still executing. Please check the task queue.
7569         '204':
7570           content:
7571             application/vnd.ceph.api.v1.0+json:
7572               type: object
7573           description: Resource deleted.
7574         '400':
7575           description: Operation exception. Please check the response body for details.
7576         '401':
7577           description: Unauthenticated access. Please login first.
7578         '403':
7579           description: Unauthorized access. Please check your permissions.
7580         '500':
7581           description: Unexpected error. Please check the response body for the stack
7582             trace.
7583       security:
7584       - jwt: []
7585       tags:
7586       - Prometheus
7587   /api/prometheus/silences:
7588     get:
7589       parameters: []
7590       responses:
7591         '200':
7592           content:
7593             application/vnd.ceph.api.v1.0+json:
7594               type: object
7595           description: OK
7596         '400':
7597           description: Operation exception. Please check the response body for details.
7598         '401':
7599           description: Unauthenticated access. Please login first.
7600         '403':
7601           description: Unauthorized access. Please check your permissions.
7602         '500':
7603           description: Unexpected error. Please check the response body for the stack
7604             trace.
7605       security:
7606       - jwt: []
7607       tags:
7608       - Prometheus
7609   /api/rgw/bucket:
7610     get:
7611       parameters:
7612       - default: false
7613         in: query
7614         name: stats
7615         schema:
7616           type: boolean
7617       - allowEmptyValue: true
7618         in: query
7619         name: daemon_name
7620         schema:
7621           type: string
7622       - allowEmptyValue: true
7623         in: query
7624         name: uid
7625         schema:
7626           type: string
7627       responses:
7628         '200':
7629           content:
7630             application/vnd.ceph.api.v1.1+json:
7631               type: object
7632           description: OK
7633         '400':
7634           description: Operation exception. Please check the response body for details.
7635         '401':
7636           description: Unauthenticated access. Please login first.
7637         '403':
7638           description: Unauthorized access. Please check your permissions.
7639         '500':
7640           description: Unexpected error. Please check the response body for the stack
7641             trace.
7642       security:
7643       - jwt: []
7644       tags:
7645       - RgwBucket
7646     post:
7647       parameters: []
7648       requestBody:
7649         content:
7650           application/json:
7651             schema:
7652               properties:
7653                 bucket:
7654                   type: string
7655                 daemon_name:
7656                   type: string
7657                 lock_enabled:
7658                   default: 'false'
7659                   type: string
7660                 lock_mode:
7661                   type: string
7662                 lock_retention_period_days:
7663                   type: string
7664                 lock_retention_period_years:
7665                   type: string
7666                 placement_target:
7667                   type: string
7668                 uid:
7669                   type: string
7670                 zonegroup:
7671                   type: string
7672               required:
7673               - bucket
7674               - uid
7675               type: object
7676       responses:
7677         '201':
7678           content:
7679             application/vnd.ceph.api.v1.0+json:
7680               type: object
7681           description: Resource created.
7682         '202':
7683           content:
7684             application/vnd.ceph.api.v1.0+json:
7685               type: object
7686           description: Operation is still executing. Please check the task queue.
7687         '400':
7688           description: Operation exception. Please check the response body for details.
7689         '401':
7690           description: Unauthenticated access. Please login first.
7691         '403':
7692           description: Unauthorized access. Please check your permissions.
7693         '500':
7694           description: Unexpected error. Please check the response body for the stack
7695             trace.
7696       security:
7697       - jwt: []
7698       tags:
7699       - RgwBucket
7700   /api/rgw/bucket/{bucket}:
7701     delete:
7702       parameters:
7703       - in: path
7704         name: bucket
7705         required: true
7706         schema:
7707           type: string
7708       - default: 'true'
7709         in: query
7710         name: purge_objects
7711         schema:
7712           type: string
7713       - allowEmptyValue: true
7714         in: query
7715         name: daemon_name
7716         schema:
7717           type: string
7718       responses:
7719         '202':
7720           content:
7721             application/vnd.ceph.api.v1.0+json:
7722               type: object
7723           description: Operation is still executing. Please check the task queue.
7724         '204':
7725           content:
7726             application/vnd.ceph.api.v1.0+json:
7727               type: object
7728           description: Resource deleted.
7729         '400':
7730           description: Operation exception. Please check the response body for details.
7731         '401':
7732           description: Unauthenticated access. Please login first.
7733         '403':
7734           description: Unauthorized access. Please check your permissions.
7735         '500':
7736           description: Unexpected error. Please check the response body for the stack
7737             trace.
7738       security:
7739       - jwt: []
7740       tags:
7741       - RgwBucket
7742     get:
7743       parameters:
7744       - in: path
7745         name: bucket
7746         required: true
7747         schema:
7748           type: string
7749       - allowEmptyValue: true
7750         in: query
7751         name: daemon_name
7752         schema:
7753           type: string
7754       responses:
7755         '200':
7756           content:
7757             application/vnd.ceph.api.v1.0+json:
7758               type: object
7759           description: OK
7760         '400':
7761           description: Operation exception. Please check the response body for details.
7762         '401':
7763           description: Unauthenticated access. Please login first.
7764         '403':
7765           description: Unauthorized access. Please check your permissions.
7766         '500':
7767           description: Unexpected error. Please check the response body for the stack
7768             trace.
7769       security:
7770       - jwt: []
7771       tags:
7772       - RgwBucket
7773     put:
7774       parameters:
7775       - in: path
7776         name: bucket
7777         required: true
7778         schema:
7779           type: string
7780       requestBody:
7781         content:
7782           application/json:
7783             schema:
7784               properties:
7785                 bucket_id:
7786                   type: string
7787                 daemon_name:
7788                   type: string
7789                 lock_mode:
7790                   type: string
7791                 lock_retention_period_days:
7792                   type: string
7793                 lock_retention_period_years:
7794                   type: string
7795                 mfa_delete:
7796                   type: string
7797                 mfa_token_pin:
7798                   type: string
7799                 mfa_token_serial:
7800                   type: string
7801                 uid:
7802                   type: string
7803                 versioning_state:
7804                   type: string
7805               required:
7806               - bucket_id
7807               - uid
7808               type: object
7809       responses:
7810         '200':
7811           content:
7812             application/vnd.ceph.api.v1.0+json:
7813               type: object
7814           description: Resource updated.
7815         '202':
7816           content:
7817             application/vnd.ceph.api.v1.0+json:
7818               type: object
7819           description: Operation is still executing. Please check the task queue.
7820         '400':
7821           description: Operation exception. Please check the response body for details.
7822         '401':
7823           description: Unauthenticated access. Please login first.
7824         '403':
7825           description: Unauthorized access. Please check your permissions.
7826         '500':
7827           description: Unexpected error. Please check the response body for the stack
7828             trace.
7829       security:
7830       - jwt: []
7831       tags:
7832       - RgwBucket
7833   /api/rgw/daemon:
7834     get:
7835       parameters: []
7836       responses:
7837         '200':
7838           content:
7839             application/vnd.ceph.api.v1.0+json:
7840               schema:
7841                 items:
7842                   properties:
7843                     id:
7844                       description: Daemon ID
7845                       type: string
7846                     server_hostname:
7847                       description: ''
7848                       type: string
7849                     version:
7850                       description: Ceph Version
7851                       type: string
7852                     zone_name:
7853                       description: Zone
7854                       type: string
7855                     zonegroup_name:
7856                       description: Zone Group
7857                       type: string
7858                   type: object
7859                 required:
7860                 - id
7861                 - version
7862                 - server_hostname
7863                 - zonegroup_name
7864                 - zone_name
7865                 type: array
7866           description: OK
7867         '400':
7868           description: Operation exception. Please check the response body for details.
7869         '401':
7870           description: Unauthenticated access. Please login first.
7871         '403':
7872           description: Unauthorized access. Please check your permissions.
7873         '500':
7874           description: Unexpected error. Please check the response body for the stack
7875             trace.
7876       security:
7877       - jwt: []
7878       summary: Display RGW Daemons
7879       tags:
7880       - RgwDaemon
7881   /api/rgw/daemon/{svc_id}:
7882     get:
7883       parameters:
7884       - in: path
7885         name: svc_id
7886         required: true
7887         schema:
7888           type: string
7889       responses:
7890         '200':
7891           content:
7892             application/vnd.ceph.api.v1.0+json:
7893               type: object
7894           description: OK
7895         '400':
7896           description: Operation exception. Please check the response body for details.
7897         '401':
7898           description: Unauthenticated access. Please login first.
7899         '403':
7900           description: Unauthorized access. Please check your permissions.
7901         '500':
7902           description: Unexpected error. Please check the response body for the stack
7903             trace.
7904       security:
7905       - jwt: []
7906       tags:
7907       - RgwDaemon
7908   /api/rgw/site:
7909     get:
7910       parameters:
7911       - allowEmptyValue: true
7912         in: query
7913         name: query
7914         schema:
7915           type: string
7916       - allowEmptyValue: true
7917         in: query
7918         name: daemon_name
7919         schema:
7920           type: string
7921       responses:
7922         '200':
7923           content:
7924             application/vnd.ceph.api.v1.0+json:
7925               type: object
7926           description: OK
7927         '400':
7928           description: Operation exception. Please check the response body for details.
7929         '401':
7930           description: Unauthenticated access. Please login first.
7931         '403':
7932           description: Unauthorized access. Please check your permissions.
7933         '500':
7934           description: Unexpected error. Please check the response body for the stack
7935             trace.
7936       security:
7937       - jwt: []
7938       tags:
7939       - RgwSite
7940   /api/rgw/status:
7941     get:
7942       parameters: []
7943       responses:
7944         '200':
7945           content:
7946             application/vnd.ceph.api.v1.0+json:
7947               schema:
7948                 properties:
7949                   available:
7950                     description: Is RGW available?
7951                     type: boolean
7952                   message:
7953                     description: Descriptions
7954                     type: string
7955                 required:
7956                 - available
7957                 - message
7958                 type: object
7959           description: OK
7960         '400':
7961           description: Operation exception. Please check the response body for details.
7962         '401':
7963           description: Unauthenticated access. Please login first.
7964         '403':
7965           description: Unauthorized access. Please check your permissions.
7966         '500':
7967           description: Unexpected error. Please check the response body for the stack
7968             trace.
7969       security:
7970       - jwt: []
7971       summary: Display RGW Status
7972       tags:
7973       - Rgw
7974   /api/rgw/user:
7975     get:
7976       parameters:
7977       - allowEmptyValue: true
7978         in: query
7979         name: daemon_name
7980         schema:
7981           type: string
7982       responses:
7983         '200':
7984           content:
7985             application/vnd.ceph.api.v1.0+json:
7986               schema:
7987                 properties:
7988                   list_of_users:
7989                     description: list of rgw users
7990                     items:
7991                       type: string
7992                     type: array
7993                 required:
7994                 - list_of_users
7995                 type: object
7996           description: OK
7997         '400':
7998           description: Operation exception. Please check the response body for details.
7999         '401':
8000           description: Unauthenticated access. Please login first.
8001         '403':
8002           description: Unauthorized access. Please check your permissions.
8003         '500':
8004           description: Unexpected error. Please check the response body for the stack
8005             trace.
8006       security:
8007       - jwt: []
8008       summary: Display RGW Users
8009       tags:
8010       - RgwUser
8011     post:
8012       parameters: []
8013       requestBody:
8014         content:
8015           application/json:
8016             schema:
8017               properties:
8018                 access_key:
8019                   type: string
8020                 daemon_name:
8021                   type: string
8022                 display_name:
8023                   type: string
8024                 email:
8025                   type: string
8026                 generate_key:
8027                   type: string
8028                 max_buckets:
8029                   type: string
8030                 secret_key:
8031                   type: string
8032                 suspended:
8033                   type: string
8034                 uid:
8035                   type: string
8036               required:
8037               - uid
8038               - display_name
8039               type: object
8040       responses:
8041         '201':
8042           content:
8043             application/vnd.ceph.api.v1.0+json:
8044               type: object
8045           description: Resource created.
8046         '202':
8047           content:
8048             application/vnd.ceph.api.v1.0+json:
8049               type: object
8050           description: Operation is still executing. Please check the task queue.
8051         '400':
8052           description: Operation exception. Please check the response body for details.
8053         '401':
8054           description: Unauthenticated access. Please login first.
8055         '403':
8056           description: Unauthorized access. Please check your permissions.
8057         '500':
8058           description: Unexpected error. Please check the response body for the stack
8059             trace.
8060       security:
8061       - jwt: []
8062       tags:
8063       - RgwUser
8064   /api/rgw/user/get_emails:
8065     get:
8066       parameters:
8067       - allowEmptyValue: true
8068         in: query
8069         name: daemon_name
8070         schema:
8071           type: string
8072       responses:
8073         '200':
8074           content:
8075             application/vnd.ceph.api.v1.0+json:
8076               type: object
8077           description: OK
8078         '400':
8079           description: Operation exception. Please check the response body for details.
8080         '401':
8081           description: Unauthenticated access. Please login first.
8082         '403':
8083           description: Unauthorized access. Please check your permissions.
8084         '500':
8085           description: Unexpected error. Please check the response body for the stack
8086             trace.
8087       security:
8088       - jwt: []
8089       tags:
8090       - RgwUser
8091   /api/rgw/user/{uid}:
8092     delete:
8093       parameters:
8094       - in: path
8095         name: uid
8096         required: true
8097         schema:
8098           type: string
8099       - allowEmptyValue: true
8100         in: query
8101         name: daemon_name
8102         schema:
8103           type: string
8104       responses:
8105         '202':
8106           content:
8107             application/vnd.ceph.api.v1.0+json:
8108               type: object
8109           description: Operation is still executing. Please check the task queue.
8110         '204':
8111           content:
8112             application/vnd.ceph.api.v1.0+json:
8113               type: object
8114           description: Resource deleted.
8115         '400':
8116           description: Operation exception. Please check the response body for details.
8117         '401':
8118           description: Unauthenticated access. Please login first.
8119         '403':
8120           description: Unauthorized access. Please check your permissions.
8121         '500':
8122           description: Unexpected error. Please check the response body for the stack
8123             trace.
8124       security:
8125       - jwt: []
8126       tags:
8127       - RgwUser
8128     get:
8129       parameters:
8130       - in: path
8131         name: uid
8132         required: true
8133         schema:
8134           type: string
8135       - allowEmptyValue: true
8136         in: query
8137         name: daemon_name
8138         schema:
8139           type: string
8140       - default: true
8141         in: query
8142         name: stats
8143         schema:
8144           type: boolean
8145       responses:
8146         '200':
8147           content:
8148             application/vnd.ceph.api.v1.0+json:
8149               type: object
8150           description: OK
8151         '400':
8152           description: Operation exception. Please check the response body for details.
8153         '401':
8154           description: Unauthenticated access. Please login first.
8155         '403':
8156           description: Unauthorized access. Please check your permissions.
8157         '500':
8158           description: Unexpected error. Please check the response body for the stack
8159             trace.
8160       security:
8161       - jwt: []
8162       tags:
8163       - RgwUser
8164     put:
8165       parameters:
8166       - in: path
8167         name: uid
8168         required: true
8169         schema:
8170           type: string
8171       requestBody:
8172         content:
8173           application/json:
8174             schema:
8175               properties:
8176                 daemon_name:
8177                   type: string
8178                 display_name:
8179                   type: string
8180                 email:
8181                   type: string
8182                 max_buckets:
8183                   type: string
8184                 suspended:
8185                   type: string
8186               type: object
8187       responses:
8188         '200':
8189           content:
8190             application/vnd.ceph.api.v1.0+json:
8191               type: object
8192           description: Resource updated.
8193         '202':
8194           content:
8195             application/vnd.ceph.api.v1.0+json:
8196               type: object
8197           description: Operation is still executing. Please check the task queue.
8198         '400':
8199           description: Operation exception. Please check the response body for details.
8200         '401':
8201           description: Unauthenticated access. Please login first.
8202         '403':
8203           description: Unauthorized access. Please check your permissions.
8204         '500':
8205           description: Unexpected error. Please check the response body for the stack
8206             trace.
8207       security:
8208       - jwt: []
8209       tags:
8210       - RgwUser
8211   /api/rgw/user/{uid}/capability:
8212     delete:
8213       parameters:
8214       - in: path
8215         name: uid
8216         required: true
8217         schema:
8218           type: string
8219       - in: query
8220         name: type
8221         required: true
8222         schema:
8223           type: string
8224       - in: query
8225         name: perm
8226         required: true
8227         schema:
8228           type: string
8229       - allowEmptyValue: true
8230         in: query
8231         name: daemon_name
8232         schema:
8233           type: string
8234       responses:
8235         '202':
8236           content:
8237             application/vnd.ceph.api.v1.0+json:
8238               type: object
8239           description: Operation is still executing. Please check the task queue.
8240         '204':
8241           content:
8242             application/vnd.ceph.api.v1.0+json:
8243               type: object
8244           description: Resource deleted.
8245         '400':
8246           description: Operation exception. Please check the response body for details.
8247         '401':
8248           description: Unauthenticated access. Please login first.
8249         '403':
8250           description: Unauthorized access. Please check your permissions.
8251         '500':
8252           description: Unexpected error. Please check the response body for the stack
8253             trace.
8254       security:
8255       - jwt: []
8256       tags:
8257       - RgwUser
8258     post:
8259       parameters:
8260       - in: path
8261         name: uid
8262         required: true
8263         schema:
8264           type: string
8265       requestBody:
8266         content:
8267           application/json:
8268             schema:
8269               properties:
8270                 daemon_name:
8271                   type: string
8272                 perm:
8273                   type: string
8274                 type:
8275                   type: string
8276               required:
8277               - type
8278               - perm
8279               type: object
8280       responses:
8281         '201':
8282           content:
8283             application/vnd.ceph.api.v1.0+json:
8284               type: object
8285           description: Resource created.
8286         '202':
8287           content:
8288             application/vnd.ceph.api.v1.0+json:
8289               type: object
8290           description: Operation is still executing. Please check the task queue.
8291         '400':
8292           description: Operation exception. Please check the response body for details.
8293         '401':
8294           description: Unauthenticated access. Please login first.
8295         '403':
8296           description: Unauthorized access. Please check your permissions.
8297         '500':
8298           description: Unexpected error. Please check the response body for the stack
8299             trace.
8300       security:
8301       - jwt: []
8302       tags:
8303       - RgwUser
8304   /api/rgw/user/{uid}/key:
8305     delete:
8306       parameters:
8307       - in: path
8308         name: uid
8309         required: true
8310         schema:
8311           type: string
8312       - default: s3
8313         in: query
8314         name: key_type
8315         schema:
8316           type: string
8317       - allowEmptyValue: true
8318         in: query
8319         name: subuser
8320         schema:
8321           type: string
8322       - allowEmptyValue: true
8323         in: query
8324         name: access_key
8325         schema:
8326           type: string
8327       - allowEmptyValue: true
8328         in: query
8329         name: daemon_name
8330         schema:
8331           type: string
8332       responses:
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         '204':
8339           content:
8340             application/vnd.ceph.api.v1.0+json:
8341               type: object
8342           description: Resource deleted.
8343         '400':
8344           description: Operation exception. Please check the response body for details.
8345         '401':
8346           description: Unauthenticated access. Please login first.
8347         '403':
8348           description: Unauthorized access. Please check your permissions.
8349         '500':
8350           description: Unexpected error. Please check the response body for the stack
8351             trace.
8352       security:
8353       - jwt: []
8354       tags:
8355       - RgwUser
8356     post:
8357       parameters:
8358       - in: path
8359         name: uid
8360         required: true
8361         schema:
8362           type: string
8363       requestBody:
8364         content:
8365           application/json:
8366             schema:
8367               properties:
8368                 access_key:
8369                   type: string
8370                 daemon_name:
8371                   type: string
8372                 generate_key:
8373                   default: 'true'
8374                   type: string
8375                 key_type:
8376                   default: s3
8377                   type: string
8378                 secret_key:
8379                   type: string
8380                 subuser:
8381                   type: string
8382               type: object
8383       responses:
8384         '201':
8385           content:
8386             application/vnd.ceph.api.v1.0+json:
8387               type: object
8388           description: Resource created.
8389         '202':
8390           content:
8391             application/vnd.ceph.api.v1.0+json:
8392               type: object
8393           description: Operation is still executing. Please check the task queue.
8394         '400':
8395           description: Operation exception. Please check the response body for details.
8396         '401':
8397           description: Unauthenticated access. Please login first.
8398         '403':
8399           description: Unauthorized access. Please check your permissions.
8400         '500':
8401           description: Unexpected error. Please check the response body for the stack
8402             trace.
8403       security:
8404       - jwt: []
8405       tags:
8406       - RgwUser
8407   /api/rgw/user/{uid}/quota:
8408     get:
8409       parameters:
8410       - in: path
8411         name: uid
8412         required: true
8413         schema:
8414           type: string
8415       - allowEmptyValue: true
8416         in: query
8417         name: daemon_name
8418         schema:
8419           type: string
8420       responses:
8421         '200':
8422           content:
8423             application/vnd.ceph.api.v1.0+json:
8424               type: object
8425           description: OK
8426         '400':
8427           description: Operation exception. Please check the response body for details.
8428         '401':
8429           description: Unauthenticated access. Please login first.
8430         '403':
8431           description: Unauthorized access. Please check your permissions.
8432         '500':
8433           description: Unexpected error. Please check the response body for the stack
8434             trace.
8435       security:
8436       - jwt: []
8437       tags:
8438       - RgwUser
8439     put:
8440       parameters:
8441       - in: path
8442         name: uid
8443         required: true
8444         schema:
8445           type: string
8446       requestBody:
8447         content:
8448           application/json:
8449             schema:
8450               properties:
8451                 daemon_name:
8452                   type: string
8453                 enabled:
8454                   type: string
8455                 max_objects:
8456                   type: string
8457                 max_size_kb:
8458                   type: integer
8459                 quota_type:
8460                   type: string
8461               required:
8462               - quota_type
8463               - enabled
8464               - max_size_kb
8465               - max_objects
8466               type: object
8467       responses:
8468         '200':
8469           content:
8470             application/vnd.ceph.api.v1.0+json:
8471               type: object
8472           description: Resource updated.
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       - RgwUser
8491   /api/rgw/user/{uid}/subuser:
8492     post:
8493       parameters:
8494       - in: path
8495         name: uid
8496         required: true
8497         schema:
8498           type: string
8499       requestBody:
8500         content:
8501           application/json:
8502             schema:
8503               properties:
8504                 access:
8505                   type: string
8506                 access_key:
8507                   type: string
8508                 daemon_name:
8509                   type: string
8510                 generate_secret:
8511                   default: 'true'
8512                   type: string
8513                 key_type:
8514                   default: s3
8515                   type: string
8516                 secret_key:
8517                   type: string
8518                 subuser:
8519                   type: string
8520               required:
8521               - subuser
8522               - access
8523               type: object
8524       responses:
8525         '201':
8526           content:
8527             application/vnd.ceph.api.v1.0+json:
8528               type: object
8529           description: Resource created.
8530         '202':
8531           content:
8532             application/vnd.ceph.api.v1.0+json:
8533               type: object
8534           description: Operation is still executing. Please check the task queue.
8535         '400':
8536           description: Operation exception. Please check the response body for details.
8537         '401':
8538           description: Unauthenticated access. Please login first.
8539         '403':
8540           description: Unauthorized access. Please check your permissions.
8541         '500':
8542           description: Unexpected error. Please check the response body for the stack
8543             trace.
8544       security:
8545       - jwt: []
8546       tags:
8547       - RgwUser
8548   /api/rgw/user/{uid}/subuser/{subuser}:
8549     delete:
8550       description: "\n        :param purge_keys: Set to False to do not purge the\
8551         \ keys.\n                           Note, this only works for s3 subusers.\n\
8552         \        "
8553       parameters:
8554       - in: path
8555         name: uid
8556         required: true
8557         schema:
8558           type: string
8559       - in: path
8560         name: subuser
8561         required: true
8562         schema:
8563           type: string
8564       - default: 'true'
8565         in: query
8566         name: purge_keys
8567         schema:
8568           type: string
8569       - allowEmptyValue: true
8570         in: query
8571         name: daemon_name
8572         schema:
8573           type: string
8574       responses:
8575         '202':
8576           content:
8577             application/vnd.ceph.api.v1.0+json:
8578               type: object
8579           description: Operation is still executing. Please check the task queue.
8580         '204':
8581           content:
8582             application/vnd.ceph.api.v1.0+json:
8583               type: object
8584           description: Resource deleted.
8585         '400':
8586           description: Operation exception. Please check the response body for details.
8587         '401':
8588           description: Unauthenticated access. Please login first.
8589         '403':
8590           description: Unauthorized access. Please check your permissions.
8591         '500':
8592           description: Unexpected error. Please check the response body for the stack
8593             trace.
8594       security:
8595       - jwt: []
8596       tags:
8597       - RgwUser
8598   /api/role:
8599     get:
8600       parameters: []
8601       responses:
8602         '200':
8603           content:
8604             application/vnd.ceph.api.v1.0+json:
8605               schema:
8606                 items:
8607                   properties:
8608                     description:
8609                       description: Role Descriptions
8610                       type: string
8611                     name:
8612                       description: Role Name
8613                       type: string
8614                     scopes_permissions:
8615                       description: ''
8616                       properties:
8617                         cephfs:
8618                           description: ''
8619                           items:
8620                             type: string
8621                           type: array
8622                       required:
8623                       - cephfs
8624                       type: object
8625                     system:
8626                       description: ''
8627                       type: boolean
8628                   type: object
8629                 required:
8630                 - name
8631                 - description
8632                 - scopes_permissions
8633                 - system
8634                 type: array
8635           description: OK
8636         '400':
8637           description: Operation exception. Please check the response body for details.
8638         '401':
8639           description: Unauthenticated access. Please login first.
8640         '403':
8641           description: Unauthorized access. Please check your permissions.
8642         '500':
8643           description: Unexpected error. Please check the response body for the stack
8644             trace.
8645       security:
8646       - jwt: []
8647       summary: Display Role list
8648       tags:
8649       - Role
8650     post:
8651       parameters: []
8652       requestBody:
8653         content:
8654           application/json:
8655             schema:
8656               properties:
8657                 description:
8658                   type: string
8659                 name:
8660                   type: string
8661                 scopes_permissions:
8662                   type: string
8663               type: object
8664       responses:
8665         '201':
8666           content:
8667             application/vnd.ceph.api.v1.0+json:
8668               type: object
8669           description: Resource created.
8670         '202':
8671           content:
8672             application/vnd.ceph.api.v1.0+json:
8673               type: object
8674           description: Operation is still executing. Please check the task queue.
8675         '400':
8676           description: Operation exception. Please check the response body for details.
8677         '401':
8678           description: Unauthenticated access. Please login first.
8679         '403':
8680           description: Unauthorized access. Please check your permissions.
8681         '500':
8682           description: Unexpected error. Please check the response body for the stack
8683             trace.
8684       security:
8685       - jwt: []
8686       tags:
8687       - Role
8688   /api/role/{name}:
8689     delete:
8690       parameters:
8691       - in: path
8692         name: name
8693         required: true
8694         schema:
8695           type: string
8696       responses:
8697         '202':
8698           content:
8699             application/vnd.ceph.api.v1.0+json:
8700               type: object
8701           description: Operation is still executing. Please check the task queue.
8702         '204':
8703           content:
8704             application/vnd.ceph.api.v1.0+json:
8705               type: object
8706           description: Resource deleted.
8707         '400':
8708           description: Operation exception. Please check the response body for details.
8709         '401':
8710           description: Unauthenticated access. Please login first.
8711         '403':
8712           description: Unauthorized access. Please check your permissions.
8713         '500':
8714           description: Unexpected error. Please check the response body for the stack
8715             trace.
8716       security:
8717       - jwt: []
8718       tags:
8719       - Role
8720     get:
8721       parameters:
8722       - in: path
8723         name: name
8724         required: true
8725         schema:
8726           type: string
8727       responses:
8728         '200':
8729           content:
8730             application/vnd.ceph.api.v1.0+json:
8731               type: object
8732           description: OK
8733         '400':
8734           description: Operation exception. Please check the response body for details.
8735         '401':
8736           description: Unauthenticated access. Please login first.
8737         '403':
8738           description: Unauthorized access. Please check your permissions.
8739         '500':
8740           description: Unexpected error. Please check the response body for the stack
8741             trace.
8742       security:
8743       - jwt: []
8744       tags:
8745       - Role
8746     put:
8747       parameters:
8748       - in: path
8749         name: name
8750         required: true
8751         schema:
8752           type: string
8753       requestBody:
8754         content:
8755           application/json:
8756             schema:
8757               properties:
8758                 description:
8759                   type: string
8760                 scopes_permissions:
8761                   type: string
8762               type: object
8763       responses:
8764         '200':
8765           content:
8766             application/vnd.ceph.api.v1.0+json:
8767               type: object
8768           description: Resource updated.
8769         '202':
8770           content:
8771             application/vnd.ceph.api.v1.0+json:
8772               type: object
8773           description: Operation is still executing. Please check the task queue.
8774         '400':
8775           description: Operation exception. Please check the response body for details.
8776         '401':
8777           description: Unauthenticated access. Please login first.
8778         '403':
8779           description: Unauthorized access. Please check your permissions.
8780         '500':
8781           description: Unexpected error. Please check the response body for the stack
8782             trace.
8783       security:
8784       - jwt: []
8785       tags:
8786       - Role
8787   /api/role/{name}/clone:
8788     post:
8789       parameters:
8790       - in: path
8791         name: name
8792         required: true
8793         schema:
8794           type: string
8795       requestBody:
8796         content:
8797           application/json:
8798             schema:
8799               properties:
8800                 new_name:
8801                   type: string
8802               required:
8803               - new_name
8804               type: object
8805       responses:
8806         '201':
8807           content:
8808             application/vnd.ceph.api.v1.0+json:
8809               type: object
8810           description: Resource created.
8811         '202':
8812           content:
8813             application/vnd.ceph.api.v1.0+json:
8814               type: object
8815           description: Operation is still executing. Please check the task queue.
8816         '400':
8817           description: Operation exception. Please check the response body for details.
8818         '401':
8819           description: Unauthenticated access. Please login first.
8820         '403':
8821           description: Unauthorized access. Please check your permissions.
8822         '500':
8823           description: Unexpected error. Please check the response body for the stack
8824             trace.
8825       security:
8826       - jwt: []
8827       tags:
8828       - Role
8829   /api/service:
8830     get:
8831       parameters:
8832       - allowEmptyValue: true
8833         in: query
8834         name: service_name
8835         schema:
8836           type: string
8837       responses:
8838         '200':
8839           content:
8840             application/vnd.ceph.api.v1.0+json:
8841               type: object
8842           description: OK
8843         '400':
8844           description: Operation exception. Please check the response body for details.
8845         '401':
8846           description: Unauthenticated access. Please login first.
8847         '403':
8848           description: Unauthorized access. Please check your permissions.
8849         '500':
8850           description: Unexpected error. Please check the response body for the stack
8851             trace.
8852       security:
8853       - jwt: []
8854       tags:
8855       - Service
8856     post:
8857       description: "\n        :param service_spec: The service specification as JSON.\n\
8858         \        :param service_name: The service name, e.g. 'alertmanager'.\n   \
8859         \     :return: None\n        "
8860       parameters: []
8861       requestBody:
8862         content:
8863           application/json:
8864             schema:
8865               properties:
8866                 service_name:
8867                   type: string
8868                 service_spec:
8869                   type: string
8870               required:
8871               - service_spec
8872               - service_name
8873               type: object
8874       responses:
8875         '201':
8876           content:
8877             application/vnd.ceph.api.v1.0+json:
8878               type: object
8879           description: Resource created.
8880         '202':
8881           content:
8882             application/vnd.ceph.api.v1.0+json:
8883               type: object
8884           description: Operation is still executing. Please check the task queue.
8885         '400':
8886           description: Operation exception. Please check the response body for details.
8887         '401':
8888           description: Unauthenticated access. Please login first.
8889         '403':
8890           description: Unauthorized access. Please check your permissions.
8891         '500':
8892           description: Unexpected error. Please check the response body for the stack
8893             trace.
8894       security:
8895       - jwt: []
8896       tags:
8897       - Service
8898   /api/service/known_types:
8899     get:
8900       description: "\n        Get a list of known service types, e.g. 'alertmanager',\n\
8901         \        'node-exporter', 'osd' or 'rgw'.\n        "
8902       parameters: []
8903       responses:
8904         '200':
8905           content:
8906             application/vnd.ceph.api.v1.0+json:
8907               type: object
8908           description: OK
8909         '400':
8910           description: Operation exception. Please check the response body for details.
8911         '401':
8912           description: Unauthenticated access. Please login first.
8913         '403':
8914           description: Unauthorized access. Please check your permissions.
8915         '500':
8916           description: Unexpected error. Please check the response body for the stack
8917             trace.
8918       security:
8919       - jwt: []
8920       tags:
8921       - Service
8922   /api/service/{service_name}:
8923     delete:
8924       description: "\n        :param service_name: The service name, e.g. 'mds' or\
8925         \ 'crash.foo'.\n        :return: None\n        "
8926       parameters:
8927       - in: path
8928         name: service_name
8929         required: true
8930         schema:
8931           type: string
8932       responses:
8933         '202':
8934           content:
8935             application/vnd.ceph.api.v1.0+json:
8936               type: object
8937           description: Operation is still executing. Please check the task queue.
8938         '204':
8939           content:
8940             application/vnd.ceph.api.v1.0+json:
8941               type: object
8942           description: Resource deleted.
8943         '400':
8944           description: Operation exception. Please check the response body for details.
8945         '401':
8946           description: Unauthenticated access. Please login first.
8947         '403':
8948           description: Unauthorized access. Please check your permissions.
8949         '500':
8950           description: Unexpected error. Please check the response body for the stack
8951             trace.
8952       security:
8953       - jwt: []
8954       tags:
8955       - Service
8956     get:
8957       parameters:
8958       - in: path
8959         name: service_name
8960         required: true
8961         schema:
8962           type: string
8963       responses:
8964         '200':
8965           content:
8966             application/vnd.ceph.api.v1.0+json:
8967               type: object
8968           description: OK
8969         '400':
8970           description: Operation exception. Please check the response body for details.
8971         '401':
8972           description: Unauthenticated access. Please login first.
8973         '403':
8974           description: Unauthorized access. Please check your permissions.
8975         '500':
8976           description: Unexpected error. Please check the response body for the stack
8977             trace.
8978       security:
8979       - jwt: []
8980       tags:
8981       - Service
8982   /api/service/{service_name}/daemons:
8983     get:
8984       parameters:
8985       - in: path
8986         name: service_name
8987         required: true
8988         schema:
8989           type: string
8990       responses:
8991         '200':
8992           content:
8993             application/vnd.ceph.api.v1.0+json:
8994               type: object
8995           description: OK
8996         '400':
8997           description: Operation exception. Please check the response body for details.
8998         '401':
8999           description: Unauthenticated access. Please login first.
9000         '403':
9001           description: Unauthorized access. Please check your permissions.
9002         '500':
9003           description: Unexpected error. Please check the response body for the stack
9004             trace.
9005       security:
9006       - jwt: []
9007       tags:
9008       - Service
9009   /api/settings:
9010     get:
9011       description: "\n        Get the list of available options.\n        :param names:\
9012         \ A comma separated list of option names that should\n        be processed.\
9013         \ Defaults to ``None``.\n        :type names: None|str\n        :return: A\
9014         \ list of available options.\n        :rtype: list[dict]\n        "
9015       parameters:
9016       - allowEmptyValue: true
9017         description: Name of Settings
9018         in: query
9019         name: names
9020         schema:
9021           type: string
9022       responses:
9023         '200':
9024           content:
9025             application/vnd.ceph.api.v1.0+json:
9026               schema:
9027                 items:
9028                   properties:
9029                     default:
9030                       description: Default Settings
9031                       type: boolean
9032                     name:
9033                       description: Settings Name
9034                       type: string
9035                     type:
9036                       description: Type of Settings
9037                       type: string
9038                     value:
9039                       description: Settings Value
9040                       type: boolean
9041                   type: object
9042                 required:
9043                 - name
9044                 - default
9045                 - type
9046                 - value
9047                 type: array
9048           description: OK
9049         '400':
9050           description: Operation exception. Please check the response body for details.
9051         '401':
9052           description: Unauthenticated access. Please login first.
9053         '403':
9054           description: Unauthorized access. Please check your permissions.
9055         '500':
9056           description: Unexpected error. Please check the response body for the stack
9057             trace.
9058       security:
9059       - jwt: []
9060       summary: Display Settings Information
9061       tags:
9062       - Settings
9063     put:
9064       parameters: []
9065       responses:
9066         '200':
9067           content:
9068             application/vnd.ceph.api.v1.0+json:
9069               type: object
9070           description: Resource updated.
9071         '202':
9072           content:
9073             application/vnd.ceph.api.v1.0+json:
9074               type: object
9075           description: Operation is still executing. Please check the task queue.
9076         '400':
9077           description: Operation exception. Please check the response body for details.
9078         '401':
9079           description: Unauthenticated access. Please login first.
9080         '403':
9081           description: Unauthorized access. Please check your permissions.
9082         '500':
9083           description: Unexpected error. Please check the response body for the stack
9084             trace.
9085       security:
9086       - jwt: []
9087       tags:
9088       - Settings
9089   /api/settings/{name}:
9090     delete:
9091       parameters:
9092       - in: path
9093         name: name
9094         required: true
9095         schema:
9096           type: string
9097       responses:
9098         '202':
9099           content:
9100             application/vnd.ceph.api.v1.0+json:
9101               type: object
9102           description: Operation is still executing. Please check the task queue.
9103         '204':
9104           content:
9105             application/vnd.ceph.api.v1.0+json:
9106               type: object
9107           description: Resource deleted.
9108         '400':
9109           description: Operation exception. Please check the response body for details.
9110         '401':
9111           description: Unauthenticated access. Please login first.
9112         '403':
9113           description: Unauthorized access. Please check your permissions.
9114         '500':
9115           description: Unexpected error. Please check the response body for the stack
9116             trace.
9117       security:
9118       - jwt: []
9119       tags:
9120       - Settings
9121     get:
9122       description: "\n        Get the given option.\n        :param name: The name\
9123         \ of the option.\n        :return: Returns a dict containing the name, type,\n\
9124         \        default value and current value of the given option.\n        :rtype:\
9125         \ dict\n        "
9126       parameters:
9127       - in: path
9128         name: name
9129         required: true
9130         schema:
9131           type: string
9132       responses:
9133         '200':
9134           content:
9135             application/vnd.ceph.api.v1.0+json:
9136               type: object
9137           description: OK
9138         '400':
9139           description: Operation exception. Please check the response body for details.
9140         '401':
9141           description: Unauthenticated access. Please login first.
9142         '403':
9143           description: Unauthorized access. Please check your permissions.
9144         '500':
9145           description: Unexpected error. Please check the response body for the stack
9146             trace.
9147       security:
9148       - jwt: []
9149       tags:
9150       - Settings
9151     put:
9152       parameters:
9153       - in: path
9154         name: name
9155         required: true
9156         schema:
9157           type: string
9158       requestBody:
9159         content:
9160           application/json:
9161             schema:
9162               properties:
9163                 value:
9164                   type: string
9165               required:
9166               - value
9167               type: object
9168       responses:
9169         '200':
9170           content:
9171             application/vnd.ceph.api.v1.0+json:
9172               type: object
9173           description: Resource updated.
9174         '202':
9175           content:
9176             application/vnd.ceph.api.v1.0+json:
9177               type: object
9178           description: Operation is still executing. Please check the task queue.
9179         '400':
9180           description: Operation exception. Please check the response body for details.
9181         '401':
9182           description: Unauthenticated access. Please login first.
9183         '403':
9184           description: Unauthorized access. Please check your permissions.
9185         '500':
9186           description: Unexpected error. Please check the response body for the stack
9187             trace.
9188       security:
9189       - jwt: []
9190       tags:
9191       - Settings
9192   /api/summary:
9193     get:
9194       parameters: []
9195       responses:
9196         '200':
9197           content:
9198             application/vnd.ceph.api.v1.0+json:
9199               schema:
9200                 properties:
9201                   executing_tasks:
9202                     description: ''
9203                     items:
9204                       type: string
9205                     type: array
9206                   finished_tasks:
9207                     description: ''
9208                     items:
9209                       properties:
9210                         begin_time:
9211                           description: ''
9212                           type: string
9213                         duration:
9214                           description: ''
9215                           type: integer
9216                         end_time:
9217                           description: ''
9218                           type: string
9219                         exception:
9220                           description: ''
9221                           type: string
9222                         metadata:
9223                           description: ''
9224                           properties:
9225                             pool:
9226                               description: ''
9227                               type: integer
9228                           required:
9229                           - pool
9230                           type: object
9231                         name:
9232                           description: ''
9233                           type: string
9234                         progress:
9235                           description: ''
9236                           type: integer
9237                         ret_value:
9238                           description: ''
9239                           type: string
9240                         success:
9241                           description: ''
9242                           type: boolean
9243                       required:
9244                       - name
9245                       - metadata
9246                       - begin_time
9247                       - end_time
9248                       - duration
9249                       - progress
9250                       - success
9251                       - ret_value
9252                       - exception
9253                       type: object
9254                     type: array
9255                   have_mon_connection:
9256                     description: ''
9257                     type: string
9258                   health_status:
9259                     description: ''
9260                     type: string
9261                   mgr_host:
9262                     description: ''
9263                     type: string
9264                   mgr_id:
9265                     description: ''
9266                     type: string
9267                   rbd_mirroring:
9268                     description: ''
9269                     properties:
9270                       errors:
9271                         description: ''
9272                         type: integer
9273                       warnings:
9274                         description: ''
9275                         type: integer
9276                     required:
9277                     - warnings
9278                     - errors
9279                     type: object
9280                   version:
9281                     description: ''
9282                     type: string
9283                 required:
9284                 - health_status
9285                 - mgr_id
9286                 - mgr_host
9287                 - have_mon_connection
9288                 - executing_tasks
9289                 - finished_tasks
9290                 - version
9291                 - rbd_mirroring
9292                 type: object
9293           description: OK
9294         '400':
9295           description: Operation exception. Please check the response body for details.
9296         '401':
9297           description: Unauthenticated access. Please login first.
9298         '403':
9299           description: Unauthorized access. Please check your permissions.
9300         '500':
9301           description: Unexpected error. Please check the response body for the stack
9302             trace.
9303       security:
9304       - jwt: []
9305       summary: Display Summary
9306       tags:
9307       - Summary
9308   /api/task:
9309     get:
9310       parameters:
9311       - allowEmptyValue: true
9312         description: Task Name
9313         in: query
9314         name: name
9315         schema:
9316           type: string
9317       responses:
9318         '200':
9319           content:
9320             application/vnd.ceph.api.v1.0+json:
9321               schema:
9322                 properties:
9323                   executing_tasks:
9324                     description: ongoing executing tasks
9325                     type: string
9326                   finished_tasks:
9327                     description: ''
9328                     items:
9329                       properties:
9330                         begin_time:
9331                           description: Task begin time
9332                           type: string
9333                         duration:
9334                           description: ''
9335                           type: integer
9336                         end_time:
9337                           description: Task end time
9338                           type: string
9339                         exception:
9340                           description: ''
9341                           type: boolean
9342                         metadata:
9343                           description: ''
9344                           properties:
9345                             pool:
9346                               description: ''
9347                               type: integer
9348                           required:
9349                           - pool
9350                           type: object
9351                         name:
9352                           description: finished tasks name
9353                           type: string
9354                         progress:
9355                           description: Progress of tasks
9356                           type: integer
9357                         ret_value:
9358                           description: ''
9359                           type: boolean
9360                         success:
9361                           description: ''
9362                           type: boolean
9363                       required:
9364                       - name
9365                       - metadata
9366                       - begin_time
9367                       - end_time
9368                       - duration
9369                       - progress
9370                       - success
9371                       - ret_value
9372                       - exception
9373                       type: object
9374                     type: array
9375                 required:
9376                 - executing_tasks
9377                 - finished_tasks
9378                 type: object
9379           description: OK
9380         '400':
9381           description: Operation exception. Please check the response body for details.
9382         '401':
9383           description: Unauthenticated access. Please login first.
9384         '403':
9385           description: Unauthorized access. Please check your permissions.
9386         '500':
9387           description: Unexpected error. Please check the response body for the stack
9388             trace.
9389       security:
9390       - jwt: []
9391       summary: Display Tasks
9392       tags:
9393       - Task
9394   /api/telemetry:
9395     put:
9396       description: "\n        Enables or disables sending data collected by the Telemetry\n\
9397         \        module.\n        :param enable: Enable or disable sending data\n\
9398         \        :type enable: bool\n        :param license_name: License string e.g.\
9399         \ 'sharing-1-0' to\n        make sure the user is aware of and accepts the\
9400         \ license\n        for sharing Telemetry data.\n        :type license_name:\
9401         \ string\n        "
9402       parameters: []
9403       requestBody:
9404         content:
9405           application/json:
9406             schema:
9407               properties:
9408                 enable:
9409                   default: true
9410                   type: boolean
9411                 license_name:
9412                   type: string
9413               type: object
9414       responses:
9415         '200':
9416           content:
9417             application/vnd.ceph.api.v1.0+json:
9418               type: object
9419           description: Resource updated.
9420         '202':
9421           content:
9422             application/vnd.ceph.api.v1.0+json:
9423               type: object
9424           description: Operation is still executing. Please check the task queue.
9425         '400':
9426           description: Operation exception. Please check the response body for details.
9427         '401':
9428           description: Unauthenticated access. Please login first.
9429         '403':
9430           description: Unauthorized access. Please check your permissions.
9431         '500':
9432           description: Unexpected error. Please check the response body for the stack
9433             trace.
9434       security:
9435       - jwt: []
9436       tags:
9437       - Telemetry
9438   /api/telemetry/report:
9439     get:
9440       description: "\n        Get Ceph and device report data\n        :return: Ceph\
9441         \ and device report data\n        :rtype: dict\n        "
9442       parameters: []
9443       responses:
9444         '200':
9445           content:
9446             application/vnd.ceph.api.v1.0+json:
9447               schema:
9448                 properties:
9449                   device_report:
9450                     description: ''
9451                     type: string
9452                   report:
9453                     description: ''
9454                     properties:
9455                       balancer:
9456                         description: ''
9457                         properties:
9458                           active:
9459                             description: ''
9460                             type: boolean
9461                           mode:
9462                             description: ''
9463                             type: string
9464                         required:
9465                         - active
9466                         - mode
9467                         type: object
9468                       channels:
9469                         description: ''
9470                         items:
9471                           type: string
9472                         type: array
9473                       channels_available:
9474                         description: ''
9475                         items:
9476                           type: string
9477                         type: array
9478                       config:
9479                         description: ''
9480                         properties:
9481                           active_changed:
9482                             description: ''
9483                             items:
9484                               type: string
9485                             type: array
9486                           cluster_changed:
9487                             description: ''
9488                             items:
9489                               type: string
9490                             type: array
9491                         required:
9492                         - cluster_changed
9493                         - active_changed
9494                         type: object
9495                       crashes:
9496                         description: ''
9497                         items:
9498                           type: integer
9499                         type: array
9500                       created:
9501                         description: ''
9502                         type: string
9503                       crush:
9504                         description: ''
9505                         properties:
9506                           bucket_algs:
9507                             description: ''
9508                             properties:
9509                               straw2:
9510                                 description: ''
9511                                 type: integer
9512                             required:
9513                             - straw2
9514                             type: object
9515                           bucket_sizes:
9516                             description: ''
9517                             properties:
9518                               '1':
9519                                 description: ''
9520                                 type: integer
9521                               '3':
9522                                 description: ''
9523                                 type: integer
9524                             required:
9525                             - '1'
9526                             - '3'
9527                             type: object
9528                           bucket_types:
9529                             description: ''
9530                             properties:
9531                               '1':
9532                                 description: ''
9533                                 type: integer
9534                               '11':
9535                                 description: ''
9536                                 type: integer
9537                             required:
9538                             - '1'
9539                             - '11'
9540                             type: object
9541                           compat_weight_set:
9542                             description: ''
9543                             type: boolean
9544                           device_classes:
9545                             description: ''
9546                             items:
9547                               type: integer
9548                             type: array
9549                           num_buckets:
9550                             description: ''
9551                             type: integer
9552                           num_devices:
9553                             description: ''
9554                             type: integer
9555                           num_rules:
9556                             description: ''
9557                             type: integer
9558                           num_types:
9559                             description: ''
9560                             type: integer
9561                           num_weight_sets:
9562                             description: ''
9563                             type: integer
9564                           tunables:
9565                             description: ''
9566                             properties:
9567                               allowed_bucket_algs:
9568                                 description: ''
9569                                 type: integer
9570                               choose_local_fallback_tries:
9571                                 description: ''
9572                                 type: integer
9573                               choose_local_tries:
9574                                 description: ''
9575                                 type: integer
9576                               choose_total_tries:
9577                                 description: ''
9578                                 type: integer
9579                               chooseleaf_descend_once:
9580                                 description: ''
9581                                 type: integer
9582                               chooseleaf_stable:
9583                                 description: ''
9584                                 type: integer
9585                               chooseleaf_vary_r:
9586                                 description: ''
9587                                 type: integer
9588                               has_v2_rules:
9589                                 description: ''
9590                                 type: integer
9591                               has_v3_rules:
9592                                 description: ''
9593                                 type: integer
9594                               has_v4_buckets:
9595                                 description: ''
9596                                 type: integer
9597                               has_v5_rules:
9598                                 description: ''
9599                                 type: integer
9600                               legacy_tunables:
9601                                 description: ''
9602                                 type: integer
9603                               minimum_required_version:
9604                                 description: ''
9605                                 type: string
9606                               optimal_tunables:
9607                                 description: ''
9608                                 type: integer
9609                               profile:
9610                                 description: ''
9611                                 type: string
9612                               require_feature_tunables:
9613                                 description: ''
9614                                 type: integer
9615                               require_feature_tunables2:
9616                                 description: ''
9617                                 type: integer
9618                               require_feature_tunables3:
9619                                 description: ''
9620                                 type: integer
9621                               require_feature_tunables5:
9622                                 description: ''
9623                                 type: integer
9624                               straw_calc_version:
9625                                 description: ''
9626                                 type: integer
9627                             required:
9628                             - choose_local_tries
9629                             - choose_local_fallback_tries
9630                             - choose_total_tries
9631                             - chooseleaf_descend_once
9632                             - chooseleaf_vary_r
9633                             - chooseleaf_stable
9634                             - straw_calc_version
9635                             - allowed_bucket_algs
9636                             - profile
9637                             - optimal_tunables
9638                             - legacy_tunables
9639                             - minimum_required_version
9640                             - require_feature_tunables
9641                             - require_feature_tunables2
9642                             - has_v2_rules
9643                             - require_feature_tunables3
9644                             - has_v3_rules
9645                             - has_v4_buckets
9646                             - require_feature_tunables5
9647                             - has_v5_rules
9648                             type: object
9649                         required:
9650                         - num_devices
9651                         - num_types
9652                         - num_buckets
9653                         - num_rules
9654                         - device_classes
9655                         - tunables
9656                         - compat_weight_set
9657                         - num_weight_sets
9658                         - bucket_algs
9659                         - bucket_sizes
9660                         - bucket_types
9661                         type: object
9662                       fs:
9663                         description: ''
9664                         properties:
9665                           count:
9666                             description: ''
9667                             type: integer
9668                           feature_flags:
9669                             description: ''
9670                             properties:
9671                               enable_multiple:
9672                                 description: ''
9673                                 type: boolean
9674                               ever_enabled_multiple:
9675                                 description: ''
9676                                 type: boolean
9677                             required:
9678                             - enable_multiple
9679                             - ever_enabled_multiple
9680                             type: object
9681                           filesystems:
9682                             description: ''
9683                             items:
9684                               type: integer
9685                             type: array
9686                           num_standby_mds:
9687                             description: ''
9688                             type: integer
9689                           total_num_mds:
9690                             description: ''
9691                             type: integer
9692                         required:
9693                         - count
9694                         - feature_flags
9695                         - num_standby_mds
9696                         - filesystems
9697                         - total_num_mds
9698                         type: object
9699                       hosts:
9700                         description: ''
9701                         properties:
9702                           num:
9703                             description: ''
9704                             type: integer
9705                           num_with_mds:
9706                             description: ''
9707                             type: integer
9708                           num_with_mgr:
9709                             description: ''
9710                             type: integer
9711                           num_with_mon:
9712                             description: ''
9713                             type: integer
9714                           num_with_osd:
9715                             description: ''
9716                             type: integer
9717                         required:
9718                         - num
9719                         - num_with_mon
9720                         - num_with_mds
9721                         - num_with_osd
9722                         - num_with_mgr
9723                         type: object
9724                       leaderboard:
9725                         description: ''
9726                         type: boolean
9727                       license:
9728                         description: ''
9729                         type: string
9730                       metadata:
9731                         description: ''
9732                         properties:
9733                           mon:
9734                             description: ''
9735                             properties:
9736                               arch:
9737                                 description: ''
9738                                 properties:
9739                                   x86_64:
9740                                     description: ''
9741                                     type: integer
9742                                 required:
9743                                 - x86_64
9744                                 type: object
9745                               ceph_version:
9746                                 description: ''
9747                                 properties:
9748                                   ceph version 16.0.0-3151-gf202994fcf:
9749                                     description: ''
9750                                     type: integer
9751                                 required:
9752                                 - ceph version 16.0.0-3151-gf202994fcf
9753                                 type: object
9754                               cpu:
9755                                 description: ''
9756                                 properties:
9757                                   Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
9758                                     description: ''
9759                                     type: integer
9760                                 required:
9761                                 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
9762                                 type: object
9763                               distro:
9764                                 description: ''
9765                                 properties:
9766                                   centos:
9767                                     description: ''
9768                                     type: integer
9769                                 required:
9770                                 - centos
9771                                 type: object
9772                               distro_description:
9773                                 description: ''
9774                                 properties:
9775                                   CentOS Linux 8 (Core):
9776                                     description: ''
9777                                     type: integer
9778                                 required:
9779                                 - CentOS Linux 8 (Core)
9780                                 type: object
9781                               kernel_description:
9782                                 description: ''
9783                                 properties:
9784                                   '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
9785                                     description: ''
9786                                     type: integer
9787                                 required:
9788                                 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
9789                                 type: object
9790                               kernel_version:
9791                                 description: ''
9792                                 properties:
9793                                   5.7.7-200.fc32.x86_64:
9794                                     description: ''
9795                                     type: integer
9796                                 required:
9797                                 - 5.7.7-200.fc32.x86_64
9798                                 type: object
9799                               os:
9800                                 description: ''
9801                                 properties:
9802                                   Linux:
9803                                     description: ''
9804                                     type: integer
9805                                 required:
9806                                 - Linux
9807                                 type: object
9808                             required:
9809                             - arch
9810                             - ceph_version
9811                             - os
9812                             - cpu
9813                             - kernel_description
9814                             - kernel_version
9815                             - distro_description
9816                             - distro
9817                             type: object
9818                           osd:
9819                             description: ''
9820                             properties:
9821                               arch:
9822                                 description: ''
9823                                 properties:
9824                                   x86_64:
9825                                     description: ''
9826                                     type: integer
9827                                 required:
9828                                 - x86_64
9829                                 type: object
9830                               ceph_version:
9831                                 description: ''
9832                                 properties:
9833                                   ceph version 16.0.0-3151-gf202994fcf:
9834                                     description: ''
9835                                     type: integer
9836                                 required:
9837                                 - ceph version 16.0.0-3151-gf202994fcf
9838                                 type: object
9839                               cpu:
9840                                 description: ''
9841                                 properties:
9842                                   Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz:
9843                                     description: ''
9844                                     type: integer
9845                                 required:
9846                                 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz
9847                                 type: object
9848                               distro:
9849                                 description: ''
9850                                 properties:
9851                                   centos:
9852                                     description: ''
9853                                     type: integer
9854                                 required:
9855                                 - centos
9856                                 type: object
9857                               distro_description:
9858                                 description: ''
9859                                 properties:
9860                                   CentOS Linux 8 (Core):
9861                                     description: ''
9862                                     type: integer
9863                                 required:
9864                                 - CentOS Linux 8 (Core)
9865                                 type: object
9866                               kernel_description:
9867                                 description: ''
9868                                 properties:
9869                                   '#1 SMP Wed Jul 1 19:53:01 UTC 2020':
9870                                     description: ''
9871                                     type: integer
9872                                 required:
9873                                 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020'
9874                                 type: object
9875                               kernel_version:
9876                                 description: ''
9877                                 properties:
9878                                   5.7.7-200.fc32.x86_64:
9879                                     description: ''
9880                                     type: integer
9881                                 required:
9882                                 - 5.7.7-200.fc32.x86_64
9883                                 type: object
9884                               os:
9885                                 description: ''
9886                                 properties:
9887                                   Linux:
9888                                     description: ''
9889                                     type: integer
9890                                 required:
9891                                 - Linux
9892                                 type: object
9893                               osd_objectstore:
9894                                 description: ''
9895                                 properties:
9896                                   bluestore:
9897                                     description: ''
9898                                     type: integer
9899                                 required:
9900                                 - bluestore
9901                                 type: object
9902                               rotational:
9903                                 description: ''
9904                                 properties:
9905                                   '1':
9906                                     description: ''
9907                                     type: integer
9908                                 required:
9909                                 - '1'
9910                                 type: object
9911                             required:
9912                             - osd_objectstore
9913                             - rotational
9914                             - arch
9915                             - ceph_version
9916                             - os
9917                             - cpu
9918                             - kernel_description
9919                             - kernel_version
9920                             - distro_description
9921                             - distro
9922                             type: object
9923                         required:
9924                         - osd
9925                         - mon
9926                         type: object
9927                       mon:
9928                         description: ''
9929                         properties:
9930                           count:
9931                             description: ''
9932                             type: integer
9933                           features:
9934                             description: ''
9935                             properties:
9936                               optional:
9937                                 description: ''
9938                                 items:
9939                                   type: integer
9940                                 type: array
9941                               persistent:
9942                                 description: ''
9943                                 items:
9944                                   type: string
9945                                 type: array
9946                             required:
9947                             - persistent
9948                             - optional
9949                             type: object
9950                           ipv4_addr_mons:
9951                             description: ''
9952                             type: integer
9953                           ipv6_addr_mons:
9954                             description: ''
9955                             type: integer
9956                           min_mon_release:
9957                             description: ''
9958                             type: integer
9959                           v1_addr_mons:
9960                             description: ''
9961                             type: integer
9962                           v2_addr_mons:
9963                             description: ''
9964                             type: integer
9965                         required:
9966                         - count
9967                         - features
9968                         - min_mon_release
9969                         - v1_addr_mons
9970                         - v2_addr_mons
9971                         - ipv4_addr_mons
9972                         - ipv6_addr_mons
9973                         type: object
9974                       osd:
9975                         description: ''
9976                         properties:
9977                           cluster_network:
9978                             description: ''
9979                             type: boolean
9980                           count:
9981                             description: ''
9982                             type: integer
9983                           require_min_compat_client:
9984                             description: ''
9985                             type: string
9986                           require_osd_release:
9987                             description: ''
9988                             type: string
9989                         required:
9990                         - count
9991                         - require_osd_release
9992                         - require_min_compat_client
9993                         - cluster_network
9994                         type: object
9995                       pools:
9996                         description: ''
9997                         items:
9998                           properties:
9999                             cache_mode:
10000                               description: ''
10001                               type: string
10002                             erasure_code_profile:
10003                               description: ''
10004                               type: string
10005                             min_size:
10006                               description: ''
10007                               type: integer
10008                             pg_autoscale_mode:
10009                               description: ''
10010                               type: string
10011                             pg_num:
10012                               description: ''
10013                               type: integer
10014                             pgp_num:
10015                               description: ''
10016                               type: integer
10017                             pool:
10018                               description: ''
10019                               type: integer
10020                             size:
10021                               description: ''
10022                               type: integer
10023                             target_max_bytes:
10024                               description: ''
10025                               type: integer
10026                             target_max_objects:
10027                               description: ''
10028                               type: integer
10029                             type:
10030                               description: ''
10031                               type: string
10032                           required:
10033                           - pool
10034                           - type
10035                           - pg_num
10036                           - pgp_num
10037                           - size
10038                           - min_size
10039                           - pg_autoscale_mode
10040                           - target_max_bytes
10041                           - target_max_objects
10042                           - erasure_code_profile
10043                           - cache_mode
10044                           type: object
10045                         type: array
10046                       rbd:
10047                         description: ''
10048                         properties:
10049                           mirroring_by_pool:
10050                             description: ''
10051                             items:
10052                               type: boolean
10053                             type: array
10054                           num_images_by_pool:
10055                             description: ''
10056                             items:
10057                               type: integer
10058                             type: array
10059                           num_pools:
10060                             description: ''
10061                             type: integer
10062                         required:
10063                         - num_pools
10064                         - num_images_by_pool
10065                         - mirroring_by_pool
10066                         type: object
10067                       report_id:
10068                         description: ''
10069                         type: string
10070                       report_timestamp:
10071                         description: ''
10072                         type: string
10073                       report_version:
10074                         description: ''
10075                         type: integer
10076                       rgw:
10077                         description: ''
10078                         properties:
10079                           count:
10080                             description: ''
10081                             type: integer
10082                           frontends:
10083                             description: ''
10084                             items:
10085                               type: string
10086                             type: array
10087                           zonegroups:
10088                             description: ''
10089                             type: integer
10090                           zones:
10091                             description: ''
10092                             type: integer
10093                         required:
10094                         - count
10095                         - zones
10096                         - zonegroups
10097                         - frontends
10098                         type: object
10099                       services:
10100                         description: ''
10101                         properties:
10102                           rgw:
10103                             description: ''
10104                             type: integer
10105                         required:
10106                         - rgw
10107                         type: object
10108                       usage:
10109                         description: ''
10110                         properties:
10111                           pg_num:
10112                             description: ''
10113                             type: integer
10114                           pools:
10115                             description: ''
10116                             type: integer
10117                           total_avail_bytes:
10118                             description: ''
10119                             type: integer
10120                           total_bytes:
10121                             description: ''
10122                             type: integer
10123                           total_used_bytes:
10124                             description: ''
10125                             type: integer
10126                         required:
10127                         - pools
10128                         - pg_num
10129                         - total_used_bytes
10130                         - total_bytes
10131                         - total_avail_bytes
10132                         type: object
10133                     required:
10134                     - leaderboard
10135                     - report_version
10136                     - report_timestamp
10137                     - report_id
10138                     - channels
10139                     - channels_available
10140                     - license
10141                     - created
10142                     - mon
10143                     - config
10144                     - rbd
10145                     - pools
10146                     - osd
10147                     - crush
10148                     - fs
10149                     - metadata
10150                     - hosts
10151                     - usage
10152                     - services
10153                     - rgw
10154                     - balancer
10155                     - crashes
10156                     type: object
10157                 required:
10158                 - report
10159                 - device_report
10160                 type: object
10161           description: OK
10162         '400':
10163           description: Operation exception. Please check the response body for details.
10164         '401':
10165           description: Unauthenticated access. Please login first.
10166         '403':
10167           description: Unauthorized access. Please check your permissions.
10168         '500':
10169           description: Unexpected error. Please check the response body for the stack
10170             trace.
10171       security:
10172       - jwt: []
10173       summary: Get Detailed Telemetry report
10174       tags:
10175       - Telemetry
10176   /api/user:
10177     get:
10178       parameters: []
10179       responses:
10180         '200':
10181           content:
10182             application/vnd.ceph.api.v1.0+json:
10183               schema:
10184                 properties:
10185                   email:
10186                     description: User email address
10187                     type: string
10188                   enabled:
10189                     description: Is the user enabled?
10190                     type: boolean
10191                   lastUpdate:
10192                     description: Details last updated
10193                     type: integer
10194                   name:
10195                     description: User Name
10196                     type: string
10197                   pwdExpirationDate:
10198                     description: Password Expiration date
10199                     type: string
10200                   pwdUpdateRequired:
10201                     description: Is Password Update Required?
10202                     type: boolean
10203                   roles:
10204                     description: User Roles
10205                     items:
10206                       type: string
10207                     type: array
10208                   username:
10209                     description: Username of the user
10210                     type: string
10211                 required:
10212                 - username
10213                 - roles
10214                 - name
10215                 - email
10216                 - lastUpdate
10217                 - enabled
10218                 - pwdExpirationDate
10219                 - pwdUpdateRequired
10220                 type: object
10221           description: OK
10222         '400':
10223           description: Operation exception. Please check the response body for details.
10224         '401':
10225           description: Unauthenticated access. Please login first.
10226         '403':
10227           description: Unauthorized access. Please check your permissions.
10228         '500':
10229           description: Unexpected error. Please check the response body for the stack
10230             trace.
10231       security:
10232       - jwt: []
10233       summary: Get List Of Users
10234       tags:
10235       - User
10236     post:
10237       parameters: []
10238       requestBody:
10239         content:
10240           application/json:
10241             schema:
10242               properties:
10243                 email:
10244                   type: string
10245                 enabled:
10246                   default: true
10247                   type: boolean
10248                 name:
10249                   type: string
10250                 password:
10251                   type: string
10252                 pwdExpirationDate:
10253                   type: string
10254                 pwdUpdateRequired:
10255                   default: true
10256                   type: boolean
10257                 roles:
10258                   type: string
10259                 username:
10260                   type: string
10261               type: object
10262       responses:
10263         '201':
10264           content:
10265             application/vnd.ceph.api.v1.0+json:
10266               type: object
10267           description: Resource created.
10268         '202':
10269           content:
10270             application/vnd.ceph.api.v1.0+json:
10271               type: object
10272           description: Operation is still executing. Please check the task queue.
10273         '400':
10274           description: Operation exception. Please check the response body for details.
10275         '401':
10276           description: Unauthenticated access. Please login first.
10277         '403':
10278           description: Unauthorized access. Please check your permissions.
10279         '500':
10280           description: Unexpected error. Please check the response body for the stack
10281             trace.
10282       security:
10283       - jwt: []
10284       tags:
10285       - User
10286   /api/user/validate_password:
10287     post:
10288       description: "\n        Check if the password meets the password policy.\n \
10289         \       :param password: The password to validate.\n        :param username:\
10290         \ The name of the user (optional).\n        :param old_password: The old password\
10291         \ (optional).\n        :return: An object with properties valid, credits and\
10292         \ valuation.\n        'credits' contains the password complexity credits and\n\
10293         \        'valuation' the textual summary of the validation.\n        "
10294       parameters: []
10295       requestBody:
10296         content:
10297           application/json:
10298             schema:
10299               properties:
10300                 old_password:
10301                   type: string
10302                 password:
10303                   type: string
10304                 username:
10305                   type: string
10306               required:
10307               - password
10308               type: object
10309       responses:
10310         '201':
10311           content:
10312             application/vnd.ceph.api.v1.0+json:
10313               type: object
10314           description: Resource created.
10315         '202':
10316           content:
10317             application/vnd.ceph.api.v1.0+json:
10318               type: object
10319           description: Operation is still executing. Please check the task queue.
10320         '400':
10321           description: Operation exception. Please check the response body for details.
10322         '401':
10323           description: Unauthenticated access. Please login first.
10324         '403':
10325           description: Unauthorized access. Please check your permissions.
10326         '500':
10327           description: Unexpected error. Please check the response body for the stack
10328             trace.
10329       security:
10330       - jwt: []
10331       tags:
10332       - UserPasswordPolicy
10333   /api/user/{username}:
10334     delete:
10335       parameters:
10336       - in: path
10337         name: username
10338         required: true
10339         schema:
10340           type: string
10341       responses:
10342         '202':
10343           content:
10344             application/vnd.ceph.api.v1.0+json:
10345               type: object
10346           description: Operation is still executing. Please check the task queue.
10347         '204':
10348           content:
10349             application/vnd.ceph.api.v1.0+json:
10350               type: object
10351           description: Resource deleted.
10352         '400':
10353           description: Operation exception. Please check the response body for details.
10354         '401':
10355           description: Unauthenticated access. Please login first.
10356         '403':
10357           description: Unauthorized access. Please check your permissions.
10358         '500':
10359           description: Unexpected error. Please check the response body for the stack
10360             trace.
10361       security:
10362       - jwt: []
10363       tags:
10364       - User
10365     get:
10366       parameters:
10367       - in: path
10368         name: username
10369         required: true
10370         schema:
10371           type: string
10372       responses:
10373         '200':
10374           content:
10375             application/vnd.ceph.api.v1.0+json:
10376               type: object
10377           description: OK
10378         '400':
10379           description: Operation exception. Please check the response body for details.
10380         '401':
10381           description: Unauthenticated access. Please login first.
10382         '403':
10383           description: Unauthorized access. Please check your permissions.
10384         '500':
10385           description: Unexpected error. Please check the response body for the stack
10386             trace.
10387       security:
10388       - jwt: []
10389       tags:
10390       - User
10391     put:
10392       parameters:
10393       - in: path
10394         name: username
10395         required: true
10396         schema:
10397           type: string
10398       requestBody:
10399         content:
10400           application/json:
10401             schema:
10402               properties:
10403                 email:
10404                   type: string
10405                 enabled:
10406                   type: string
10407                 name:
10408                   type: string
10409                 password:
10410                   type: string
10411                 pwdExpirationDate:
10412                   type: string
10413                 pwdUpdateRequired:
10414                   default: false
10415                   type: boolean
10416                 roles:
10417                   type: string
10418               type: object
10419       responses:
10420         '200':
10421           content:
10422             application/vnd.ceph.api.v1.0+json:
10423               type: object
10424           description: Resource updated.
10425         '202':
10426           content:
10427             application/vnd.ceph.api.v1.0+json:
10428               type: object
10429           description: Operation is still executing. Please check the task queue.
10430         '400':
10431           description: Operation exception. Please check the response body for details.
10432         '401':
10433           description: Unauthenticated access. Please login first.
10434         '403':
10435           description: Unauthorized access. Please check your permissions.
10436         '500':
10437           description: Unexpected error. Please check the response body for the stack
10438             trace.
10439       security:
10440       - jwt: []
10441       tags:
10442       - User
10443   /api/user/{username}/change_password:
10444     post:
10445       parameters:
10446       - in: path
10447         name: username
10448         required: true
10449         schema:
10450           type: string
10451       requestBody:
10452         content:
10453           application/json:
10454             schema:
10455               properties:
10456                 new_password:
10457                   type: string
10458                 old_password:
10459                   type: string
10460               required:
10461               - old_password
10462               - new_password
10463               type: object
10464       responses:
10465         '201':
10466           content:
10467             application/vnd.ceph.api.v1.0+json:
10468               type: object
10469           description: Resource created.
10470         '202':
10471           content:
10472             application/vnd.ceph.api.v1.0+json:
10473               type: object
10474           description: Operation is still executing. Please check the task queue.
10475         '400':
10476           description: Operation exception. Please check the response body for details.
10477         '401':
10478           description: Unauthenticated access. Please login first.
10479         '403':
10480           description: Unauthorized access. Please check your permissions.
10481         '500':
10482           description: Unexpected error. Please check the response body for the stack
10483             trace.
10484       security:
10485       - jwt: []
10486       tags:
10487       - UserChangePassword
10488 schemes:
10489 - https
10490 servers:
10491 - url: /
10492 tags:
10493 - description: Initiate a session with Ceph
10494   name: Auth
10495 - description: Cephfs Management API
10496   name: Cephfs
10497 - description: Get Cluster Details
10498   name: Cluster
10499 - description: Manage Cluster Configurations
10500   name: ClusterConfiguration
10501 - description: Crush Rule Management API
10502   name: CrushRule
10503 - description: Perform actions on daemons
10504   name: Daemon
10505 - description: Erasure Code Profile Management API
10506   name: ErasureCodeProfile
10507 - description: Manage Features API
10508   name: FeatureTogglesEndpoint
10509 - description: Grafana Management API
10510   name: Grafana
10511 - description: Display Detailed Cluster health Status
10512   name: Health
10513 - description: Get Host Details
10514   name: Host
10515 - description: Iscsi Management API
10516   name: Iscsi
10517 - description: Get Iscsi Target Details
10518   name: IscsiTarget
10519 - description: Logs Management API
10520   name: Logs
10521 - description: Mds Perf Counters Management API
10522   name: MdsPerfCounter
10523 - description: Get details of MGR Module
10524   name: MgrModule
10525 - description: Mgr Perf Counters Management API
10526   name: MgrPerfCounter
10527 - description: Mon Perf Counters Management API
10528   name: MonPerfCounter
10529 - description: Get Monitor Details
10530   name: Monitor
10531 - description: NFS-Ganesha Cluster Management API
10532   name: NFS-Ganesha
10533 - description: OSD management API
10534   name: OSD
10535 - description: Orchestrator Management API
10536   name: Orchestrator
10537 - description: OSD Perf Counters Management API
10538   name: OsdPerfCounter
10539 - description: Perf Counters Management API
10540   name: PerfCounters
10541 - description: Get pool details by pool name
10542   name: Pool
10543 - description: Prometheus Management API
10544   name: Prometheus
10545 - description: Prometheus Notifications Management API
10546   name: PrometheusNotifications
10547 - description: RBD Management API
10548   name: Rbd
10549 - description: RBD Mirroring Management API
10550   name: RbdMirroring
10551 - description: RBD Mirroring Pool Bootstrap Management API
10552   name: RbdMirroringPoolBootstrap
10553 - description: RBD Mirroring Pool Mode Management API
10554   name: RbdMirroringPoolMode
10555 - description: RBD Mirroring Pool Peer Management API
10556   name: RbdMirroringPoolPeer
10557 - description: RBD Mirroring Summary Management API
10558   name: RbdMirroringSummary
10559 - description: RBD Namespace Management API
10560   name: RbdNamespace
10561 - description: RBD Snapshot Management API
10562   name: RbdSnapshot
10563 - description: RBD Trash Management API
10564   name: RbdTrash
10565 - description: Feedback API
10566   name: Report
10567 - description: RGW Management API
10568   name: Rgw
10569 - description: RGW Bucket Management API
10570   name: RgwBucket
10571 - description: RGW Daemon Management API
10572   name: RgwDaemon
10573 - description: Rgw Mirroring Perf Counters Management API
10574   name: RgwMirrorPerfCounter
10575 - description: Rgw Perf Counters Management API
10576   name: RgwPerfCounter
10577 - description: RGW Site Management API
10578   name: RgwSite
10579 - description: RGW User Management API
10580   name: RgwUser
10581 - description: Role Management API
10582   name: Role
10583 - description: Service Management API
10584   name: Service
10585 - description: Settings Management API
10586   name: Settings
10587 - description: Get Ceph Summary Details
10588   name: Summary
10589 - description: Task Management API
10590   name: Task
10591 - description: Tcmu Runner Perf Counters Management API
10592   name: TcmuRunnerPerfCounter
10593 - description: Display Telemetry Report
10594   name: Telemetry
10595 - description: Display User Details
10596   name: User
10597 - description: Change User Password
10598   name: UserChangePassword
10599 - description: Get User Password Policy Details
10600   name: UserPasswordPolicy