Developing solutions with the application programming interface

The IBM Spectrum Protect™ application programming interface (API) is packaged with the IBM Spectrum Protect backup-archive client. With the API, you can protect business applications such as databases in the IBM Spectrum Protect environment.

What's new for IBM Spectrum Protect API
Read about new and changed features. Review the release notes before installing the product.
Installing the API
Information about installing the IBM Spectrum Protect application programming interface (API) is provided in the installation procedures for the backup-archive client.
API overview
The IBM Spectrum Protect application program interface (API) enables an application client to use storage management functions.
Building and running the sample API application
The API package includes sample applications that demonstrate the API function calls in context. Install a sample application and review the source code to understand how you can use the function calls.
Considerations for designing an application
When you design an application, you must have a broad understanding of many aspects of the API.
Understanding interoperability
The API has two types of interoperability: between the backup-archive client and API applications and between different operating systems.
Using the API with Unicode
The IBM Spectrum Protect API supports Unicode UCS2, a fixed length, double-byte code page that has code points for all known code pages, such as Japanese, Chinese, or German. It supports as many as 65,535 unique code points.
API function calls
API return codes source file: dsmrc.h
The dsmrc.h header file contains all return codes that the API can return to an application.
API type definitions source files
API function definitions source file
This appendix contains the dsmapifp.h header file, so you can see the function definitions for the API.
API return codes reference