Mediator REST API

Version: 6.5.22

Schemes: http, https

Summary

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

Paths

GET

the static file path for the server administration frontend

200 OK

OK

304 Not Modified

Not Modified

400 Bad Request

Could not access file

404 Not Found

File not found

GET /api

Returns the API as OpenAPI 2.0 specification.

200 OK

OK

GET /backups

Returns all backups grouped by volume.

200 OK

OK

POST /dumpApplicationState

Writes an application state dump in the working directory

200 OK

OK

500 Internal Server Error

Could not write state

GET /info

Returns basic server information.

200 OK

OK

GET /log

Downloads the server log file.

200 OK

OK

404 Not Found

Log file not found

GET /volumes

Returns all volumes.

200 OK

OK

POST /volumes

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

200 OK

OK

400 Bad Request

Bad request

DELETE /volumes/{volumeID}

Deletes the specified volume. Creates a backup before deleting by default.

volumeID

the volume name

path string
backup

set to "false" if no backup should be created before deleting

query boolean
200 OK

OK

404 Not Found

Volume not found

GET /volumes/{volumeID}

Downloads the specified volume.

volumeID

the volume name

path string
200 OK

OK

404 Not Found

Volume not found

POST /volumes/{volumeID}

Manages the specified volume.

volumeID

the volume name

path string
action
  • upgradeBlockFileSystem - Upgrades the BlockFileSystem of the specified volume
  • rename - Renames the specified volume to the given target name.
  • compress - Compresses the storage of the specified volume.
  • upgradeCoastVersion - Upgrades the volume to the current Coast-Version (Attention: This process is irreversible!!)
  • backup - Creates a backup for the specified volume.
  • copy - Copies the specified volume to a new volume with the given target name.
query object , x ∈ { upgradeBlockFileSystem , rename , compress , upgradeCoastVersion , backup , copy }
newVolumeID

The new volume name. Only required for action=rename

query string
targetID

the target name. Only required for action=copy

query string
200 OK

OK

404 Not Found

Volume not found

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
200 OK

OK

400 Bad Request

Bad request

GET /volumes/{volumeID}/backups

Returns all backups for the specified volume.

volumeID

the volume name

path string
200 OK

OK

404 Not Found

Volume not found

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
200 OK

OK

404 Not Found

Backup not found

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
200 OK

OK

404 Not Found

Could not recover the specified volume

GET /volumes/{volumeID}/garbageCollection

Returns the status of the garbage collection for the specified volume

volumeID

the volume name

path string
200 OK

OK

404 Not Found

Volume not found

POST /volumes/{volumeID}/garbageCollection

Manages the garbage collection for the specified volume

volumeID

the volume name

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

OK

404 Not Found

Volume not found

GET /volumes/{volumeID}/info

Returns basic information for the specified volume.

volumeID

the volume name

path string
200 OK

OK

404 Not Found

Volume not found

Schema definitions

Context: object

RenderContext: object