Ridgeline 4.0 REST API Quick Start PDF - Extreme Networks

More documents

Recommendations

Info

1 IntroductionOverviewAudienceWhat Is REST?Advantages of REST over SOAPLimitationsOverviewThis quick start is intended as a reference for the REST API, which allows a client application to query anetwork management server running Ridgeline 4.0 or later. Extreme Networks REST XML API enablesreliable external device-to-device management communication. The API interface provides amechanism to communicate with Extreme Networks network management servers using XMLmessages. Its standards-based REST/XML architecture makes it easy to integrate the networkinfrastructure with higher-level application and business software. In this release, the interface may beused to retrieve the network inventory (devices, slots, ports, and links).AudienceThis guide is intended for software developers using a programming interface to write applications forExtreme Networks devices. It assumes a basic working knowledge of the following:• Concepts and operation of XML API interfaces and web services• Writing web services client code in JavaWhat Is REST?REST (Representational State Transfer) is a set of constraints that when applied to the design of asystem creates a software architectural style that exploits the existing technology and protocols of theweb, including HTTP (Hypertext Transfer Protocol) and XML (Extensible Markup Language).Advantages of REST over SOAPRidgeline 4.0 uses a new API REST instead of SOAP (Simple Object Access Protocol), which was theAPI of previous releases. REST has the following advantages over SOAP:• REST facilitates the transaction between web servers by allowing loose coupling between differentservices.• REST is less strongly typed than SOAP.
Introduction• Unlike SOAP, REST does not require XML parsing and does not require a message header to andfrom a service provider, thus using less bandwidth.LimitationsThe following limitations apply to REST support in Ridgeline 4.0:• Only HTTP GET operations are supported.• HTTPS is not supported by the Ridgeline 4.0 web server.• Field selection of entities is not supported.• Embedded Boolean statements within query strings are not supported.• Caching is not supported.Ridgeline 4.0 REST API Quick Start 5
Page 1 and 2: Ridgeline 4.0 REST API QuickStart
Page 3: Table of ContentsChapter 1: Introdu
Page 7: What is Supported in REST?Table 2:
Page 10 and 11: What is Supported in REST?REST Supp
Page 12 and 13: What is Supported in REST?Table 14:
Page 14 and 15: What is Supported in REST?Table 20:
Page 16 and 17: Authentication and ExceptionsTable
Page 18 and 19: 4 Using the REST APIUsing the REST
Page 20 and 21: Using the REST APInew AuthScope(thi
Page 22 and 23: Using the REST API}package com.extr

Ridgeline 4.0 REST API Quick Start PDF - Extreme Networks

Create successful ePaper yourself

Delete template?

Save as template?