Previous Topic: Web Service API Reference GuideNext Topic: API Generic Syntax


Web Service API Overview

The CA AppLogic Application Programming Interface (API) supports programming styles based on the principles of REST (Representational State Transfer). The Web Services API enables developers of RESTful client software to directly interface with our grid or Virtual Data Centers (VDC). The API allows for programmatic control of large pools of virtualized infrastructure to be available within each VDC. To use the Web Service API, the 'WS_API' application should be running on a grid. The 'WS_API' application provides HTTP, HTTPS and VPN based access to the REST API.

The types of transactions are:

Synchronous

Synchronous requests run immediately and return a result.

Asynchronous

Asynchronous requests, such as app start and vol create, require a few seconds to complete and run in the background. This allows you to continue working while these longer transactions process. Asynchronous requests return a Job ID that can be polled to determine the current status.

Note: CA AppLogic can run a maximum of 10 concurrent asynchronous requests at one time.

For more information see the WS_API datasheet.

This section contains the following topics:

API Generic Syntax

Valid Web API Objects

Web API Version 2 Documentation

For 3.7, we updated this guide to reflect the Web API Version 2. In particular, we updated the JSON and XML Sample Output sections and the Syntax and Example sections. If you are using the Web API Version 1, use the Web Service API Reference Guide for 3.5.