System backup uses a backup policy to create a snapshot of the configuration of One Identity Safeguard for Privileged Sessions (SPS) to a remote backup server. For details on how backup policies work, see Data and configuration backups in the Administration Guide. For details on configuring a backup policy using the REST API, see Backup policy. To encypt the backup, see Encrypting system backup policy.
URL
GET https://<IP-address-of-SPS>/api/configuration/management/system_backup
Sample request
The following command lists the system backup settings of SPS.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/system_backup
Response
The following is a sample response received when listing the endpoints for date and time settings.
{
"body": {
"backup_policy": "<key-to-a-backup-policy>"
},
"key": "system_backup",
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/system_backup",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/universal_siem_forwarder",
"parent": "/api/configuration/management",
"previous": "/api/configuration/management/syslog",
"remaining_seconds": 600,
"transaction": "/api/transaction"
}
}
| backup_policy |
Contains the ID of the backup policy to use for system backups. For details on configuring a backup policy using the REST API, see Backup policy. |
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
System backup uses a backup policy to create a snapshot of the configuration of One Identity Safeguard for Privileged Sessions (SPS) to a remote backup server. For details on how backup policies work, see Data and configuration backups in the Administration Guide. For details on configuring a backup policy using the REST API, see Backup policy. This section describes how to create encrypted system backups.
URL
GET https://<IP-address-of-SPS>/api/management/exported_configuration_encryption
Sample request
The following command lists the system backup settings of SPS.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/exported_configuration_encryption
Response
The following is a sample response received when listing the endpoints for date and time settings.
{
"body": {
"encryption": {
"enabled": true,
"gpg_public_key": {
"fingerprint": "2F2E3967EDAD2F288E54EE8693B99C4F545B7670",
"public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nmQGNBF3rnZ0BDADHdz5/kCkrl7T8w861AGGXdGK/lwxunTCx6tfhSsFREWmKjhfr\nYTLNxsodALXtAphHeNAeUWwXjYDJelAlMVcDrVtLp7Ht8tqnmNt2NWUSmfFIF3ga\nD1OsH2UjT5Xt6XAjKvFfWeHSxkS0QHIcLfUT5WDoUcTEsR8jEdj80A7Z6.......
CT1WwbMg5VoXQ3Rpp8evcUTzy3+ra/GosCSaFSrE31pyXkULB9+EAU7W\n23YDiM21csIaqX+XDGMex5Hq4PMhO7cqSMyB\n=j20J\n-----END PGP PUBLIC KEY BLOCK-----\n",
"uids": [
"Demo User <example@oneidentity.com>"
]
}
}
},
"key": "exported_configuration_encryption",
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/exported_configuration_encryption",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/health_monitoring",
"parent": "/api/configuration/management",
"previous": "/api/configuration/management/email",
"remaining_seconds": 600,
"transaction": "/api/transaction"
}
}
| encryption |
|
Top level element |
Defines encryption settings for system backups. |
|
enabled |
boolean |
When set to True, enables encryption of the system backups. Enabling encryption requires setting the gpg_public_key option. |
|
gpg_public_key |
JSON object |
Contains the fingerprint, public_key, and the list of uids of the GPG public key used to encrypt system backups. For example: "gpg_public_key": {
"fingerprint": "2F2E3967EDAD2F288E54EE8693B99C4F545B7670",
"public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nmQGNBF3rnZ0BDADHdz5/kCkrl7T8w861AGGXdGK/lwxunTCx6tfhSsFREWmKjhfr\nYTLNxsodALXtAphHeNAeUWwXjYDJelAlMVcDrVtLp7Ht8tqnmNt2NWUSmfFIF3ga\nD1OsH2UjT5Xt6XAjKvFfWeHSxkS0QHIcLfUT5WDoUcTEsR8jEdj80A7Z6hKyF29g\...
R40Niv4Ge6aYneDpk3yTBco6bBYDR7NKA7OREXCfqcyCeYB121UQ\nbb5aTZAaW8D8IRmybxpRxRAaHZX0apBgDLKwWf48kLOnOC9O7hgcyY1spZgTGz7i\nTryxlBl/CT1WwbMg5VoXQ3Rpp8evcUTzy3+ra/GosCSaFSrE31pyXkULB9+EAU7W\n23YDiM21csIaqX+XDGMex5Hq4PMhO7cqSMyB\n=j20J\n-----END PGP PUBLIC KEY BLOCK-----\n",
"uids": [
"Demo User <example@oneidentity.com>"
]
} |
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
Contains the endpoints for configuring date and time on SPS.
URL
GET https://<IP-address-of-SPS>/api/configuration/datetime
Sample request
The following command lists endpoints for configuring date and time settings on SPS.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/datetime
Response
The following is a sample response received when listing the endpoints for date and time settings.
{
"items": [
{
"key": "ntp_servers",
"meta": {
"href": "/api/configuration/datetime/ntp_servers"
}
},
{
"key": "timezone",
"meta": {
"href": "/api/configuration/datetime/timezone"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/datetime",
"last": "/api/configuration/x509",
"next": "/api/configuration/http",
"parent": "/api/configuration",
"previous": "/api/configuration/alerting",
"transaction": "/api/transaction"
}
}
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
