• Account Management
  • Alias
  • Application
  • Application Admin
  • Application Licensing
  • Audit
  • Backup
  • Directory
  • Directory Admin
  • Group Admin
  • Group Level Admin
  • Groups
  • Groups Membership
  • LDAP Connection Pool
  • Look and Feel
  • Mail Server
  • Remember Me
  • SAML Configuration
  • Server Info
  • Sessions
  • Token
  • User Admin
  • User Authentication
  • Users
Server
Crowd Data Center / Reference / REST API

Backup

Postman Collection
OpenAPI
POST

Create backup

Creates manual backup

Request

Request bodyapplication/json

entity with the name of the backup file

fileName

string

Responses

returned if backup was successfully created

application/json

any

POST/rest/admin/1.0/backup
1 2 3 4 5 6 7 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/backup' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "fileName": "myBackup.xml" }'
200Response
1 2 3 4 { "timeTaken": 1400, "backupFileFullPath": "some/path/to/the/backup/myBackup.xml" }
GET

Get configuration

Returns backup configuration

Request

This request has no parameters.

Responses

returned if backup configuration was returned successfully

application/json

any

GET/rest/admin/1.0/backup/configuration
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/backup/configuration' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 { "dailyBackupTime": 870, "resetDomainEnabled": true, "backupConnectorEnabled": false, "scheduledBackupEnabled": true }
POST

Save configuration

Saves backup configuration

Request

Request bodyapplication/json

an entity with configuration of backup

backupConnectorEnabled

boolean

dailyBackupTime

string

resetDomainEnabled

boolean

scheduledBackupEnabled

boolean

Responses

returned if backup configuration was saved successfully

POST/rest/admin/1.0/backup/configuration
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/backup/configuration' \ --header 'Content-Type: application/json' \ --data '{ "dailyBackupTime": 870, "resetDomainEnabled": true, "backupConnectorEnabled": false, "scheduledBackupEnabled": true }'
GET

Get summary

Returns backup summary

Request

This request has no parameters.

Responses

returned if backup summary was returned successfully

application/json

any

GET/rest/admin/1.0/backup/summary
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/backup/summary' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "recentBackupDate": 1562934600, "oldestBackupDate": 1562848200, "currentTimeOnServer": 1563522753 }

Rate this page: