Skip to content

Latest commit

 

History

History
95 lines (90 loc) · 16.6 KB

endpoints.md

File metadata and controls

95 lines (90 loc) · 16.6 KB

REST API Endpoints Reference

Note: Fields in request structs marked with "omitempty" struct tag are optional.

Name Methods Path Request Response
GetVersion GET /version VersionResp
VolumeCreate POST /volumes VolCreateReq VolumeCreateResp
VolumeExpand POST /volumes/{volname}/expand VolExpandReq VolumeExpandResp
VolumeOptionGet GET /volumes/{volname}/options/{optname} VolumeOptionGetResp
VolumeOptionsGet GET /volumes/{volname}/options VolumeOptionsGetResp
VolumeOptions POST /volumes/{volname}/options VolOptionReq VolumeOptionResp
VolumeReset DELETE /volumes/{volname}/options VolOptionResetReq
OptionGroupList GET /volumes/options-group OptionGroupListResp
OptionGroupCreate POST /volumes/options-group OptionGroupReq
OptionGroupDelete DELETE /volumes/options-group/{groupname}
VolumeDelete DELETE /volumes/{volname}
VolumeInfo GET /volumes/{volname} VolumeGetResp
VolumeBricksStatus GET /volumes/{volname}/bricks BricksStatusResp
VolumeStatus GET /volumes/{volname}/status VolumeStatusResp
VolumeList GET /volumes VolumeListResp
VolumeStart POST /volumes/{volname}/start VolumeStartReq VolumeStartResp
VolumeStop POST /volumes/{volname}/stop VolumeStopResp
Statedump POST /volumes/{volname}/statedump VolStatedumpReq
VolfilesGenerate POST /volfiles
VolfilesGet GET /volfiles
VolfilesGet GET /volfiles/{volfileid:.*}
EditVolume POST /volumes/{volname}/edit VolEditReq VolumeEditResp
SnapshotCreate POST /snapshot
SnapshotActivate POST /snapshot/{snapname}/activate
SnapshotDeactivate POST /snapshot/{snapname}/deactivate
SnapshotClone POST /snapshot/{snapname}/clone
SnapshotRestore POST /snapshot/{snapname}/restore
SnapshotInfo GET /snapshot/{snapname}
SnapshotListAll GET /snapshots
SnapshotStatus GET /snapshot/{snapname}/status
SnapshotDelete DELETE /snapshot/{snapname}
SnapshotConfigGet GET /snapshot/config
SnapshotConfigSet POST /snapshot/config
SnapshotConfigReset DELETE /snapshot/config
GetPeer GET /peers/{peerid} PeerGetResp
GetPeers GET /peers PeerListResp
DeletePeer DELETE /peers/{peerid}
AddPeer POST /peers PeerAddReq PeerAddResp
EditPeer POST /peers/{peerid} PeerEditReq PeerEditResp
SetGlobalOptions POST /cluster/options
GetGlobalOptions GET /cluster/options
GeoReplicationCreate POST /geo-replication/{mastervolid}/{remotevolid} GeorepCreateReq GeorepSession
GeoReplicationStart POST /geo-replication/{mastervolid}/{remotevolid}/start GeorepCommandsReq GeorepSession
GeoReplicationStop POST /geo-replication/{mastervolid}/{remotevolid}/stop GeorepCommandsReq GeorepSession
GeoReplicationDelete DELETE /geo-replication/{mastervolid}/{remotevolid}
GeoReplicationPause POST /geo-replication/{mastervolid}/{remotevolid}/pause GeorepCommandsReq GeorepSession
GeoReplicationResume POST /geo-replication/{mastervolid}/{remotevolid}/resume GeorepCommandsReq GeorepSession
GeoReplicationStatus GET /geo-replication/{mastervolid}/{remotevolid} GeorepSession
GeoReplicationConfigGet GET /geo-replication/{mastervolid}/{remotevolid}/config GeorepOption GeorepOption
GeoReplicationConfigSet POST /geo-replication/{mastervolid}/{remotevolid}/config
GeoReplicationConfigReset DELETE /geo-replication/{mastervolid}/{remotevolid}/config
GeoReplicationStatusList GET /geo-replication GeorepSession
GeoReplicationSshKeyGenerate POST /ssh-key/{volname}/generate GeorepSSHPublicKey
GeoReplicationSshKeyPush POST /ssh-key/{volname}/push GeorepSSHPublicKey
GeoReplicationSshKeyGet GET /ssh-key/{volname} GeorepSSHPublicKey
BitrotEnable POST /volumes/{volname}/bitrot/enable
BitrotDisable POST /volumes/{volname}/bitrot/disable
BitrotScrubOndemand POST /volumes/{volname}/bitrot/scrubondemand
BitrotScrubStatus GET /volumes/{volname}/bitrot/scrubstatus
QuotaList GET /quota/{volname}/limit
QuotaLimit POST /quota/{volname}/limit
QuotaRemove DELETE /quota/{volname}/limit
EventsWebhookAdd POST /events/webhook Webhook
EventsWebhookTest POST /events/webhook/test Webhook
EventsWebhookDelete DELETE /events/webhook WebhookDel
EventsWebhookList GET /events/webhook WebhookList
EventsList GET /events Event
SelfHealInfo GET /volumes/{volname}/{opts}/heal-info BrickHealInfo
SelfHealInfo2 GET /volumes/{volname}/heal-info BrickHealInfo
SelfHeal POST /volumes/{volname}/heal
DeviceAdd POST /devices/{peerid} AddDeviceReq AddDeviceResp
DeviceList GET /devices/{peerid} ListDeviceResp
DeviceEdit POST /devices/{peerid} EditDeviceReq
DeviceListAll GET /devices ListDeviceResp
RebalanceStart POST /volumes/{volname}/rebalance/start StartReq
RebalanceStop POST /volumes/{volname}/rebalance/stop
RebalanceStatus GET /volumes/{volname}/rebalance
Statedump GET /statedump
List Endpoints GET /endpoints ListEndpointsResp
Glusterd2 service status GET /ping