summaryrefslogtreecommitdiff
path: root/src/mailman/queue/docs/rest.txt
blob: b46f0f304091eae3328fecf95165c89d2626826c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
===========
REST server
===========

Mailman is controllable through an administrative RESTful HTTP server.

    >>> from mailman.testing import helpers
    >>> master = helpers.TestableMaster(helpers.wait_for_webservice)
    >>> master.start('rest')

The RESTful server can be used to access basic version information.

    >>> dump_json('http://localhost:8001/3.0/system')
    http_etag: "..."
    mailman_version: GNU Mailman 3.0... (...)
    python_version: ...
    resource_type_link: http://localhost:8001/3.0/#system
    self_link: http://localhost:8001/3.0/system


Clean up
========

    >>> master.stop()