Mediator REST API

Schemes: http, https

Summary

Path	Operation	Description
/admin-ui	GET
/api	GET
/backups	GET
/info	GET
/log	GET
/volumes	GET
/volumes	POST
/volumes/{volumeID}	DELETE
	GET
	POST
	PUT
/volumes/{volumeID}/backups	GET
/volumes/{volumeID}/backups/{version}	DELETE
/volumes/{volumeID}/backups/{version}	POST
/volumes/{volumeID}/garbageCollection	GET
/volumes/{volumeID}/garbageCollection	POST
/volumes/{volumeID}/info	GET

Paths

GET /admin-ui

the static file path for the mediator administration frontend

GET /api

Returns the API as swagger.

GET /backups

Returns all backups grouped by volume.

GET /info

Returns basic mediator information.

GET /log

Downloads the mediator log file.

GET /volumes

Returns all volumes.

POST /volumes

Uploads the volume that is attached to the request. The name of the uploaded zip file is used as volumeID.

DELETE /volumes/{volumeID}

Deletes the specified volume. Creates a backup.


volumeID	the volume name	path	string

GET /volumes/{volumeID}

Downloads the specified volume.


volumeID	the volume name	path	string

POST /volumes/{volumeID}


volumeID	the volume name	path	string
action	upgradeBlockFileSystem: Upgrades the BlockFileSystem of the specified volume to coast version 6.1. copy: Copies the specified volume to a new volume with the given target name. rename: Renames the specified volume to the given target name. backup: Creates a backup for the specified volume. compress: Compresses the storage of the specified volume.	query	object , x ∈ { upgradeBlockFileSystem , copy , rename , backup , compress }
targetID	the target name. Only required for action=copy	query	string
newVolumeID	The new volume name. Only required for action=rename	query	string

PUT /volumes/{volumeID}

Replaces the specified volume with the uploaded volume. This resource requires a volume zip file attached to the request.


volumeID	the volume name	path	string

GET /volumes/{volumeID}/backups

Returns all backups for the specified volume.


volumeID	the volume name	path	string

DELETE /volumes/{volumeID}/backups/{version}

Deletes the backup with the given version for the specified volume.


volumeID	the volume name	path	string
version	the backup version	path	string

POST /volumes/{volumeID}/backups/{version}

Restores the backup with the given version for the specified volume.


volumeID	the volume name	path	string
version	the backup version	path	string
targetID	the name for the restored volume	query	string

GET /volumes/{volumeID}/garbageCollection

Returns the status of the garbageCollection for the specified volume.


volumeID	the volume name	path	string

POST /volumes/{volumeID}/garbageCollection


volumeID	the volume name	path	string
action	stop: Stops the garbageCollection ( if active ) for the specified volume. pause: Pauses the garbageCollection ( if active ) for the specified volume. start: Starts / resumes the garbageCollection for the specified volume.	query	object , x ∈ { stop , pause , start }

GET /volumes/{volumeID}/info

Returns basic information for the specified volume.


volumeID	the volume name	path	string