Administration APIs

You can use the APIs under the administration category to modify backup settings, verify the backup file information and cluster certificates, and also manage ONTAP clusters as Active IQ Unified Manager datasources.

Note: You must have the Application Administrator role for running these operations. You can also use the Unified Manager web UI for configuring these settings.
HTTP verb Path Description

GET

PATCH

/admin/backup-settings

/admin/backup-settings

You can use the GET method to view the settings of the backup schedule configured in Unified Manager by default. You can verify the following:
  • Whether the schedule is enabled or disabled
  • Frequency of the backup scheduled (daily or weekly)
  • Time of the backup
  • Maximum number of backup files that should be retained in the application

The time of the backup is in server time zone.

The database backup settings are available on Unified Manager by default, and you cannot create a backup schedule. However, you can use the PATCH method to modify the default settings.

GET

/admin/backup-file-info

A backup dump file is generated every time the backup schedule is modified for Unified Manager. You can use this method to verify whether the backup file is generated according to the modified backup settings, and whether the information on the file matches the modified settings.

GET

/admin/datasource-certificate

You can use this method to view the datasource (cluster) certificate from the trust store. Validating the certificate is required before adding an ONTAP cluster as a Unified Manager datasource.

GET

POST

PATCH

DELETE

/admin/datasources/clusters

/admin/datasources/clusters/{key}

You can use the GET method to retrieve the details of the datasources (ONTAP clusters) managed by Unified Manager.

You can also add a new cluster to Unified Manager as a datasource. For adding a cluster, you must know its host name, user name, and password.

For modifying and deleting a cluster managed as a datasource by Unified Manager, use the ONTAP cluster key.