Ridgeline 4.0 REST API Quick Start PDF - Extreme Networks

More documents

Recommendations

Info

Authentication and ExceptionsTable 21: Supported HTTP Status Codes (continued)HTTP Status CodesDescription403 Forbidden The request is valid, but cannot be executed at this time.The server understands the request, and the request is valid, but theserver refuses to process it for one of the following reasons:• The credentials represent a user who is not allowed to performthe requested operation (a read-only user, for example, may nothave permission to create a new entity).• A modification, creation, or deletion operation was attemptedagainst a read-only entity.404 Not Found The request references an unknown URL.406 Not Acceptable Exception When a client makes a request of a server, it indicates the type ofdata it can accept. If a server is capable only of producing data thatthe client will find unacceptable, it instead returns this exception.408 Request Timeout An internal service did not respond in a timely manner.500 Internal Error The API encountered an unexpected error (a database connectionfailed, a service timed out, etc.).503 Service Unavailable The API service cannot process the request at this time (the service isunavailable—it is initializing, for example).Exception InformationEach errored response is accompanied by an exception message in the format requested by the client:XMLhttp response code numbererrcodehuman readable messageJSON{“response-code : “http response code number”“specific-error”: “errcode”“specific-msg” : “human readable message”}Note that this exception format contains redundant information (the HTTP response code). This can besafely ignored by most clients. Adobe Flash, however, does not pass responses for anything other thanHTTP 200 OK. To support these clients, the API supports the error code suppression as a query string:HTTP GET /v1.0/dataservice/inventory/devices?status=down&suppress_errors=trueRidgeline 4.0 REST API Quick Start 16
Authentication and ExceptionsIf this query string is supplied with a request, all responses report the HTTP status, 200 OK, allowingclients to access the actual HTTP error code within the response object. The suppression of errors is notenabled by default.Ridgeline 4.0 REST API Quick Start 17
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 14 and 15: What is Supported in REST?Table 20:
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?