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