IBM Spectrum Protect Plus REST API Reference
Overview
Before you begin
Methodology
Response and request format: JSON
Structure of an HTTP response message
HATEOAS and URI representation
Getting started
Developing a client application by using the curl tool
Developing a client application by using Postman
Python REST API
Developing a client application with the JupyterLab application
Dashboard and session management
Sessions
Creating a session ID
Alerts
Getting alert information
Getting alert information in CSV format
Jobs and Operations
Running Jobs
Getting job session information
Canceling a job
Job History
Getting a log for a job session
Schedule
Getting information about scheduled jobs
Starting a job manually
Starting an ad hoc backup job
Manage Protection
Policy Overview
Getting information about SLA policies
Adding an SLA policy
Editing the configuration of an SLA policy
Deleting an SLA policy
Virtualized Systems (VMware, Hyper-V, Amazon EC2)
Running an inventory job for virtualized systems
Getting status of a hypervisor inventory job
Getting information about virtualized systems
Searching virtualized system instances
Getting virtualized system instances with view filters
Adding VMWare vCenter Server or Hyper-V server
Unregistering a virtualized system
Application Servers (File Systems, Containers, Cloud Management, Databases)
Running an inventory job for application server instances
Getting status of an inventory job for application servers
Databases (Db2, Exchange, MongoDB, Oracle, SQL)
Getting information for databases
Databases: SQL
Getting information about log backups for SQL Servers
Starting an ad hoc log backup job for SQL Servers
System Configuration
Backup Storage: Disk
Getting Disk Storage information about vSnap servers
Adding Disk Storage: vSnap server
Initializing a vSnap server
Rescanning Disk Storage: vSnap server
Unregistring a vSnap server
Backup Storage: Object Storage
Getting information about object storage and repository servers
Getting bucket information
Adding an object storage server or a repository server
Unregistering an object storage server or a repository server
Backup Storage: Repository Server
Getting repository server information
Adding a repository server
Unregistering a repository server
VADP proxy
Getting VADP proxy information
Registering a VADP proxy
Additional actions for a VADP proxy
Unregistering a VADP proxy
Site
Getting site information
Adding a site
Editing the configuration of a site
Deleting a site
LDAP/SMTP
Getting LDAP server information
Adding an LDAP server
Editing the configuration of an LDAP server
Unregistering an LDAP server
Getting SMTP server information
Adding an SMTP server
Editing the configuration of an SMTP server
Deleting an SMTP server
Keys and Certificates
Getting information about access keys and SSH keys
Adding an access key
Adding an SSH key
Editing the configuration of an access key or an SSH key
Deleting an access key or an SSH key
Getting certificate information
Adding a certificate
Deleting a certificate
Reports and Analytics
Reports
Getting report information
Deleting a custom report
Scheduling a report
Creating a custom report
Report parameters
vSnap Storage Utilization
Protected and Unprotected VMs
Configuration
Additional topics for vSnap Storage Utilization
Protected virtual machines
Base backup sizes
Incremental backup sizes
Recovery points
Analytics
Getting backup history for a virtual machine
Getting database backup history
Getting virtual machine backup compliance
Getting database backup compliance
Counting virtual machines
Counting databases
Counting protected virtual machines
Counting protected databases
Accounts
User
Getting user information
Adding an individual user
Adding users that are based on an LDAP group
Modifying settings of users
Changing a user password
Deleting users
Role
Getting role information
Creating a role
Editing the configuration of a role
Deleting a role
Resource Group
Getting resource group information
Identity
Getting identity information
Adding an identity
Editing an identity
Deleting an identity
Appendix: Additional topics for the REST API
Collection resources
Application
Cloud
Hypervisor
Identity
Job
LDAP
Report
Security
Site
SLA policy
SMTP
Storage
VADP
Operation parameters for JSON object output
Filter
Sort
Pagination
Aggregate functions
General structure
COUNT()
SUM()
MAX()
GROUP clause
Glossary
IBM Spectrum Protect Plus REST API Reference
»
Reports and Analytics
Reports and Analytics
ΒΆ
Reports
Report parameters
Additional topics for vSnap Storage Utilization
Analytics