Getting Started with the REST APIs

The vFabric Administration Server REST APIs are built on HTTP protocol. There is an API for the vFabric Administration Server and one for each vFabric product that can be managed through vFabric Administration Server.

Subtopics

Key Facts About the REST APIs

Using the REST API Documentation

Writing Scripts With the vFabric Administration Server APIs

Key Facts About the REST APIs

Each API defines the resources and operations used to manage deployments of that vFabric component. For example, the vFabric GemFire, vFabric RabbitMQ, and vFabric tc Server APIs each support groups,which are collections of nodes that can be addressed as a unit. However, only GemFire has locator-instances, and only tc Server has templates, because these objects are specific features of their products.

  • vFabric Administration Server is a client-server service implemented on HTTP.

  • Like HTTP, vFabric Administration Server requests are stateless. Each request contains the data required to perform the requested action.

  • Entities managed with vFabric Administration Server include computers (nodes), groups of nodes, installation images, installations, instances, and other objects applicable to the specific vFabric products. These entities are mapped to consistent resource identifiers (URIs).

  • Each vFabric software product has its own REST API that describes the resources, requests, and responses.

  • Responses include a numeric status code that describes the result of the operation, for example, 200 for "Success" or 404 for "Resource does not exist."

  • A request or response can have a payload, usually a JSON document, but sometimes a text file or an encoded binary file.