glusterd2/doc/endpoints.md

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	VolumeOptionResp
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
ReplaceBrick	POST	/volumes/{volname}/replacebrick	ReplaceBrickReq	ReplaceBrickResp
EditVolume	POST	/volumes/{volname}/edit	VolEditReq	VolumeEditResp
ProfileVolume	GET	/volumes/{volname}/profile/{option}		BrickProfileInfo
SnapshotCreate	POST	/snapshots	SnapCreateReq	SnapCreateResp
SnapshotActivate	POST	/snapshots/{snapname}/activate	SnapActivateReq	SnapshotActivateResp
SnapshotDeactivate	POST	/snapshots/{snapname}/deactivate		SnapshotDeactivateResp
SnapshotClone	POST	/snapshots/{snapname}/clone	SnapCloneReq	SnapshotCloneResp
SnapshotRestore	POST	/snapshots/{snapname}/restore
SnapshotInfo	GET	/snapshots/{snapname}		SnapGetResp
SnapshotListAll	GET	/snapshots		SnapListResp
SnapshotStatus	GET	/snapshots/{snapname}/status		SnapStatusResp
SnapshotDelete	DELETE	/snapshots/{snapname}
SnapshotConfigGet	GET	/snapshots/config
SnapshotConfigSet	POST	/snapshots/config
SnapshotConfigReset	DELETE	/snapshots/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
SetClusterOptions	POST	/cluster/options
GetClusterOptions	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
GeoReplicationConfigSet	POST	/geo-replication/{mastervolid}/{remotevolid}/config	GeorepOption	GeorepOption
GeoReplicationConfigReset	DELETE	/geo-replication/{mastervolid}/{remotevolid}/config
GeoReplicationStatusList	GET	/geo-replication		GeorepSessionList
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
Split-Brain-Operations	POST	/volumes/{volname}/split-brain/{operation}	SplitBrainReq
DeviceAdd	POST	/devices/{peerid}	AddDeviceReq	AddDeviceResp
DeviceInfo	GET	/devices/{peerid}/{device:.*}		ListDeviceResp
DevicesInPeer	GET	/devices/{peerid}		ListDeviceResp
DeviceEdit	POST	/devices/{peerid}/{device:.*}	EditDeviceReq
DevicesList	GET	/devices		ListDeviceResp
RebalanceStart	POST	/volumes/{volname}/rebalance/start	StartReq
RebalanceStop	POST	/volumes/{volname}/rebalance/stop
RebalanceStatus	GET	/volumes/{volname}/rebalance
BlockCreate	POST	/blockvolumes/{provider}	BlockVolumeCreateRequest	BlockVolumeCreateResp
BlockDelete	DELETE	/blockvolumes/{provider}/{name}
BlockList	GET	/blockvolumes/{provider}
BlockGet	GET	/blockvolumes/{provider}/{name}
TraceEnable	POST	/tracemgmt	SetupTracingReq	JaegerConfigInfo
TraceStatus	GET	/tracemgmt		JaegerConfigInfo
TraceUpdate	POST	/tracemgmt/update	SetupTracingReq	JaegerConfigInfo
TraceDisable	DELETE	/tracemgmt
Statedump	GET	/statedump
List Endpoints	GET	/endpoints		ListEndpointsResp
Glusterd2 service status	GET	/ping