Extreme API with Python
Table Of Contents
- 1 Preface
- 2 Introduction
- 3 EXOS APIs
- 4 VOSS API
- 5 XMC API
- 6 ExtremeCloud IQ API
- 7 Extreme Campus Controller API
Extreme API with Python
Page | 9
Part no.9036931-00 Rev AA February 2021
2.2.2 HTTP Status Codes
When working with HTTP, it is important to understand the status code that is returned in a CALL. There
are five status code categories:
1xx: informational response
2xx: successful
3xx: redirection
4xx: client error
5xx: server error
You should see a 200 when everything is operating normally (OK). Error codes such as 403 (forbidden
access) or 404 (not found) help identify issues.
A complete list of the status codes is available in several locations, such as Wikipedia:
HTTPS://en.wikipedia.org/wiki/List_of_HTTP_status_codes
2.2.3 HTTP Request Methods
In REST, you send commands centered around a resource, which is anything that can be pointed to via
HTTP protocol. CALL the API using standard HTTP request methods, such as: GET, POST, PUT, DELETE,
and PATCH. There are more methods, but for REST APIs they are usually not required.
HTTPS://www.w3schools.com/tags/ref_httpmethods.asp
Note: This is sometimes referred to as CRUD (Create, Read, Update, Delete), which is basically a cycle for
database records.
It is important to understand the role of the request methods:
Use GET to request data from a specified resource. You can think of it as a read.
Use POST to send data to a server to create or update a resource.
Use PUT to send data to a server to create or update a resource. This might seem redundant
with POST, but there is a difference between them: PUT is idempotent. That is, if you are calling
multiple times using the same PUT request, it will always produce the same result. POST will
create multiples of the same resource.
Use PATCH to send data to a server to update an existing resource.
Use DELETE to delete a specified resource.
The API dictates the method you use. For example, if you use PUT instead of POST, you will receive an
error from the server.
2.2.4 HTTP Headers
With HTTP, the data you transfer can be separated in headers and body. The body contains the usable
data (the html to represent a web page, the data in JSON, etc.). The headers are very important because
they provide crucial information about the body content.










