IBM Spectrum Protect Plus REST API Reference Logo
  • Overview
    • General information
      • About this publication
      • About IBM Spectrum Protect Plus
      • Welcome to IBM Spectrum Protect Plus REST API
      • Structure of an HTTP response message
    • Getting started
      • Developing API by using the curl tool
      • Developing API by using Postman
      • Python REST API
      • Developing API by using JupyterLab
      • Java REST API
  • Dashboard and session management
    • Session
      • Creating a session ID
    • Alert
      • Getting alert information
      • Getting alert information in the CSV format
  • Jobs and Operations
    • Running Jobs
      • Getting job session information
      • Canceling a job
    • Job History
      • Getting a log for a specific job session
    • Schedule
      • Starting an SLA policy
      • Starting an ad hoc backup job
  • Manage Protection
    • Policy Overview
      • Adding an SLA policy
      • Deleting an SLA policy
    • Virtualized Systems: VMware
      • Adding vCenter Server
      • Associating VMware instances with SLA policies
      • Updating options of VMware instances
      • Searching VMware instances
    • Virtualized Systems: Hyper-V
      • Registering Hyper-V Server
    • Virtualized Systems: Amazon EC2
    • 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
      • Getting virtualized system instances with tag view
      • Getting virtualized system instances with storage view
      • Getting virtualized system instances with host view
      • Deleting 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 application server’s information for databases
      • Adding an application server for databases
  • 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
    • Backup Storage: Repository Server
      • Getting repository server information
      • Adding a repository server
      • Unregistering a repository server
    • VADP proxy
      • Getting VADP proxy information
      • Adding a VADP proxy
      • Deleting 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
      • Deleting 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
      • Reports and report parameters
      • Report Protected and Unprotected VMs
      • Report Configuration
    • Report: VM Backup Utilization
      • Report: VM Backup Utilization - Protected virtual machines
      • Report: VM Backup Utilization - Base backup sizes
      • Report: VM Backup Utilization - Incremental backup sizes
      • Report: VM Backup Utilization - Recovery points
    • Analytics
      • Obtaining virtual machines backup history
      • Getting a 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 users
      • Modifying settings of users
      • Changing a user password
      • Deleting users
    • Role
      • Getting role information
      • Creating a role
      • Modifying a role
      • Deleting a role
    • Resource Group
      • Getting resource group information
    • Identity
      • Getting identity information
      • Adding an identity
      • Updating an identity
      • Deleting an identity
  • Appendix: Additional topics for the REST API
    • Collection resources
      • Cloud
      • Hypervisor
      • Identity
      • LDAP
      • Report
      • Security
      • Site
      • SLA policy
      • SMTP
      • Storage
  • Accessibility features for the IBM Spectrum Protect product family
    • Overview
    • Keyboard navigation
    • Interface information
    • Vendor software
    • Related accessibility information
  • Glossary
  • Notices
    • Trademarks
    • Terms and conditions for product documentation
    • Privacy policy considerations
IBM Spectrum Protect Plus REST API Reference
  • Docs »
  • Additional information about this publication

Additional information about this publication¶

  • Accessibility features for the IBM Spectrum Protect product family
  • Notices
  • Glossary

© Copyright 2020, IBM Corporation.

Built with Sphinx using a theme provided by Read the Docs.