This web service generates and downloads a configuration backup as a signed ZIP archive. The name of the archive is backup_{backup_name}_{YYYY-MM-DDTHH-MM-SS.NNNNNNNNN}.
- It is not possible to restore the configuration of a portal from the ZIP file. Get in touch with a Fluid Topics representative for help.
- Downloads are rate-limited to 5 requests per second.
- This web service is available to users or API keys with the
ADMINrole. - It is necessary to provide an
Ft-Calling-Appvalue when using Fluid Topics web services. See Fluid Topics calling app.
| Method | Endpoint |
|---|---|
GET |
|
| Path parameter | Type | Required? | Description |
|---|---|---|---|
backupId |
String | Yes | Unique identifier of the configuration backup to download. Use the List configuration backups web service to get the ID. |
| Return code | Description |
|---|---|
200 OK |
Returns the configuration backup as an application/zip file attachment. |
401 UNAUTHORIZED |
The authorization header is absent or invalid. |
403 FORBIDDEN |
The user or API key must be an ADMIN. |
404 NOT FOUND |
No configuration backup exists with the given ID. |
429 TOO MANY REQUESTS |
The rate limit for download requests has been exceeded. |
For a comprehensive list of all possible return codes, see Return codes.