1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
=================
Basic operation
=================
In order to do anything with the REST API, you need to know its `Basic AUTH`_
credentials, and the version of the API you wish to speak to.
Credentials
===========
If you include the proper basic authorization credentials, the request
succeeds.
>>> import requests
>>> response = requests.get(
... 'http://localhost:9001/3.0/system/versions',
... auth=('restadmin', 'restpass'))
>>> print(response.status_code)
200
System version information
==========================
System version information can be retrieved from the server, in the form of a
JSON encoded response.
>>> dump_json('http://localhost:9001/3.0/system/versions')
api_version: 3.0
http_etag: "..."
mailman_version: GNU Mailman 3...
python_version: ...
self_link: http://localhost:9001/3.0/system/versions
API Versions
============
The REST API exposes two versions which are almost completely identical. As
you've seen above, the ``3.0`` API is the base API. There is also a ``3.1``
API, which can be used interchangably::
>>> dump_json('http://localhost:9001/3.1/system/versions')
api_version: 3.1
http_etag: "..."
mailman_version: GNU Mailman 3...
python_version: ...
self_link: http://localhost:9001/3.1/system/versions
The only difference is the way UUIDs are represented. UUIDs are 128-bit
unique ids for objects such as users and members. In version ``3.0`` of the
API, UUIDs are represented as 128-bit integers, but these were found to be
incompatible for some versions of JavaScript, so in API version ``3.1`` UUIDs
are represented as hex strings.
Choose whichever API version makes sense for your application. In general, we
recommend using API ``3.1``, but most of the current documentation describes
API ``3.0``. Just make the mental substitution as you read along.
.. _REST: http://en.wikipedia.org/wiki/REST
.. _`Basic AUTH`: https://en.wikipedia.org/wiki/Basic_auth
|
