Skip to content

CephFS

All operations require authentication.

5 operationsv1/dedicated/ceph
Agent setup

List CephFS filesystemsProduction

GET
/1.0/dedicated/ceph/{serviceName}/cephfs

Returns the CephFS filesystems of the cluster. The list is empty until a filesystem is enabled.

Path parameters

serviceName
required
string

Service name

Response

200response[]successful operation
enabled
read-only
boolean

Filesystem state

fsName
read-only
string

Filesystem name

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/ceph/{serviceName}/cephfs \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "enabled": true, "fsName": "string" }]

Get a CephFS filesystemProduction

GET
/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName}

Returns a CephFS filesystem of the cluster.

Path parameters

fsName
required
string

Fs name

serviceName
required
string

Service name

Response

200responsesuccessful operation
enabled
read-only
boolean

Filesystem state

fsName
read-only
string

Filesystem name

Example uses fsName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "enabled": true, "fsName": "string"}

Enable a CephFS filesystemProduction

POST
/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName}/enable

Enables the filesystem, which becomes available within a few minutes. Only one filesystem can be enabled, and it must be named fs-default.

Path parameters

fsName
required
string

Fs name

serviceName
required
string

Service name

Response

200stringsuccessful operation

Example uses fsName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName}/enable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"string"

Disable a CephFS filesystemProduction

POST
/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName}/disable

Blocks access to the filesystem and keeps its data. The filesystem can be enabled again later.

Path parameters

fsName
required
string

Fs name

serviceName
required
string

Service name

Response

200stringsuccessful operation

Example uses fsName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName}/disable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"string"

Delete a CephFS filesystemProduction

DELETE
/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName}

Permanently deletes the filesystem and all its data. Only a disabled filesystem can be deleted.

Path parameters

fsName
required
string

Fs name

serviceName
required
string

Service name

Response

200stringsuccessful operation

Example uses fsName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/ceph/{serviceName}/cephfs/{fsName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
"string"