Synapse

Learn about actions >

• anonymize-user

  Anonymizes an user in order to make it GDPR compliant.

• create-backup

  Creates a backup to s3 storage.

• delete-backup

  Delete a backup in s3 storage by backup-id.

  Params

  • backup-id string

    The backup-id to identify the backup to delete.

  Required

  backup-id

• list-backups

  Lists backups in s3 storage.

• promote-user-admin

  Promote a user as a server administrator. You need to supply a user name.

• register-user

  Registers a user for the Synapse server. You need to supply a user name and whether that user should be an admin or not.

• reset-instance

  Set a new server_name before running this action. Once a server_name is configured, you must start a new instance if you wish a different one. This actions will erase all data and create a instance with the new server_name.

• restore-backup

  Restore a Synapse backup. S3 credentials are retrieved from the relation with the S3 integrator charm. The server_name and filesystem configuration for the application should be identical to the application restored.

  Params

  • backup-id string

    The backup-id to identify the backup to restore.

  Required

  backup-id