basePath: / components: securitySchemes: jwt: bearerFormat: JWT scheme: bearer type: http host: example.com info: description: This is the official Ceph REST API title: Ceph REST API version: v1 openapi: 3.0.0 paths: /api/auth: post: parameters: [] requestBody: content: application/json: schema: properties: password: description: Password type: string ttl: description: Token Time to Live (in hours) type: integer username: description: Username type: string required: - username - password type: object responses: '201': content: application/json: schema: properties: permissions: description: List of permissions acquired properties: cephfs: description: '' items: type: string type: array required: &id001 - cephfs type: object pwdExpirationDate: description: Password expiration date type: string pwdUpdateRequired: description: Is password update required? type: boolean sso: description: Uses single sign on? type: boolean token: description: Authentication Token type: string username: description: Username type: string required: &id002 - token - username - permissions - pwdExpirationDate - sso - pwdUpdateRequired type: object application/vnd.ceph.api.v1.0+json: schema: properties: permissions: description: List of permissions acquired properties: cephfs: description: '' items: type: string type: array required: *id001 type: object pwdExpirationDate: description: Password expiration date type: string pwdUpdateRequired: description: Is password update required? type: boolean sso: description: Uses single sign on? type: boolean token: description: Authentication Token type: string username: description: Username type: string required: *id002 type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. summary: Dashboard Authentication tags: - Auth /api/auth/check: post: parameters: - description: Authentication Token in: query name: token required: true schema: type: string requestBody: content: application/json: schema: properties: token: description: Authentication Token type: string required: - token type: object responses: '201': content: application/json: schema: properties: permissions: description: List of permissions acquired properties: cephfs: description: '' items: type: string type: array required: &id003 - cephfs type: object pwdUpdateRequired: description: Is password update required? type: boolean sso: description: Uses single sign on? type: boolean username: description: Username type: string required: &id004 - username - permissions - sso - pwdUpdateRequired type: object application/vnd.ceph.api.v1.0+json: schema: properties: permissions: description: List of permissions acquired properties: cephfs: description: '' items: type: string type: array required: *id003 type: object pwdUpdateRequired: description: Is password update required? type: boolean sso: description: Uses single sign on? type: boolean username: description: Username type: string required: *id004 type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. summary: Check token Authentication tags: - Auth /api/auth/logout: post: parameters: [] responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. tags: - Auth /api/block/image: get: parameters: - allowEmptyValue: true description: Pool Name in: query name: pool_name schema: type: string - default: 0 description: offset in: query name: offset schema: type: integer - default: 5 description: limit in: query name: limit schema: type: integer - default: '' in: query name: search schema: type: string - default: '' in: query name: sort schema: type: string responses: '200': content: application/json: schema: items: properties: pool_name: description: pool name type: string value: description: '' items: type: string type: array type: object required: &id005 - value - pool_name type: array application/vnd.ceph.api.v2.0+json: schema: items: properties: pool_name: description: pool name type: string value: description: '' items: type: string type: array type: object required: *id005 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Rbd Images tags: - Rbd post: parameters: [] requestBody: content: application/json: schema: properties: configuration: type: string data_pool: type: string features: type: string metadata: type: string mirror_mode: type: string name: type: string namespace: type: string obj_size: type: integer pool_name: type: string schedule_interval: default: '' type: string size: type: integer stripe_count: type: integer stripe_unit: type: string required: - name - pool_name - size type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd /api/block/image/clone_format_version: get: description: "Return the RBD clone format version.\n " parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd /api/block/image/default_features: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd /api/block/image/trash: get: description: List all entries from trash. parameters: - allowEmptyValue: true description: Name of the pool in: query name: pool_name schema: type: string responses: '200': content: application/json: schema: items: properties: pool_name: description: pool name type: string status: description: '' type: integer value: description: '' items: type: string type: array type: object required: &id006 - status - value - pool_name type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: pool_name: description: pool name type: string status: description: '' type: integer value: description: '' items: type: string type: array type: object required: *id006 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get RBD Trash Details by pool name tags: - RbdTrash /api/block/image/trash/purge: post: description: Remove all expired images from trash. parameters: - allowEmptyValue: true in: query name: pool_name schema: type: string requestBody: content: application/json: schema: properties: pool_name: type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdTrash /api/block/image/trash/{image_id_spec}: delete: description: "Delete an image from trash.\n If image deferment time has\ \ not expired you can not removed it unless use force.\n But an actively\ \ in-use by clones or has snapshots can not be removed.\n " parameters: - in: path name: image_id_spec required: true schema: type: string - default: false in: query name: force schema: type: boolean responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdTrash /api/block/image/trash/{image_id_spec}/restore: post: description: Restore an image from trash. parameters: - in: path name: image_id_spec required: true schema: type: string requestBody: content: application/json: schema: properties: new_image_name: type: string required: - new_image_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdTrash /api/block/image/{image_spec}: delete: parameters: - in: path name: image_spec required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd get: parameters: - description: URL-encoded "pool/rbd_name". e.g. "rbd%2Ffoo" in: path name: image_spec required: true schema: type: string - default: false description: When true, usage information is not returned in: query name: omit_usage schema: type: boolean responses: '200': content: application/json: schema: items: properties: pool_name: description: pool name type: string value: description: '' items: type: string type: array type: object required: &id007 - value - pool_name type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: pool_name: description: pool name type: string value: description: '' items: type: string type: array type: object required: *id007 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Rbd Image Info tags: - Rbd put: parameters: - in: path name: image_spec required: true schema: type: string requestBody: content: application/json: schema: properties: configuration: type: string enable_mirror: type: string features: type: string force: default: false type: boolean image_mirror_mode: type: string metadata: type: string mirror_mode: type: string name: type: string primary: type: string remove_scheduling: default: false type: boolean resync: default: false type: boolean schedule_interval: default: '' type: string schedule_level: type: string size: type: integer type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd /api/block/image/{image_spec}/copy: post: parameters: - in: path name: image_spec required: true schema: type: string requestBody: content: application/json: schema: properties: configuration: type: string data_pool: type: string dest_image_name: type: string dest_namespace: type: string dest_pool_name: type: string features: type: string metadata: type: string obj_size: type: integer snapshot_name: type: string stripe_count: type: integer stripe_unit: type: string required: - dest_pool_name - dest_namespace - dest_image_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd /api/block/image/{image_spec}/flatten: post: parameters: - in: path name: image_spec required: true schema: type: string responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd /api/block/image/{image_spec}/move_trash: post: description: "Move an image to the trash.\n Images, even ones actively\ \ in-use by clones,\n can be moved to the trash and deleted at a later\ \ time.\n " parameters: - in: path name: image_spec required: true schema: type: string requestBody: content: application/json: schema: properties: delay: default: 0 type: integer type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Rbd /api/block/image/{image_spec}/snap: post: parameters: - in: path name: image_spec required: true schema: type: string requestBody: content: application/json: schema: properties: mirrorImageSnapshot: type: string snapshot_name: type: string required: - snapshot_name - mirrorImageSnapshot type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdSnapshot /api/block/image/{image_spec}/snap/{snapshot_name}: delete: parameters: - in: path name: image_spec required: true schema: type: string - in: path name: snapshot_name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdSnapshot put: parameters: - in: path name: image_spec required: true schema: type: string - in: path name: snapshot_name required: true schema: type: string requestBody: content: application/json: schema: properties: is_protected: type: boolean new_snap_name: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdSnapshot /api/block/image/{image_spec}/snap/{snapshot_name}/clone: post: description: "\n Clones a snapshot to an image\n " parameters: - in: path name: image_spec required: true schema: type: string - in: path name: snapshot_name required: true schema: type: string requestBody: content: application/json: schema: properties: child_image_name: type: string child_namespace: type: string child_pool_name: type: string configuration: type: string data_pool: type: string features: type: string metadata: type: string obj_size: type: integer stripe_count: type: integer stripe_unit: type: string required: - child_pool_name - child_image_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdSnapshot /api/block/image/{image_spec}/snap/{snapshot_name}/rollback: post: parameters: - in: path name: image_spec required: true schema: type: string - in: path name: snapshot_name required: true schema: type: string responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdSnapshot /api/block/mirroring/pool/{pool_name}: get: parameters: - description: Pool Name in: path name: pool_name required: true schema: type: string responses: '200': content: application/json: schema: properties: mirror_mode: description: Mirror Mode type: string required: &id008 - mirror_mode type: object application/vnd.ceph.api.v1.0+json: schema: properties: mirror_mode: description: Mirror Mode type: string required: *id008 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Rbd Mirroring Summary tags: - RbdMirroringPoolMode put: parameters: - in: path name: pool_name required: true schema: type: string requestBody: content: application/json: schema: properties: mirror_mode: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolMode /api/block/mirroring/pool/{pool_name}/bootstrap/peer: post: parameters: - in: path name: pool_name required: true schema: type: string requestBody: content: application/json: schema: properties: direction: type: string token: type: string required: - direction - token type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolBootstrap /api/block/mirroring/pool/{pool_name}/bootstrap/token: post: parameters: - in: path name: pool_name required: true schema: type: string responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolBootstrap /api/block/mirroring/pool/{pool_name}/peer: get: parameters: - in: path name: pool_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolPeer post: parameters: - in: path name: pool_name required: true schema: type: string requestBody: content: application/json: schema: properties: client_id: type: string cluster_name: type: string key: type: string mon_host: type: string required: - cluster_name - client_id type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolPeer /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}: delete: parameters: - in: path name: pool_name required: true schema: type: string - in: path name: peer_uuid required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolPeer get: parameters: - in: path name: pool_name required: true schema: type: string - in: path name: peer_uuid required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolPeer put: parameters: - in: path name: pool_name required: true schema: type: string - in: path name: peer_uuid required: true schema: type: string requestBody: content: application/json: schema: properties: client_id: type: string cluster_name: type: string key: type: string mon_host: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringPoolPeer /api/block/mirroring/site_name: get: parameters: [] responses: '200': content: application/json: schema: properties: site_name: description: Site Name type: string required: &id009 - site_name type: object application/vnd.ceph.api.v1.0+json: schema: properties: site_name: description: Site Name type: string required: *id009 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Rbd Mirroring sitename tags: - RbdMirroring put: parameters: [] requestBody: content: application/json: schema: properties: site_name: type: string required: - site_name type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroring /api/block/mirroring/summary: get: parameters: [] responses: '200': content: application/json: schema: properties: content_data: description: '' properties: daemons: description: '' items: type: string type: array image_error: description: '' items: type: string type: array image_ready: description: '' items: type: string type: array image_syncing: description: '' items: type: string type: array pools: description: Pools items: properties: health: description: pool health type: string health_color: description: '' type: string mirror_mode: description: status type: string name: description: Pool name type: string peer_uuids: description: '' items: type: string type: array required: &id010 - name - health_color - health - mirror_mode - peer_uuids type: object type: array required: &id011 - daemons - pools - image_error - image_syncing - image_ready type: object site_name: description: site name type: string status: description: '' type: integer required: &id012 - site_name - status - content_data type: object application/vnd.ceph.api.v1.0+json: schema: properties: content_data: description: '' properties: daemons: description: '' items: type: string type: array image_error: description: '' items: type: string type: array image_ready: description: '' items: type: string type: array image_syncing: description: '' items: type: string type: array pools: description: Pools items: properties: health: description: pool health type: string health_color: description: '' type: string mirror_mode: description: status type: string name: description: Pool name type: string peer_uuids: description: '' items: type: string type: array required: *id010 type: object type: array required: *id011 type: object site_name: description: site name type: string status: description: '' type: integer required: *id012 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Rbd Mirroring Summary tags: - RbdMirroringSummary /api/block/mirroring/{pool_name}/{image_name}/summary: get: parameters: - in: path name: pool_name required: true schema: type: string - in: path name: image_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdMirroringSummary /api/block/pool/{pool_name}/group: get: parameters: - description: Name of the pool to list groups from in: path name: pool_name required: true schema: type: string - allowEmptyValue: true description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. in: query name: namespace schema: type: string responses: '200': content: application/json: schema: items: properties: group: description: group name type: string num_images: description: '' type: integer type: object required: &id013 - group - num_images type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: group: description: group name type: string num_images: description: '' type: integer type: object required: *id013 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all RBD groups in a pool tags: - RbdGroup post: parameters: - description: Name of the pool where the group will be created in: path name: pool_name required: true schema: type: string requestBody: content: application/json: schema: properties: name: description: Name for the new group type: string namespace: description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. type: string required: - name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create a new RBD group in the specified pool tags: - RbdGroup /api/block/pool/{pool_name}/group/{group_name}: delete: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group to delete in: path name: group_name required: true schema: type: string - allowEmptyValue: true description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. in: query name: namespace schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete an RBD group. All images must be removed from the group first. tags: - RbdGroup get: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group to retrieve in: path name: group_name required: true schema: type: string - allowEmptyValue: true description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. in: query name: namespace schema: type: string responses: '200': content: application/json: schema: properties: images: description: List of images in the group with their pool, namespace, and name items: type: object type: array required: &id014 - images type: object application/vnd.ceph.api.v1.0+json: schema: properties: images: description: List of images in the group with their pool, namespace, and name items: type: object type: array required: *id014 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get details of a specific RBD group including its member images tags: - RbdGroup put: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Current name of the group in: path name: group_name required: true schema: type: string requestBody: content: application/json: schema: properties: namespace: description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. type: string new_name: description: New name for the group type: string required: - new_name type: object responses: '200': content: application/json: schema: properties: {} type: object application/vnd.ceph.api.v1.0+json: schema: properties: {} type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Rename an existing RBD group tags: - RbdGroup /api/block/pool/{pool_name}/group/{group_name}/image: delete: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group to remove the image from in: path name: group_name required: true schema: type: string - description: Name of the image to remove from the group in: query name: image_name required: true schema: type: string - allowEmptyValue: true description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. in: query name: namespace schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Remove an RBD image from a group. The image itself is not deleted. tags: - RbdGroup post: parameters: - description: Name of the pool containing both the group and image in: path name: pool_name required: true schema: type: string - description: Name of the group to add the image to in: path name: group_name required: true schema: type: string requestBody: content: application/json: schema: properties: image_name: description: Name of the image to add to the group type: string namespace: description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. type: string required: - image_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Add an RBD image to a group. The image must be in the same pool and namespace. tags: - RbdGroup /api/block/pool/{pool_name}/group/{group_name}/snap: get: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group to list snapshots for in: path name: group_name required: true schema: type: string - allowEmptyValue: true description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. in: query name: namespace schema: type: string responses: '200': content: application/json: schema: items: properties: id: description: snapshot id type: string name: description: snapshot name type: string namespace_type: description: namespace type type: integer state: description: snapshot state type: integer type: object required: &id015 - id - name - state - namespace_type type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: id: description: snapshot id type: string name: description: snapshot name type: string namespace_type: description: namespace type type: integer state: description: snapshot state type: integer type: object required: *id015 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all snapshots of an RBD group tags: - RbdGroupSnapshot post: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group to snapshot in: path name: group_name required: true schema: type: string requestBody: content: application/json: schema: properties: flags: default: 0 description: Snapshot creation flags (optional) type: integer namespace: description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. type: string snapshot_name: description: Name for the new snapshot type: string required: - snapshot_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create a crash-consistent snapshot of all images in the group tags: - RbdGroupSnapshot /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name}: delete: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group in: path name: group_name required: true schema: type: string - description: Name of the snapshot to delete in: path name: snapshot_name required: true schema: type: string - allowEmptyValue: true description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. in: query name: namespace schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete a group snapshot. This removes the snapshot for all images in the group. tags: - RbdGroupSnapshot get: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group in: path name: group_name required: true schema: type: string - description: Name of the snapshot to retrieve in: path name: snapshot_name required: true schema: type: string - allowEmptyValue: true description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. in: query name: namespace schema: type: string responses: '200': content: application/json: schema: properties: id: description: snapshot id type: string image_snap_name: description: image snapshot name type: string image_snaps: description: image snapshots items: type: object type: array name: description: snapshot name type: string namespace_type: description: namespace type type: integer state: description: snapshot state type: integer required: &id016 - id - name - state - namespace_type - image_snap_name - image_snaps type: object application/vnd.ceph.api.v1.0+json: schema: properties: id: description: snapshot id type: string image_snap_name: description: image snapshot name type: string image_snaps: description: image snapshots items: type: object type: array name: description: snapshot name type: string namespace_type: description: namespace type type: integer state: description: snapshot state type: integer required: *id016 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get detailed information about a specific group snapshot tags: - RbdGroupSnapshot put: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group in: path name: group_name required: true schema: type: string - description: Current name of the snapshot in: path name: snapshot_name required: true schema: type: string requestBody: content: application/json: schema: properties: namespace: description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. type: string new_snap_name: description: New name for the snapshot type: string type: object responses: '200': content: application/json: schema: properties: {} type: object application/vnd.ceph.api.v1.0+json: schema: properties: {} type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Rename a group snapshot tags: - RbdGroupSnapshot /api/block/pool/{pool_name}/group/{group_name}/snap/{snapshot_name}/rollback: post: parameters: - description: Name of the pool containing the group in: path name: pool_name required: true schema: type: string - description: Name of the group to rollback in: path name: group_name required: true schema: type: string - description: Name of the snapshot to rollback to in: path name: snapshot_name required: true schema: type: string requestBody: content: application/json: schema: properties: namespace: description: Optional RBD namespace within the pool. Provides logical isolation of images. When specified, operations are scoped to that namespace. If omitted, the default namespace is used. type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Rollback all images in the group to their state at the time of the snapshot tags: - RbdGroupSnapshot /api/block/pool/{pool_name}/namespace: get: parameters: - in: path name: pool_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdNamespace post: parameters: - in: path name: pool_name required: true schema: type: string requestBody: content: application/json: schema: properties: namespace: type: string required: - namespace type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdNamespace /api/block/pool/{pool_name}/namespace/{namespace}: delete: parameters: - in: path name: pool_name required: true schema: type: string - in: path name: namespace required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RbdNamespace /api/cephfs: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs post: parameters: [] requestBody: content: application/json: schema: properties: data_pool: type: string metadata_pool: type: string name: type: string service_spec: type: string required: - name - service_spec type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/auth: put: parameters: [] requestBody: content: application/json: schema: properties: caps: description: Path and given capabilities type: string client_id: description: Cephx user ID type: string fs_name: description: File system name type: string root_squash: description: File System Identifier type: string required: - fs_name - client_id - caps - root_squash type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Set Ceph authentication capabilities for the specified user ID in the given path tags: - Cephfs /api/cephfs/mirror: post: parameters: [] requestBody: content: application/json: schema: properties: fs_name: description: File system name type: string token: description: Bootstrap token type: string required: - fs_name - token type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create bootstrap peer tags: - CephfsMirror /api/cephfs/mirror/daemon-status: get: parameters: [] responses: '200': content: application/json: schema: items: properties: daemon_id: description: Daemon ID type: integer filesystems: description: List of filesystems on daemon items: properties: directory_count: description: Directory count type: integer filesystem_id: description: Filesystem ID type: integer name: description: Filesystem name type: string peers: description: List of peer objects items: properties: remote: description: Remote peer information properties: client_name: description: Ceph client name type: string cluster_name: description: Remote cluster name type: string fs_name: description: Remote filesystem name type: string required: &id017 - client_name - cluster_name - fs_name type: object stats: description: Peer statistics properties: failure_count: description: Number of sync failures type: integer recovery_count: description: Number of peer recoveries type: integer required: &id018 - failure_count - recovery_count type: object uuid: description: Peer UUID type: string required: &id019 - uuid - remote - stats type: object type: array required: &id020 - filesystem_id - name - directory_count - peers type: object type: array type: object required: &id021 - daemon_id - filesystems type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: daemon_id: description: Daemon ID type: integer filesystems: description: List of filesystems on daemon items: properties: directory_count: description: Directory count type: integer filesystem_id: description: Filesystem ID type: integer name: description: Filesystem name type: string peers: description: List of peer objects items: properties: remote: description: Remote peer information properties: client_name: description: Ceph client name type: string cluster_name: description: Remote cluster name type: string fs_name: description: Remote filesystem name type: string required: *id017 type: object stats: description: Peer statistics properties: failure_count: description: Number of sync failures type: integer recovery_count: description: Number of peer recoveries type: integer required: *id018 type: object uuid: description: Peer UUID type: string required: *id019 type: object type: array required: *id020 type: object type: array type: object required: *id021 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get mirror daemon and peers information tags: - CephfsMirror /api/cephfs/mirror/token: post: parameters: [] requestBody: content: application/json: schema: properties: client_name: description: Client entity's name type: string fs_name: description: File system name type: string site_name: description: Site name type: string required: - fs_name - client_name - site_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create bootstrap token tags: - CephfsMirror /api/cephfs/mirror/{fs_name}: get: parameters: - description: File system name in: path name: fs_name required: true schema: type: string responses: '200': content: application/json: schema: items: properties: uuid: description: Peer ID properties: client_name: description: Ceph client name type: string fs_name: description: File system name type: string site_name: description: Remote site name type: string required: &id022 - client_name - site_name - fs_name type: object type: object required: &id023 - uuid type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: uuid: description: Peer ID properties: client_name: description: Ceph client name type: string fs_name: description: File system name type: string site_name: description: Remote site name type: string required: *id022 type: object type: object required: *id023 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get peers tags: - CephfsMirror /api/cephfs/mirror/{fs_name}/{peer_uuid}: delete: parameters: - description: File system name in: path name: fs_name required: true schema: type: string - description: Peer UUID in: path name: peer_uuid required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete peer tags: - CephfsMirror /api/cephfs/remove/{name}: delete: parameters: - description: File System Name in: path name: name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Remove CephFS Volume tags: - Cephfs /api/cephfs/rename: put: parameters: [] requestBody: content: application/json: schema: properties: name: description: Existing FS Name type: string new_name: description: New FS Name type: string required: - name - new_name type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Rename CephFS Volume tags: - Cephfs /api/cephfs/snapshot/schedule: post: parameters: [] requestBody: content: application/json: schema: properties: fs: type: string group: type: string path: type: string retention_policy: type: string snap_schedule: type: string start: type: string subvol: type: string required: - fs - path - snap_schedule - start type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSnapshotSchedule /api/cephfs/snapshot/schedule/{fs}: get: parameters: - in: path name: fs required: true schema: type: string - default: / in: query name: path schema: type: string - default: true in: query name: recursive schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSnapshotSchedule /api/cephfs/snapshot/schedule/{fs}/{path}: put: parameters: - in: path name: fs required: true schema: type: string - in: path name: path required: true schema: type: string requestBody: content: application/json: schema: properties: group: type: string retention_to_add: type: string retention_to_remove: type: string subvol: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSnapshotSchedule /api/cephfs/snapshot/schedule/{fs}/{path}/activate: post: parameters: - in: path name: fs required: true schema: type: string - in: path name: path required: true schema: type: string requestBody: content: application/json: schema: properties: group: type: string schedule: type: string start: type: string subvol: type: string required: - schedule - start type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSnapshotSchedule /api/cephfs/snapshot/schedule/{fs}/{path}/deactivate: post: parameters: - in: path name: fs required: true schema: type: string - in: path name: path required: true schema: type: string requestBody: content: application/json: schema: properties: group: type: string schedule: type: string start: type: string subvol: type: string required: - schedule - start type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSnapshotSchedule /api/cephfs/snapshot/schedule/{fs}/{path}/delete_snapshot: delete: parameters: - in: path name: fs required: true schema: type: string - in: path name: path required: true schema: type: string - in: query name: schedule required: true schema: type: string - in: query name: start required: true schema: type: string - allowEmptyValue: true in: query name: retention_policy schema: type: string - allowEmptyValue: true in: query name: subvol schema: type: string - allowEmptyValue: true in: query name: group schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSnapshotSchedule /api/cephfs/subvolume: post: parameters: [] requestBody: content: application/json: schema: properties: subvol_name: type: string vol_name: type: string required: - vol_name - subvol_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume /api/cephfs/subvolume/group: post: parameters: [] requestBody: content: application/json: schema: properties: group_name: type: string vol_name: type: string required: - vol_name - group_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeGroup /api/cephfs/subvolume/group/{vol_name}: delete: parameters: - in: path name: vol_name required: true schema: type: string - in: query name: group_name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeGroup get: parameters: - in: path name: vol_name required: true schema: type: string - default: true in: query name: info schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeGroup put: parameters: - in: path name: vol_name required: true schema: type: string requestBody: content: application/json: schema: properties: group_name: type: string size: type: integer required: - group_name - size type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeGroup /api/cephfs/subvolume/group/{vol_name}/info: get: parameters: - in: path name: vol_name required: true schema: type: string - in: query name: group_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeGroup /api/cephfs/subvolume/snapshot: post: parameters: [] requestBody: content: application/json: schema: properties: group_name: default: '' type: string snap_name: type: string subvol_name: type: string vol_name: type: string required: - vol_name - subvol_name - snap_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeSnapshot /api/cephfs/subvolume/snapshot/clone: post: parameters: [] requestBody: content: application/json: schema: properties: clone_name: type: string group_name: default: '' type: string snap_name: type: string subvol_name: type: string target_group_name: default: '' type: string vol_name: type: string required: - vol_name - subvol_name - snap_name - clone_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create a clone of a subvolume snapshot tags: - CephfsSnapshotClone /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}: delete: parameters: - in: path name: vol_name required: true schema: type: string - in: path name: subvol_name required: true schema: type: string - in: query name: snap_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string - default: true in: query name: force schema: type: boolean responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeSnapshot get: parameters: - in: path name: vol_name required: true schema: type: string - in: path name: subvol_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string - default: true in: query name: info schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeSnapshot /api/cephfs/subvolume/snapshot/{vol_name}/{subvol_name}/info: get: parameters: - in: path name: vol_name required: true schema: type: string - in: path name: subvol_name required: true schema: type: string - in: query name: snap_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephfsSubvolumeSnapshot /api/cephfs/subvolume/{vol_name}: delete: parameters: - in: path name: vol_name required: true schema: type: string - in: query name: subvol_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string - default: false in: query name: retain_snapshots schema: type: boolean responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume get: parameters: - in: path name: vol_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string - default: true in: query name: info schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume put: parameters: - in: path name: vol_name required: true schema: type: string requestBody: content: application/json: schema: properties: group_name: default: '' type: string size: type: integer subvol_name: type: string required: - subvol_name - size type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume /api/cephfs/subvolume/{vol_name}/exists: get: parameters: - in: path name: vol_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume /api/cephfs/subvolume/{vol_name}/info: get: parameters: - in: path name: vol_name required: true schema: type: string - in: query name: subvol_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume /api/cephfs/subvolume/{vol_name}/snapshot-visibility: get: parameters: - in: path name: vol_name required: true schema: type: string - in: query name: subvol_name required: true schema: type: string - default: '' in: query name: group_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume put: parameters: - in: path name: vol_name required: true schema: type: string requestBody: content: application/json: schema: properties: group_name: default: '' type: string subvol_name: type: string value: type: string required: - subvol_name - value type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CephFSSubvolume /api/cephfs/{fs_id}: get: parameters: - in: path name: fs_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/client/{client_id}: delete: parameters: - in: path name: fs_id required: true schema: type: string - in: path name: client_id required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/clients: get: parameters: - in: path name: fs_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/get_root_directory: get: description: "\n The root directory that can't be fetched using ls_dir\ \ (api).\n :param fs_id: The filesystem identifier.\n :return:\ \ The root directory\n :rtype: dict\n " parameters: - in: path name: fs_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/ls_dir: get: description: "\n List directories of specified path.\n :param\ \ fs_id: The filesystem identifier.\n :param path: The path where to\ \ start listing the directory content.\n Defaults to '/' if not set.\n\ \ :type path: str | bytes\n :param depth: The number of steps\ \ to go down the directory tree.\n :type depth: int | str\n \ \ :return: The names of the directories below the specified path.\n \ \ :rtype: list\n " parameters: - in: path name: fs_id required: true schema: type: string - allowEmptyValue: true in: query name: path schema: type: string - default: 1 in: query name: depth schema: type: integer responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/mds_counters: get: parameters: - in: path name: fs_id required: true schema: type: string - allowEmptyValue: true in: query name: counters schema: type: integer responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/quota: get: description: "\n Get the quotas of the specified path.\n :param\ \ fs_id: The filesystem identifier.\n :param path: The path of the\ \ directory/file.\n :return: Returns a dictionary containing 'max_bytes'\n\ \ and 'max_files'.\n :rtype: dict\n " parameters: - description: File System Identifier in: path name: fs_id required: true schema: type: string - description: File System Path in: query name: path required: true schema: type: string responses: '200': content: application/json: schema: properties: max_bytes: description: '' type: integer max_files: description: '' type: integer required: &id024 - max_bytes - max_files type: object application/vnd.ceph.api.v1.0+json: schema: properties: max_bytes: description: '' type: integer max_files: description: '' type: integer required: *id024 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Cephfs Quotas of the specified path tags: - Cephfs put: description: "\n Set the quotas of the specified path.\n :param\ \ fs_id: The filesystem identifier.\n :param path: The path of the\ \ directory/file.\n :param max_bytes: The byte limit.\n :param\ \ max_files: The file limit.\n " parameters: - in: path name: fs_id required: true schema: type: string requestBody: content: application/json: schema: properties: max_bytes: type: string max_files: type: string path: type: string required: - path type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/rename-path: put: description: "\n Rename a file or directory.\n :param fs_id: The\ \ filesystem identifier.\n :param src_path: The path to the existing\ \ file or directory.\n :param dst_path: The new name of the file or\ \ directory.\n " parameters: - in: path name: fs_id required: true schema: type: string requestBody: content: application/json: schema: properties: dst_path: type: string src_path: type: string required: - src_path - dst_path type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/snapshot: delete: description: "\n Remove a snapshot.\n :param fs_id: The filesystem\ \ identifier.\n :param path: The path of the directory.\n :param\ \ name: The name of the snapshot.\n " parameters: - in: path name: fs_id required: true schema: type: string - in: query name: path required: true schema: type: string - in: query name: name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs post: description: "\n Create a snapshot.\n :param fs_id: The filesystem\ \ identifier.\n :param path: The path of the directory.\n :param\ \ name: The name of the snapshot. If not specified, a name using the\n \ \ current time in RFC3339 UTC format will be generated.\n :return:\ \ The name of the snapshot.\n :rtype: str\n " parameters: - in: path name: fs_id required: true schema: type: string requestBody: content: application/json: schema: properties: name: type: string path: type: string required: - path type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/statfs: get: description: "\n Get the statfs of the specified path.\n :param\ \ fs_id: The filesystem identifier.\n :param path: The path of the\ \ directory/file.\n :return: Returns a dictionary containing 'bytes',\n\ \ 'files' and 'subdirs'.\n :rtype: dict\n " parameters: - description: File System Identifier in: path name: fs_id required: true schema: type: string - description: File System Path in: query name: path required: true schema: type: string responses: '200': content: application/json: schema: properties: bytes: description: '' type: integer files: description: '' type: integer subdirs: description: '' type: integer required: &id025 - bytes - files - subdirs type: object application/vnd.ceph.api.v1.0+json: schema: properties: bytes: description: '' type: integer files: description: '' type: integer subdirs: description: '' type: integer required: *id025 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Cephfs statfs of the specified path tags: - Cephfs /api/cephfs/{fs_id}/tree: delete: description: "\n Remove a directory.\n :param fs_id: The filesystem\ \ identifier.\n :param path: The path of the directory.\n " parameters: - in: path name: fs_id required: true schema: type: string - in: query name: path required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs post: description: "\n Create a directory.\n :param fs_id: The filesystem\ \ identifier.\n :param path: The path of the directory.\n " parameters: - in: path name: fs_id required: true schema: type: string requestBody: content: application/json: schema: properties: path: type: string required: - path type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/unlink: delete: description: "\n Removes a file, link, or symbolic link.\n :param\ \ fs_id: The filesystem identifier.\n :param path: The path of the\ \ file or link to unlink.\n " parameters: - in: path name: fs_id required: true schema: type: string - in: query name: path required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cephfs/{fs_id}/write_to_file: post: description: "\n Write some data to the specified path.\n :param\ \ fs_id: The filesystem identifier.\n :param path: The path of the\ \ file to write.\n :param buf: The str to write to the buf.\n \ \ " parameters: - in: path name: fs_id required: true schema: type: string requestBody: content: application/json: schema: properties: buf: type: string path: type: string required: - path - buf type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Cephfs /api/cluster: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the cluster status tags: - Cluster put: parameters: [] requestBody: content: application/json: schema: properties: status: description: Cluster Status type: string required: - status type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update the cluster status tags: - Cluster /api/cluster/upgrade: get: parameters: - default: false description: Show all image tags in: query name: tags schema: type: boolean - allowEmptyValue: true description: Ceph Image in: query name: image schema: type: string - default: false description: Show all available versions in: query name: show_all_versions schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the available versions to upgrade tags: - Upgrade /api/cluster/upgrade/pause: put: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Pause the cluster upgrade tags: - Upgrade /api/cluster/upgrade/resume: put: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Resume the cluster upgrade tags: - Upgrade /api/cluster/upgrade/start: post: parameters: [] requestBody: content: application/json: schema: properties: daemon_types: type: string host_placement: type: string image: type: string limit: type: string services: type: string version: type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Start the cluster upgrade tags: - Upgrade /api/cluster/upgrade/status: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the cluster upgrade status tags: - Upgrade /api/cluster/upgrade/stop: put: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Stop the cluster upgrade tags: - Upgrade /api/cluster/user: get: description: "\n Get list of ceph users and its associated data\n \ \ " parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get list of ceph users tags: - Cluster post: description: "\n Add a Ceph user, with its defined capabilities.\n \ \ " parameters: [] requestBody: content: application/json: schema: properties: capabilities: description: List of capabilities to add to user_entity items: properties: cap: description: Capability to add; eg. allow * type: string entity: description: Entity to add type: string required: - entity - cap type: object type: array import_data: default: '' type: string user_entity: default: '' description: Entity to add type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create Ceph User tags: - Cluster put: description: "\n Change the ceph user capabilities.\n Setting\ \ new capabilities will overwrite current ones.\n " parameters: [] requestBody: content: application/json: schema: properties: capabilities: description: List of updated capabilities to user_entity items: properties: cap: description: Capability to edit; eg. allow * type: string entity: description: Entity to edit type: string required: - entity - cap type: object type: array user_entity: default: '' description: Entity to edit type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Edit Ceph User Capabilities tags: - Cluster /api/cluster/user/export: post: parameters: [] requestBody: content: application/json: schema: properties: entities: description: List of entities to export items: type: string type: array required: - entities type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Export Ceph Users tags: - Cluster /api/cluster/user/{user_entities}: delete: description: "\n Delete one or more ceph users and their defined capabilities.\n\ \ user_entities: comma-separated string of users to delete\n \ \ " parameters: - in: path name: user_entities required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete one or more Ceph Users tags: - Cluster /api/cluster_conf: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - ClusterConfiguration post: parameters: [] requestBody: content: application/json: schema: properties: force_update: description: Force update the config option type: boolean name: description: Config option name type: string value: description: Section and Value of the config option items: properties: section: description: Section/Client where config needs to be updated type: string value: description: Value of the config option type: string required: - section - value type: object type: array required: - name - value type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create/Update Cluster Configuration tags: - ClusterConfiguration put: parameters: [] requestBody: content: application/json: schema: properties: options: type: string required: - options type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - ClusterConfiguration /api/cluster_conf/filter: get: parameters: - allowEmptyValue: true description: Config option names in: query name: names schema: type: string responses: '200': content: application/json: schema: items: properties: can_update_at_runtime: description: Check if can update at runtime type: boolean daemon_default: description: Daemon specific default value type: string default: description: Default value for the config option type: string desc: description: Description of the configuration type: string enum_values: description: List of enums allowed items: type: string type: array flags: description: List of flags associated items: type: string type: array level: description: Config option level type: string long_desc: description: Elaborated description type: string max: description: Maximum value type: string min: description: Minimum value type: string name: description: Name of the config option type: string see_also: description: Related config options items: type: string type: array services: description: Services associated with the config option items: type: string type: array tags: description: Tags associated with the cluster items: type: string type: array type: description: Config option type type: string type: object required: &id026 - name - type - level - desc - long_desc - default - daemon_default - tags - services - see_also - enum_values - min - max - can_update_at_runtime - flags type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: can_update_at_runtime: description: Check if can update at runtime type: boolean daemon_default: description: Daemon specific default value type: string default: description: Default value for the config option type: string desc: description: Description of the configuration type: string enum_values: description: List of enums allowed items: type: string type: array flags: description: List of flags associated items: type: string type: array level: description: Config option level type: string long_desc: description: Elaborated description type: string max: description: Maximum value type: string min: description: Minimum value type: string name: description: Name of the config option type: string see_also: description: Related config options items: type: string type: array services: description: Services associated with the config option items: type: string type: array tags: description: Tags associated with the cluster items: type: string type: array type: description: Config option type type: string type: object required: *id026 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Cluster Configuration by name tags: - ClusterConfiguration /api/cluster_conf/{name}: delete: parameters: - in: path name: name required: true schema: type: string - in: query name: section required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - ClusterConfiguration get: parameters: - in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - ClusterConfiguration /api/crush_rule: get: parameters: [] responses: '200': content: application/json: schema: properties: max_size: description: Maximum size of Rule type: integer min_size: description: Minimum size of Rule type: integer rule_id: description: Rule ID type: integer rule_name: description: Rule Name type: string ruleset: description: RuleSet related to the rule type: integer steps: description: Steps included in the rule items: type: object type: array type: description: Type of Rule type: integer required: &id027 - rule_id - rule_name - ruleset - type - min_size - max_size - steps type: object application/vnd.ceph.api.v2.0+json: schema: properties: max_size: description: Maximum size of Rule type: integer min_size: description: Minimum size of Rule type: integer rule_id: description: Rule ID type: integer rule_name: description: Rule Name type: string ruleset: description: RuleSet related to the rule type: integer steps: description: Steps included in the rule items: type: object type: array type: description: Type of Rule type: integer required: *id027 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List Crush Rule Configuration tags: - CrushRule post: parameters: [] requestBody: content: application/json: schema: properties: device_class: type: string failure_domain: type: string name: type: string pool_type: default: replication type: string profile: type: string root: type: string required: - name - failure_domain type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CrushRule /api/crush_rule/{name}: delete: parameters: - in: path name: name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CrushRule get: parameters: - in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v2.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - CrushRule /api/daemon: get: description: "List all daemons in the cluster. Also filter by the daemon types\ \ specified\n\n :param daemon_types: List of daemon types to filter\ \ by.\n :return: Returns list of daemons.\n :rtype: list\n \ \ " parameters: - allowEmptyValue: true in: query name: daemon_types schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Daemon /api/daemon/{daemon_name}: put: parameters: - in: path name: daemon_name required: true schema: type: string requestBody: content: application/json: schema: properties: action: default: '' type: string container_image: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Daemon /api/erasure_code_profile: get: parameters: [] responses: '200': content: application/json: schema: items: properties: crush-failure-domain: description: '' type: string k: description: Number of data chunks type: integer m: description: Number of coding chunks type: integer name: description: Name of the profile type: string plugin: description: Plugin Info type: string technique: description: '' type: string type: object required: &id028 - crush-failure-domain - k - m - plugin - technique - name type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: crush-failure-domain: description: '' type: string k: description: Number of data chunks type: integer m: description: Number of coding chunks type: integer name: description: Name of the profile type: string plugin: description: Plugin Info type: string technique: description: '' type: string type: object required: *id028 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List Erasure Code Profile Information tags: - ErasureCodeProfile post: parameters: [] requestBody: content: application/json: schema: properties: name: type: string required: - name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - ErasureCodeProfile /api/erasure_code_profile/{name}: delete: parameters: - in: path name: name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - ErasureCodeProfile get: parameters: - in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - ErasureCodeProfile /api/feature_toggles: get: parameters: [] responses: '200': content: application/json: schema: properties: cephfs: description: '' type: boolean dashboard: description: '' type: boolean iscsi: description: '' type: boolean mirroring: description: '' type: boolean nfs: description: '' type: boolean rbd: description: '' type: boolean rgw: description: '' type: boolean required: &id029 - rbd - mirroring - iscsi - cephfs - rgw - nfs - dashboard type: object application/vnd.ceph.api.v1.0+json: schema: properties: cephfs: description: '' type: boolean dashboard: description: '' type: boolean iscsi: description: '' type: boolean mirroring: description: '' type: boolean nfs: description: '' type: boolean rbd: description: '' type: boolean rgw: description: '' type: boolean required: *id029 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get List Of Features tags: - FeatureTogglesEndpoint /api/feedback: get: description: "\n List all issues details.\n " parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Report post: description: "\n Create an issue.\n :param project: The affected\ \ ceph component.\n :param tracker: The tracker type.\n :param\ \ subject: The title of the issue.\n :param description: The description\ \ of the issue.\n :param api_key: Ceph tracker api key.\n " parameters: [] requestBody: content: application/json: schema: properties: api_key: type: string description: type: string project: type: string subject: type: string tracker: type: string required: - project - tracker - subject - description type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Report /api/feedback/api_key: delete: description: "\n Deletes Ceph tracker API key.\n " parameters: [] responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Report get: description: "\n Returns Ceph tracker API key.\n " parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Report post: description: "\n Sets Ceph tracker API key.\n :param api_key:\ \ The Ceph tracker API key.\n " parameters: [] requestBody: content: application/json: schema: properties: api_key: type: string required: - api_key type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Report /api/grafana/dashboards: post: parameters: [] responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Grafana /api/grafana/url: get: parameters: [] responses: '200': content: application/json: schema: properties: instance: description: grafana instance type: string required: &id030 - instance type: object application/vnd.ceph.api.v1.0+json: schema: properties: instance: description: grafana instance type: string required: *id030 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List Grafana URL Instance tags: - Grafana /api/grafana/validation/{params}: get: parameters: - in: path name: params required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Grafana /api/hardware/summary: get: description: "\n Get the health status of as many hardware categories,\ \ or all of them if none is given\n :param categories: The hardware\ \ type, all of them by default\n :param hostname: The host to retrieve\ \ from, all of them by default\n " parameters: - allowEmptyValue: true in: query name: categories schema: type: string - allowEmptyValue: true in: query name: hostname schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Retrieve a summary of the hardware health status tags: - Hardware /api/health/full: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Cluster's detailed health report tags: - Health /api/health/get_cluster_capacity: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Health /api/health/get_cluster_fsid: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Health /api/health/get_telemetry_status: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Health /api/health/minimal: get: parameters: [] responses: '200': content: application/json: schema: properties: client_perf: description: '' properties: read_bytes_sec: description: '' type: integer read_op_per_sec: description: '' type: integer recovering_bytes_per_sec: description: '' type: integer write_bytes_sec: description: '' type: integer write_op_per_sec: description: '' type: integer required: &id031 - read_bytes_sec - read_op_per_sec - recovering_bytes_per_sec - write_bytes_sec - write_op_per_sec type: object df: description: '' properties: stats: description: '' properties: total_avail_bytes: description: '' type: integer total_bytes: description: '' type: integer total_used_raw_bytes: description: '' type: integer required: &id032 - total_avail_bytes - total_bytes - total_used_raw_bytes type: object required: &id033 - stats type: object fs_map: description: '' properties: filesystems: description: '' items: properties: mdsmap: description: '' properties: balancer: description: '' type: string btime: description: '' type: string compat: description: '' properties: compat: description: '' type: string incompat: description: '' type: string ro_compat: description: '' type: string required: &id034 - compat - ro_compat - incompat type: object created: description: '' type: string damaged: description: '' items: type: integer type: array data_pools: description: '' items: type: integer type: array enabled: description: '' type: boolean epoch: description: '' type: integer ever_allowed_features: description: '' type: integer explicitly_allowed_features: description: '' type: integer failed: description: '' items: type: integer type: array flags: description: '' type: integer fs_name: description: '' type: string in: description: '' items: type: integer type: array info: description: '' type: string last_failure: description: '' type: integer last_failure_osd_epoch: description: '' type: integer max_file_size: description: '' type: integer max_mds: description: '' type: integer metadata_pool: description: '' type: integer modified: description: '' type: string required_client_features: description: '' type: string root: description: '' type: integer session_autoclose: description: '' type: integer session_timeout: description: '' type: integer standby_count_wanted: description: '' type: integer stopped: description: '' items: type: integer type: array tableserver: description: '' type: integer up: description: '' type: string required: &id035 - session_autoclose - balancer - up - last_failure_osd_epoch - in - last_failure - max_file_size - explicitly_allowed_features - damaged - tableserver - failed - metadata_pool - epoch - btime - stopped - max_mds - compat - required_client_features - data_pools - info - fs_name - created - standby_count_wanted - enabled - modified - session_timeout - flags - ever_allowed_features - root type: object standbys: description: '' type: string required: &id036 - mdsmap - standbys type: object type: array required: &id037 - filesystems type: object health: description: '' properties: checks: description: '' type: string mutes: description: '' type: string status: description: '' type: string required: &id038 - checks - mutes - status type: object hosts: description: '' type: integer iscsi_daemons: description: '' properties: down: description: '' type: integer up: description: '' type: integer required: &id039 - up - down type: object mgr_map: description: '' properties: active_name: description: '' type: string standbys: description: '' type: string required: &id040 - active_name - standbys type: object mon_status: description: '' properties: monmap: description: '' properties: mons: description: '' type: string required: &id041 - mons type: object quorum: description: '' items: type: integer type: array required: &id042 - monmap - quorum type: object osd_map: description: '' properties: osds: description: '' items: properties: in: description: '' type: integer up: description: '' type: integer required: &id043 - in - up type: object type: array required: &id044 - osds type: object pg_info: description: '' properties: object_stats: description: '' properties: num_object_copies: description: '' type: integer num_objects: description: '' type: integer num_objects_degraded: description: '' type: integer num_objects_misplaced: description: '' type: integer num_objects_unfound: description: '' type: integer required: &id045 - num_objects - num_object_copies - num_objects_degraded - num_objects_misplaced - num_objects_unfound type: object pgs_per_osd: description: '' type: integer statuses: description: '' type: string required: &id046 - object_stats - pgs_per_osd - statuses type: object pools: description: '' type: string rgw: description: '' type: integer scrub_status: description: '' type: string required: &id047 - client_perf - df - fs_map - health - hosts - iscsi_daemons - mgr_map - mon_status - osd_map - pg_info - pools - rgw - scrub_status type: object application/vnd.ceph.api.v1.0+json: schema: properties: client_perf: description: '' properties: read_bytes_sec: description: '' type: integer read_op_per_sec: description: '' type: integer recovering_bytes_per_sec: description: '' type: integer write_bytes_sec: description: '' type: integer write_op_per_sec: description: '' type: integer required: *id031 type: object df: description: '' properties: stats: description: '' properties: total_avail_bytes: description: '' type: integer total_bytes: description: '' type: integer total_used_raw_bytes: description: '' type: integer required: *id032 type: object required: *id033 type: object fs_map: description: '' properties: filesystems: description: '' items: properties: mdsmap: description: '' properties: balancer: description: '' type: string btime: description: '' type: string compat: description: '' properties: compat: description: '' type: string incompat: description: '' type: string ro_compat: description: '' type: string required: *id034 type: object created: description: '' type: string damaged: description: '' items: type: integer type: array data_pools: description: '' items: type: integer type: array enabled: description: '' type: boolean epoch: description: '' type: integer ever_allowed_features: description: '' type: integer explicitly_allowed_features: description: '' type: integer failed: description: '' items: type: integer type: array flags: description: '' type: integer fs_name: description: '' type: string in: description: '' items: type: integer type: array info: description: '' type: string last_failure: description: '' type: integer last_failure_osd_epoch: description: '' type: integer max_file_size: description: '' type: integer max_mds: description: '' type: integer metadata_pool: description: '' type: integer modified: description: '' type: string required_client_features: description: '' type: string root: description: '' type: integer session_autoclose: description: '' type: integer session_timeout: description: '' type: integer standby_count_wanted: description: '' type: integer stopped: description: '' items: type: integer type: array tableserver: description: '' type: integer up: description: '' type: string required: *id035 type: object standbys: description: '' type: string required: *id036 type: object type: array required: *id037 type: object health: description: '' properties: checks: description: '' type: string mutes: description: '' type: string status: description: '' type: string required: *id038 type: object hosts: description: '' type: integer iscsi_daemons: description: '' properties: down: description: '' type: integer up: description: '' type: integer required: *id039 type: object mgr_map: description: '' properties: active_name: description: '' type: string standbys: description: '' type: string required: *id040 type: object mon_status: description: '' properties: monmap: description: '' properties: mons: description: '' type: string required: *id041 type: object quorum: description: '' items: type: integer type: array required: *id042 type: object osd_map: description: '' properties: osds: description: '' items: properties: in: description: '' type: integer up: description: '' type: integer required: *id043 type: object type: array required: *id044 type: object pg_info: description: '' properties: object_stats: description: '' properties: num_object_copies: description: '' type: integer num_objects: description: '' type: integer num_objects_degraded: description: '' type: integer num_objects_misplaced: description: '' type: integer num_objects_unfound: description: '' type: integer required: *id045 type: object pgs_per_osd: description: '' type: integer statuses: description: '' type: string required: *id046 type: object pools: description: '' type: string rgw: description: '' type: integer scrub_status: description: '' type: string required: *id047 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Cluster's health report with lesser details tags: - Health /api/health/snapshot: get: parameters: [] responses: '200': content: application/json: schema: properties: fsid: description: Cluster filesystem ID type: string fsmap: description: Filesystem map details properties: num_active: description: Number of active mds type: integer num_standbys: description: Standby MDS count type: integer required: &id048 - num_active - num_standbys type: object health: description: Cluster health overview properties: checks: description: Health checks keyed by name properties: : description: Individual health check object properties: muted: description: Whether the check is muted type: boolean severity: description: Health severity level type: string summary: description: Summary details properties: count: description: Occurrence count type: integer message: description: Human-readable summary type: string required: &id049 - message - count type: object required: &id050 - severity - summary - muted type: object required: &id051 - type: object mutes: description: List of muted check names items: type: string type: array status: description: Overall health status type: string required: &id052 - status - checks - mutes type: object mgrmap: description: Manager map details properties: num_active: description: Number of active managers type: integer num_standbys: description: Standby manager count type: integer required: &id053 - num_active - num_standbys type: object monmap: description: Monitor map details properties: num_mons: description: Number of monitors type: integer quorum: description: List of monitors in quorum items: type: integer type: array required: &id054 - num_mons - quorum type: object num_hosts: description: Count of hosts type: integer num_hosts_available: description: Count of available hosts type: integer num_iscsi_gateways: description: Iscsi gateways status properties: down: description: Count of iSCSI gateways not running type: integer up: description: Count of iSCSI gateways running type: integer required: &id055 - up - down type: object num_rgw_gateways: description: Count of RGW gateway daemons running type: integer osdmap: description: OSD map details properties: in: description: Number of OSDs in type: integer num_osds: description: Total OSD count type: integer up: description: Number of OSDs up type: integer required: &id056 - in - up - num_osds type: object pgmap: description: Placement group map details properties: bytes_total: description: Total capacity in bytes type: integer bytes_used: description: Used capacity in bytes type: integer num_pgs: description: Total PG count type: integer num_pools: description: Number of pools type: integer pgs_by_state: description: List of PG counts by state items: properties: count: description: Count of PGs in this state type: integer state_name: description: Placement group state type: string required: &id057 - state_name - count type: object type: array recovering_bytes_per_sec: description: Total recovery in bytes type: integer required: &id058 - pgs_by_state - num_pools - num_pgs - bytes_used - bytes_total - recovering_bytes_per_sec type: object required: &id059 - fsid - health - monmap - osdmap - pgmap - mgrmap - fsmap - num_rgw_gateways - num_iscsi_gateways - num_hosts - num_hosts_available type: object application/vnd.ceph.api.v1.0+json: schema: properties: fsid: description: Cluster filesystem ID type: string fsmap: description: Filesystem map details properties: num_active: description: Number of active mds type: integer num_standbys: description: Standby MDS count type: integer required: *id048 type: object health: description: Cluster health overview properties: checks: description: Health checks keyed by name properties: : description: Individual health check object properties: muted: description: Whether the check is muted type: boolean severity: description: Health severity level type: string summary: description: Summary details properties: count: description: Occurrence count type: integer message: description: Human-readable summary type: string required: *id049 type: object required: *id050 type: object required: *id051 type: object mutes: description: List of muted check names items: type: string type: array status: description: Overall health status type: string required: *id052 type: object mgrmap: description: Manager map details properties: num_active: description: Number of active managers type: integer num_standbys: description: Standby manager count type: integer required: *id053 type: object monmap: description: Monitor map details properties: num_mons: description: Number of monitors type: integer quorum: description: List of monitors in quorum items: type: integer type: array required: *id054 type: object num_hosts: description: Count of hosts type: integer num_hosts_available: description: Count of available hosts type: integer num_iscsi_gateways: description: Iscsi gateways status properties: down: description: Count of iSCSI gateways not running type: integer up: description: Count of iSCSI gateways running type: integer required: *id055 type: object num_rgw_gateways: description: Count of RGW gateway daemons running type: integer osdmap: description: OSD map details properties: in: description: Number of OSDs in type: integer num_osds: description: Total OSD count type: integer up: description: Number of OSDs up type: integer required: *id056 type: object pgmap: description: Placement group map details properties: bytes_total: description: Total capacity in bytes type: integer bytes_used: description: Used capacity in bytes type: integer num_pgs: description: Total PG count type: integer num_pools: description: Number of pools type: integer pgs_by_state: description: List of PG counts by state items: properties: count: description: Count of PGs in this state type: integer state_name: description: Placement group state type: string required: *id057 type: object type: array recovering_bytes_per_sec: description: Total recovery in bytes type: integer required: *id058 type: object required: *id059 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get a quick overview of cluster health at a moment, analogous to the ceph status command in CLI. tags: - Health /api/host: get: parameters: - allowEmptyValue: true description: Host Sources in: query name: sources schema: type: string - default: false description: Host Facts in: query name: facts schema: type: boolean - default: 0 in: query name: offset schema: type: integer - default: 5 in: query name: limit schema: type: integer - default: '' in: query name: search schema: type: string - default: '' in: query name: sort schema: type: string - default: true description: Include Service Instances in: query name: include_service_instances schema: type: boolean responses: '200': content: application/json: schema: properties: addr: description: Host address type: string ceph_version: description: Ceph version type: string hostname: description: Hostname type: string labels: description: Labels related to the host items: type: string type: array service_instances: description: Service instances related to the host items: properties: count: description: Number of instances of the service type: integer type: description: type of service type: string required: &id060 - type - count type: object type: array service_type: description: '' type: string services: description: Services related to the host items: properties: id: description: Service Id type: string type: description: type of service type: string required: &id061 - type - id type: object type: array sources: description: Host Sources properties: ceph: description: '' type: boolean orchestrator: description: '' type: boolean required: &id062 - ceph - orchestrator type: object status: description: '' type: string required: &id063 - hostname - services - service_instances - ceph_version - addr - labels - service_type - sources - status type: object application/vnd.ceph.api.v1.3+json: schema: properties: addr: description: Host address type: string ceph_version: description: Ceph version type: string hostname: description: Hostname type: string labels: description: Labels related to the host items: type: string type: array service_instances: description: Service instances related to the host items: properties: count: description: Number of instances of the service type: integer type: description: type of service type: string required: *id060 type: object type: array service_type: description: '' type: string services: description: Services related to the host items: properties: id: description: Service Id type: string type: description: type of service type: string required: *id061 type: object type: array sources: description: Host Sources properties: ceph: description: '' type: boolean orchestrator: description: '' type: boolean required: *id062 type: object status: description: '' type: string required: *id063 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List Host Specifications tags: - Host post: parameters: [] requestBody: content: application/json: schema: properties: addr: description: Network Address type: string hostname: description: Hostname type: string labels: description: Host Labels items: type: string type: array status: description: Host Status type: string required: - hostname type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host /api/host/{hostname}: delete: parameters: - in: path name: hostname required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host get: description: "\n Get the specified host.\n :raises: cherrypy.HTTPError:\ \ If host not found.\n " parameters: - in: path name: hostname required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.2+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host put: description: "\n Update the specified host.\n Note, this is only\ \ supported when Ceph Orchestrator is enabled.\n :param hostname: The\ \ name of the host to be processed.\n :param update_labels: To update\ \ the labels.\n :param labels: List of labels.\n :param maintenance:\ \ Enter/Exit maintenance mode.\n :param force: Force enter maintenance\ \ mode.\n :param drain: Drain host\n " parameters: - description: Hostname in: path name: hostname required: true schema: type: string requestBody: content: application/json: schema: properties: drain: default: false description: Drain Host type: boolean force: default: false description: Force Enter Maintenance type: boolean labels: description: Host Labels items: type: string type: array maintenance: default: false description: Enter/Exit Maintenance type: boolean update_labels: default: false description: Update Labels type: boolean type: object responses: '200': content: application/json: schema: properties: {} type: object application/vnd.ceph.api.v0.1+json: schema: properties: {} type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host /api/host/{hostname}/daemons: get: parameters: - in: path name: hostname required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host /api/host/{hostname}/devices: get: parameters: - in: path name: hostname required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host /api/host/{hostname}/identify_device: post: description: "\n Identify a device by switching on the device light for\ \ N seconds.\n :param hostname: The hostname of the device to process.\n\ \ :param device: The device identifier to process, e.g. ``/dev/dm-0``\ \ or\n ``ABC1234DEF567-1R1234_ABC8DE0Q``.\n :param duration:\ \ The duration in seconds how long the LED should flash.\n " parameters: - in: path name: hostname required: true schema: type: string requestBody: content: application/json: schema: properties: device: type: string duration: type: string required: - device - duration type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host /api/host/{hostname}/inventory: get: parameters: - description: Hostname in: path name: hostname required: true schema: type: string - allowEmptyValue: true description: Trigger asynchronous refresh in: query name: refresh schema: type: string responses: '200': content: application/json: schema: properties: addr: description: Host address type: string devices: description: Host devices items: properties: available: description: If the device can be provisioned to an OSD type: boolean device_id: description: Device's udev ID type: string human_readable_type: description: Device type. ssd or hdd type: string lsm_data: description: '' properties: errors: description: '' items: type: string type: array health: description: '' type: string ledSupport: description: '' properties: FAILstatus: description: '' type: string FAILsupport: description: '' type: string IDENTstatus: description: '' type: string IDENTsupport: description: '' type: string required: &id064 - IDENTsupport - IDENTstatus - FAILsupport - FAILstatus type: object linkSpeed: description: '' type: string mediaType: description: '' type: string rpm: description: '' type: string serialNum: description: '' type: string transport: description: '' type: string required: &id065 - serialNum - transport - mediaType - rpm - linkSpeed - health - ledSupport - errors type: object lvs: description: '' items: properties: block_uuid: description: '' type: string cluster_fsid: description: '' type: string cluster_name: description: '' type: string name: description: '' type: string osd_fsid: description: '' type: string osd_id: description: '' type: string osdspec_affinity: description: '' type: string type: description: '' type: string required: &id066 - name - osd_id - cluster_name - type - osd_fsid - cluster_fsid - osdspec_affinity - block_uuid type: object type: array osd_ids: description: Device OSD IDs items: type: integer type: array path: description: Device path type: string rejected_reasons: description: '' items: type: string type: array sys_api: description: '' properties: human_readable_size: description: '' type: string locked: description: '' type: integer model: description: '' type: string nr_requests: description: '' type: string partitions: description: '' properties: partition_name: description: '' properties: holders: description: '' items: type: string type: array human_readable_size: description: '' type: string sectors: description: '' type: string sectorsize: description: '' type: integer size: description: '' type: integer start: description: '' type: string required: &id067 - start - sectors - sectorsize - size - human_readable_size - holders type: object required: &id068 - partition_name type: object path: description: '' type: string removable: description: '' type: string rev: description: '' type: string ro: description: '' type: string rotational: description: '' type: string sas_address: description: '' type: string sas_device_handle: description: '' type: string scheduler_mode: description: '' type: string sectors: description: '' type: integer sectorsize: description: '' type: string size: description: '' type: integer support_discard: description: '' type: string vendor: description: '' type: string required: &id069 - removable - ro - vendor - model - rev - sas_address - sas_device_handle - support_discard - rotational - nr_requests - scheduler_mode - partitions - sectors - sectorsize - size - human_readable_size - path - locked type: object required: &id070 - rejected_reasons - available - path - sys_api - lvs - human_readable_type - device_id - lsm_data - osd_ids type: object type: array labels: description: Host labels items: type: string type: array name: description: Hostname type: string required: &id071 - name - addr - devices - labels type: object application/vnd.ceph.api.v1.0+json: schema: properties: addr: description: Host address type: string devices: description: Host devices items: properties: available: description: If the device can be provisioned to an OSD type: boolean device_id: description: Device's udev ID type: string human_readable_type: description: Device type. ssd or hdd type: string lsm_data: description: '' properties: errors: description: '' items: type: string type: array health: description: '' type: string ledSupport: description: '' properties: FAILstatus: description: '' type: string FAILsupport: description: '' type: string IDENTstatus: description: '' type: string IDENTsupport: description: '' type: string required: *id064 type: object linkSpeed: description: '' type: string mediaType: description: '' type: string rpm: description: '' type: string serialNum: description: '' type: string transport: description: '' type: string required: *id065 type: object lvs: description: '' items: properties: block_uuid: description: '' type: string cluster_fsid: description: '' type: string cluster_name: description: '' type: string name: description: '' type: string osd_fsid: description: '' type: string osd_id: description: '' type: string osdspec_affinity: description: '' type: string type: description: '' type: string required: *id066 type: object type: array osd_ids: description: Device OSD IDs items: type: integer type: array path: description: Device path type: string rejected_reasons: description: '' items: type: string type: array sys_api: description: '' properties: human_readable_size: description: '' type: string locked: description: '' type: integer model: description: '' type: string nr_requests: description: '' type: string partitions: description: '' properties: partition_name: description: '' properties: holders: description: '' items: type: string type: array human_readable_size: description: '' type: string sectors: description: '' type: string sectorsize: description: '' type: integer size: description: '' type: integer start: description: '' type: string required: *id067 type: object required: *id068 type: object path: description: '' type: string removable: description: '' type: string rev: description: '' type: string ro: description: '' type: string rotational: description: '' type: string sas_address: description: '' type: string sas_device_handle: description: '' type: string scheduler_mode: description: '' type: string sectors: description: '' type: integer sectorsize: description: '' type: string size: description: '' type: integer support_discard: description: '' type: string vendor: description: '' type: string required: *id069 type: object required: *id070 type: object type: array labels: description: Host labels items: type: string type: array name: description: Hostname type: string required: *id071 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get inventory of a host tags: - Host /api/host/{hostname}/smart: get: parameters: - in: path name: hostname required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Host /api/iscsi/discoveryauth: get: parameters: [] responses: '200': content: application/json: schema: items: properties: mutual_password: description: '' type: string mutual_user: description: '' type: string password: description: password type: string user: description: username type: string type: object required: &id072 - user - password - mutual_user - mutual_password type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: mutual_password: description: '' type: string mutual_user: description: '' type: string password: description: password type: string user: description: username type: string type: object required: *id072 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Iscsi discoveryauth Details tags: - Iscsi put: parameters: - description: Username in: query name: user required: true schema: type: string - description: Password in: query name: password required: true schema: type: string - description: Mutual UserName in: query name: mutual_user required: true schema: type: string - description: Mutual Password in: query name: mutual_password required: true schema: type: string requestBody: content: application/json: schema: properties: mutual_password: description: Mutual Password type: string mutual_user: description: Mutual UserName type: string password: description: Password type: string user: description: Username type: string required: - user - password - mutual_user - mutual_password type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Set Iscsi discoveryauth tags: - Iscsi /api/iscsi/target: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - IscsiTarget post: parameters: [] requestBody: content: application/json: schema: properties: acl_enabled: type: string auth: type: string clients: type: string disks: type: string groups: type: string portals: type: string target_controls: type: string target_iqn: type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - IscsiTarget /api/iscsi/target/{target_iqn}: delete: parameters: - in: path name: target_iqn required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - IscsiTarget get: parameters: - in: path name: target_iqn required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - IscsiTarget put: parameters: - in: path name: target_iqn required: true schema: type: string requestBody: content: application/json: schema: properties: acl_enabled: type: string auth: type: string clients: type: string disks: type: string groups: type: string new_target_iqn: type: string portals: type: string target_controls: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - IscsiTarget /api/logs/all: get: parameters: [] responses: '200': content: application/json: schema: properties: audit_log: description: Audit log items: properties: addrs: description: '' properties: addrvec: description: '' items: properties: addr: description: IP Address type: string nonce: description: '' type: integer type: description: '' type: string required: &id073 - type - addr - nonce type: object type: array required: &id074 - addrvec type: object channel: description: '' type: string message: description: '' type: string name: description: '' type: string priority: description: '' type: string rank: description: '' type: string seq: description: '' type: integer stamp: description: '' type: string required: &id075 - name - rank - addrs - stamp - seq - channel - priority - message type: object type: array clog: description: '' items: type: string type: array required: &id076 - clog - audit_log type: object application/vnd.ceph.api.v1.0+json: schema: properties: audit_log: description: Audit log items: properties: addrs: description: '' properties: addrvec: description: '' items: properties: addr: description: IP Address type: string nonce: description: '' type: integer type: description: '' type: string required: *id073 type: object type: array required: *id074 type: object channel: description: '' type: string message: description: '' type: string name: description: '' type: string priority: description: '' type: string rank: description: '' type: string seq: description: '' type: integer stamp: description: '' type: string required: *id075 type: object type: array clog: description: '' items: type: string type: array required: *id076 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Logs Configuration tags: - Logs /api/mgr/module: get: description: "\n Get the list of managed modules.\n :return: A\ \ list of objects with the fields 'enabled', 'name' and 'options'.\n \ \ :rtype: list\n " parameters: [] responses: '200': content: application/json: schema: items: properties: always_on: description: Is it an always on module? type: boolean enabled: description: Is Module Enabled type: boolean name: description: Module Name type: string options: description: Module Options properties: Option_name: description: Options properties: default_value: description: Default value for the option type: integer desc: description: Description of the option type: string enum_allowed: description: '' items: type: string type: array flags: description: List of flags associated type: integer level: description: Option level type: string long_desc: description: Elaborated description type: string max: description: Maximum value type: string min: description: Minimum value type: string name: description: Name of the option type: string see_also: description: Related options items: type: string type: array tags: description: Tags associated with the option items: type: string type: array type: description: Type of the option type: string required: &id077 - name - type - level - flags - default_value - min - max - enum_allowed - desc - long_desc - tags - see_also type: object required: &id078 - Option_name type: object type: object required: &id079 - name - enabled - always_on - options type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: always_on: description: Is it an always on module? type: boolean enabled: description: Is Module Enabled type: boolean name: description: Module Name type: string options: description: Module Options properties: Option_name: description: Options properties: default_value: description: Default value for the option type: integer desc: description: Description of the option type: string enum_allowed: description: '' items: type: string type: array flags: description: List of flags associated type: integer level: description: Option level type: string long_desc: description: Elaborated description type: string max: description: Maximum value type: string min: description: Minimum value type: string name: description: Name of the option type: string see_also: description: Related options items: type: string type: array tags: description: Tags associated with the option items: type: string type: array type: description: Type of the option type: string required: *id077 type: object required: *id078 type: object type: object required: *id079 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List Mgr modules tags: - MgrModule /api/mgr/module/{module_name}: get: description: "\n Retrieve the values of the persistent configuration\ \ settings.\n :param module_name: The name of the Ceph Mgr module.\n\ \ :type module_name: str\n :return: The values of the module\ \ options.\n :rtype: dict\n " parameters: - in: path name: module_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MgrModule put: description: "\n Set the values of the persistent configuration settings.\n\ \ :param module_name: The name of the Ceph Mgr module.\n :type\ \ module_name: str\n :param config: The values of the module options\ \ to be stored.\n :type config: dict\n " parameters: - in: path name: module_name required: true schema: type: string requestBody: content: application/json: schema: properties: config: type: string required: - config type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MgrModule /api/mgr/module/{module_name}/disable: post: description: "\n Disable the specified Ceph Mgr module.\n :param\ \ module_name: The name of the Ceph Mgr module.\n :type module_name:\ \ str\n " parameters: - in: path name: module_name required: true schema: type: string responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MgrModule /api/mgr/module/{module_name}/enable: post: description: "\n Enable the specified Ceph Mgr module.\n :param\ \ module_name: The name of the Ceph Mgr module.\n :type module_name:\ \ str\n " parameters: - in: path name: module_name required: true schema: type: string responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MgrModule /api/mgr/module/{module_name}/options: get: description: "\n Get the module options of the specified Ceph Mgr module.\n\ \ :param module_name: The name of the Ceph Mgr module.\n :type\ \ module_name: str\n :return: The module options as list of dicts.\n\ \ :rtype: list\n " parameters: - in: path name: module_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MgrModule /api/monitor: get: parameters: [] responses: '200': content: application/json: schema: properties: in_quorum: description: '' items: properties: addr: description: '' type: string name: description: '' type: string priority: description: '' type: integer public_addr: description: '' type: string public_addrs: description: '' properties: addrvec: description: '' items: properties: addr: description: '' type: string nonce: description: '' type: integer type: description: '' type: string required: &id080 - type - addr - nonce type: object type: array required: &id081 - addrvec type: object rank: description: '' type: integer stats: description: '' properties: num_sessions: description: '' items: type: integer type: array required: &id082 - num_sessions type: object weight: description: '' type: integer required: &id083 - rank - name - public_addrs - addr - public_addr - priority - weight - stats type: object type: array mon_status: description: '' properties: election_epoch: description: '' type: integer extra_probe_peers: description: '' items: type: string type: array feature_map: description: '' properties: client: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: &id084 - features - release - num type: object type: array mds: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: &id085 - features - release - num type: object type: array mgr: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: &id086 - features - release - num type: object type: array mon: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: &id087 - features - release - num type: object type: array required: &id088 - mon - mds - client - mgr type: object features: description: '' properties: quorum_con: description: '' type: string quorum_mon: description: '' items: type: string type: array required_con: description: '' type: string required_mon: description: '' items: type: integer type: array required: &id089 - required_con - required_mon - quorum_con - quorum_mon type: object monmap: description: '' properties: created: description: '' type: string epoch: description: '' type: integer features: description: '' properties: optional: description: '' items: type: string type: array persistent: description: '' items: type: string type: array required: &id090 - persistent - optional type: object fsid: description: '' type: string min_mon_release: description: '' type: integer min_mon_release_name: description: '' type: string modified: description: '' type: string mons: description: '' items: properties: addr: description: '' type: string name: description: '' type: string priority: description: '' type: integer public_addr: description: '' type: string public_addrs: description: '' properties: addrvec: description: '' items: properties: addr: description: '' type: string nonce: description: '' type: integer type: description: '' type: string required: &id091 - type - addr - nonce type: object type: array required: &id092 - addrvec type: object rank: description: '' type: integer stats: description: '' properties: num_sessions: description: '' items: type: integer type: array required: &id093 - num_sessions type: object weight: description: '' type: integer required: &id094 - rank - name - public_addrs - addr - public_addr - priority - weight - stats type: object type: array required: &id095 - epoch - fsid - modified - created - min_mon_release - min_mon_release_name - features - mons type: object name: description: '' type: string outside_quorum: description: '' items: type: string type: array quorum: description: '' items: type: integer type: array quorum_age: description: '' type: integer rank: description: '' type: integer state: description: '' type: string sync_provider: description: '' items: type: string type: array required: &id096 - name - rank - state - election_epoch - quorum - quorum_age - features - outside_quorum - extra_probe_peers - sync_provider - monmap - feature_map type: object out_quorum: description: '' items: type: integer type: array required: &id097 - mon_status - in_quorum - out_quorum type: object application/vnd.ceph.api.v1.0+json: schema: properties: in_quorum: description: '' items: properties: addr: description: '' type: string name: description: '' type: string priority: description: '' type: integer public_addr: description: '' type: string public_addrs: description: '' properties: addrvec: description: '' items: properties: addr: description: '' type: string nonce: description: '' type: integer type: description: '' type: string required: *id080 type: object type: array required: *id081 type: object rank: description: '' type: integer stats: description: '' properties: num_sessions: description: '' items: type: integer type: array required: *id082 type: object weight: description: '' type: integer required: *id083 type: object type: array mon_status: description: '' properties: election_epoch: description: '' type: integer extra_probe_peers: description: '' items: type: string type: array feature_map: description: '' properties: client: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: *id084 type: object type: array mds: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: *id085 type: object type: array mgr: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: *id086 type: object type: array mon: description: '' items: properties: features: description: '' type: string num: description: '' type: integer release: description: '' type: string required: *id087 type: object type: array required: *id088 type: object features: description: '' properties: quorum_con: description: '' type: string quorum_mon: description: '' items: type: string type: array required_con: description: '' type: string required_mon: description: '' items: type: integer type: array required: *id089 type: object monmap: description: '' properties: created: description: '' type: string epoch: description: '' type: integer features: description: '' properties: optional: description: '' items: type: string type: array persistent: description: '' items: type: string type: array required: *id090 type: object fsid: description: '' type: string min_mon_release: description: '' type: integer min_mon_release_name: description: '' type: string modified: description: '' type: string mons: description: '' items: properties: addr: description: '' type: string name: description: '' type: string priority: description: '' type: integer public_addr: description: '' type: string public_addrs: description: '' properties: addrvec: description: '' items: properties: addr: description: '' type: string nonce: description: '' type: integer type: description: '' type: string required: *id091 type: object type: array required: *id092 type: object rank: description: '' type: integer stats: description: '' properties: num_sessions: description: '' items: type: integer type: array required: *id093 type: object weight: description: '' type: integer required: *id094 type: object type: array required: *id095 type: object name: description: '' type: string outside_quorum: description: '' items: type: string type: array quorum: description: '' items: type: integer type: array quorum_age: description: '' type: integer rank: description: '' type: integer state: description: '' type: string sync_provider: description: '' items: type: string type: array required: *id096 type: object out_quorum: description: '' items: type: integer type: array required: *id097 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Monitor Details tags: - Monitor /api/multi-cluster/auth: post: parameters: [] requestBody: content: application/json: schema: properties: cluster_alias: type: string hub_url: type: string password: type: string ssl_certificate: type: string ssl_verify: default: false type: boolean ttl: type: string url: type: string username: type: string required: - url - cluster_alias - username type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Authenticate to a remote cluster tags: - Multi-cluster /api/multi-cluster/check_token_status: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/multi-cluster/delete_cluster/{cluster_name}/{cluster_user}: delete: parameters: - in: path name: cluster_name required: true schema: type: string - in: path name: cluster_user required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/multi-cluster/edit_cluster: put: parameters: [] requestBody: content: application/json: schema: properties: cluster_alias: type: string name: type: string ssl_certificate: type: string url: type: string username: type: string verify: default: false type: boolean required: - name - url - cluster_alias - username type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/multi-cluster/get_config: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/multi-cluster/get_prometheus_api_url: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/multi-cluster/reconnect_cluster: put: parameters: [] requestBody: content: application/json: schema: properties: cluster_token: type: string password: type: string ssl_certificate: type: string ssl_verify: default: false type: boolean ttl: type: string url: type: string username: type: string required: - url type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/multi-cluster/security_config: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/multi-cluster/set_config: put: parameters: [] requestBody: content: application/json: schema: properties: config: type: string required: - config type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Multi-cluster /api/nfs-ganesha/cluster: get: parameters: - default: false in: query name: info schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - NFS-Ganesha /api/nfs-ganesha/export: get: parameters: - allowEmptyValue: true in: query name: cluster_id schema: type: string responses: '200': content: application/json: schema: items: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: &id098 - addresses - access_type - squash type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: &id099 - name type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array type: object required: &id100 - export_id - path - cluster_id - pseudo - access_type - squash - security_label - protocols - transports - fsal - clients type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: *id098 type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: *id099 type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array type: object required: *id100 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all or cluster specific NFS-Ganesha exports tags: - NFS-Ganesha post: parameters: [] requestBody: content: application/json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: - addresses - access_type - squash type: object type: array cluster_id: description: Cluster identifier type: string fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string required: - name type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: - path - cluster_id - pseudo - access_type - squash - security_label - protocols - transports - fsal - clients type: object responses: '201': content: application/json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: &id101 - addresses - access_type - squash type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: &id102 - name type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: &id103 - export_id - path - cluster_id - pseudo - access_type - squash - security_label - protocols - transports - fsal - clients type: object application/vnd.ceph.api.v2.0+json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: *id101 type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: *id102 type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: *id103 type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v2.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Creates a new NFS-Ganesha export tags: - NFS-Ganesha /api/nfs-ganesha/export/{cluster_id}/{export_id}: delete: parameters: - description: Cluster identifier in: path name: cluster_id required: true schema: type: string - description: Export ID in: path name: export_id required: true schema: type: integer responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v2.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v2.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Deletes an NFS-Ganesha export tags: - NFS-Ganesha get: parameters: - description: Cluster identifier in: path name: cluster_id required: true schema: type: string - description: Export ID in: path name: export_id required: true schema: type: string responses: '200': content: application/json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: &id104 - addresses - access_type - squash type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: &id105 - name type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: &id106 - export_id - path - cluster_id - pseudo - access_type - squash - security_label - protocols - transports - fsal - clients type: object application/vnd.ceph.api.v1.0+json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: *id104 type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: *id105 type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: *id106 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get an NFS-Ganesha export tags: - NFS-Ganesha put: parameters: - description: Cluster identifier in: path name: cluster_id required: true schema: type: string - description: Export ID in: path name: export_id required: true schema: type: integer requestBody: content: application/json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: - addresses - access_type - squash type: object type: array fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string required: - name type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: - path - pseudo - access_type - squash - security_label - protocols - transports - fsal - clients type: object responses: '200': content: application/json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: &id107 - addresses - access_type - squash type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: &id108 - name type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: &id109 - export_id - path - cluster_id - pseudo - access_type - squash - security_label - protocols - transports - fsal - clients type: object application/vnd.ceph.api.v2.0+json: schema: properties: access_type: description: Export access type type: string clients: description: List of client configurations items: properties: access_type: description: Client access type type: string addresses: description: list of IP addresses items: type: string type: array squash: description: Client squash policy type: string required: *id107 type: object type: array cluster_id: description: Cluster identifier type: string export_id: description: Export ID type: integer fsal: description: FSAL configuration properties: fs_name: description: CephFS filesystem name type: string name: description: name of FSAL type: string sec_label_xattr: description: Name of xattr for security label type: string user_id: description: User id type: string required: *id108 type: object path: description: Export path type: string protocols: description: List of protocol types items: type: integer type: array pseudo: description: Pseudo FS path type: string security_label: description: Security label type: string squash: description: Export squash policy type: string transports: description: List of transport types items: type: string type: array required: *id109 type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v2.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Updates an NFS-Ganesha export tags: - NFS-Ganesha /api/nvmeof/gateway: get: parameters: - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get information about the NVMeoF gateway tags: - NVMe-oF Gateway /api/nvmeof/gateway/group: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - NVMe-oF Gateway /api/nvmeof/gateway/io_stats: put: parameters: [] requestBody: content: application/json: schema: properties: enabled: description: Enable IO statistics collection type: boolean gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - enabled type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Enable or disable IO statistics collection tags: - NVMe-oF Gateway /api/nvmeof/gateway/listener_info/{nqn}: get: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get NVMeoF gateway's listeners info tags: - NVMe-oF Gateway /api/nvmeof/gateway/log_level: get: parameters: - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get NVMeoF gateway log level information tags: - NVMe-oF Gateway put: parameters: [] requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string log_level: description: Log level type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - log_level type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Set NVMeoF gateway log levels tags: - NVMe-oF Gateway /api/nvmeof/gateway/stats: get: parameters: - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get NVMeoF statistics for the gateway tags: - NVMe-oF Gateway /api/nvmeof/gateway/version: get: parameters: - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the version of the NVMeoF gateway tags: - NVMe-oF Gateway /api/nvmeof/spdk/log_level: get: parameters: - allowEmptyValue: true description: Get all log flags in: query name: all_log_flags schema: type: boolean - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get NVMeoF gateway spdk log levels tags: - NVMe-oF SPDK put: parameters: [] requestBody: content: application/json: schema: properties: extra_log_flags: description: Extra log flags items: type: string type: array gw_group: description: NVMeoF gateway group type: string log_level: description: SPDK log level type: string print_level: description: SPDK print level type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Set NVMeoF gateway spdk log levels tags: - NVMe-oF SPDK /api/nvmeof/spdk/log_level/disable: put: parameters: [] requestBody: content: application/json: schema: properties: extra_log_flags: description: Extra log flags items: type: string type: array gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Disable NVMeoF gateway spdk log tags: - NVMe-oF SPDK /api/nvmeof/subsystem: get: parameters: - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all NVMeoF subsystems tags: - NVMe-oF Subsystem post: parameters: [] requestBody: content: application/json: schema: properties: dhchap_key: description: Subsystem DH-HMAC-CHAP key type: string gw_group: description: NVMeoF gateway group type: string max_namespaces: description: Maximum number of namespaces type: integer network_mask: description: Network mask to automatically create listeners items: type: string type: array no_group_append: default: false description: Do not append gateway group name to the NQN type: boolean nqn: description: NVMeoF subsystem NQN type: string port: description: Port to use for the created listeners type: integer secure_listeners: default: false description: Make all the auto-listeners for this subsystem secure type: boolean serial_number: description: Subsystem serial number type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - nqn type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create a new NVMeoF subsystem tags: - NVMe-oF Subsystem /api/nvmeof/subsystem/{nqn}: delete: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - default: 'false' description: Force delete in: query name: force schema: type: boolean - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete an existing NVMeoF subsystem tags: - NVMe-oF Subsystem get: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get information from a specific NVMeoF subsystem tags: - NVMe-oF Subsystem /api/nvmeof/subsystem/{nqn}/connection: get: parameters: - allowEmptyValue: true description: NVMeoF subsystem NQN in: path name: nqn schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all NVMeoF Subsystem Connections tags: - NVMe-oF Subsystem Connection /api/nvmeof/subsystem/{nqn}/host: get: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all allowed hosts for an NVMeoF subsystem tags: - NVMe-oF Subsystem Host Allowlist post: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string requestBody: content: application/json: schema: properties: dhchap_controller_key: type: string dhchap_key: type: string gw_group: description: NVMeoF gateway group type: string host_nqn: description: NVMeoF host NQN. Use "*" to allow any host. type: string psk: type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - host_nqn type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Allow hosts to access an NVMeoF subsystem tags: - NVMe-oF Subsystem Host Allowlist /api/nvmeof/subsystem/{nqn}/host/{host_nqn}: delete: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF host NQN. Use "*" to disallow any host. in: path name: host_nqn required: true schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Disallow hosts from accessing an NVMeoF subsystem tags: - NVMe-oF Subsystem Host Allowlist /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/change_controller_key: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF host NQN in: path name: host_nqn required: true schema: type: string requestBody: content: application/json: schema: properties: dhchap_controller_key: description: Host DH-HMAC-CHAP controller key type: string gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - dhchap_controller_key type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Change host DH-HMAC-CHAP controller key tags: - NVMe-oF Subsystem Host Allowlist /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/change_key: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF host NQN in: path name: host_nqn required: true schema: type: string requestBody: content: application/json: schema: properties: dhchap_key: description: Host DH-HMAC-CHAP key type: string gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - dhchap_key type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Change host DH-HMAC-CHAP key tags: - NVMe-oF Subsystem Host Allowlist /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/del_controller_key: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF host NQN. in: path name: host_nqn required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete host DH-HMAC-CHAP controller key tags: - NVMe-oF Subsystem Host Allowlist /api/nvmeof/subsystem/{nqn}/host/{host_nqn}/del_key: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF host NQN. in: path name: host_nqn required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete host DH-HMAC-CHAP key tags: - NVMe-oF Subsystem Host Allowlist /api/nvmeof/subsystem/{nqn}/listener: get: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all NVMeoF listeners tags: - NVMe-oF Subsystem Listener post: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string requestBody: content: application/json: schema: properties: adrfam: default: 0 description: NVMeoF address family (0 - IPv4, 1 - IPv6) type: integer gw_group: description: NVMeoF gateway group type: string host_name: description: NVMeoF hostname type: string secure: default: false description: Use a secure channel type: boolean server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF transport address type: string trsvcid: default: 4420 description: NVMeoF transport service port type: integer verify_host_name: default: false description: Fail if the host name doesn't match the gateway's host name type: boolean required: - host_name - traddr type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create a new NVMeoF listener tags: - NVMe-oF Subsystem Listener /api/nvmeof/subsystem/{nqn}/listener/{host_name}/{traddr}: delete: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF hostname in: path name: host_name required: true schema: type: string - description: NVMeoF transport address in: path name: traddr required: true schema: type: string - default: 4420 description: NVMeoF transport service port in: query name: trsvcid schema: type: integer - default: 0 description: NVMeoF address family (0 - IPv4, 1 - IPv6) in: query name: adrfam schema: type: integer - default: false in: query name: force schema: type: boolean - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete an existing NVMeoF listener tags: - NVMe-oF Subsystem Listener /api/nvmeof/subsystem/{nqn}/namespace: get: parameters: - allowEmptyValue: true description: NVMeoF subsystem NQN in: path name: nqn schema: type: string - allowEmptyValue: true description: NVMeoF Namespace ID to filter by in: query name: nsid schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List all NVMeoF namespaces in a subsystem tags: - NVMe-oF Subsystem Namespace post: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string requestBody: content: application/json: schema: properties: block_size: default: 512 description: NVMeoF namespace block size type: integer create_image: default: false description: Create RBD image type: boolean disable_auto_resize: default: false description: Disable auto resize type: string encryption_algorithm: description: Algorithm to use for encryption type: string encryption_format: description: Encryption format(s) to use, LUKS1 or LUKS2, separated by commas items: type: string type: array force: default: false description: Force create namespace even it image is used by other namespace type: boolean gw_group: description: NVMeoF gateway group type: string key_id: description: Key ID(s) to use for encryption pass phrases, separated by commas items: type: string type: array load_balancing_group: description: Load balancing group type: integer location: description: Gateway location for namespace type: string no_auto_visible: default: false description: Namespace will be visible only for the allowed hosts type: boolean nsid: description: Create RBD image type: string rados_namespace: description: RADOS namespace name type: string rbd_image_name: description: RBD image name type: string rbd_image_size: description: RBD image size type: integer rbd_pool: default: rbd description: RBD pool name type: string read_only: default: false description: Read only namespace type: string server_address: description: NVMeoF gateway address type: string size: description: Deprecated. Use `rbd_image_size` instead type: integer traddr: description: NVMeoF gateway address (deprecated) type: string trash_image: default: false description: Trash the RBD image when namespace is removed type: boolean required: - rbd_image_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create a new NVMeoF namespace. tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}: delete: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string - default: 'false' description: Force remove the RBD image in: query name: force schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete an existing NVMeoF namespace tags: - NVMe-oF Subsystem Namespace get: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get info from specified NVMeoF namespace tags: - NVMe-oF Subsystem Namespace patch: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string load_balancing_group: description: Load balancing group type: integer location: description: Namespace location type: string r_mbytes_per_second: description: Read MB/s type: integer rbd_image_size: description: RBD image size type: integer rw_ios_per_second: description: Read/Write IOPS type: integer rw_mbytes_per_second: description: Read/Write MB/s type: integer server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string trash_image: description: Trash RBD image after removing namespace type: boolean w_mbytes_per_second: description: Write MB/s type: integer type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update an existing NVMeoF namespace tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/add_host: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: force: description: Allow adding the host to the namespace even if the host has no access to the subsystem type: boolean gw_group: description: NVMeoF gateway group type: string host_nqn: description: NVMeoF host NQN. Use "*" to allow any host. type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - host_nqn type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Adds a host to the specified NVMeoF namespace tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/change_load_balancing_group: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string load_balancing_group: description: Load balancing group type: integer server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: set the load balancing group for specified NVMeoF namespace tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/change_visibility: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: auto_visible: description: True if visible to all hosts type: boolean force: default: false description: True if visible to all hosts type: boolean gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - auto_visible type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: changes the visibility of the specified NVMeoF namespace to all or selected hosts tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/del_host: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string host_nqn: description: NVMeoF host NQN. Use "*" to allow any host. type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - host_nqn type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Removes a host from the specified NVMeoF namespace tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/io_stats: get: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string - allowEmptyValue: true description: NVMeoF gateway group in: query name: gw_group schema: type: string - allowEmptyValue: true description: NVMeoF gateway address in: query name: server_address schema: type: string - allowEmptyValue: true description: NVMeoF gateway address (deprecated) in: query name: traddr schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get IO stats from specified NVMeoF namespace tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/refresh_size: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: refresh the specified NVMeoF namespace to current RBD image size tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/resize: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string rbd_image_size: description: RBD image size type: integer server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - rbd_image_size type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: resize the specified NVMeoF namespace tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_auto_resize: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: auto_resize_enabled: description: Enable or disable auto resize of namespace when RBD image is resized type: boolean gw_group: description: NVMeoF gateway group type: string server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - auto_resize_enabled type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Enable or disable namespace auto resize when RBD image is resized tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_qos: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: force: default: false description: Set QOS limits even if they were changed by RBD type: boolean gw_group: description: NVMeoF gateway group type: string r_mbytes_per_second: description: Read MB/s type: integer rw_ios_per_second: description: Read/Write IOPS type: integer rw_mbytes_per_second: description: Read/Write MB/s type: integer server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string w_mbytes_per_second: description: Write MB/s type: integer type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: set QOS for specified NVMeoF namespace tags: - NVMe-oF Subsystem Namespace /api/nvmeof/subsystem/{nqn}/namespace/{nsid}/set_rbd_trash_image: put: parameters: - description: NVMeoF subsystem NQN in: path name: nqn required: true schema: type: string - description: NVMeoF Namespace ID in: path name: nsid required: true schema: type: string requestBody: content: application/json: schema: properties: gw_group: description: NVMeoF gateway group type: string rbd_trash_image_on_delete: description: True if active type: boolean server_address: description: NVMeoF gateway address type: string traddr: description: NVMeoF gateway address (deprecated) type: string required: - rbd_trash_image_on_delete type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: changes the trash image on delete of the specified NVMeoF namespace to all or selected hosts tags: - NVMe-oF Subsystem Namespace /api/osd: get: parameters: - default: 0 in: query name: offset schema: type: integer - default: 10 in: query name: limit schema: type: integer - default: '' in: query name: search schema: type: string - default: '' in: query name: sort schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD post: parameters: [] requestBody: content: application/json: schema: properties: data: type: string method: type: string tracking_id: type: string required: - method - data - tracking_id type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/flags: get: parameters: [] responses: '200': content: application/json: schema: properties: list_of_flags: description: '' items: type: string type: array required: &id110 - list_of_flags type: object application/vnd.ceph.api.v1.0+json: schema: properties: list_of_flags: description: '' items: type: string type: array required: *id110 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display OSD Flags tags: - OSD put: description: "\n The `recovery_deletes`, `sortbitwise` and `pglog_hardlimit`\ \ flags cannot be unset.\n `purged_snapshots` cannot even be set. It\ \ is therefore required to at\n least include those four flags for\ \ a successful operation.\n " parameters: [] requestBody: content: application/json: schema: properties: flags: description: List of flags to set. The flags `recovery_deletes`, `sortbitwise` and `pglog_hardlimit` cannot be unset. Additionally `purged_snapshots` cannot even be set. items: type: string type: array required: - flags type: object responses: '200': content: application/json: schema: properties: list_of_flags: description: '' items: type: string type: array required: &id111 - list_of_flags type: object application/vnd.ceph.api.v1.0+json: schema: properties: list_of_flags: description: '' items: type: string type: array required: *id111 type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Sets OSD flags for the entire cluster. tags: - OSD /api/osd/flags/individual: get: parameters: [] responses: '200': content: application/json: schema: properties: flags: description: List of active flags items: type: string type: array osd: description: OSD ID type: integer required: &id112 - osd - flags type: object application/vnd.ceph.api.v1.0+json: schema: properties: flags: description: List of active flags items: type: string type: array osd: description: OSD ID type: integer required: *id112 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Displays individual OSD flags tags: - OSD put: description: "\n Updates flags (`noout`, `noin`, `nodown`, `noup`) for\ \ an individual\n subset of OSDs.\n " parameters: [] requestBody: content: application/json: schema: properties: flags: description: Directory of flags to set or unset. The flags `noin`, `noout`, `noup` and `nodown` are going to be considered only. properties: nodown: description: Sets/unsets `nodown` type: boolean noin: description: Sets/unsets `noin` type: boolean noout: description: Sets/unsets `noout` type: boolean noup: description: Sets/unsets `noup` type: boolean type: object ids: description: List of OSD ids the flags should be applied to. items: type: integer type: array required: - flags - ids type: object responses: '200': content: application/json: schema: properties: added: description: List of added flags items: type: string type: array ids: description: List of updated OSDs items: type: integer type: array removed: description: List of removed flags items: type: string type: array required: &id113 - added - removed - ids type: object application/vnd.ceph.api.v1.0+json: schema: properties: added: description: List of added flags items: type: string type: array ids: description: List of updated OSDs items: type: integer type: array removed: description: List of removed flags items: type: string type: array required: *id113 type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Sets OSD flags for a subset of individual OSDs. tags: - OSD /api/osd/safe_to_delete: get: description: "\n :type ids: int|[int]\n " parameters: - in: query name: svc_ids required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/safe_to_destroy: get: description: "\n :type ids: int|[int]\n " parameters: - description: OSD Service Identifier in: query name: ids required: true schema: type: string responses: '200': content: application/json: schema: properties: active: description: '' items: type: integer type: array is_safe_to_destroy: description: Is OSD safe to destroy? type: boolean missing_stats: description: '' items: type: string type: array safe_to_destroy: description: Is OSD safe to destroy? items: type: string type: array stored_pgs: description: Stored Pool groups in Osd items: type: string type: array required: &id114 - safe_to_destroy - active - missing_stats - stored_pgs - is_safe_to_destroy type: object application/vnd.ceph.api.v1.0+json: schema: properties: active: description: '' items: type: integer type: array is_safe_to_destroy: description: Is OSD safe to destroy? type: boolean missing_stats: description: '' items: type: string type: array safe_to_destroy: description: Is OSD safe to destroy? items: type: string type: array stored_pgs: description: Stored Pool groups in Osd items: type: string type: array required: *id114 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Check If OSD is Safe to Destroy tags: - OSD /api/osd/settings: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v0.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}: delete: parameters: - in: path name: svc_id required: true schema: type: string - allowEmptyValue: true in: query name: preserve_id schema: type: string - allowEmptyValue: true in: query name: force schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD get: description: "\n Returns collected data about an OSD.\n\n :return:\ \ Returns the requested data.\n " parameters: - in: path name: svc_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD put: parameters: - in: path name: svc_id required: true schema: type: string requestBody: content: application/json: schema: properties: device_class: type: string required: - device_class type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}/destroy: post: description: "\n Mark osd as being destroyed. Keeps the ID intact (allowing\ \ reuse), but\n removes cephx keys, config-key data and lockbox keys,\ \ rendering data\n permanently unreadable.\n\n The osd must\ \ be marked down before being destroyed.\n " parameters: - in: path name: svc_id required: true schema: type: string responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}/devices: get: parameters: - in: path name: svc_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}/histogram: get: description: "\n :return: Returns the histogram data.\n " parameters: - in: path name: svc_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}/mark: put: description: "\n Note: osd must be marked `down` before marking lost.\n\ \ " parameters: - description: SVC ID in: path name: svc_id required: true schema: type: string requestBody: content: application/json: schema: properties: action: type: string required: - action type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Mark OSD flags (out, in, down, lost, ...) tags: - OSD /api/osd/{svc_id}/purge: post: description: "\n Note: osd must be marked `down` before removal.\n \ \ " parameters: - in: path name: svc_id required: true schema: type: string responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}/reweight: post: description: "\n Reweights the OSD temporarily.\n\n Note that\ \ \u2018ceph osd reweight\u2019 is not a persistent setting. When an OSD\n\ \ gets marked out, the osd weight will be set to 0. When it gets marked\n\ \ in again, the weight will be changed to 1.\n\n Because of\ \ this \u2018ceph osd reweight\u2019 is a temporary solution. You should\n\ \ only use it to keep your cluster running while you\u2019re ordering\ \ more\n hardware.\n\n - Craig Lewis (http://lists.ceph.com/pipermail/ceph-users-ceph.com/2014-June/040967.html)\n\ \ " parameters: - in: path name: svc_id required: true schema: type: string requestBody: content: application/json: schema: properties: weight: type: string required: - weight type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}/scrub: post: parameters: - in: path name: svc_id required: true schema: type: string - default: false in: query name: deep schema: type: boolean requestBody: content: application/json: schema: properties: deep: default: false type: boolean type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/osd/{svc_id}/smart: get: parameters: - in: path name: svc_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OSD /api/perf_counters: get: parameters: [] responses: '200': content: application/json: schema: properties: mon.a: description: Service ID properties: .cache_bytes: description: '' properties: description: description: '' type: string nick: description: '' type: string priority: description: '' type: integer type: description: '' type: integer units: description: '' type: integer value: description: '' type: integer required: &id115 - description - nick - type - priority - units - value type: object required: &id116 - .cache_bytes type: object required: &id117 - mon.a type: object application/vnd.ceph.api.v1.0+json: schema: properties: mon.a: description: Service ID properties: .cache_bytes: description: '' properties: description: description: '' type: string nick: description: '' type: string priority: description: '' type: integer type: description: '' type: integer units: description: '' type: integer value: description: '' type: integer required: *id115 type: object required: *id116 type: object required: *id117 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Perf Counters tags: - PerfCounters /api/perf_counters/mds/{service_id}: get: parameters: - in: path name: service_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MdsPerfCounter /api/perf_counters/mgr/{service_id}: get: parameters: - in: path name: service_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MgrPerfCounter /api/perf_counters/mon/{service_id}: get: parameters: - in: path name: service_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - MonPerfCounter /api/perf_counters/osd/{service_id}: get: parameters: - in: path name: service_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - OsdPerfCounter /api/perf_counters/rbd-mirror/{service_id}: get: parameters: - in: path name: service_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwMirrorPerfCounter /api/perf_counters/rgw/{service_id}: get: parameters: - in: path name: service_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwPerfCounter /api/perf_counters/tcmu-runner/{service_id}: get: parameters: - in: path name: service_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - TcmuRunnerPerfCounter /api/pool: get: parameters: - allowEmptyValue: true description: Pool Attributes in: query name: attrs schema: type: string - default: false description: Pool Stats in: query name: stats schema: type: boolean responses: '200': content: application/json: schema: items: properties: application_metadata: description: '' items: type: string type: array auid: description: '' type: integer cache_min_evict_age: description: '' type: integer cache_min_flush_age: description: '' type: integer cache_mode: description: '' type: string cache_target_dirty_high_ratio_micro: description: '' type: integer cache_target_dirty_ratio_micro: description: '' type: integer cache_target_full_ratio_micro: description: '' type: integer create_time: description: '' type: string crush_rule: description: '' type: string erasure_code_profile: description: '' type: string expected_num_objects: description: '' type: integer fast_read: description: '' type: boolean flags: description: '' type: integer flags_names: description: flags name type: string grade_table: description: '' items: type: string type: array hit_set_count: description: '' type: integer hit_set_grade_decay_rate: description: '' type: integer hit_set_params: description: '' properties: type: description: '' type: string required: &id118 - type type: object hit_set_period: description: '' type: integer hit_set_search_last_n: description: '' type: integer last_change: description: '' type: string last_force_op_resend: description: '' type: string last_force_op_resend_preluminous: description: '' type: string last_force_op_resend_prenautilus: description: '' type: string last_pg_merge_meta: description: '' properties: last_epoch_clean: description: '' type: integer last_epoch_started: description: '' type: integer ready_epoch: description: '' type: integer source_pgid: description: '' type: string source_version: description: '' type: string target_version: description: '' type: string required: &id119 - ready_epoch - last_epoch_started - last_epoch_clean - source_pgid - source_version - target_version type: object min_read_recency_for_promote: description: '' type: integer min_size: description: '' type: integer min_write_recency_for_promote: description: '' type: integer object_hash: description: '' type: integer options: description: '' properties: pg_num_max: description: '' type: integer pg_num_min: description: '' type: integer required: &id120 - pg_num_min - pg_num_max type: object pg_autoscale_mode: description: '' type: string pg_num: description: '' type: integer pg_num_pending: description: '' type: integer pg_num_target: description: '' type: integer pg_placement_num: description: '' type: integer pg_placement_num_target: description: '' type: integer pool: description: pool id type: integer pool_name: description: pool name type: string pool_snaps: description: '' items: type: string type: array quota_max_bytes: description: '' type: integer quota_max_objects: description: '' type: integer read_tier: description: '' type: integer removed_snaps: description: '' items: type: string type: array size: description: pool size type: integer snap_epoch: description: '' type: integer snap_mode: description: '' type: string snap_seq: description: '' type: integer stripe_width: description: '' type: integer target_max_bytes: description: '' type: integer target_max_objects: description: '' type: integer tier_of: description: '' type: integer tiers: description: '' items: type: string type: array type: description: type of pool type: string use_gmt_hitset: description: '' type: boolean write_tier: description: '' type: integer type: object required: &id121 - pool - pool_name - flags - flags_names - type - size - min_size - crush_rule - object_hash - pg_autoscale_mode - pg_num - pg_placement_num - pg_placement_num_target - pg_num_target - pg_num_pending - last_pg_merge_meta - auid - snap_mode - snap_seq - snap_epoch - pool_snaps - quota_max_bytes - quota_max_objects - tiers - tier_of - read_tier - write_tier - cache_mode - target_max_bytes - target_max_objects - cache_target_dirty_ratio_micro - cache_target_dirty_high_ratio_micro - cache_target_full_ratio_micro - cache_min_flush_age - cache_min_evict_age - erasure_code_profile - hit_set_params - hit_set_period - hit_set_count - use_gmt_hitset - min_read_recency_for_promote - min_write_recency_for_promote - hit_set_grade_decay_rate - hit_set_search_last_n - grade_table - stripe_width - expected_num_objects - fast_read - options - application_metadata - create_time - last_change - last_force_op_resend - last_force_op_resend_prenautilus - last_force_op_resend_preluminous - removed_snaps type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: application_metadata: description: '' items: type: string type: array auid: description: '' type: integer cache_min_evict_age: description: '' type: integer cache_min_flush_age: description: '' type: integer cache_mode: description: '' type: string cache_target_dirty_high_ratio_micro: description: '' type: integer cache_target_dirty_ratio_micro: description: '' type: integer cache_target_full_ratio_micro: description: '' type: integer create_time: description: '' type: string crush_rule: description: '' type: string erasure_code_profile: description: '' type: string expected_num_objects: description: '' type: integer fast_read: description: '' type: boolean flags: description: '' type: integer flags_names: description: flags name type: string grade_table: description: '' items: type: string type: array hit_set_count: description: '' type: integer hit_set_grade_decay_rate: description: '' type: integer hit_set_params: description: '' properties: type: description: '' type: string required: *id118 type: object hit_set_period: description: '' type: integer hit_set_search_last_n: description: '' type: integer last_change: description: '' type: string last_force_op_resend: description: '' type: string last_force_op_resend_preluminous: description: '' type: string last_force_op_resend_prenautilus: description: '' type: string last_pg_merge_meta: description: '' properties: last_epoch_clean: description: '' type: integer last_epoch_started: description: '' type: integer ready_epoch: description: '' type: integer source_pgid: description: '' type: string source_version: description: '' type: string target_version: description: '' type: string required: *id119 type: object min_read_recency_for_promote: description: '' type: integer min_size: description: '' type: integer min_write_recency_for_promote: description: '' type: integer object_hash: description: '' type: integer options: description: '' properties: pg_num_max: description: '' type: integer pg_num_min: description: '' type: integer required: *id120 type: object pg_autoscale_mode: description: '' type: string pg_num: description: '' type: integer pg_num_pending: description: '' type: integer pg_num_target: description: '' type: integer pg_placement_num: description: '' type: integer pg_placement_num_target: description: '' type: integer pool: description: pool id type: integer pool_name: description: pool name type: string pool_snaps: description: '' items: type: string type: array quota_max_bytes: description: '' type: integer quota_max_objects: description: '' type: integer read_tier: description: '' type: integer removed_snaps: description: '' items: type: string type: array size: description: pool size type: integer snap_epoch: description: '' type: integer snap_mode: description: '' type: string snap_seq: description: '' type: integer stripe_width: description: '' type: integer target_max_bytes: description: '' type: integer target_max_objects: description: '' type: integer tier_of: description: '' type: integer tiers: description: '' items: type: string type: array type: description: type of pool type: string use_gmt_hitset: description: '' type: boolean write_tier: description: '' type: integer type: object required: *id121 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Pool List tags: - Pool post: parameters: [] requestBody: content: application/json: schema: properties: pool: default: rbd-mirror type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Pool /api/pool/{pool_name}: delete: parameters: - in: path name: pool_name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Pool get: parameters: - in: path name: pool_name required: true schema: type: string - allowEmptyValue: true in: query name: attrs schema: type: string - default: false in: query name: stats schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Pool put: parameters: - in: path name: pool_name required: true schema: type: string requestBody: content: application/json: schema: properties: application_metadata: type: string configuration: type: string flags: type: string rbd_mirroring: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Pool /api/pool/{pool_name}/configuration: get: parameters: - in: path name: pool_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Pool /api/prometheus: get: parameters: - default: false in: query name: cluster_filter schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/prometheus/alertgroup: get: parameters: - default: false in: query name: cluster_filter schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/prometheus/data: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/prometheus/notifications: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - PrometheusNotifications /api/prometheus/prometheus_query_data: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/prometheus/rules: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/prometheus/silence: post: parameters: [] responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/prometheus/silence/{s_id}: delete: parameters: - in: path name: s_id required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/prometheus/silences: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Prometheus /api/rgw/accounts: get: description: "\n List all account ids or all detailed account info based\ \ on the 'detailed' query parameter.\n\n - If detailed=True, returns\ \ detailed account info.\n - If detailed=False, returns only account\ \ ids.\n " parameters: - allowEmptyValue: true in: query name: daemon_name schema: type: string - default: false in: query name: detailed schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUserAccounts post: description: "\n Create an account\n\n :param account_name: Account\ \ name\n :return: Returns account resource.\n :rtype: Dict[str,\ \ Any]\n " parameters: [] requestBody: content: application/json: schema: properties: account_name: description: Account name type: string daemon_name: description: Name of the daemon type: string email: description: Email type: string max_access_keys: description: Max access keys type: integer max_buckets: description: Max buckets type: integer max_group: description: Max groups type: integer max_roles: description: Max roles type: integer max_users: description: Max users type: integer tenant: description: Tenant type: string required: - account_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update RGW account info tags: - RgwUserAccounts /api/rgw/accounts/{account_id}: delete: description: "\n Removes an account\n\n :param account_id: account\ \ identifier\n :return: None.\n " parameters: - description: Account id in: path name: account_id required: true schema: type: string - allowEmptyValue: true description: Name of the daemon in: query name: daemon_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete RGW Account tags: - RgwUserAccounts get: description: "\n Get an account by account id\n " parameters: - description: Account id in: path name: account_id required: true schema: type: string - allowEmptyValue: true description: Name of the daemon in: query name: daemon_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get RGW Account by id tags: - RgwUserAccounts put: description: "\n Modifies an account\n\n :param account_id: Account\ \ identifier\n :return: Returns modified account resource.\n \ \ :rtype: Dict[str, Any]\n " parameters: - description: Account id in: path name: account_id required: true schema: type: string requestBody: content: application/json: schema: properties: account_name: description: Account name type: string daemon_name: description: Name of the daemon type: string email: description: Email type: string max_access_keys: description: Max access keys type: integer max_buckets: description: Max buckets type: integer max_group: description: Max groups type: integer max_roles: description: Max roles type: integer max_users: description: Max users type: integer tenant: description: Tenant type: string required: - account_name type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update RGW account info tags: - RgwUserAccounts /api/rgw/accounts/{account_id}/quota: put: description: "\n Modifies quota\n\n :param account_id: Account\ \ identifier\n :param quota_type: 'account' or 'bucket'\n :return:\ \ Returns modified quota.\n :rtype: Dict[str, Any]\n " parameters: - description: Account id in: path name: account_id required: true schema: type: string requestBody: content: application/json: schema: properties: enabled: type: string max_objects: description: Max objects type: string max_size: description: Max size type: string quota_type: description: Quota type type: string required: - quota_type - max_size - max_objects - enabled type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Set RGW Account/Bucket quota tags: - RgwUserAccounts /api/rgw/accounts/{account_id}/quota/status: put: description: "\n Enable/Disable quota\n\n :param account_id: Account\ \ identifier\n :param quota_type: 'account' or 'bucket'\n :param\ \ quota_status: 'enable' or 'disable'\n :return: Returns modified quota.\n\ \ :rtype: Dict[str, Any]\n " parameters: - description: Account id in: path name: account_id required: true schema: type: string requestBody: content: application/json: schema: properties: quota_status: description: Quota status type: string quota_type: description: Quota type type: string required: - quota_type - quota_status type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Enable/Disable RGW Account/Bucket quota tags: - RgwUserAccounts /api/rgw/bucket: get: parameters: - default: false in: query name: stats schema: type: boolean - allowEmptyValue: true in: query name: daemon_name schema: type: string - allowEmptyValue: true in: query name: uid schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.1+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket post: parameters: [] requestBody: content: application/json: schema: properties: bucket: type: string bucket_policy: type: string canned_acl: type: string daemon_name: type: string encryption_state: default: 'false' type: string encryption_type: type: string key_id: type: string lock_enabled: default: 'false' type: string lock_mode: type: string lock_retention_period_days: type: string lock_retention_period_years: type: string placement_target: type: string replication: default: 'false' type: string tags: type: string uid: type: string zonegroup: type: string required: - bucket - uid type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket /api/rgw/bucket/deleteEncryption: delete: parameters: - in: query name: bucket_name required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string - allowEmptyValue: true in: query name: owner schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket /api/rgw/bucket/getEncryption: get: parameters: - in: query name: bucket_name required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string - allowEmptyValue: true in: query name: owner schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket /api/rgw/bucket/getEncryptionConfig: get: parameters: - allowEmptyValue: true in: query name: daemon_name schema: type: string - allowEmptyValue: true in: query name: owner schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket /api/rgw/bucket/lifecycle: get: parameters: - default: '' in: query name: bucket_name schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string - allowEmptyValue: true in: query name: owner schema: type: string - allowEmptyValue: true in: query name: tenant schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket put: parameters: [] requestBody: content: application/json: schema: properties: bucket_name: default: '' type: string daemon_name: type: string lifecycle: default: '' type: string owner: type: string tenant: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket /api/rgw/bucket/notification: delete: parameters: - in: query name: bucket_name required: true schema: type: string - in: query name: notification_id required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string - allowEmptyValue: true in: query name: owner schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete the bucket notification tags: - RgwBucket get: parameters: - in: query name: bucket_name required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string - allowEmptyValue: true in: query name: owner schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the bucket notification tags: - RgwBucket put: parameters: [] requestBody: content: application/json: schema: properties: bucket_name: type: string daemon_name: type: string notification: default: '' type: string owner: type: string required: - bucket_name type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create or update the bucket notification tags: - RgwBucket /api/rgw/bucket/ratelimit: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the bucket global rate limit tags: - RgwBucket /api/rgw/bucket/setEncryptionConfig: put: parameters: [] requestBody: content: application/json: schema: properties: config: type: string daemon_name: type: string encryption_type: type: string kms_provider: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket /api/rgw/bucket/{bucket}: delete: parameters: - in: path name: bucket required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket get: parameters: - in: path name: bucket required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket put: parameters: - in: path name: bucket required: true schema: type: string requestBody: content: application/json: schema: properties: bucket_id: type: string bucket_policy: type: string canned_acl: type: string daemon_name: type: string encryption_state: default: 'false' type: string encryption_type: type: string key_id: type: string lifecycle: type: string lock_mode: type: string lock_retention_period_days: type: string lock_retention_period_years: type: string mfa_delete: type: string mfa_token_pin: type: string mfa_token_serial: type: string replication: type: string tags: type: string uid: type: string versioning_state: type: string required: - bucket_id type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwBucket /api/rgw/bucket/{uid}/ratelimit: get: parameters: - in: path name: uid required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the bucket rate limit tags: - RgwBucket put: parameters: - in: path name: uid required: true schema: type: string requestBody: content: application/json: schema: properties: enabled: type: string max_read_bytes: type: string max_read_ops: type: string max_write_bytes: type: string max_write_ops: type: string required: - enabled - max_read_ops - max_write_ops - max_read_bytes - max_write_bytes type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update the bucket rate limit tags: - RgwBucket /api/rgw/daemon: get: parameters: [] responses: '200': content: application/json: schema: items: properties: id: description: Daemon ID type: string port: description: Port type: integer server_hostname: description: '' type: string version: description: Ceph Version type: string zone_name: description: Zone type: string zonegroup_name: description: Zone Group type: string type: object required: &id122 - id - version - server_hostname - zonegroup_name - zone_name - port type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: id: description: Daemon ID type: string port: description: Port type: integer server_hostname: description: '' type: string version: description: Ceph Version type: string zone_name: description: Zone type: string zonegroup_name: description: Zone Group type: string type: object required: *id122 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display RGW Daemons tags: - RgwDaemon /api/rgw/daemon/set_multisite_config: put: parameters: [] requestBody: content: application/json: schema: properties: daemon_name: type: string realm_name: type: string zone_name: type: string zonegroup_name: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwDaemon /api/rgw/daemon/{svc_id}: get: parameters: - in: path name: svc_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwDaemon /api/rgw/multisite/sync-flow: put: parameters: [] requestBody: content: application/json: schema: properties: bucket_name: default: '' type: string destination_zone: type: string flow_id: type: string flow_type: type: string group_id: type: string source_zone: type: string zones: type: string required: - flow_id - flow_type - group_id type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create or update the sync flow tags: - RgwMultisite /api/rgw/multisite/sync-flow/{flow_id}/{flow_type}/{group_id}: delete: parameters: - in: path name: flow_id required: true schema: type: string - in: path name: flow_type required: true schema: type: string - in: path name: group_id required: true schema: type: string - default: '' in: query name: source_zone schema: type: string - default: '' in: query name: destination_zone schema: type: string - allowEmptyValue: true in: query name: zones schema: type: string - default: '' in: query name: bucket_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Remove the sync flow tags: - RgwMultisite /api/rgw/multisite/sync-pipe: put: parameters: [] requestBody: content: application/json: schema: properties: bucket_name: default: '' type: string destination_bucket: default: '' type: string destination_zones: type: string group_id: type: string mode: default: '' type: string pipe_id: type: string source_bucket: default: '' type: string source_zones: type: string user: default: '' type: string required: - group_id - pipe_id - source_zones - destination_zones type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create or update the sync pipe tags: - RgwMultisite /api/rgw/multisite/sync-pipe/{group_id}/{pipe_id}: delete: parameters: - in: path name: group_id required: true schema: type: string - in: path name: pipe_id required: true schema: type: string - allowEmptyValue: true in: query name: source_zones schema: type: string - allowEmptyValue: true in: query name: destination_zones schema: type: string - default: '' in: query name: bucket_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Remove the sync pipe tags: - RgwMultisite /api/rgw/multisite/sync-policy: get: parameters: - default: '' in: query name: bucket_name schema: type: string - default: '' in: query name: zonegroup_name schema: type: string - allowEmptyValue: true in: query name: all_policy schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the sync policy tags: - RgwMultisite /api/rgw/multisite/sync-policy-group: post: parameters: [] requestBody: content: application/json: schema: properties: bucket_name: default: '' type: string group_id: type: string status: type: string required: - group_id - status type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create the sync policy group tags: - RgwMultisite put: parameters: [] requestBody: content: application/json: schema: properties: bucket_name: default: '' type: string group_id: type: string status: type: string required: - group_id - status type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update the sync policy group tags: - RgwMultisite /api/rgw/multisite/sync-policy-group/{group_id}: delete: parameters: - in: path name: group_id required: true schema: type: string - default: '' in: query name: bucket_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Remove the sync policy group tags: - RgwMultisite get: parameters: - in: path name: group_id required: true schema: type: string - default: '' in: query name: bucket_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the sync policy group tags: - RgwMultisite /api/rgw/multisite/sync_status: get: parameters: - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the sync status tags: - RgwMultisite /api/rgw/realm: get: parameters: - allowEmptyValue: true in: query name: replicable schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm post: parameters: [] requestBody: content: application/json: schema: properties: default: type: string realm_name: type: string required: - realm_name - default type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm /api/rgw/realm/get_all_realms_info: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm /api/rgw/realm/get_realm_tokens: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm /api/rgw/realm/import_realm_token: post: parameters: [] requestBody: content: application/json: schema: properties: placement_spec: type: string port: type: string realm_token: type: string zone_name: type: string required: - realm_token - zone_name - port type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm /api/rgw/realm/{realm_name}: delete: parameters: - in: path name: realm_name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm get: parameters: - in: path name: realm_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm put: parameters: - in: path name: realm_name required: true schema: type: string requestBody: content: application/json: schema: properties: default: default: '' type: string new_realm_name: type: string required: - new_realm_name type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwRealm /api/rgw/roles: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List RGW roles tags: - RGW post: parameters: [] requestBody: content: application/json: schema: properties: role_assume_policy_doc: default: '' type: string role_name: default: '' type: string role_path: default: '' type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create RGW role tags: - RGW put: parameters: [] requestBody: content: application/json: schema: properties: max_session_duration: type: string role_name: type: string required: - role_name - max_session_duration type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Edit RGW role tags: - RGW /api/rgw/roles/{role_name}: delete: parameters: - in: path name: role_name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete RGW role tags: - RGW /api/rgw/site: get: parameters: - allowEmptyValue: true in: query name: query schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwSite /api/rgw/topic: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get RGW Topic List tags: - RGW Topic Management post: parameters: [] requestBody: content: application/json: schema: properties: ack_level: description: Amqp ack level type: string amqp_exchange: description: Amqp exchange type: string ca_location: description: Ca location type: string cloud_events: default: false description: Cloud events type: string daemon_name: description: Name of the daemon type: string kafka_brokers: description: Kafka brokers type: string max_retries: description: Max retries type: string mechanism: description: Mechanism type: string name: description: Name of the topic type: string opaque_data: description: OpaqueData type: string owner: description: Name of the owner type: string persistent: default: false description: Persistent type: boolean policy: description: Policy type: string push_endpoint: description: Push Endpoint type: string retry_sleep_duration: description: Retry sleep duration type: string time_to_live: description: Time to live type: string use_ssl: default: false description: Use ssl type: boolean verify_ssl: default: false description: Verify ssl type: boolean required: - name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create a new RGW Topic tags: - RGW Topic Management /api/rgw/topic/{key}: delete: parameters: - description: The metadata object key to retrieve the topic e.g topic:topic_name in: path name: key required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete RGW Topic tags: - RGW Topic Management get: parameters: - description: The metadata object key to retrieve the topic e.g owner:topic_name in: path name: key required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get RGW Topic tags: - RGW Topic Management /api/rgw/user: get: parameters: - allowEmptyValue: true in: query name: daemon_name schema: type: string - default: false description: If true, returns complete user details for each user. If false, returns only the list of usernames. in: query name: detailed schema: type: boolean responses: '200': content: application/json: schema: properties: list_of_users: description: list of rgw users items: type: string type: array required: &id123 - list_of_users type: object application/vnd.ceph.api.v1.0+json: schema: properties: list_of_users: description: list of rgw users items: type: string type: array required: *id123 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display RGW Users tags: - RgwUser post: description: Create a new RGW user. parameters: [] requestBody: content: application/json: schema: properties: access_key: type: string account_id: type: integer account_policies: type: integer account_root_user: default: false type: integer daemon_name: type: string display_name: type: string email: type: string generate_key: type: string max_buckets: type: string secret_key: type: string suspended: type: string system: type: string uid: type: string required: - uid - display_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/user/get_emails: get: parameters: - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/user/ratelimit: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the user global rate limit tags: - RgwUser /api/rgw/user/{uid}: delete: parameters: - in: path name: uid required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser get: parameters: - in: path name: uid required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string - default: true in: query name: stats schema: type: boolean responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser put: description: Update an existing RGW user. parameters: - in: path name: uid required: true schema: type: string requestBody: content: application/json: schema: properties: account_id: type: integer account_policies: type: integer account_root_user: default: false type: integer daemon_name: type: string display_name: type: string email: type: string max_buckets: type: string suspended: type: string system: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/user/{uid}/capability: delete: parameters: - in: path name: uid required: true schema: type: string - in: query name: type required: true schema: type: string - in: query name: perm required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser post: parameters: - in: path name: uid required: true schema: type: string requestBody: content: application/json: schema: properties: daemon_name: type: string perm: type: string type: type: string required: - type - perm type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/user/{uid}/key: delete: parameters: - in: path name: uid required: true schema: type: string - default: s3 in: query name: key_type schema: type: string - allowEmptyValue: true in: query name: subuser schema: type: string - allowEmptyValue: true in: query name: access_key schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser post: parameters: - in: path name: uid required: true schema: type: string requestBody: content: application/json: schema: properties: access_key: type: string daemon_name: type: string generate_key: default: 'true' type: string key_type: default: s3 type: string secret_key: type: string subuser: type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/user/{uid}/quota: get: parameters: - in: path name: uid required: true schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser put: parameters: - in: path name: uid required: true schema: type: string requestBody: content: application/json: schema: properties: daemon_name: type: string enabled: type: string max_objects: type: string max_size_kb: type: integer quota_type: type: string required: - quota_type - enabled - max_size_kb - max_objects type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/user/{uid}/ratelimit: get: parameters: - in: path name: uid required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get the user rate limit tags: - RgwUser put: parameters: - in: path name: uid required: true schema: type: string requestBody: content: application/json: schema: properties: enabled: default: false type: boolean max_read_bytes: default: 0 type: integer max_read_ops: default: 0 type: integer max_write_bytes: default: 0 type: integer max_write_ops: default: 0 type: integer type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update the user rate limit tags: - RgwUser /api/rgw/user/{uid}/subuser: post: parameters: - in: path name: uid required: true schema: type: string requestBody: content: application/json: schema: properties: access: type: string access_key: type: string daemon_name: type: string generate_secret: default: 'true' type: string key_type: default: s3 type: string secret_key: type: string subuser: type: string required: - subuser - access type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/user/{uid}/subuser/{subuser}: delete: description: "\n :param purge_keys: Set to False to do not purge the\ \ keys.\n Note, this only works for s3 subusers.\n\ \ " parameters: - in: path name: uid required: true schema: type: string - in: path name: subuser required: true schema: type: string - default: 'true' in: query name: purge_keys schema: type: string - allowEmptyValue: true in: query name: daemon_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwUser /api/rgw/zone: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone post: parameters: [] requestBody: content: application/json: schema: properties: access_key: type: string default: default: false type: boolean master: default: false type: boolean secret_key: type: string sync_from: default: '' type: string sync_from_all: default: '' type: string tier_type: default: '' type: string zone_endpoints: type: string zone_name: type: string zonegroup_name: type: string required: - zone_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone /api/rgw/zone/create_system_user: put: parameters: [] requestBody: content: application/json: schema: properties: userName: type: string zoneName: type: string required: - userName - zoneName type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone /api/rgw/zone/get_all_zones_info: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone /api/rgw/zone/get_pool_names: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone /api/rgw/zone/get_user_list: get: parameters: - allowEmptyValue: true in: query name: zoneName schema: type: string - allowEmptyValue: true in: query name: realmName schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone /api/rgw/zone/storage-class: post: parameters: [] requestBody: content: application/json: schema: properties: compression: default: '' type: string data_pool: type: string placement_target: type: string storage_class: type: string zone_name: type: string required: - zone_name - placement_target - storage_class - data_pool type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone put: parameters: [] requestBody: content: application/json: schema: properties: compression: default: '' type: string data_pool: type: string placement_target: type: string storage_class: type: string zone_name: type: string required: - zone_name - placement_target - storage_class - data_pool type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone /api/rgw/zone/{zone_name}: delete: parameters: - in: path name: zone_name required: true schema: type: string - in: query name: delete_pools required: true schema: type: string - allowEmptyValue: true in: query name: pools schema: type: string - allowEmptyValue: true in: query name: zonegroup_name schema: type: string - allowEmptyValue: true in: query name: realm_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone get: parameters: - in: path name: zone_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone put: parameters: - in: path name: zone_name required: true schema: type: string requestBody: content: application/json: schema: properties: access_key: default: '' type: string compression: default: '' type: string data_extra_pool: default: '' type: string data_pool: default: '' type: string data_pool_class: default: '' type: string default: default: '' type: string index_pool: default: '' type: string master: default: '' type: string new_zone_name: type: string placement_target: default: '' type: string secret_key: default: '' type: string storage_class: default: '' type: string sync_from: default: '' type: string sync_from_all: default: '' type: string tier_type: default: '' type: string zone_endpoints: default: '' type: string zonegroup_name: type: string required: - new_zone_name - zonegroup_name type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZone /api/rgw/zonegroup: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup post: parameters: [] requestBody: content: application/json: schema: properties: default: type: string master: type: string realm_name: type: string zonegroup_endpoints: type: string zonegroup_name: type: string required: - realm_name - zonegroup_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup /api/rgw/zonegroup/get_all_zonegroups_info: get: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup /api/rgw/zonegroup/get_placement_target_by_placement_id/{placement_id}: get: parameters: - in: path name: placement_id required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup /api/rgw/zonegroup/storage-class: post: parameters: [] requestBody: content: application/json: schema: properties: placement_targets: default: [] type: string zone_group: type: string required: - zone_group type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup put: parameters: [] requestBody: content: application/json: schema: properties: placement_targets: default: [] type: string zone_group: type: string required: - zone_group type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup /api/rgw/zonegroup/storage-class/{placement_id}/{storage_class}: delete: parameters: - in: path name: placement_id required: true schema: type: string - in: path name: storage_class required: true schema: type: string - default: '' in: query name: zone_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup /api/rgw/zonegroup/{zonegroup_name}: delete: parameters: - in: path name: zonegroup_name required: true schema: type: string - in: query name: delete_pools required: true schema: type: string - allowEmptyValue: true in: query name: pools schema: type: string - allowEmptyValue: true in: query name: realm_name schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup get: parameters: - in: path name: zonegroup_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup put: parameters: - in: path name: zonegroup_name required: true schema: type: string requestBody: content: application/json: schema: properties: add_zones: default: [] type: string default: default: '' type: string master: default: '' type: string new_zonegroup_name: type: string placement_targets: default: [] type: string realm_name: type: string remove_zones: default: [] type: string zonegroup_endpoints: default: '' type: string required: - realm_name - new_zonegroup_name type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - RgwZonegroup /api/role: get: parameters: [] responses: '200': content: application/json: schema: items: properties: description: description: Role Descriptions type: string name: description: Role Name type: string scopes_permissions: description: '' properties: cephfs: description: '' items: type: string type: array required: &id124 - cephfs type: object system: description: '' type: boolean type: object required: &id125 - name - description - scopes_permissions - system type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: description: description: Role Descriptions type: string name: description: Role Name type: string scopes_permissions: description: '' properties: cephfs: description: '' items: type: string type: array required: *id124 type: object system: description: '' type: boolean type: object required: *id125 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Role list tags: - Role post: parameters: [] requestBody: content: application/json: schema: properties: description: type: string name: type: string scopes_permissions: type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Role /api/role/{name}: delete: parameters: - in: path name: name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Role get: parameters: - in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Role put: parameters: - in: path name: name required: true schema: type: string requestBody: content: application/json: schema: properties: description: type: string scopes_permissions: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Role /api/role/{name}/clone: post: parameters: - in: path name: name required: true schema: type: string requestBody: content: application/json: schema: properties: new_name: type: string required: - new_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Role /api/service: get: parameters: - allowEmptyValue: true in: query name: service_name schema: type: string - default: 0 in: query name: offset schema: type: integer - default: 5 in: query name: limit schema: type: integer - default: '' in: query name: search schema: type: string - default: +service_name in: query name: sort schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v2.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service post: description: "\n :param service_spec: The service specification as JSON.\n\ \ :param service_name: The service name, e.g. 'alertmanager'.\n \ \ :return: None\n " parameters: [] requestBody: content: application/json: schema: properties: service_name: type: string service_spec: type: string required: - service_spec - service_name type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service /api/service/certificate: get: description: "\n List all certificates configured in the cluster.\n\n\ \ This endpoint returns a list of all certificates managed by certmgr,\n\ \ including both user-provided and cephadm-signed certificates.\n\n\ \ :param status: Filter by certificate status. Valid values: 'expired',\n\ \ 'expiring', 'valid', 'invalid'\n :param scope: Filter\ \ by certificate scope. Valid values: 'SERVICE',\n 'HOST', 'GLOBAL'\n\ \ :param service_type: Filter by service type. Supports wildcards\n\ \ (e.g., 'rgw*')\n :param include_cephadm_signed: If True,\ \ include cephadm-signed certificates.\n If False (default), only\ \ user-provided certificates are returned.\n :return: List of certificate\ \ objects with their details\n " parameters: - allowEmptyValue: true description: Filter by certificate status (e.g., "expired", "expiring", "valid", "invalid") in: query name: status schema: type: string - allowEmptyValue: true description: Filter by certificate scope (e.g., "service", "host", "global") in: query name: scope schema: type: string - allowEmptyValue: true description: Filter by certificate type (e.g., "rgw*") in: query name: service_type schema: type: string - default: false description: 'Include cephadm-signed certificates in the list (default: False)' in: query name: include_cephadm_signed schema: type: boolean responses: '200': content: application/json: schema: items: properties: cert_name: description: Certificate name type: string common_name: description: Certificate common name (CN) type: string days_to_expiration: description: Days remaining until expiration type: integer expiry_date: description: Certificate expiration date type: string issuer: description: Certificate issuer distinguished name type: string scope: description: Certificate scope (SERVICE, HOST, or GLOBAL) type: string signed_by: description: Certificate issuer (user or cephadm) type: string status: description: Certificate status (valid, expiring, expired, invalid) type: string target: description: Certificate target (service name or hostname) type: string type: object required: &id126 - cert_name - scope - signed_by - status - days_to_expiration - expiry_date - issuer - common_name - target type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: cert_name: description: Certificate name type: string common_name: description: Certificate common name (CN) type: string days_to_expiration: description: Days remaining until expiration type: integer expiry_date: description: Certificate expiration date type: string issuer: description: Certificate issuer distinguished name type: string scope: description: Certificate scope (SERVICE, HOST, or GLOBAL) type: string signed_by: description: Certificate issuer (user or cephadm) type: string status: description: Certificate status (valid, expiring, expired, invalid) type: string target: description: Certificate target (service name or hostname) type: string type: object required: *id126 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List All Certificates tags: - Service /api/service/certificate/root-ca: get: description: "\n Get the cephadm root CA certificate.\n\n This\ \ endpoint returns the root Certificate Authority (CA) certificate\n \ \ used by cephadm to sign other certificates in the cluster.\n\n \ \ :return: Dictionary with certificate field containing root CA certificate\ \ in PEM format\n " parameters: [] responses: '200': content: application/json: schema: properties: certificate: description: Root CA certificate in PEM format type: string required: &id127 - certificate type: object application/vnd.ceph.api.v1.0+json: schema: properties: certificate: description: Root CA certificate in PEM format type: string required: *id127 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Root CA Certificate tags: - Service /api/service/certificate/{service_name}: get: description: "\n Get detailed certificate information for a service.\n\ \n :param service_name: The service name, e.g. 'rgw.myzone'.\n \ \ :return: Detailed certificate information including full certificate\ \ details\n " parameters: - in: path name: service_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service /api/service/known_types: get: description: "\n Get a list of known service types, e.g. 'alertmanager',\n\ \ 'node-exporter', 'osd' or 'rgw'.\n " parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service /api/service/{service_name}: delete: description: "\n :param service_name: The service name, e.g. 'mds' or\ \ 'crash.foo'.\n :return: None\n " parameters: - in: path name: service_name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service get: parameters: - in: path name: service_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service put: description: "\n :param service_spec: The service specification as JSON.\n\ \ :param service_name: The service name, e.g. 'alertmanager'.\n \ \ :return: None\n " parameters: - in: path name: service_name required: true schema: type: string requestBody: content: application/json: schema: properties: service_spec: type: string required: - service_spec type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service /api/service/{service_name}/daemons: get: parameters: - in: path name: service_name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Service /api/settings: get: description: "\n Get the list of available options.\n :param names:\ \ A comma separated list of option names that should\n be processed.\ \ Defaults to ``None``.\n :type names: None|str\n :return: A\ \ list of available options.\n :rtype: list[dict]\n " parameters: - allowEmptyValue: true description: Name of Settings in: query name: names schema: type: string responses: '200': content: application/json: schema: items: properties: default: description: Default Settings type: boolean name: description: Settings Name type: string type: description: Type of Settings type: string value: description: Settings Value type: boolean type: object required: &id128 - name - default - type - value type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: default: description: Default Settings type: boolean name: description: Settings Name type: string type: description: Type of Settings type: string value: description: Settings Value type: boolean type: object required: *id128 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Settings Information tags: - Settings put: parameters: [] responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Settings /api/settings/{name}: delete: parameters: - in: path name: name required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Settings get: description: "\n Get the given option.\n :param name: The name\ \ of the option.\n :return: Returns a dict containing the name, type,\n\ \ default value and current value of the given option.\n :rtype:\ \ dict\n " parameters: - in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Settings put: parameters: - in: path name: name required: true schema: type: string requestBody: content: application/json: schema: properties: value: type: string required: - value type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Settings /api/smb/cluster: get: description: "\n List smb clusters\n " parameters: [] responses: '200': content: application/json: schema: items: properties: auth_mode: description: Either 'active-directory' or 'user' type: string cluster_id: description: Unique identifier for the cluster type: string custom_dns: description: List of custom DNS server addresses items: type: string type: array domain_settings: description: Domain-specific settings for active-directory auth mode properties: join_sources: description: List of join auth sources for domain settings items: properties: ref: description: Reference identifier for the join auth resource type: string source_type: description: resource type: string required: &id129 - source_type - ref type: object type: array realm: description: Domain realm, e.g., 'DOMAIN1.SINK.TEST' type: string required: &id130 - realm - join_sources type: object intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string placement: description: Placement configuration for the resource properties: count: description: Number of instances to place type: integer required: &id131 - count type: object public_addrs: description: Public Address items: properties: address: description: This address will be assigned to one of the host's network devices type: string destination: description: Defines where the system will assign the managed IPs. type: string required: &id132 - address - destination type: object type: array resource_type: description: ceph.smb.cluster type: string user_group_settings: description: User group settings for user auth mode items: properties: ref: description: Reference identifier for the user group resource type: string source_type: description: resource type: string required: &id133 - source_type - ref type: object type: array type: object required: &id134 - resource_type - cluster_id - auth_mode - intent - domain_settings - user_group_settings - custom_dns - public_addrs - placement type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: auth_mode: description: Either 'active-directory' or 'user' type: string cluster_id: description: Unique identifier for the cluster type: string custom_dns: description: List of custom DNS server addresses items: type: string type: array domain_settings: description: Domain-specific settings for active-directory auth mode properties: join_sources: description: List of join auth sources for domain settings items: properties: ref: description: Reference identifier for the join auth resource type: string source_type: description: resource type: string required: *id129 type: object type: array realm: description: Domain realm, e.g., 'DOMAIN1.SINK.TEST' type: string required: *id130 type: object intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string placement: description: Placement configuration for the resource properties: count: description: Number of instances to place type: integer required: *id131 type: object public_addrs: description: Public Address items: properties: address: description: This address will be assigned to one of the host's network devices type: string destination: description: Defines where the system will assign the managed IPs. type: string required: *id132 type: object type: array resource_type: description: ceph.smb.cluster type: string user_group_settings: description: User group settings for user auth mode items: properties: ref: description: Reference identifier for the user group resource type: string source_type: description: resource type: string required: *id133 type: object type: array type: object required: *id134 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List smb clusters tags: - SMB post: description: "\n Create an smb cluster\n\n :param cluster_resource:\ \ Dict cluster data\n :return: Returns cluster resource.\n :rtype:\ \ Dict[str, Any]\n " parameters: [] requestBody: content: application/json: schema: properties: cluster_resource: description: cluster_resource type: string required: - cluster_resource type: object responses: '201': content: application/json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: auth_mode: description: Either 'active-directory' or 'user' type: string cluster_id: description: Unique identifier for the cluster type: string custom_dns: description: List of custom DNS server addresses items: type: string type: array domain_settings: description: Domain-specific settings for active-directory auth mode properties: join_sources: description: List of join auth sources for domain settings items: properties: ref: description: Reference identifier for the join auth resource type: string source_type: description: resource type: string required: &id135 - source_type - ref type: object type: array realm: description: Domain realm, e.g., 'DOMAIN1.SINK.TEST' type: string required: &id136 - realm - join_sources type: object intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string placement: description: Placement configuration for the resource properties: count: description: Number of instances to place type: integer required: &id137 - count type: object public_addrs: description: Public Address items: properties: address: description: This address will be assigned to one of the host's network devices type: string destination: description: Defines where the system will assign the managed IPs. type: string required: &id138 - address - destination type: object type: array resource_type: description: ceph.smb.cluster type: string user_group_settings: description: User group settings for user auth mode items: properties: ref: description: Reference identifier for the user group resource type: string source_type: description: resource type: string required: &id139 - source_type - ref type: object type: array required: &id140 - resource_type - cluster_id - auth_mode - intent - domain_settings - user_group_settings - custom_dns - public_addrs - placement type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: &id141 - resource - state - success type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: &id142 - results - success type: object application/vnd.ceph.api.v1.0+json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: auth_mode: description: Either 'active-directory' or 'user' type: string cluster_id: description: Unique identifier for the cluster type: string custom_dns: description: List of custom DNS server addresses items: type: string type: array domain_settings: description: Domain-specific settings for active-directory auth mode properties: join_sources: description: List of join auth sources for domain settings items: properties: ref: description: Reference identifier for the join auth resource type: string source_type: description: resource type: string required: *id135 type: object type: array realm: description: Domain realm, e.g., 'DOMAIN1.SINK.TEST' type: string required: *id136 type: object intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string placement: description: Placement configuration for the resource properties: count: description: Number of instances to place type: integer required: *id137 type: object public_addrs: description: Public Address items: properties: address: description: This address will be assigned to one of the host's network devices type: string destination: description: Defines where the system will assign the managed IPs. type: string required: *id138 type: object type: array resource_type: description: ceph.smb.cluster type: string user_group_settings: description: User group settings for user auth mode items: properties: ref: description: Reference identifier for the user group resource type: string source_type: description: resource type: string required: *id139 type: object type: array required: *id140 type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: *id141 type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: *id142 type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create smb cluster tags: - SMB /api/smb/cluster/{cluster_id}: delete: description: "\n Remove an smb cluster\n\n :param cluster_id:\ \ Cluster identifier\n :return: None.\n " parameters: - description: Unique identifier for the cluster in: path name: cluster_id required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: properties: {} type: object application/vnd.ceph.api.v1.0+json: schema: properties: {} type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Remove an smb cluster tags: - SMB get: description: "\n Get an smb cluster by cluster id\n " parameters: - description: Unique identifier for the cluster in: path name: cluster_id required: true schema: type: string responses: '200': content: application/json: schema: properties: auth_mode: description: Either 'active-directory' or 'user' type: string cluster_id: description: Unique identifier for the cluster type: string custom_dns: description: List of custom DNS server addresses items: type: string type: array domain_settings: description: Domain-specific settings for active-directory auth mode properties: join_sources: description: List of join auth sources for domain settings items: properties: ref: description: Reference identifier for the join auth resource type: string source_type: description: resource type: string required: &id143 - source_type - ref type: object type: array realm: description: Domain realm, e.g., 'DOMAIN1.SINK.TEST' type: string required: &id144 - realm - join_sources type: object intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string placement: description: Placement configuration for the resource properties: count: description: Number of instances to place type: integer required: &id145 - count type: object public_addrs: description: Public Address items: properties: address: description: This address will be assigned to one of the host's network devices type: string destination: description: Defines where the system will assign the managed IPs. type: string required: &id146 - address - destination type: object type: array resource_type: description: ceph.smb.cluster type: string user_group_settings: description: User group settings for user auth mode items: properties: ref: description: Reference identifier for the user group resource type: string source_type: description: resource type: string required: &id147 - source_type - ref type: object type: array required: &id148 - resource_type - cluster_id - auth_mode - intent - domain_settings - user_group_settings - custom_dns - public_addrs - placement type: object application/vnd.ceph.api.v1.0+json: schema: properties: auth_mode: description: Either 'active-directory' or 'user' type: string cluster_id: description: Unique identifier for the cluster type: string custom_dns: description: List of custom DNS server addresses items: type: string type: array domain_settings: description: Domain-specific settings for active-directory auth mode properties: join_sources: description: List of join auth sources for domain settings items: properties: ref: description: Reference identifier for the join auth resource type: string source_type: description: resource type: string required: *id143 type: object type: array realm: description: Domain realm, e.g., 'DOMAIN1.SINK.TEST' type: string required: *id144 type: object intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string placement: description: Placement configuration for the resource properties: count: description: Number of instances to place type: integer required: *id145 type: object public_addrs: description: Public Address items: properties: address: description: This address will be assigned to one of the host's network devices type: string destination: description: Defines where the system will assign the managed IPs. type: string required: *id146 type: object type: array resource_type: description: ceph.smb.cluster type: string user_group_settings: description: User group settings for user auth mode items: properties: ref: description: Reference identifier for the user group resource type: string source_type: description: resource type: string required: *id147 type: object type: array required: *id148 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get an smb cluster tags: - SMB /api/smb/joinauth: get: description: "\n List all smb join auth resources\n\n :return:\ \ Returns list of join auth.\n :rtype: List[Dict]\n " parameters: [] responses: '200': content: application/json: schema: items: properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: &id149 - username - password type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string type: object required: &id150 - resource_type - auth_id - intent - auth - linked_to_cluster type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: *id149 type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string type: object required: *id150 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List smb join authorization resources tags: - SMB post: description: "\n Create smb join auth resource\n\n :return: Returns\ \ join auth resource.\n :rtype: Dict\n " parameters: [] requestBody: content: application/json: schema: properties: join_auth: type: string required: - join_auth type: object responses: '201': content: application/json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: &id151 - username - password type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string required: &id152 - resource_type - auth_id - intent - auth - linked_to_cluster type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: &id153 - resource - state - success type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: &id154 - results - success type: object application/vnd.ceph.api.v1.0+json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: *id151 type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string required: *id152 type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: *id153 type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: *id154 type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create smb join auth tags: - SMB /api/smb/joinauth/{auth_id}: delete: description: "\n Delete smb join auth resource\n\n :param auth_id:\ \ Join Auth identifier\n :return: None.\n " parameters: - description: auth_id in: path name: auth_id required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: properties: {} type: object application/vnd.ceph.api.v1.0+json: schema: properties: {} type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete smb join auth tags: - SMB get: description: "\n Get Join auth resource\n\n :return: Returns join\ \ auth.\n :rtype: Dict\n " parameters: - in: path name: auth_id required: true schema: type: string responses: '200': content: application/json: schema: properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: &id155 - username - password type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string required: &id156 - resource_type - auth_id - intent - auth - linked_to_cluster type: object application/vnd.ceph.api.v1.0+json: schema: properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: *id155 type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string required: *id156 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get smb join authorization resource tags: - SMB /api/smb/share: get: description: "\n List all smb shares or all shares for a given cluster\n\ \n :param cluster_id: Dict containing cluster information\n \ \ :return: Returns list of shares.\n :rtype: List[Dict]\n " parameters: - default: '' description: Unique identifier for the cluster in: query name: cluster_id schema: type: string responses: '200': content: application/json: schema: properties: browseable: description: Indicates if the share is browseable type: boolean cephfs: description: Configuration for the CephFS share properties: path: description: Path within the CephFS file system type: string provider: description: Provider of the CephFS share, e.g., 'samba-vfs' type: string subvolume: description: Subvolume within the CephFS file system type: string subvolumegroup: description: Subvolume Group in CephFS file system type: string volume: description: Name of the CephFS file system type: string required: &id157 - volume - path - provider - subvolumegroup - subvolume type: object cluster_id: description: Unique identifier for the cluster type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string name: description: Name of the share type: string read_bw_limit: description: 'QoS: max read bandwidth B/s (0=disabled)' type: integer read_delay_max: description: 'QoS: max read delay in seconds (0-300)' type: integer read_iops_limit: description: 'QoS: max read IOPS (0=disabled)' type: integer readonly: description: Indicates if the share is read-only type: boolean resource_type: description: ceph.smb.share type: string share_id: description: Unique identifier for the share type: string write_bw_limit: description: 'QoS: max write bandwidth B/s (0=disabled)' type: integer write_delay_max: description: 'QoS: max write delay in seconds (0-300)' type: integer write_iops_limit: description: 'QoS: max write IOPS (0=disabled)' type: integer required: &id158 - resource_type - cluster_id - share_id - intent - name - readonly - browseable - cephfs - read_iops_limit - write_iops_limit - read_bw_limit - write_bw_limit - read_delay_max - write_delay_max type: object application/vnd.ceph.api.v1.0+json: schema: properties: browseable: description: Indicates if the share is browseable type: boolean cephfs: description: Configuration for the CephFS share properties: path: description: Path within the CephFS file system type: string provider: description: Provider of the CephFS share, e.g., 'samba-vfs' type: string subvolume: description: Subvolume within the CephFS file system type: string subvolumegroup: description: Subvolume Group in CephFS file system type: string volume: description: Name of the CephFS file system type: string required: *id157 type: object cluster_id: description: Unique identifier for the cluster type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string name: description: Name of the share type: string read_bw_limit: description: 'QoS: max read bandwidth B/s (0=disabled)' type: integer read_delay_max: description: 'QoS: max read delay in seconds (0-300)' type: integer read_iops_limit: description: 'QoS: max read IOPS (0=disabled)' type: integer readonly: description: Indicates if the share is read-only type: boolean resource_type: description: ceph.smb.share type: string share_id: description: Unique identifier for the share type: string write_bw_limit: description: 'QoS: max write bandwidth B/s (0=disabled)' type: integer write_delay_max: description: 'QoS: max write delay in seconds (0-300)' type: integer write_iops_limit: description: 'QoS: max write IOPS (0=disabled)' type: integer required: *id158 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List smb shares tags: - SMB post: description: "\n Create an smb share\n\n :param share_resource:\ \ Dict share data\n :return: Returns share resource.\n :rtype:\ \ Dict[str, Any]\n " parameters: [] requestBody: content: application/json: schema: properties: share_resource: description: share_resource type: string required: - share_resource type: object responses: '201': content: application/json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: browseable: description: Indicates if the share is browseable type: boolean cephfs: description: Configuration for the CephFS share properties: path: description: Path within the CephFS file system type: string provider: description: Provider of the CephFS share, e.g., 'samba-vfs' type: string subvolume: description: Subvolume within the CephFS file system type: string subvolumegroup: description: Subvolume Group in CephFS file system type: string volume: description: Name of the CephFS file system type: string required: &id159 - volume - path - provider - subvolumegroup - subvolume type: object cluster_id: description: Unique identifier for the cluster type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string name: description: Name of the share type: string read_bw_limit: description: 'QoS: max read bandwidth B/s (0=disabled)' type: integer read_delay_max: description: 'QoS: max read delay in seconds (0-300)' type: integer read_iops_limit: description: 'QoS: max read IOPS (0=disabled)' type: integer readonly: description: Indicates if the share is read-only type: boolean resource_type: description: ceph.smb.share type: string share_id: description: Unique identifier for the share type: string write_bw_limit: description: 'QoS: max write bandwidth B/s (0=disabled)' type: integer write_delay_max: description: 'QoS: max write delay in seconds (0-300)' type: integer write_iops_limit: description: 'QoS: max write IOPS (0=disabled)' type: integer required: &id160 - resource_type - cluster_id - share_id - intent - name - readonly - browseable - cephfs - read_iops_limit - write_iops_limit - read_bw_limit - write_bw_limit - read_delay_max - write_delay_max type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: &id161 - resource - state - success type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: &id162 - results - success type: object application/vnd.ceph.api.v1.0+json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: browseable: description: Indicates if the share is browseable type: boolean cephfs: description: Configuration for the CephFS share properties: path: description: Path within the CephFS file system type: string provider: description: Provider of the CephFS share, e.g., 'samba-vfs' type: string subvolume: description: Subvolume within the CephFS file system type: string subvolumegroup: description: Subvolume Group in CephFS file system type: string volume: description: Name of the CephFS file system type: string required: *id159 type: object cluster_id: description: Unique identifier for the cluster type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string name: description: Name of the share type: string read_bw_limit: description: 'QoS: max read bandwidth B/s (0=disabled)' type: integer read_delay_max: description: 'QoS: max read delay in seconds (0-300)' type: integer read_iops_limit: description: 'QoS: max read IOPS (0=disabled)' type: integer readonly: description: Indicates if the share is read-only type: boolean resource_type: description: ceph.smb.share type: string share_id: description: Unique identifier for the share type: string write_bw_limit: description: 'QoS: max write bandwidth B/s (0=disabled)' type: integer write_delay_max: description: 'QoS: max write delay in seconds (0-300)' type: integer write_iops_limit: description: 'QoS: max write IOPS (0=disabled)' type: integer required: *id160 type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: *id161 type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: *id162 type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create smb share tags: - SMB /api/smb/share/qos: put: description: "\n Update QoS rate limit parameters for an SMB share.\n\ \ Omitted parameters are left unchanged. Use 0 to disable a limit.\n\ \ " parameters: [] requestBody: content: application/json: schema: properties: cluster_id: description: Unique identifier for the cluster type: string read_bw_limit: description: Max read bandwidth B/s (0=disabled) type: integer read_delay_max: description: Max read delay in seconds (0-300) type: integer read_iops_limit: description: Max read IOPS (0=disabled, 0-1000000) type: integer share_id: description: Unique identifier for the share type: string write_bw_limit: description: Max write bandwidth B/s (0=disabled) type: integer write_delay_max: description: Max write delay in seconds (0-300) type: integer write_iops_limit: description: Max write IOPS (0=disabled, 0-1000000) type: integer required: - cluster_id - share_id type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Update SMB share QoS rate limiting tags: - SMB /api/smb/share/{cluster_id}/{share_id}: delete: description: "\n Remove an smb share from a given cluster\n\n \ \ :param cluster_id: Cluster identifier\n :param share_id: Share identifier\n\ \ :return: None.\n " parameters: - description: Unique identifier for the cluster in: path name: cluster_id required: true schema: type: string - description: Unique identifier for the share in: path name: share_id required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: properties: {} type: object application/vnd.ceph.api.v1.0+json: schema: properties: {} type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Remove an smb share tags: - SMB get: description: "\n Get an smb share by cluster and share id\n " parameters: - description: Unique identifier for the cluster in: path name: cluster_id required: true schema: type: string - description: Unique identifier for the share in: path name: share_id required: true schema: type: string responses: '200': content: application/json: schema: properties: browseable: description: Indicates if the share is browseable type: boolean cephfs: description: Configuration for the CephFS share properties: path: description: Path within the CephFS file system type: string provider: description: Provider of the CephFS share, e.g., 'samba-vfs' type: string subvolume: description: Subvolume within the CephFS file system type: string subvolumegroup: description: Subvolume Group in CephFS file system type: string volume: description: Name of the CephFS file system type: string required: &id163 - volume - path - provider - subvolumegroup - subvolume type: object cluster_id: description: Unique identifier for the cluster type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string name: description: Name of the share type: string read_bw_limit: description: 'QoS: max read bandwidth B/s (0=disabled)' type: integer read_delay_max: description: 'QoS: max read delay in seconds (0-300)' type: integer read_iops_limit: description: 'QoS: max read IOPS (0=disabled)' type: integer readonly: description: Indicates if the share is read-only type: boolean resource_type: description: ceph.smb.share type: string share_id: description: Unique identifier for the share type: string write_bw_limit: description: 'QoS: max write bandwidth B/s (0=disabled)' type: integer write_delay_max: description: 'QoS: max write delay in seconds (0-300)' type: integer write_iops_limit: description: 'QoS: max write IOPS (0=disabled)' type: integer required: &id164 - resource_type - cluster_id - share_id - intent - name - readonly - browseable - cephfs - read_iops_limit - write_iops_limit - read_bw_limit - write_bw_limit - read_delay_max - write_delay_max type: object application/vnd.ceph.api.v1.0+json: schema: properties: browseable: description: Indicates if the share is browseable type: boolean cephfs: description: Configuration for the CephFS share properties: path: description: Path within the CephFS file system type: string provider: description: Provider of the CephFS share, e.g., 'samba-vfs' type: string subvolume: description: Subvolume within the CephFS file system type: string subvolumegroup: description: Subvolume Group in CephFS file system type: string volume: description: Name of the CephFS file system type: string required: *id163 type: object cluster_id: description: Unique identifier for the cluster type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string name: description: Name of the share type: string read_bw_limit: description: 'QoS: max read bandwidth B/s (0=disabled)' type: integer read_delay_max: description: 'QoS: max read delay in seconds (0-300)' type: integer read_iops_limit: description: 'QoS: max read IOPS (0=disabled)' type: integer readonly: description: Indicates if the share is read-only type: boolean resource_type: description: ceph.smb.share type: string share_id: description: Unique identifier for the share type: string write_bw_limit: description: 'QoS: max write bandwidth B/s (0=disabled)' type: integer write_delay_max: description: 'QoS: max write delay in seconds (0-300)' type: integer write_iops_limit: description: 'QoS: max write IOPS (0=disabled)' type: integer required: *id164 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get an smb share tags: - SMB /api/smb/usersgroups: get: description: "\n List all smb usersgroups resources\n\n :return:\ \ Returns list of usersgroups\n :rtype: List[Dict]\n " parameters: [] responses: '200': content: application/json: schema: items: properties: intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.usersgroups type: string users_groups_id: description: A short string identifying the usersgroups resource type: string values: description: Required object containing users and groups information properties: groups: description: List of group objects, each containing a name items: properties: name: description: The name of the group type: string required: &id165 - name type: object type: array users: description: List of user objects, each containing a name and password items: properties: name: description: The user name type: string password: description: The password for the user type: string required: &id166 - name - password type: object type: array required: &id167 - users - groups type: object type: object required: &id168 - resource_type - users_groups_id - intent - values - linked_to_cluster type: array application/vnd.ceph.api.v1.0+json: schema: items: properties: intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.usersgroups type: string users_groups_id: description: A short string identifying the usersgroups resource type: string values: description: Required object containing users and groups information properties: groups: description: List of group objects, each containing a name items: properties: name: description: The name of the group type: string required: *id165 type: object type: array users: description: List of user objects, each containing a name and password items: properties: name: description: The user name type: string password: description: The password for the user type: string required: *id166 type: object type: array required: *id167 type: object type: object required: *id168 type: array description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: List smb user resources tags: - SMB post: description: "\n Create smb usersgroups resource\n\n :return:\ \ Returns usersgroups resource.\n :rtype: Dict\n " parameters: [] requestBody: content: application/json: schema: properties: usersgroups: type: string required: - usersgroups type: object responses: '201': content: application/json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: results: description: List of operation results items: properties: resource: description: Resource properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: &id169 - username - password type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string required: &id170 - resource_type - auth_id - intent - auth - linked_to_cluster type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: &id171 - resource - state - success type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: &id172 - results - success type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: &id173 - resource - state - success type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: &id174 - results - success type: object application/vnd.ceph.api.v1.0+json: schema: properties: results: description: List of operation results items: properties: resource: description: Resource properties: results: description: List of operation results items: properties: resource: description: Resource properties: auth: description: Authentication credentials properties: password: description: Password for authentication type: string username: description: Username for authentication type: string required: *id169 type: object auth_id: description: Unique identifier for the join auth resource type: string intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.join.auth type: string required: *id170 type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: *id171 type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: *id172 type: object state: description: The current state of the resource, e.g., 'created', 'updated', 'deleted' type: string success: description: Indicates if the operation was successful type: boolean required: *id173 type: object type: array success: description: Indicates if the overall operation was successful type: boolean required: *id174 type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Create smb usersgroups tags: - SMB /api/smb/usersgroups/{users_groups_id}: delete: description: "\n Delete smb usersgroups resource\n\n :param users_group_id:\ \ Users identifier\n :return: None.\n " parameters: - description: users_groups_id in: path name: users_groups_id required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: properties: {} type: object application/vnd.ceph.api.v1.0+json: schema: properties: {} type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Delete smb join auth tags: - SMB get: description: "\n Get Users and groups resource\n\n :return: Returns\ \ join auth.\n :rtype: Dict\n " parameters: - in: path name: users_groups_id required: true schema: type: string responses: '200': content: application/json: schema: properties: intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.usersgroups type: string users_groups_id: description: A short string identifying the usersgroups resource type: string values: description: Required object containing users and groups information properties: groups: description: List of group objects, each containing a name items: properties: name: description: The name of the group type: string required: &id175 - name type: object type: array users: description: List of user objects, each containing a name and password items: properties: name: description: The user name type: string password: description: The password for the user type: string required: &id176 - name - password type: object type: array required: &id177 - users - groups type: object required: &id178 - resource_type - users_groups_id - intent - values - linked_to_cluster type: object application/vnd.ceph.api.v1.0+json: schema: properties: intent: description: Desired state of the resource, e.g., 'present' or 'removed' type: string linked_to_cluster: description: Optional string containing a cluster ID. If set, the resource is linked to the cluster and will be automatically removed when the cluster is removed type: string resource_type: description: ceph.smb.usersgroups type: string users_groups_id: description: A short string identifying the usersgroups resource type: string values: description: Required object containing users and groups information properties: groups: description: List of group objects, each containing a name items: properties: name: description: The name of the group type: string required: *id175 type: object type: array users: description: List of user objects, each containing a name and password items: properties: name: description: The user name type: string password: description: The password for the user type: string required: *id176 type: object type: array required: *id177 type: object required: *id178 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get smb usersgroups authorization resource tags: - SMB /api/summary: get: parameters: [] responses: '200': content: application/json: schema: properties: executing_tasks: description: '' items: type: string type: array finished_tasks: description: '' items: properties: begin_time: description: '' type: string duration: description: '' type: integer end_time: description: '' type: string exception: description: '' type: string metadata: description: '' properties: pool: description: '' type: integer required: &id179 - pool type: object name: description: '' type: string progress: description: '' type: integer ret_value: description: '' type: string success: description: '' type: boolean required: &id180 - name - metadata - begin_time - end_time - duration - progress - success - ret_value - exception type: object type: array have_mon_connection: description: '' type: string health_status: description: '' type: string mgr_host: description: '' type: string mgr_id: description: '' type: string rbd_mirroring: description: '' properties: errors: description: '' type: integer warnings: description: '' type: integer required: &id181 - warnings - errors type: object version: description: '' type: string required: &id182 - health_status - mgr_id - mgr_host - have_mon_connection - executing_tasks - finished_tasks - version - rbd_mirroring type: object application/vnd.ceph.api.v1.0+json: schema: properties: executing_tasks: description: '' items: type: string type: array finished_tasks: description: '' items: properties: begin_time: description: '' type: string duration: description: '' type: integer end_time: description: '' type: string exception: description: '' type: string metadata: description: '' properties: pool: description: '' type: integer required: *id179 type: object name: description: '' type: string progress: description: '' type: integer ret_value: description: '' type: string success: description: '' type: boolean required: *id180 type: object type: array have_mon_connection: description: '' type: string health_status: description: '' type: string mgr_host: description: '' type: string mgr_id: description: '' type: string rbd_mirroring: description: '' properties: errors: description: '' type: integer warnings: description: '' type: integer required: *id181 type: object version: description: '' type: string required: *id182 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Summary tags: - Summary /api/task: get: parameters: - allowEmptyValue: true description: Task Name in: query name: name schema: type: string responses: '200': content: application/json: schema: properties: executing_tasks: description: ongoing executing tasks type: string finished_tasks: description: '' items: properties: begin_time: description: Task begin time type: string duration: description: '' type: integer end_time: description: Task end time type: string exception: description: '' type: boolean metadata: description: '' properties: pool: description: '' type: integer required: &id183 - pool type: object name: description: finished tasks name type: string progress: description: Progress of tasks type: integer ret_value: description: '' type: boolean success: description: '' type: boolean required: &id184 - name - metadata - begin_time - end_time - duration - progress - success - ret_value - exception type: object type: array required: &id185 - executing_tasks - finished_tasks type: object application/vnd.ceph.api.v1.0+json: schema: properties: executing_tasks: description: ongoing executing tasks type: string finished_tasks: description: '' items: properties: begin_time: description: Task begin time type: string duration: description: '' type: integer end_time: description: Task end time type: string exception: description: '' type: boolean metadata: description: '' properties: pool: description: '' type: integer required: *id183 type: object name: description: finished tasks name type: string progress: description: Progress of tasks type: integer ret_value: description: '' type: boolean success: description: '' type: boolean required: *id184 type: object type: array required: *id185 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Display Tasks tags: - Task /api/telemetry: put: description: "\n Enables or disables sending data collected by the Telemetry\n\ \ module.\n :param enable: Enable or disable sending data\n\ \ :type enable: bool\n :param license_name: License string e.g.\ \ 'sharing-1-0' to\n make sure the user is aware of and accepts the\ \ license\n for sharing Telemetry data.\n :type license_name:\ \ string\n " parameters: [] requestBody: content: application/json: schema: properties: enable: default: true type: boolean license_name: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - Telemetry /api/telemetry/report: get: description: "\n Get Ceph and device report data\n :return: Ceph\ \ and device report data\n :rtype: dict\n " parameters: [] responses: '200': content: application/json: schema: properties: device_report: description: '' type: string report: description: '' properties: balancer: description: '' properties: active: description: '' type: boolean mode: description: '' type: string required: &id186 - active - mode type: object channels: description: '' items: type: string type: array channels_available: description: '' items: type: string type: array config: description: '' properties: active_changed: description: '' items: type: string type: array cluster_changed: description: '' items: type: string type: array required: &id187 - cluster_changed - active_changed type: object crashes: description: '' items: type: integer type: array created: description: '' type: string crush: description: '' properties: bucket_algs: description: '' properties: straw2: description: '' type: integer required: &id188 - straw2 type: object bucket_sizes: description: '' properties: '1': description: '' type: integer '3': description: '' type: integer required: &id189 - '1' - '3' type: object bucket_types: description: '' properties: '1': description: '' type: integer '11': description: '' type: integer required: &id190 - '1' - '11' type: object compat_weight_set: description: '' type: boolean device_classes: description: '' items: type: integer type: array num_buckets: description: '' type: integer num_devices: description: '' type: integer num_rules: description: '' type: integer num_types: description: '' type: integer num_weight_sets: description: '' type: integer tunables: description: '' properties: allowed_bucket_algs: description: '' type: integer choose_local_fallback_tries: description: '' type: integer choose_local_tries: description: '' type: integer choose_total_tries: description: '' type: integer chooseleaf_descend_once: description: '' type: integer chooseleaf_stable: description: '' type: integer chooseleaf_vary_r: description: '' type: integer has_v2_rules: description: '' type: integer has_v3_rules: description: '' type: integer has_v4_buckets: description: '' type: integer has_v5_rules: description: '' type: integer legacy_tunables: description: '' type: integer minimum_required_version: description: '' type: string optimal_tunables: description: '' type: integer profile: description: '' type: string require_feature_tunables: description: '' type: integer require_feature_tunables2: description: '' type: integer require_feature_tunables3: description: '' type: integer require_feature_tunables5: description: '' type: integer straw_calc_version: description: '' type: integer required: &id191 - choose_local_tries - choose_local_fallback_tries - choose_total_tries - chooseleaf_descend_once - chooseleaf_vary_r - chooseleaf_stable - straw_calc_version - allowed_bucket_algs - profile - optimal_tunables - legacy_tunables - minimum_required_version - require_feature_tunables - require_feature_tunables2 - has_v2_rules - require_feature_tunables3 - has_v3_rules - has_v4_buckets - require_feature_tunables5 - has_v5_rules type: object required: &id192 - num_devices - num_types - num_buckets - num_rules - device_classes - tunables - compat_weight_set - num_weight_sets - bucket_algs - bucket_sizes - bucket_types type: object fs: description: '' properties: count: description: '' type: integer feature_flags: description: '' properties: enable_multiple: description: '' type: boolean ever_enabled_multiple: description: '' type: boolean required: &id193 - enable_multiple - ever_enabled_multiple type: object filesystems: description: '' items: type: integer type: array num_standby_mds: description: '' type: integer total_num_mds: description: '' type: integer required: &id194 - count - feature_flags - num_standby_mds - filesystems - total_num_mds type: object hosts: description: '' properties: num: description: '' type: integer num_with_mds: description: '' type: integer num_with_mgr: description: '' type: integer num_with_mon: description: '' type: integer num_with_osd: description: '' type: integer required: &id195 - num - num_with_mon - num_with_mds - num_with_osd - num_with_mgr type: object leaderboard: description: '' type: boolean license: description: '' type: string metadata: description: '' properties: mon: description: '' properties: arch: description: '' properties: x86_64: description: '' type: integer required: &id196 - x86_64 type: object ceph_version: description: '' properties: ceph version 16.0.0-3151-gf202994fcf: description: '' type: integer required: &id197 - ceph version 16.0.0-3151-gf202994fcf type: object cpu: description: '' properties: Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz: description: '' type: integer required: &id198 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz type: object distro: description: '' properties: centos: description: '' type: integer required: &id199 - centos type: object distro_description: description: '' properties: CentOS Linux 8 (Core): description: '' type: integer required: &id200 - CentOS Linux 8 (Core) type: object kernel_description: description: '' properties: '#1 SMP Wed Jul 1 19:53:01 UTC 2020': description: '' type: integer required: &id201 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020' type: object kernel_version: description: '' properties: 5.7.7-200.fc32.x86_64: description: '' type: integer required: &id202 - 5.7.7-200.fc32.x86_64 type: object os: description: '' properties: Linux: description: '' type: integer required: &id203 - Linux type: object required: &id204 - arch - ceph_version - os - cpu - kernel_description - kernel_version - distro_description - distro type: object osd: description: '' properties: arch: description: '' properties: x86_64: description: '' type: integer required: &id205 - x86_64 type: object ceph_version: description: '' properties: ceph version 16.0.0-3151-gf202994fcf: description: '' type: integer required: &id206 - ceph version 16.0.0-3151-gf202994fcf type: object cpu: description: '' properties: Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz: description: '' type: integer required: &id207 - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz type: object distro: description: '' properties: centos: description: '' type: integer required: &id208 - centos type: object distro_description: description: '' properties: CentOS Linux 8 (Core): description: '' type: integer required: &id209 - CentOS Linux 8 (Core) type: object kernel_description: description: '' properties: '#1 SMP Wed Jul 1 19:53:01 UTC 2020': description: '' type: integer required: &id210 - '#1 SMP Wed Jul 1 19:53:01 UTC 2020' type: object kernel_version: description: '' properties: 5.7.7-200.fc32.x86_64: description: '' type: integer required: &id211 - 5.7.7-200.fc32.x86_64 type: object os: description: '' properties: Linux: description: '' type: integer required: &id212 - Linux type: object osd_objectstore: description: '' properties: bluestore: description: '' type: integer required: &id213 - bluestore type: object rotational: description: '' properties: '1': description: '' type: integer required: &id214 - '1' type: object required: &id215 - osd_objectstore - rotational - arch - ceph_version - os - cpu - kernel_description - kernel_version - distro_description - distro type: object required: &id216 - osd - mon type: object mon: description: '' properties: count: description: '' type: integer features: description: '' properties: optional: description: '' items: type: integer type: array persistent: description: '' items: type: string type: array required: &id217 - persistent - optional type: object ipv4_addr_mons: description: '' type: integer ipv6_addr_mons: description: '' type: integer min_mon_release: description: '' type: integer v1_addr_mons: description: '' type: integer v2_addr_mons: description: '' type: integer required: &id218 - count - features - min_mon_release - v1_addr_mons - v2_addr_mons - ipv4_addr_mons - ipv6_addr_mons type: object osd: description: '' properties: cluster_network: description: '' type: boolean count: description: '' type: integer require_min_compat_client: description: '' type: string require_osd_release: description: '' type: string required: &id219 - count - require_osd_release - require_min_compat_client - cluster_network type: object pools: description: '' items: properties: cache_mode: description: '' type: string erasure_code_profile: description: '' type: string min_size: description: '' type: integer pg_autoscale_mode: description: '' type: string pg_num: description: '' type: integer pgp_num: description: '' type: integer pool: description: '' type: integer size: description: '' type: integer target_max_bytes: description: '' type: integer target_max_objects: description: '' type: integer type: description: '' type: string required: &id220 - pool - type - pg_num - pgp_num - size - min_size - pg_autoscale_mode - target_max_bytes - target_max_objects - erasure_code_profile - cache_mode type: object type: array rbd: description: '' properties: mirroring_by_pool: description: '' items: type: boolean type: array num_images_by_pool: description: '' items: type: integer type: array num_pools: description: '' type: integer required: &id221 - num_pools - num_images_by_pool - mirroring_by_pool type: object report_id: description: '' type: string report_timestamp: description: '' type: string report_version: description: '' type: integer rgw: description: '' properties: count: description: '' type: integer frontends: description: '' items: type: string type: array zonegroups: description: '' type: integer zones: description: '' type: integer required: &id222 - count - zones - zonegroups - frontends type: object services: description: '' properties: rgw: description: '' type: integer required: &id223 - rgw type: object usage: description: '' properties: pg_num: description: '' type: integer pools: description: '' type: integer total_avail_bytes: description: '' type: integer total_bytes: description: '' type: integer total_used_bytes: description: '' type: integer required: &id224 - pools - pg_num - total_used_bytes - total_bytes - total_avail_bytes type: object required: &id225 - leaderboard - report_version - report_timestamp - report_id - channels - channels_available - license - created - mon - config - rbd - pools - osd - crush - fs - metadata - hosts - usage - services - rgw - balancer - crashes type: object required: &id226 - report - device_report type: object application/vnd.ceph.api.v1.0+json: schema: properties: device_report: description: '' type: string report: description: '' properties: balancer: description: '' properties: active: description: '' type: boolean mode: description: '' type: string required: *id186 type: object channels: description: '' items: type: string type: array channels_available: description: '' items: type: string type: array config: description: '' properties: active_changed: description: '' items: type: string type: array cluster_changed: description: '' items: type: string type: array required: *id187 type: object crashes: description: '' items: type: integer type: array created: description: '' type: string crush: description: '' properties: bucket_algs: description: '' properties: straw2: description: '' type: integer required: *id188 type: object bucket_sizes: description: '' properties: '1': description: '' type: integer '3': description: '' type: integer required: *id189 type: object bucket_types: description: '' properties: '1': description: '' type: integer '11': description: '' type: integer required: *id190 type: object compat_weight_set: description: '' type: boolean device_classes: description: '' items: type: integer type: array num_buckets: description: '' type: integer num_devices: description: '' type: integer num_rules: description: '' type: integer num_types: description: '' type: integer num_weight_sets: description: '' type: integer tunables: description: '' properties: allowed_bucket_algs: description: '' type: integer choose_local_fallback_tries: description: '' type: integer choose_local_tries: description: '' type: integer choose_total_tries: description: '' type: integer chooseleaf_descend_once: description: '' type: integer chooseleaf_stable: description: '' type: integer chooseleaf_vary_r: description: '' type: integer has_v2_rules: description: '' type: integer has_v3_rules: description: '' type: integer has_v4_buckets: description: '' type: integer has_v5_rules: description: '' type: integer legacy_tunables: description: '' type: integer minimum_required_version: description: '' type: string optimal_tunables: description: '' type: integer profile: description: '' type: string require_feature_tunables: description: '' type: integer require_feature_tunables2: description: '' type: integer require_feature_tunables3: description: '' type: integer require_feature_tunables5: description: '' type: integer straw_calc_version: description: '' type: integer required: *id191 type: object required: *id192 type: object fs: description: '' properties: count: description: '' type: integer feature_flags: description: '' properties: enable_multiple: description: '' type: boolean ever_enabled_multiple: description: '' type: boolean required: *id193 type: object filesystems: description: '' items: type: integer type: array num_standby_mds: description: '' type: integer total_num_mds: description: '' type: integer required: *id194 type: object hosts: description: '' properties: num: description: '' type: integer num_with_mds: description: '' type: integer num_with_mgr: description: '' type: integer num_with_mon: description: '' type: integer num_with_osd: description: '' type: integer required: *id195 type: object leaderboard: description: '' type: boolean license: description: '' type: string metadata: description: '' properties: mon: description: '' properties: arch: description: '' properties: x86_64: description: '' type: integer required: *id196 type: object ceph_version: description: '' properties: ceph version 16.0.0-3151-gf202994fcf: description: '' type: integer required: *id197 type: object cpu: description: '' properties: Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz: description: '' type: integer required: *id198 type: object distro: description: '' properties: centos: description: '' type: integer required: *id199 type: object distro_description: description: '' properties: CentOS Linux 8 (Core): description: '' type: integer required: *id200 type: object kernel_description: description: '' properties: '#1 SMP Wed Jul 1 19:53:01 UTC 2020': description: '' type: integer required: *id201 type: object kernel_version: description: '' properties: 5.7.7-200.fc32.x86_64: description: '' type: integer required: *id202 type: object os: description: '' properties: Linux: description: '' type: integer required: *id203 type: object required: *id204 type: object osd: description: '' properties: arch: description: '' properties: x86_64: description: '' type: integer required: *id205 type: object ceph_version: description: '' properties: ceph version 16.0.0-3151-gf202994fcf: description: '' type: integer required: *id206 type: object cpu: description: '' properties: Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz: description: '' type: integer required: *id207 type: object distro: description: '' properties: centos: description: '' type: integer required: *id208 type: object distro_description: description: '' properties: CentOS Linux 8 (Core): description: '' type: integer required: *id209 type: object kernel_description: description: '' properties: '#1 SMP Wed Jul 1 19:53:01 UTC 2020': description: '' type: integer required: *id210 type: object kernel_version: description: '' properties: 5.7.7-200.fc32.x86_64: description: '' type: integer required: *id211 type: object os: description: '' properties: Linux: description: '' type: integer required: *id212 type: object osd_objectstore: description: '' properties: bluestore: description: '' type: integer required: *id213 type: object rotational: description: '' properties: '1': description: '' type: integer required: *id214 type: object required: *id215 type: object required: *id216 type: object mon: description: '' properties: count: description: '' type: integer features: description: '' properties: optional: description: '' items: type: integer type: array persistent: description: '' items: type: string type: array required: *id217 type: object ipv4_addr_mons: description: '' type: integer ipv6_addr_mons: description: '' type: integer min_mon_release: description: '' type: integer v1_addr_mons: description: '' type: integer v2_addr_mons: description: '' type: integer required: *id218 type: object osd: description: '' properties: cluster_network: description: '' type: boolean count: description: '' type: integer require_min_compat_client: description: '' type: string require_osd_release: description: '' type: string required: *id219 type: object pools: description: '' items: properties: cache_mode: description: '' type: string erasure_code_profile: description: '' type: string min_size: description: '' type: integer pg_autoscale_mode: description: '' type: string pg_num: description: '' type: integer pgp_num: description: '' type: integer pool: description: '' type: integer size: description: '' type: integer target_max_bytes: description: '' type: integer target_max_objects: description: '' type: integer type: description: '' type: string required: *id220 type: object type: array rbd: description: '' properties: mirroring_by_pool: description: '' items: type: boolean type: array num_images_by_pool: description: '' items: type: integer type: array num_pools: description: '' type: integer required: *id221 type: object report_id: description: '' type: string report_timestamp: description: '' type: string report_version: description: '' type: integer rgw: description: '' properties: count: description: '' type: integer frontends: description: '' items: type: string type: array zonegroups: description: '' type: integer zones: description: '' type: integer required: *id222 type: object services: description: '' properties: rgw: description: '' type: integer required: *id223 type: object usage: description: '' properties: pg_num: description: '' type: integer pools: description: '' type: integer total_avail_bytes: description: '' type: integer total_bytes: description: '' type: integer total_used_bytes: description: '' type: integer required: *id224 type: object required: *id225 type: object required: *id226 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get Detailed Telemetry report tags: - Telemetry /api/user: get: parameters: [] responses: '200': content: application/json: schema: properties: email: description: User email address type: string enabled: description: Is the user enabled? type: boolean lastUpdate: description: Details last updated type: integer name: description: User Name type: string pwdExpirationDate: description: Password Expiration date type: string pwdUpdateRequired: description: Is Password Update Required? type: boolean roles: description: User Roles items: type: string type: array username: description: Username of the user type: string required: &id227 - username - roles - name - email - lastUpdate - enabled - pwdExpirationDate - pwdUpdateRequired type: object application/vnd.ceph.api.v1.0+json: schema: properties: email: description: User email address type: string enabled: description: Is the user enabled? type: boolean lastUpdate: description: Details last updated type: integer name: description: User Name type: string pwdExpirationDate: description: Password Expiration date type: string pwdUpdateRequired: description: Is Password Update Required? type: boolean roles: description: User Roles items: type: string type: array username: description: Username of the user type: string required: *id227 type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] summary: Get List Of Users tags: - User post: parameters: [] requestBody: content: application/json: schema: properties: email: type: string enabled: default: true type: boolean name: type: string password: type: string pwdExpirationDate: type: string pwdUpdateRequired: default: true type: boolean roles: type: string username: type: string type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - User /api/user/validate_password: post: description: "\n Check if the password meets the password policy.\n \ \ :param password: The password to validate.\n :param username:\ \ The name of the user (optional).\n :param old_password: The old password\ \ (optional).\n :return: An object with properties valid, credits and\ \ valuation.\n 'credits' contains the password complexity credits and\n\ \ 'valuation' the textual summary of the validation.\n " parameters: [] requestBody: content: application/json: schema: properties: old_password: type: string password: type: string username: type: string required: - password type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - UserPasswordPolicy /api/user/{username}: delete: parameters: - in: path name: username required: true schema: type: string responses: '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '204': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource deleted. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - User get: parameters: - in: path name: username required: true schema: type: string responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: OK '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - User put: parameters: - in: path name: username required: true schema: type: string requestBody: content: application/json: schema: properties: email: type: string enabled: type: string name: type: string password: type: string pwdExpirationDate: type: string pwdUpdateRequired: default: false type: boolean roles: type: string type: object responses: '200': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource updated. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - User /api/user/{username}/change_password: post: parameters: - in: path name: username required: true schema: type: string requestBody: content: application/json: schema: properties: new_password: type: string old_password: type: string required: - old_password - new_password type: object responses: '201': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Resource created. '202': content: application/json: schema: type: object application/vnd.ceph.api.v1.0+json: schema: type: object description: Operation is still executing. Please check the task queue. '400': description: Operation exception. Please check the response body for details. '401': description: Unauthenticated access. Please login first. '403': description: Unauthorized access. Please check your permissions. '500': description: Unexpected error. Please check the response body for the stack trace. security: - jwt: [] tags: - UserChangePassword schemes: - https servers: - url: / tags: - description: Initiate a session with Ceph name: Auth - description: Cephfs Snapshot Scheduling API name: CephFSSnapshotSchedule - description: CephFS Subvolume Management API name: CephFSSubvolume - description: Cephfs Management API name: Cephfs - description: Cephfs Mirror Management API name: CephfsMirror - description: Cephfs Snapshot Clone Management API name: CephfsSnapshotClone - description: Cephfs Subvolume Group Management API name: CephfsSubvolumeGroup - description: Cephfs Subvolume Snapshot Management API name: CephfsSubvolumeSnapshot - description: Get Cluster Details name: Cluster - description: Manage Cluster Configurations name: ClusterConfiguration - description: Crush Rule Management API name: CrushRule - description: Perform actions on daemons name: Daemon - description: Erasure Code Profile Management API name: ErasureCodeProfile - description: Manage Features API name: FeatureTogglesEndpoint - description: Grafana Management API name: Grafana - description: Hardware management API name: Hardware - description: Display Detailed Cluster health Status name: Health - description: Get Host Details name: Host - description: Iscsi Management API name: Iscsi - description: Get Iscsi Target Details name: IscsiTarget - description: Logs Management API name: Logs - description: Mds Perf Counters Management API name: MdsPerfCounter - description: Get details of MGR Module name: MgrModule - description: Mgr Perf Counters Management API name: MgrPerfCounter - description: Mon Perf Counters Management API name: MonPerfCounter - description: Get Monitor Details name: Monitor - description: Multi-cluster Management API name: Multi-cluster - description: NFS-Ganesha Cluster Management API name: NFS-Ganesha - description: NVMe-oF Gateway Management API name: NVMe-oF Gateway - description: NVMe-oF SPDK Management API name: NVMe-oF SPDK - description: NVMe-oF Subsystem Management API name: NVMe-oF Subsystem - description: NVMe-oF Subsystem Connection Management API name: NVMe-oF Subsystem Connection - description: NVMe-oF Subsystem Host Allowlist Management API name: NVMe-oF Subsystem Host Allowlist - description: NVMe-oF Subsystem Listener Management API name: NVMe-oF Subsystem Listener - description: NVMe-oF Subsystem Namespace Management API name: NVMe-oF Subsystem Namespace - description: OSD management API name: OSD - description: OSD Perf Counters Management API name: OsdPerfCounter - description: Perf Counters Management API name: PerfCounters - description: Get pool details by pool name name: Pool - description: Prometheus Management API name: Prometheus - description: Prometheus Notifications Management API name: PrometheusNotifications - description: List of RGW roles name: RGW - description: RGW Topic Management API name: RGW Topic Management - description: RBD Management API name: Rbd - description: RBD Group Management API name: RbdGroup - description: RBD Group Snapshot Management API name: RbdGroupSnapshot - description: RBD Mirroring Management API name: RbdMirroring - description: RBD Mirroring Pool Bootstrap Management API name: RbdMirroringPoolBootstrap - description: RBD Mirroring Pool Mode Management API name: RbdMirroringPoolMode - description: RBD Mirroring Pool Peer Management API name: RbdMirroringPoolPeer - description: RBD Mirroring Summary Management API name: RbdMirroringSummary - description: RBD Namespace Management API name: RbdNamespace - description: RBD Snapshot Management API name: RbdSnapshot - description: RBD Trash Management API name: RbdTrash - description: Feedback API name: Report - description: RGW Bucket Management API name: RgwBucket - description: RGW Daemon Management API name: RgwDaemon - description: Rgw Mirroring Perf Counters Management API name: RgwMirrorPerfCounter - description: RGW Multisite Management API name: RgwMultisite - description: Rgw Perf Counters Management API name: RgwPerfCounter - description: '*No description available*' name: RgwRealm - description: RGW Site Management API name: RgwSite - description: RGW User Management API name: RgwUser - description: RGW User Accounts API name: RgwUserAccounts - description: '*No description available*' name: RgwZone - description: '*No description available*' name: RgwZonegroup - description: Role Management API name: Role - description: SMB Cluster Management API name: SMB - description: Service Management API name: Service - description: Settings Management API name: Settings - description: Get Ceph Summary Details name: Summary - description: Task Management API name: Task - description: Tcmu Runner Perf Counters Management API name: TcmuRunnerPerfCounter - description: Display Telemetry Report name: Telemetry - description: Upgrade Management API name: Upgrade - description: Display User Details name: User - description: Change User Password name: UserChangePassword - description: Get User Password Policy Details name: UserPasswordPolicy