Owner's Manual

REST APIs

Representational state transfer (REST) functionality is supported using the Restlet framework for the Java

platform. The RESTful web API is implemented using HTTP and REST principles and is a collection of

resources, including the following requirements:

• The base URI for the web service (for example, http://example.com/resources)

• The Internet media type for the data (for AFC, this is JSON)

• The set of operations supported by the web service using HTTP methods (for example, GET, PUT,

POST, or DELETE)

• The API is hypertext-driven.

AFC uses the RESTful web service as the programmatic access interface. To use REST APIs, enter the

REST API on the AFC interface.

NOTE: REST APIs are case-sensitive. Do not use spaces.

To view a list of supported REST APIs, enter sdnc/v1/help in the GUI or by click the Build Query link

and switch to List view.

REST Actions

REST uses standard HTTP actions to update the resource state. The RESTful web service supports the

following HTTP resource actions:

• GET

• POST

• PUT

• DELETE

REST Resources

The REST resources used by the software are grouped into the following categories:

• System

• Managed objects

– Infrastructure objects

– Virtual objects

• Graph

• Counter

• Log

• Alarm

REST APIs