Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ceph CRUSH API

The CRUSH API from Ceph — 2 operation(s) for crush.

Ceph CRUSH API is one of 6 APIs that Ceph publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRUSH. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{manager_host}:{dashboard_port}/api.

3 operations 2 paths 0 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{manager_host}:{dashboard_port}/api
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Ceph CRUSH API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT obtained from POST /api/auth.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

CRUSH 3
GET
/crush_rule
List CRUSH rules
listCrushRules → 200
POST
/crush_rule
Create CRUSH rule
createCrushRule body → 201
DELETE
/crush_rule/{name}
Delete CRUSH rule
deleteCrushRule 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceph-crush-api-openapi.yml Raw ↑

Other APIs Ceph publishes across the network.

Ceph Auth API
Ceph Cluster API
Ceph Configuration API
Ceph Daemon API
Ceph User API