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 Configuration API

The Configuration API from Ceph — 3 operation(s) for configuration.

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

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

This API exposes 4 operations across 3 paths, and defines 1 schema. 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.

4 operations 3 paths 1 schemas 1 DELETE2 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 Configuration 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 4

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

Configuration 4
GET
/cluster_conf
List cluster configuration
listClusterConf → 200
POST
/cluster_conf
Create or update configuration option
setClusterConf body → 201
GET
/cluster_conf/filter
Filter cluster configuration
filterClusterConf 1 param → 200
DELETE
/cluster_conf/{name}
Delete configuration option
deleteClusterConf 1 param → 204

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ClusterConfig (7 properties). Each schema is shown below with its type and property counts.

ClusterConfig
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceph-configuration-api-openapi.yml Raw ↑

Other APIs Ceph publishes across the network.

Ceph Auth API
Ceph Cluster API
Ceph CRUSH API
Ceph Daemon API
Ceph User API