Restore a configuration backup from a remote portal - Fluid Topics

Restore a configuration backup from a remote portal - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category

Reference Guides

Audience

public

Version

Latest

This web service triggers the restore of a configuration backup from a remote Fluid Topics portal onto the current portal.

This web service is available to users or API keys with the ADMIN role.
It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.

Method	Endpoint
`POST`	`/api/remote-portals/{remoteId}/backups/{backupId}/restore`

Path parameter	Type	Required?	Description
`remoteId`	String	Yes	Unique identifier of the remote portal where the configuration backup is located. Use the List remote portals web service to get the ID.
`backupId`	String	Yes	Unique identifier of the configuration backup. Use the List configuration backups on a remote portal web service to get the ID.

Request example

The following example shows a JSON request body for this web service:

{
  "subsets": [
    "SOURCES",
    "THEME",
    "LANGUAGES"
  ],
  "createAutoBackup": false
}

Field Type Required? Description

Field	Type	Required?	Description
`subsets`	Array	No	List of configuration categories to restore. If omitted, all available categories are restored. Possible values are: `ACCESS_RULE` `ASSETS` `CLASSIC_READER_PAGE` `CLASSIC_SEARCH_PAGE` `CODE_LIBRARY` `CONFIDENTIALITY` `CONTENT_STYLES` `CUSTOM_JS` `DESIGNED_PAGES` `ENRICH_AND_CLEAN` `HOMEPAGE` `LANGUAGES` `METADATA` `NOTIFICATIONS` `OFFLINE` `PORTAL_GENERAL` `PORTAL_METADATA` `PRETTY_URL` `PRINT_TEMPLATES` `SOURCES` `THEME_STUDIO` `THEME` `VOCABULARIES` The following categories are not accessible from a `CONSUMER` portal: `ACCESS_RULE` `ENRICH_AND_CLEAN` `METADATA` `PRETTY_URL` `SOURCES` `VOCABULARIES` Some categories require others to be included in the same request: `ENRICH_AND_CLEAN` requires `VOCABULARIES` `DESIGNED_PAGES` requires `ASSETS`, `CODE_LIBRARY`, `LANGUAGES`, `THEME_STUDIO`, and `PORTAL_METADATA`.
`createAutoBackup`	Boolean	Yes	If `true`, an automatic configuration backup of the current configuration is created before the restore is applied.

subsets

Array

List of configuration categories to restore. If omitted, all available categories are restored. Possible values are:

The following categories are not accessible from a CONSUMER portal:

Some categories require others to be included in the same request:

createAutoBackup Boolean Yes If true, an automatic configuration backup of the current configuration is created before the restore is applied.

Response body

The following example shows a JSON response body for this web service:

{
  "id": "xyz789",
  "status": "IN_PROGRESS"
}

Field	Type	Description
`id`	String	Unique identifier of the restore operation. Use this ID with the Get configuration restore status endpoint to track progress.
`status`	String	Current status of the restore operation. Always `IN_PROGRESS` at creation. Possible values are: `IN_PROGRESS` `DONE` `ERROR`

Return code	Description
`200 OK`	The restore operation was created. Returns the operation ID and its initial status.
`400 BAD REQUEST`	The provided `remoteId` or `backupId` does not exist. The selected categories are invalid (unsupported on this portal type or missing dependencies). A restore operation is already in progress.
`401 UNAUTHORIZED`	The authorization header is absent or invalid.
`403 FORBIDDEN`	The user or API key must be an `ADMIN`.
`500 INTERNAL SERVER ERROR`	An error occurred when communicating with the remote server. The remote API key configured in the remote portal is invalid or unauthorized. The remote server is running an incompatible version. The remote server returned an unexpected error.

For a comprehensive list of all possible return codes, see Return codes.