Get configuration restore status - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service returns the status of a configuration restore operation.

  • 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
GET 
/api/backups/restore/{operationId}
Path parameter Type Required? Description
operationId String Yes Unique identifier of a restore operation.
Get the operationId in the response of the Restore a configuration backup web service.

Response body

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

{
  "id": "xyz789",
  "status": "DONE"
}
Field Type Description
id String Unique identifier of the restore operation.
status String Current status of the restore operation. Possible values are:
  • DONE
  • ERROR
  • IN_PROGRESS
Return code Description
200 OK Returns the restore operation and its current status.
401 UNAUTHORIZED The authorization header is absent or invalid.
403 FORBIDDEN The user or API key must be an ADMIN.
404 NOT FOUND No restore operation exists with the given ID.

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