Method Endpoint

GET

/cxf/bpc-core/configuration/backups

Description

Get a list of all backups/snapshots as JSON.

Returns

The requested data as JSON.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_VIEW

POST

/cxf/bpc-core/configuration/backups/create

Description

Creates a backup/snapshot of the BPC configuration index bpc-configuration.

Returns

The backup/snapshot info as JSON.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_CREATE

POST

/cxf/bpc-core/configuration/backups/create/{backupJobIdentifier}

Description

Creates a backup/snapshot of the indices related to a backup job.

Path Parameter

backupJobIdentifier

the identifier of the backup job

Returns

The backup/snapshot info as JSON.

HTTP Status Code

  • 200 : OK

  • 404 : Backup job not found

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_CREATE

GET

/cxf/bpc-core/configuration/backups/{snapshotName}

Description

Get the data of a specific backup/snapshot.

Path Parameter

snapshotName

the name of the backup/snapshot to get the infos for

Returns

The requested backup/snapshot data as JSON.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_VIEW

DELETE

/cxf/bpc-core/configuration/backups/{snapshotName}

Description

Delete a specific backup/snapshot.

Path Parameter

snapshotName

the name of the backup/snapshot to delete

Returns

The info of the deleted backup/snapshot as JSON.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_DELETE

PUT

/cxf/bpc-core/configuration/backups/activate/{snapshotName}

Description

Restores and activates a specific backup/snapshot.

Path Parameter

snapshotName

the name of the backup/snapshot to restore and activate

Returns

Some infos about the restored and activated backup/snapshot as JSON.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_ACTIVATE

PUT

/cxf/bpc-core/configuration/backups/restore/{snapshotName}

Description

Restores but does not activate a specific backup/snapshot.

Path Parameter

snapshotName

the name of the snapshot to restore

Query Parameter

index-name

to give the OpenSearch index a new name (Optional; works only when the backup contains exactly one index)

Returns

Some infos about the restored backup/snapshot as JSON.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_RESTORE

GET

/cxf/bpc-core/configuration/backups/download/{snapshotName}

Description

Download the content of a backup/snapshot.

Path Parameter

snapshotName

the name of the backup/snapshot to download

Returns

The requested data as JSON. Uses the snapshotName parameter value as the filename.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_DOWNLOAD

GET

/cxf/bpc-core/configuration/backups/export/{snapshotName}

Description

Export the content of a bpc-configuration index backup/snapshot as GlobalConfig object.

Path Parameter

snapshotName

the name of the backup/snapshot

Returns

The requested data as JSON.

HTTP Status Code

  • 200 : OK

Content-Type

  • application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

  • Role : BACKUPS_ADMIN

  • Right : BACKUPS_EXPORT
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen