Ridgeline 4.0 REST API Quick Start PDF - Extreme Networks

More documents

Recommendations

Info

What is Supported in REST?Table 20: REST Supported Attributes for PortsAttribute Meaning Usable as Query StringDeviceIPIP address of device containing portIDSystem-assigned identifierPortRange Port range specifications (1–32)IDM-EnabledTrue or falseRBM-EnabledTrue or falsePagination SupportClients can request the numbers and starting point of the entities to a GET response using these twoparameters:• Offset—indicates the beginning index• Limit—indicates the total number of entities that the client can acceptExamples:HTTP GET ridgeline.co.com:8081/v1.0/dataservice/inventory/devices?limit=50(Retrieves the first 50 entries. Note that offset=1 is implied.)HTTP GET ridgeline.co.com:8081/v1.0/dataservice/inventory/devices?offset=50&limit=50(Retrieves the next 50 entries.)Filtering SupportFiltering allows you to separate desired data that matches your designated criteria from a larger dataset. URL GET retrievals can be filtered using query-string style filters that meet these conditions:• Query strings can be combined together with an implied “AND”.• A specific query string can appear only once in the URL.The query string filtering format is: ?filter=valueExample:A client can retrieve a list of devices that are down (or unreachable) using this URL:HTTP GET ridgeline.co.com:8081/v1.0/dataservice/inventory/devices?status=downRidgeline 4.0 REST API Quick Start 14
3 Authentication and ExceptionsAuthenticationExceptionsException InformationAuthenticationClients must provide credentials to access the API; no anonymous access is allowed. The REST API usesthe authentication methods built-in to HTTP. Security credentials are validated by the existingmechanism for Ridgeline users, permitting access for both locally defined users as well as thoseauthenticated via RADIUS authorization. There is no dedicated REST request to deliver the user’scredentials to the server; the credentials are provided using basic auth-method.ExceptionsThe API service supports the following HTTP status codes.Table 21: Supported HTTP Status CodesHTTP Status CodesDescription200 OK The request was executed successfully (or suppress_errors=true).400 Bad Request The request is invalid.This error code appears for a variety of reasons:• The request format is invalid, specifying unsupported querystrings or invalid entity fields.• The request is incomplete—missing required fields for an entitycreation.• The request cannot be completed due to the exhaustion of aninternal resource.• The request violates an internal limit (the maximum number ofentities that can be returned in a retrieval request or themaximum number of entities that can be updated in a singleoperation).401 Unauthorized The supplied authentication credentials are invalid for the request.This error code appears for two reasons:• The credentials are not present within the request.• The credentials are invalid.
Page 1 and 2: Ridgeline 4.0 REST API QuickStart
Page 3 and 4: Table of ContentsChapter 1: Introdu
Page 5 and 6: Introduction• Unlike SOAP, REST d
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 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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?