Create general settings backup

Get password-protected archive with device settings.

Backup does not include data from tables, such as identifiers, access rules and so on.

For tables data backup please use /system/settings/tables endpoint.

Responses

• 200
• 401

---

Password-protected ZIP file

application/octet-stream

• Schema

---

Schema

• string binary

  Zip archive, must contain setting files in BAS-IP format

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...