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

The Auth API from Ceph — 3 operation(s) for auth.

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

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

This API exposes 3 operations across 3 paths, and defines 2 schemas. 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 3 paths 2 schemas 3 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 Auth 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 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 3
POST
/auth
Obtain JWT token
login body → 201401
POST
/auth/check
Validate token
checkAuth body → 200
POST
/auth/logout
Logout
logout → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are AuthResponse (6 properties), AuthRequest (2 properties). Each schema is shown below with its type and property counts.

AuthResponse
object
6 properties
AuthRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceph-auth-api-openapi.yml Raw ↑

Other APIs Ceph publishes across the network.

Ceph Cluster API
Ceph Configuration API
Ceph CRUSH API
Ceph Daemon API
Ceph User API