Ceph RESTful API

Introduction

The Ceph RESTful API (henceforth Ceph API) is provided by the Ceph Dashboard module. The Ceph API service is available at the same URL as the regular Ceph Dashboard, under the /api base path (please refer to Host Name and Port):

http://<server_addr>:<server_port>/api

or, if HTTPS is enabled (please refer to SSL/TLS Support):

https://<server_addr>:<ssl_server_port>/api

The Ceph API leverages the following standards:

警告

Some endpoints are still under active development, and should be carefully used since new Ceph releases could bring backward incompatible changes.

Authentication and Authorization

Requests to the Ceph API pass through two access control checkpoints:

  • Authentication: ensures that the request is performed on behalf of an existing and valid user account.

  • Authorization: ensures that the previously authenticated user can in fact perform a specific action (create, read, update or delete) on the target endpoint.

So, prior to start consuming the Ceph API, a valid JSON Web Token (JWT) has to be obtained, and it may then be reused for subsequent requests. The /api/auth endpoint will provide the valid token:

$ curl -X POST "https://example.com:8443/api/auth" \
  -H  "Accept: application/vnd.ceph.api.v1.0+json" \
  -H  "Content-Type: application/json" \
  -d '{"username": <username>, "password": <password>}'

{ "token": "<redacted_token>", ...}

The token obtained must be passed together with every API request in the Authorization HTTP header:

curl -H "Authorization: Bearer <token>" ...

Authentication and authorization can be further configured from the Ceph CLI, the Ceph-Dashboard UI and the Ceph API itself (please refer to User and Role Management).

Versioning

One of the main goals of the Ceph API is to keep a stable interface. For this purpose, Ceph API is built upon the following principles:

  • Mandatory: in order to avoid implicit defaults, all endpoints require an explicit default version (starting with 1.0).

  • Per-endpoint: as this API wraps many different Ceph components, this allows for a finer-grained change control.

    • Content/MIME Type: the version expected from a specific endpoint is stated by the Accept: application/vnd.ceph.api.v<major>.<minor>+json HTTP header. If the current Ceph API server is not able to address that specific major version, a 415 - Unsupported Media Type response will be returned.

  • Semantic Versioning: with a major.minor version:

    • Major changes are backward incompatible: they might result in non-additive changes to the request and/or response formats of a specific endpoint.

    • Minor changes are backward/forward compatible: they basically consists of additive changes to the request or response formats of a specific endpoint.

An example:

$ curl -X GET "https://example.com:8443/api/osd" \
  -H  "Accept: application/vnd.ceph.api.v1.0+json" \
  -H  "Authorization: Bearer <token>"

Specification

Auth

POST /api/auth

Example request:

POST /api/auth HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "password": "string",
    "username": "string"
}
Status Codes
POST /api/auth/check

Check token Authentication

Query Parameters

  • token (string) -- Authentication Token (Required)

Example request:

POST /api/auth/check?token=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "token": "string"
}
Status Codes
POST /api/auth/logout
Status Codes

Cephfs

GET /api/cephfs

Example request:

GET /api/cephfs HTTP/1.1
Host: example.com
Status Codes
GET /api/cephfs/{fs_id}
Parameters

  • fs_id (string) --

Example request:

GET /api/cephfs/{fs_id} HTTP/1.1
Host: example.com
Status Codes
DELETE /api/cephfs/{fs_id}/client/{client_id}
Parameters

  • fs_id (string) --

  • client_id (string) --

Status Codes
GET /api/cephfs/{fs_id}/clients
Parameters

  • fs_id (string) --

Example request:

GET /api/cephfs/{fs_id}/clients HTTP/1.1
Host: example.com
Status Codes
GET /api/cephfs/{fs_id}/get_root_directory

The root directory that can't be fetched using ls_dir (api). :param fs_id: The filesystem identifier. :return: The root directory :rtype: dict

Parameters

  • fs_id (string) --

Example request:

GET /api/cephfs/{fs_id}/get_root_directory HTTP/1.1
Host: example.com
Status Codes
GET /api/cephfs/{fs_id}/ls_dir

List directories of specified path. :param fs_id: The filesystem identifier. :param path: The path where to start listing the directory content. Defaults to '/' if not set. :type path: str | bytes :param depth: The number of steps to go down the directory tree. :type depth: int | str :return: The names of the directories below the specified path. :rtype: list

Parameters

  • fs_id (string) --

Query Parameters

  • path (string) --

  • depth (integer) --

Example request:

GET /api/cephfs/{fs_id}/ls_dir HTTP/1.1
Host: example.com
Status Codes
GET /api/cephfs/{fs_id}/mds_counters
Parameters

  • fs_id (string) --

Query Parameters

  • counters (integer) --

Example request:

GET /api/cephfs/{fs_id}/mds_counters HTTP/1.1
Host: example.com
Status Codes
GET /api/cephfs/{fs_id}/quota

Get Cephfs Quotas of the specified path

Get the quotas of the specified path. :param fs_id: The filesystem identifier. :param path: The path of the directory/file. :return: Returns a dictionary containing 'max_bytes' and 'max_files'. :rtype: dict

Parameters

  • fs_id (string) -- File System Identifier

Query Parameters

  • path (string) -- File System Path (Required)

Example request:

GET /api/cephfs/{fs_id}/quota?path=string HTTP/1.1
Host: example.com
Status Codes
PUT /api/cephfs/{fs_id}/quota

Set the quotas of the specified path. :param fs_id: The filesystem identifier. :param path: The path of the directory/file. :param max_bytes: The byte limit. :param max_files: The file limit.

Parameters

  • fs_id (string) --

Example request:

PUT /api/cephfs/{fs_id}/quota HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "max_bytes": "string",
    "max_files": "string",
    "path": "string"
}
Status Codes
DELETE /api/cephfs/{fs_id}/snapshot

Remove a snapshot. :param fs_id: The filesystem identifier. :param path: The path of the directory. :param name: The name of the snapshot.

Parameters

  • fs_id (string) --

Query Parameters

  • path (string) -- (Required)

  • name (string) -- (Required)

Status Codes
POST /api/cephfs/{fs_id}/snapshot

Create a snapshot. :param fs_id: The filesystem identifier. :param path: The path of the directory. :param name: The name of the snapshot. If not specified, a name using the current time in RFC3339 UTC format will be generated. :return: The name of the snapshot. :rtype: str

Parameters

  • fs_id (string) --

Example request:

POST /api/cephfs/{fs_id}/snapshot HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "path": "string"
}
Status Codes
DELETE /api/cephfs/{fs_id}/tree

Remove a directory. :param fs_id: The filesystem identifier. :param path: The path of the directory.

Parameters

  • fs_id (string) --

Query Parameters

  • path (string) -- (Required)

Status Codes
POST /api/cephfs/{fs_id}/tree

Create a directory. :param fs_id: The filesystem identifier. :param path: The path of the directory.

Parameters

  • fs_id (string) --

Example request:

POST /api/cephfs/{fs_id}/tree HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "path": "string"
}
Status Codes

Cluster

GET /api/cluster

Get the cluster status

Example request:

GET /api/cluster HTTP/1.1
Host: example.com
Status Codes
PUT /api/cluster

Update the cluster status

Example request:

PUT /api/cluster HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "status": "string"
}
Status Codes

ClusterConfiguration

GET /api/cluster_conf

Example request:

GET /api/cluster_conf HTTP/1.1
Host: example.com
Status Codes
POST /api/cluster_conf

Example request:

POST /api/cluster_conf HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string",
    "value": "string"
}
Status Codes
PUT /api/cluster_conf

Example request:

PUT /api/cluster_conf HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "options": "string"
}
Status Codes
GET /api/cluster_conf/filter

Get Cluster Configuration by name

Query Parameters

  • names (string) -- Config option names

Example request:

GET /api/cluster_conf/filter HTTP/1.1
Host: example.com
Status Codes
DELETE /api/cluster_conf/{name}
Parameters

  • name (string) --

Query Parameters

  • section (string) -- (Required)

Status Codes
GET /api/cluster_conf/{name}
Parameters

  • name (string) --

Example request:

GET /api/cluster_conf/{name} HTTP/1.1
Host: example.com
Status Codes

CrushRule

GET /api/crush_rule

List Crush Rule Configuration

Example request:

GET /api/crush_rule HTTP/1.1
Host: example.com
Status Codes
POST /api/crush_rule

Example request:

POST /api/crush_rule HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "device_class": "string",
    "failure_domain": "string",
    "name": "string",
    "root": "string"
}
Status Codes
DELETE /api/crush_rule/{name}
Parameters

  • name (string) --

Status Codes
GET /api/crush_rule/{name}
Parameters

  • name (string) --

Example request:

GET /api/crush_rule/{name} HTTP/1.1
Host: example.com
Status Codes

Daemon

PUT /api/daemon/{daemon_name}
Parameters

  • daemon_name (string) --

Example request:

PUT /api/daemon/{daemon_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "action": "string",
    "container_image": "string"
}
Status Codes

ErasureCodeProfile

GET /api/erasure_code_profile

List Erasure Code Profile Information

Example request:

GET /api/erasure_code_profile HTTP/1.1
Host: example.com
Status Codes
POST /api/erasure_code_profile

Example request:

POST /api/erasure_code_profile HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "string"
}
Status Codes
DELETE /api/erasure_code_profile/{name}
Parameters

  • name (string) --

Status Codes
GET /api/erasure_code_profile/{name}
Parameters

  • name (string) --

Example request:

GET /api/erasure_code_profile/{name} HTTP/1.1
Host: example.com
Status Codes

FeatureTogglesEndpoint

GET /api/feature_toggles

Get List Of Features

Example request:

GET /api/feature_toggles HTTP/1.1
Host: example.com
Status Codes

Grafana

POST /api/grafana/dashboards
Status Codes
GET /api/grafana/url

List Grafana URL Instance

Example request:

GET /api/grafana/url HTTP/1.1
Host: example.com
Status Codes
GET /api/grafana/validation/{params}
Parameters

  • params (string) --

Example request:

GET /api/grafana/validation/{params} HTTP/1.1
Host: example.com
Status Codes

Health

GET /api/health/full

Example request:

GET /api/health/full HTTP/1.1
Host: example.com
Status Codes
GET /api/health/minimal

Get Cluster's minimal health report

Example request:

GET /api/health/minimal HTTP/1.1
Host: example.com
Status Codes

Host

GET /api/host

List Host Specifications

Query Parameters

  • sources (string) -- Host Sources

  • facts (boolean) -- Host Facts

Example request:

GET /api/host HTTP/1.1
Host: example.com
Status Codes
POST /api/host

Example request:

POST /api/host HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "addr": "string",
    "hostname": "string",
    "labels": [
        "string"
    ],
    "status": "string"
}
Status Codes
DELETE /api/host/{hostname}
Parameters

  • hostname (string) --

Status Codes
GET /api/host/{hostname}

Get the specified host. :raises: cherrypy.HTTPError: If host not found.

Parameters

  • hostname (string) --

Example request:

GET /api/host/{hostname} HTTP/1.1
Host: example.com
Status Codes
PUT /api/host/{hostname}

Update the specified host. Note, this is only supported when Ceph Orchestrator is enabled. :param hostname: The name of the host to be processed. :param update_labels: To update the labels. :param labels: List of labels. :param maintenance: Enter/Exit maintenance mode. :param force: Force enter maintenance mode. :param drain: Drain host

Parameters

  • hostname (string) -- Hostname

Example request:

PUT /api/host/{hostname} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "drain": true,
    "force": true,
    "labels": [
        "string"
    ],
    "maintenance": true,
    "update_labels": true
}
Status Codes
GET /api/host/{hostname}/daemons
Parameters

  • hostname (string) --

Example request:

GET /api/host/{hostname}/daemons HTTP/1.1
Host: example.com
Status Codes
GET /api/host/{hostname}/devices
Parameters

  • hostname (string) --

Example request:

GET /api/host/{hostname}/devices HTTP/1.1
Host: example.com
Status Codes
POST /api/host/{hostname}/identify_device

Identify a device by switching on the device light for N seconds. :param hostname: The hostname of the device to process. :param device: The device identifier to process, e.g. /dev/dm-0 or ABC1234DEF567-1R1234_ABC8DE0Q. :param duration: The duration in seconds how long the LED should flash.

Parameters

  • hostname (string) --

Example request:

POST /api/host/{hostname}/identify_device HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "device": "string",
    "duration": "string"
}
Status Codes
GET /api/host/{hostname}/inventory

Get inventory of a host

Parameters

  • hostname (string) -- Hostname

Query Parameters

  • refresh (string) -- Trigger asynchronous refresh

Example request:

GET /api/host/{hostname}/inventory HTTP/1.1
Host: example.com
Status Codes
GET /api/host/{hostname}/smart
Parameters

  • hostname (string) --

Example request:

GET /api/host/{hostname}/smart HTTP/1.1
Host: example.com
Status Codes

Iscsi

GET /api/iscsi/discoveryauth

Get Iscsi discoveryauth Details

Example request:

GET /api/iscsi/discoveryauth HTTP/1.1
Host: example.com
Status Codes
PUT /api/iscsi/discoveryauth

Set Iscsi discoveryauth

Query Parameters

  • user (string) -- Username (Required)

  • password (string) -- Password (Required)

  • mutual_user (string) -- Mutual UserName (Required)

  • mutual_password (string) -- Mutual Password (Required)

Example request:

PUT /api/iscsi/discoveryauth?user=string&password=string&mutual_user=string&mutual_password=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "mutual_password": "string",
    "mutual_user": "string",
    "password": "string",
    "user": "string"
}
Status Codes

IscsiTarget

GET /api/iscsi/target

Example request:

GET /api/iscsi/target HTTP/1.1
Host: example.com
Status Codes
POST /api/iscsi/target

Example request:

POST /api/iscsi/target HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "acl_enabled": "string",
    "auth": "string",
    "clients": "string",
    "disks": "string",
    "groups": "string",
    "portals": "string",
    "target_controls": "string",
    "target_iqn": "string"
}
Status Codes
DELETE /api/iscsi/target/{target_iqn}
Parameters

  • target_iqn (string) --

Status Codes
GET /api/iscsi/target/{target_iqn}
Parameters

  • target_iqn (string) --

Example request:

GET /api/iscsi/target/{target_iqn} HTTP/1.1
Host: example.com
Status Codes
PUT /api/iscsi/target/{target_iqn}
Parameters

  • target_iqn (string) --

Example request:

PUT /api/iscsi/target/{target_iqn} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "acl_enabled": "string",
    "auth": "string",
    "clients": "string",
    "disks": "string",
    "groups": "string",
    "new_target_iqn": "string",
    "portals": "string",
    "target_controls": "string"
}
Status Codes

Logs

GET /api/logs/all

Display Logs Configuration

Example request:

GET /api/logs/all HTTP/1.1
Host: example.com
Status Codes

MdsPerfCounter

GET /api/perf_counters/mds/{service_id}
Parameters

  • service_id (string) --

Example request:

GET /api/perf_counters/mds/{service_id} HTTP/1.1
Host: example.com
Status Codes

MgrModule

GET /api/mgr/module

List Mgr modules

Get the list of managed modules. :return: A list of objects with the fields 'enabled', 'name' and 'options'. :rtype: list

Example request:

GET /api/mgr/module HTTP/1.1
Host: example.com
Status Codes
GET /api/mgr/module/{module_name}

Retrieve the values of the persistent configuration settings. :param module_name: The name of the Ceph Mgr module. :type module_name: str :return: The values of the module options. :rtype: dict

Parameters

  • module_name (string) --

Example request:

GET /api/mgr/module/{module_name} HTTP/1.1
Host: example.com
Status Codes
PUT /api/mgr/module/{module_name}

Set the values of the persistent configuration settings. :param module_name: The name of the Ceph Mgr module. :type module_name: str :param config: The values of the module options to be stored. :type config: dict

Parameters

  • module_name (string) --

Example request:

PUT /api/mgr/module/{module_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "config": "string"
}
Status Codes
POST /api/mgr/module/{module_name}/disable

Disable the specified Ceph Mgr module. :param module_name: The name of the Ceph Mgr module. :type module_name: str

Parameters

  • module_name (string) --

Status Codes
POST /api/mgr/module/{module_name}/enable

Enable the specified Ceph Mgr module. :param module_name: The name of the Ceph Mgr module. :type module_name: str

Parameters

  • module_name (string) --

Status Codes
GET /api/mgr/module/{module_name}/options

Get the module options of the specified Ceph Mgr module. :param module_name: The name of the Ceph Mgr module. :type module_name: str :return: The module options as list of dicts. :rtype: list

Parameters

  • module_name (string) --

Example request:

GET /api/mgr/module/{module_name}/options HTTP/1.1
Host: example.com
Status Codes

MgrPerfCounter

GET /api/perf_counters/mgr/{service_id}
Parameters

  • service_id (string) --

Example request:

GET /api/perf_counters/mgr/{service_id} HTTP/1.1
Host: example.com
Status Codes

MonPerfCounter

GET /api/perf_counters/mon/{service_id}
Parameters

  • service_id (string) --

Example request:

GET /api/perf_counters/mon/{service_id} HTTP/1.1
Host: example.com
Status Codes

Monitor

GET /api/monitor

Get Monitor Details

Example request:

GET /api/monitor HTTP/1.1
Host: example.com
Status Codes

NFS-Ganesha

GET /api/nfs-ganesha/cluster

Example request:

GET /api/nfs-ganesha/cluster HTTP/1.1
Host: example.com
Status Codes
GET /api/nfs-ganesha/export

List all NFS-Ganesha exports

Example request:

GET /api/nfs-ganesha/export HTTP/1.1
Host: example.com
Status Codes
POST /api/nfs-ganesha/export

Creates a new NFS-Ganesha export

Example request:

POST /api/nfs-ganesha/export HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_type": "string",
    "clients": [
        {
            "access_type": "string",
            "addresses": [
                "string"
            ],
            "squash": "string"
        }
    ],
    "cluster_id": "string",
    "fsal": {
        "fs_name": "string",
        "name": "string",
        "sec_label_xattr": "string"
    },
    "path": "string",
    "protocols": [
        1
    ],
    "pseudo": "string",
    "security_label": "string",
    "squash": "string",
    "transports": [
        "string"
    ]
}
Status Codes
DELETE /api/nfs-ganesha/export/{cluster_id}/{export_id}

Deletes an NFS-Ganesha export

Parameters

  • cluster_id (string) -- Cluster identifier

  • export_id (integer) -- Export ID

Status Codes
GET /api/nfs-ganesha/export/{cluster_id}/{export_id}

Get an NFS-Ganesha export

Parameters

  • cluster_id (string) -- Cluster identifier

  • export_id (string) -- Export ID

Example request:

GET /api/nfs-ganesha/export/{cluster_id}/{export_id} HTTP/1.1
Host: example.com
Status Codes
PUT /api/nfs-ganesha/export/{cluster_id}/{export_id}

Updates an NFS-Ganesha export

Parameters

  • cluster_id (string) -- Cluster identifier

  • export_id (integer) -- Export ID

Example request:

PUT /api/nfs-ganesha/export/{cluster_id}/{export_id} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_type": "string",
    "clients": [
        {
            "access_type": "string",
            "addresses": [
                "string"
            ],
            "squash": "string"
        }
    ],
    "fsal": {
        "fs_name": "string",
        "name": "string",
        "sec_label_xattr": "string"
    },
    "path": "string",
    "protocols": [
        1
    ],
    "pseudo": "string",
    "security_label": "string",
    "squash": "string",
    "transports": [
        "string"
    ]
}
Status Codes
GET /api/nfs-ganesha/status

Status of NFS-Ganesha management feature

Example request:

GET /api/nfs-ganesha/status HTTP/1.1
Host: example.com
Status Codes

OSD

GET /api/osd

Example request:

GET /api/osd HTTP/1.1
Host: example.com
Status Codes
POST /api/osd

Example request:

POST /api/osd HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "data": "string",
    "method": "string",
    "tracking_id": "string"
}
Status Codes
GET /api/osd/flags

Display OSD Flags

Example request:

GET /api/osd/flags HTTP/1.1
Host: example.com
Status Codes
PUT /api/osd/flags

Sets OSD flags for the entire cluster.

The recovery_deletes, sortbitwise and pglog_hardlimit flags cannot be unset. purged_snapshots cannot even be set. It is therefore required to at least include those four flags for a successful operation.

Example request:

PUT /api/osd/flags HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "flags": [
        "string"
    ]
}
Status Codes
GET /api/osd/flags/individual

Displays individual OSD flags

Example request:

GET /api/osd/flags/individual HTTP/1.1
Host: example.com
Status Codes
PUT /api/osd/flags/individual

Sets OSD flags for a subset of individual OSDs.

Updates flags (noout, noin, nodown, noup) for an individual subset of OSDs.

Example request:

PUT /api/osd/flags/individual HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "flags": {
        "nodown": true,
        "noin": true,
        "noout": true,
        "noup": true
    },
    "ids": [
        1
    ]
}
Status Codes
GET /api/osd/safe_to_delete
type ids

int|[int]

Query Parameters

  • svc_ids (string) -- (Required)

Example request:

GET /api/osd/safe_to_delete?svc_ids=string HTTP/1.1
Host: example.com
Status Codes
GET /api/osd/safe_to_destroy

Check If OSD is Safe to Destroy

type ids

int|[int]

Query Parameters

  • ids (string) -- OSD Service Identifier (Required)

Example request:

GET /api/osd/safe_to_destroy?ids=string HTTP/1.1
Host: example.com
Status Codes
GET /api/osd/settings

Example request:

GET /api/osd/settings HTTP/1.1
Host: example.com
Status Codes
DELETE /api/osd/{svc_id}
Parameters

  • svc_id (string) --

Query Parameters

  • preserve_id (string) --

  • force (string) --

Status Codes
GET /api/osd/{svc_id}

Returns collected data about an OSD.

return

Returns the requested data.

Parameters

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id} HTTP/1.1
Host: example.com
Status Codes
PUT /api/osd/{svc_id}
Parameters

  • svc_id (string) --

Example request:

PUT /api/osd/{svc_id} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "device_class": "string"
}
Status Codes
POST /api/osd/{svc_id}/destroy

Mark osd as being destroyed. Keeps the ID intact (allowing reuse), but removes cephx keys, config-key data and lockbox keys, rendering data permanently unreadable.

The osd must be marked down before being destroyed.

Parameters

  • svc_id (string) --

Status Codes
GET /api/osd/{svc_id}/devices
Parameters

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id}/devices HTTP/1.1
Host: example.com
Status Codes
GET /api/osd/{svc_id}/histogram
return

Returns the histogram data.

Parameters

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id}/histogram HTTP/1.1
Host: example.com
Status Codes
PUT /api/osd/{svc_id}/mark

Mark OSD flags (out, in, down, lost, ...)

Note: osd must be marked down before marking lost.

Parameters

  • svc_id (string) -- SVC ID

Example request:

PUT /api/osd/{svc_id}/mark HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "action": "string"
}
Status Codes
POST /api/osd/{svc_id}/purge

Note: osd must be marked down before removal.

Parameters

  • svc_id (string) --

Status Codes
POST /api/osd/{svc_id}/reweight

Reweights the OSD temporarily.

Note that ‘ceph osd reweight’ is not a persistent setting. When an OSD gets marked out, the osd weight will be set to 0. When it gets marked in again, the weight will be changed to 1.

Because of this ‘ceph osd reweight’ is a temporary solution. You should only use it to keep your cluster running while you’re ordering more hardware.

Parameters

  • svc_id (string) --

Example request:

POST /api/osd/{svc_id}/reweight HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "weight": "string"
}
Status Codes
POST /api/osd/{svc_id}/scrub
Parameters

  • svc_id (string) --

Query Parameters

  • deep (boolean) --

Example request:

POST /api/osd/{svc_id}/scrub HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "deep": true
}
Status Codes
GET /api/osd/{svc_id}/smart
Parameters

  • svc_id (string) --

Example request:

GET /api/osd/{svc_id}/smart HTTP/1.1
Host: example.com
Status Codes

Orchestrator

GET /api/orchestrator/status

Display Orchestrator Status

Example request:

GET /api/orchestrator/status HTTP/1.1
Host: example.com
Status Codes

OsdPerfCounter

GET /api/perf_counters/osd/{service_id}
Parameters

  • service_id (string) --

Example request:

GET /api/perf_counters/osd/{service_id} HTTP/1.1
Host: example.com
Status Codes

PerfCounters

GET /api/perf_counters

Display Perf Counters

Example request:

GET /api/perf_counters HTTP/1.1
Host: example.com
Status Codes

Pool

GET /api/pool

Display Pool List

Query Parameters

  • attrs (string) -- Pool Attributes

  • stats (boolean) -- Pool Stats

Example request:

GET /api/pool HTTP/1.1
Host: example.com
Status Codes
POST /api/pool

Example request:

POST /api/pool HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "application_metadata": "string",
    "configuration": "string",
    "erasure_code_profile": "string",
    "flags": "string",
    "pg_num": 1,
    "pool": "string",
    "pool_type": "string",
    "rule_name": "string"
}
Status Codes
DELETE /api/pool/{pool_name}
Parameters

  • pool_name (string) --

Status Codes
GET /api/pool/{pool_name}
Parameters

  • pool_name (string) --

Query Parameters

  • attrs (string) --

  • stats (boolean) --

Example request:

GET /api/pool/{pool_name} HTTP/1.1
Host: example.com
Status Codes
PUT /api/pool/{pool_name}
Parameters

  • pool_name (string) --

Example request:

PUT /api/pool/{pool_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "application_metadata": "string",
    "configuration": "string",
    "flags": "string"
}
Status Codes
GET /api/pool/{pool_name}/configuration
Parameters

  • pool_name (string) --

Example request:

GET /api/pool/{pool_name}/configuration HTTP/1.1
Host: example.com
Status Codes

Prometheus

GET /api/prometheus

Example request:

GET /api/prometheus HTTP/1.1
Host: example.com
Status Codes
GET /api/prometheus/rules

Example request:

GET /api/prometheus/rules HTTP/1.1
Host: example.com
Status Codes
POST /api/prometheus/silence
Status Codes
DELETE /api/prometheus/silence/{s_id}
Parameters

  • s_id (string) --

Status Codes
GET /api/prometheus/silences

Example request:

GET /api/prometheus/silences HTTP/1.1
Host: example.com
Status Codes

PrometheusNotifications

GET /api/prometheus/notifications

Example request:

GET /api/prometheus/notifications HTTP/1.1
Host: example.com
Status Codes

Rbd

GET /api/block/image

Display Rbd Images

Query Parameters

  • pool_name (string) -- Pool Name

Example request:

GET /api/block/image HTTP/1.1
Host: example.com
Status Codes
POST /api/block/image

Example request:

POST /api/block/image HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "configuration": "string",
    "data_pool": "string",
    "features": "string",
    "name": "string",
    "namespace": "string",
    "obj_size": 1,
    "pool_name": "string",
    "size": 1,
    "stripe_count": 1,
    "stripe_unit": "string"
}
Status Codes
GET /api/block/image/clone_format_version

Return the RBD clone format version.

Example request:

GET /api/block/image/clone_format_version HTTP/1.1
Host: example.com
Status Codes
GET /api/block/image/default_features

Example request:

GET /api/block/image/default_features HTTP/1.1
Host: example.com
Status Codes
DELETE /api/block/image/{image_spec}
Parameters

  • image_spec (string) --

Status Codes
GET /api/block/image/{image_spec}
Parameters

  • image_spec (string) --

Example request:

GET /api/block/image/{image_spec} HTTP/1.1
Host: example.com
Status Codes
PUT /api/block/image/{image_spec}
Parameters

  • image_spec (string) --

Example request:

PUT /api/block/image/{image_spec} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "configuration": "string",
    "features": "string",
    "name": "string",
    "size": 1
}
Status Codes
POST /api/block/image/{image_spec}/copy
Parameters

  • image_spec (string) --

Example request:

POST /api/block/image/{image_spec}/copy HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "configuration": "string",
    "data_pool": "string",
    "dest_image_name": "string",
    "dest_namespace": "string",
    "dest_pool_name": "string",
    "features": "string",
    "obj_size": 1,
    "snapshot_name": "string",
    "stripe_count": 1,
    "stripe_unit": "string"
}
Status Codes
POST /api/block/image/{image_spec}/flatten
Parameters

  • image_spec (string) --

Status Codes
POST /api/block/image/{image_spec}/move_trash
Move an image to the trash.

Images, even ones actively in-use by clones, can be moved to the trash and deleted at a later time.

Parameters

  • image_spec (string) --

Example request:

POST /api/block/image/{image_spec}/move_trash HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "delay": 1
}
Status Codes

RbdMirroring

GET /api/block/mirroring/site_name

Display Rbd Mirroring sitename

Example request:

GET /api/block/mirroring/site_name HTTP/1.1
Host: example.com
Status Codes
PUT /api/block/mirroring/site_name

Example request:

PUT /api/block/mirroring/site_name HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "site_name": "string"
}
Status Codes

RbdMirroringPoolBootstrap

POST /api/block/mirroring/pool/{pool_name}/bootstrap/peer
Parameters

  • pool_name (string) --

Example request:

POST /api/block/mirroring/pool/{pool_name}/bootstrap/peer HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "direction": "string",
    "token": "string"
}
Status Codes
POST /api/block/mirroring/pool/{pool_name}/bootstrap/token
Parameters

  • pool_name (string) --

Status Codes

RbdMirroringPoolMode

GET /api/block/mirroring/pool/{pool_name}

Display Rbd Mirroring Summary

Parameters

  • pool_name (string) -- Pool Name

Example request:

GET /api/block/mirroring/pool/{pool_name} HTTP/1.1
Host: example.com
Status Codes
PUT /api/block/mirroring/pool/{pool_name}
Parameters

  • pool_name (string) --

Example request:

PUT /api/block/mirroring/pool/{pool_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "mirror_mode": "string"
}
Status Codes

RbdMirroringPoolPeer

GET /api/block/mirroring/pool/{pool_name}/peer
Parameters

  • pool_name (string) --

Example request:

GET /api/block/mirroring/pool/{pool_name}/peer HTTP/1.1
Host: example.com
Status Codes
POST /api/block/mirroring/pool/{pool_name}/peer
Parameters

  • pool_name (string) --

Example request:

POST /api/block/mirroring/pool/{pool_name}/peer HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "client_id": "string",
    "cluster_name": "string",
    "key": "string",
    "mon_host": "string"
}
Status Codes
DELETE /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
Parameters

  • pool_name (string) --

  • peer_uuid (string) --

Status Codes
GET /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
Parameters

  • pool_name (string) --

  • peer_uuid (string) --

Example request:

GET /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid} HTTP/1.1
Host: example.com
Status Codes
PUT /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}
Parameters

  • pool_name (string) --

  • peer_uuid (string) --

Example request:

PUT /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "client_id": "string",
    "cluster_name": "string",
    "key": "string",
    "mon_host": "string"
}
Status Codes

RbdMirroringSummary

GET /api/block/mirroring/summary

Display Rbd Mirroring Summary

Example request:

GET /api/block/mirroring/summary HTTP/1.1
Host: example.com
Status Codes

RbdNamespace

GET /api/block/pool/{pool_name}/namespace
Parameters

  • pool_name (string) --

Example request:

GET /api/block/pool/{pool_name}/namespace HTTP/1.1
Host: example.com
Status Codes
POST /api/block/pool/{pool_name}/namespace
Parameters

  • pool_name (string) --

Example request:

POST /api/block/pool/{pool_name}/namespace HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "namespace": "string"
}
Status Codes
DELETE /api/block/pool/{pool_name}/namespace/{namespace}
Parameters

  • pool_name (string) --

  • namespace (string) --

Status Codes

RbdSnapshot

POST /api/block/image/{image_spec}/snap
Parameters

  • image_spec (string) --

Example request:

POST /api/block/image/{image_spec}/snap HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "snapshot_name": "string"
}
Status Codes
DELETE /api/block/image/{image_spec}/snap/{snapshot_name}
Parameters

  • image_spec (string) --

  • snapshot_name (string) --

Status Codes
PUT /api/block/image/{image_spec}/snap/{snapshot_name}
Parameters

  • image_spec (string) --

  • snapshot_name (string) --

Example request:

PUT /api/block/image/{image_spec}/snap/{snapshot_name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "is_protected": true,
    "new_snap_name": "string"
}
Status Codes
POST /api/block/image/{image_spec}/snap/{snapshot_name}/clone

Clones a snapshot to an image

Parameters

  • image_spec (string) --

  • snapshot_name (string) --

Example request:

POST /api/block/image/{image_spec}/snap/{snapshot_name}/clone HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "child_image_name": "string",
    "child_namespace": "string",
    "child_pool_name": "string",
    "configuration": "string",
    "data_pool": "string",
    "features": "string",
    "obj_size": 1,
    "stripe_count": 1,
    "stripe_unit": "string"
}
Status Codes
POST /api/block/image/{image_spec}/snap/{snapshot_name}/rollback
Parameters

  • image_spec (string) --

  • snapshot_name (string) --

Status Codes

RbdTrash

GET /api/block/image/trash

Get RBD Trash Details by pool name

List all entries from trash.

Query Parameters

  • pool_name (string) -- Name of the pool

Example request:

GET /api/block/image/trash HTTP/1.1
Host: example.com
Status Codes
POST /api/block/image/trash/purge

Remove all expired images from trash.

Query Parameters

  • pool_name (string) --

Example request:

POST /api/block/image/trash/purge HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "pool_name": "string"
}
Status Codes
DELETE /api/block/image/trash/{image_id_spec}
Delete an image from trash.

If image deferment time has not expired you can not removed it unless use force. But an actively in-use by clones or has snapshots can not be removed.

Parameters

  • image_id_spec (string) --

Query Parameters

  • force (boolean) --

Status Codes
POST /api/block/image/trash/{image_id_spec}/restore

Restore an image from trash.

Parameters

  • image_id_spec (string) --

Example request:

POST /api/block/image/trash/{image_id_spec}/restore HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "new_image_name": "string"
}
Status Codes

Report

GET /api/feedback

List all issues details.

Example request:

GET /api/feedback HTTP/1.1
Host: example.com
Status Codes
POST /api/feedback

Create an issue. :param project: The affected ceph component. :param tracker: The tracker type. :param subject: The title of the issue. :param description: The description of the issue. :param api_key: Ceph tracker api key.

Example request:

POST /api/feedback HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "api_key": "string",
    "description": "string",
    "project": "string",
    "subject": "string",
    "tracker": "string"
}
Status Codes
DELETE /api/feedback/api_key

Deletes Ceph tracker API key.

Status Codes
GET /api/feedback/api_key

Returns Ceph tracker API key.

Example request:

GET /api/feedback/api_key HTTP/1.1
Host: example.com
Status Codes
POST /api/feedback/api_key

Sets Ceph tracker API key. :param api_key: The Ceph tracker API key.

Example request:

POST /api/feedback/api_key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "api_key": "string"
}
Status Codes

Rgw

GET /api/rgw/status

Display RGW Status

Example request:

GET /api/rgw/status HTTP/1.1
Host: example.com
Status Codes

RgwBucket

GET /api/rgw/bucket
Query Parameters

  • stats (boolean) --

  • daemon_name (string) --

  • uid (string) --

Example request:

GET /api/rgw/bucket HTTP/1.1
Host: example.com
Status Codes
POST /api/rgw/bucket

Example request:

POST /api/rgw/bucket HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket": "string",
    "daemon_name": "string",
    "lock_enabled": "string",
    "lock_mode": "string",
    "lock_retention_period_days": "string",
    "lock_retention_period_years": "string",
    "placement_target": "string",
    "uid": "string",
    "zonegroup": "string"
}
Status Codes
DELETE /api/rgw/bucket/{bucket}
Parameters

  • bucket (string) --

Query Parameters

  • purge_objects (string) --

  • daemon_name (string) --

Status Codes
GET /api/rgw/bucket/{bucket}
Parameters

  • bucket (string) --

Query Parameters

  • daemon_name (string) --

Example request:

GET /api/rgw/bucket/{bucket} HTTP/1.1
Host: example.com
Status Codes
PUT /api/rgw/bucket/{bucket}
Parameters

  • bucket (string) --

Example request:

PUT /api/rgw/bucket/{bucket} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_id": "string",
    "daemon_name": "string",
    "lock_mode": "string",
    "lock_retention_period_days": "string",
    "lock_retention_period_years": "string",
    "mfa_delete": "string",
    "mfa_token_pin": "string",
    "mfa_token_serial": "string",
    "uid": "string",
    "versioning_state": "string"
}
Status Codes

RgwDaemon

GET /api/rgw/daemon

Display RGW Daemons

Example request:

GET /api/rgw/daemon HTTP/1.1
Host: example.com
Status Codes
GET /api/rgw/daemon/{svc_id}
Parameters

  • svc_id (string) --

Example request:

GET /api/rgw/daemon/{svc_id} HTTP/1.1
Host: example.com
Status Codes

RgwMirrorPerfCounter

GET /api/perf_counters/rbd-mirror/{service_id}
Parameters

  • service_id (string) --

Example request:

GET /api/perf_counters/rbd-mirror/{service_id} HTTP/1.1
Host: example.com
Status Codes

RgwPerfCounter

GET /api/perf_counters/rgw/{service_id}
Parameters

  • service_id (string) --

Example request:

GET /api/perf_counters/rgw/{service_id} HTTP/1.1
Host: example.com
Status Codes

RgwSite

GET /api/rgw/site
Query Parameters

  • query (string) --

  • daemon_name (string) --

Example request:

GET /api/rgw/site HTTP/1.1
Host: example.com
Status Codes

RgwUser

GET /api/rgw/user

Display RGW Users

Query Parameters

  • daemon_name (string) --

Example request:

GET /api/rgw/user HTTP/1.1
Host: example.com
Status Codes
POST /api/rgw/user

Example request:

POST /api/rgw/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "string",
    "daemon_name": "string",
    "display_name": "string",
    "email": "string",
    "generate_key": "string",
    "max_buckets": "string",
    "secret_key": "string",
    "suspended": "string",
    "uid": "string"
}
Status Codes
GET /api/rgw/user/get_emails
Query Parameters

  • daemon_name (string) --

Example request:

GET /api/rgw/user/get_emails HTTP/1.1
Host: example.com
Status Codes
DELETE /api/rgw/user/{uid}
Parameters

  • uid (string) --

Query Parameters

  • daemon_name (string) --

Status Codes
GET /api/rgw/user/{uid}
Parameters

  • uid (string) --

Query Parameters

  • daemon_name (string) --

  • stats (boolean) --

Example request:

GET /api/rgw/user/{uid} HTTP/1.1
Host: example.com
Status Codes
PUT /api/rgw/user/{uid}
Parameters

  • uid (string) --

Example request:

PUT /api/rgw/user/{uid} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "string",
    "display_name": "string",
    "email": "string",
    "max_buckets": "string",
    "suspended": "string"
}
Status Codes
DELETE /api/rgw/user/{uid}/capability
Parameters

  • uid (string) --

Query Parameters

  • type (string) -- (Required)

  • perm (string) -- (Required)

  • daemon_name (string) --

Status Codes
POST /api/rgw/user/{uid}/capability
Parameters

  • uid (string) --

Example request:

POST /api/rgw/user/{uid}/capability HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "string",
    "perm": "string",
    "type": "string"
}
Status Codes
DELETE /api/rgw/user/{uid}/key
Parameters

  • uid (string) --

Query Parameters

  • key_type (string) --

  • subuser (string) --

  • access_key (string) --

  • daemon_name (string) --

Status Codes
POST /api/rgw/user/{uid}/key
Parameters

  • uid (string) --

Example request:

POST /api/rgw/user/{uid}/key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "string",
    "daemon_name": "string",
    "generate_key": "string",
    "key_type": "string",
    "secret_key": "string",
    "subuser": "string"
}
Status Codes
GET /api/rgw/user/{uid}/quota
Parameters

  • uid (string) --

Query Parameters

  • daemon_name (string) --

Example request:

GET /api/rgw/user/{uid}/quota HTTP/1.1
Host: example.com
Status Codes
PUT /api/rgw/user/{uid}/quota
Parameters

  • uid (string) --

Example request:

PUT /api/rgw/user/{uid}/quota HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "string",
    "enabled": "string",
    "max_objects": "string",
    "max_size_kb": 1,
    "quota_type": "string"
}
Status Codes
POST /api/rgw/user/{uid}/subuser
Parameters

  • uid (string) --

Example request:

POST /api/rgw/user/{uid}/subuser HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access": "string",
    "access_key": "string",
    "daemon_name": "string",
    "generate_secret": "string",
    "key_type": "string",
    "secret_key": "string",
    "subuser": "string"
}
Status Codes
DELETE /api/rgw/user/{uid}/subuser/{subuser}
param purge_keys

Set to False to do not purge the keys. Note, this only works for s3 subusers.

Parameters

  • uid (string) --

  • subuser (string) --

Query Parameters

  • purge_keys (string) --

  • daemon_name (string) --

Status Codes

Role

GET /api/role

Display Role list

Example request:

GET /api/role HTTP/1.1
Host: example.com
Status Codes
POST /api/role

Example request:

POST /api/role HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "description": "string",
    "name": "string",
    "scopes_permissions": "string"
}
Status Codes
DELETE /api/role/{name}
Parameters

  • name (string) --

Status Codes
GET /api/role/{name}
Parameters

  • name (string) --

Example request:

GET /api/role/{name} HTTP/1.1
Host: example.com
Status Codes
PUT /api/role/{name}
Parameters

  • name (string) --

Example request:

PUT /api/role/{name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "description": "string",
    "scopes_permissions": "string"
}
Status Codes
POST /api/role/{name}/clone
Parameters

  • name (string) --

Example request:

POST /api/role/{name}/clone HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "new_name": "string"
}
Status Codes

Service

GET /api/service
Query Parameters

  • service_name (string) --

Example request:

GET /api/service HTTP/1.1
Host: example.com
Status Codes
POST /api/service
param service_spec

The service specification as JSON.

param service_name

The service name, e.g. 'alertmanager'.

return

None

Example request:

POST /api/service HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "service_name": "string",
    "service_spec": "string"
}
Status Codes
GET /api/service/known_types

Get a list of known service types, e.g. 'alertmanager', 'node-exporter', 'osd' or 'rgw'.

Example request:

GET /api/service/known_types HTTP/1.1
Host: example.com
Status Codes
DELETE /api/service/{service_name}
param service_name

The service name, e.g. 'mds' or 'crash.foo'.

return

None

Parameters

  • service_name (string) --

Status Codes
GET /api/service/{service_name}
Parameters

  • service_name (string) --

Example request:

GET /api/service/{service_name} HTTP/1.1
Host: example.com
Status Codes
GET /api/service/{service_name}/daemons
Parameters

  • service_name (string) --

Example request:

GET /api/service/{service_name}/daemons HTTP/1.1
Host: example.com
Status Codes

Settings

GET /api/settings

Display Settings Information

Get the list of available options. :param names: A comma separated list of option names that should be processed. Defaults to None. :type names: None|str :return: A list of available options. :rtype: list[dict]

Query Parameters

  • names (string) -- Name of Settings

Example request:

GET /api/settings HTTP/1.1
Host: example.com
Status Codes
PUT /api/settings
Status Codes
DELETE /api/settings/{name}
Parameters

  • name (string) --

Status Codes
GET /api/settings/{name}

Get the given option. :param name: The name of the option. :return: Returns a dict containing the name, type, default value and current value of the given option. :rtype: dict

Parameters

  • name (string) --

Example request:

GET /api/settings/{name} HTTP/1.1
Host: example.com
Status Codes
PUT /api/settings/{name}
Parameters

  • name (string) --

Example request:

PUT /api/settings/{name} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "value": "string"
}
Status Codes

Summary

GET /api/summary

Display Summary

Example request:

GET /api/summary HTTP/1.1
Host: example.com
Status Codes

Task

GET /api/task

Display Tasks

Query Parameters

  • name (string) -- Task Name

Example request:

GET /api/task HTTP/1.1
Host: example.com
Status Codes

TcmuRunnerPerfCounter

GET /api/perf_counters/tcmu-runner/{service_id}
Parameters

  • service_id (string) --

Example request:

GET /api/perf_counters/tcmu-runner/{service_id} HTTP/1.1
Host: example.com
Status Codes

Telemetry

PUT /api/telemetry

Enables or disables sending data collected by the Telemetry module. :param enable: Enable or disable sending data :type enable: bool :param license_name: License string e.g. 'sharing-1-0' to make sure the user is aware of and accepts the license for sharing Telemetry data. :type license_name: string

Example request:

PUT /api/telemetry HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "enable": true,
    "license_name": "string"
}
Status Codes
GET /api/telemetry/report

Get Detailed Telemetry report

Get Ceph and device report data :return: Ceph and device report data :rtype: dict

Example request:

GET /api/telemetry/report HTTP/1.1
Host: example.com
Status Codes

User

GET /api/user

Get List Of Users

Example request:

GET /api/user HTTP/1.1
Host: example.com
Status Codes
POST /api/user

Example request:

POST /api/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "email": "string",
    "enabled": true,
    "name": "string",
    "password": "string",
    "pwdExpirationDate": "string",
    "pwdUpdateRequired": true,
    "roles": "string",
    "username": "string"
}
Status Codes
DELETE /api/user/{username}
Parameters

  • username (string) --

Status Codes
GET /api/user/{username}
Parameters

  • username (string) --

Example request:

GET /api/user/{username} HTTP/1.1
Host: example.com
Status Codes
PUT /api/user/{username}
Parameters

  • username (string) --

Example request:

PUT /api/user/{username} HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "email": "string",
    "enabled": "string",
    "name": "string",
    "password": "string",
    "pwdExpirationDate": "string",
    "pwdUpdateRequired": true,
    "roles": "string"
}
Status Codes

UserChangePassword

POST /api/user/{username}/change_password
Parameters

  • username (string) --

Example request:

POST /api/user/{username}/change_password HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "new_password": "string",
    "old_password": "string"
}
Status Codes

UserPasswordPolicy

POST /api/user/validate_password

Check if the password meets the password policy. :param password: The password to validate. :param username: The name of the user (optional). :param old_password: The old password (optional). :return: An object with properties valid, credits and valuation. 'credits' contains the password complexity credits and 'valuation' the textual summary of the validation.

Example request:

POST /api/user/validate_password HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "old_password": "string",
    "password": "string",
    "username": "string"
}
Status Codes