salt/doc/ref/netapi/all/salt.netapi.rest_cherrypy.rst

=============
rest_cherrypy
=============

.. contents::
    :local:

.. automodule:: salt.netapi.rest_cherrypy.app

.. automodule:: salt.netapi.rest_cherrypy.wsgi

REST URI Reference
==================

.. py:currentmodule:: salt.netapi.rest_cherrypy.app

``/``
-----

.. autoclass:: LowDataAdapter
    :members: GET, POST

``/login``
----------

.. autoclass:: Login
    :members: GET, POST

``/logout``
-----------

.. autoclass:: Logout
    :members: POST

``/minions``
------------

.. autoclass:: Minions
    :members: GET, POST

``/jobs``
---------

.. autoclass:: Jobs
    :members: GET

``/run``
--------

.. autoclass:: Run
    :members: POST

``/events``
-----------

.. autoclass:: Events
    :members: GET

``/hook``
---------

.. autoclass:: Webhook
    :members: POST

``/keys``
---------

.. autoclass:: Keys
    :members: GET, POST

``/ws``
-------

.. autoclass:: WebsocketEndpoint
    :members: GET

``/stats``
----------

.. autoclass:: Stats
    :members: GET
Added rest_cherrypy docs 2012-11-16 04:08:16 +00:00			`=============`
			`rest_cherrypy`
			`=============`

Move the local TOC up since it's such a large docstring 2017-05-12 18:03:26 +00:00			`.. contents::`
			`:local:`

Updated all saltapi import paths to salt.netapi 2014-06-19 02:54:47 +00:00			`.. automodule:: salt.netapi.rest_cherrypy.app`
Added rest_cherrypy docs 2012-11-16 04:08:16 +00:00
Updated all saltapi import paths to salt.netapi 2014-06-19 02:54:47 +00:00			`.. automodule:: salt.netapi.rest_cherrypy.wsgi`
Added deployment docs to main doc page 2013-04-13 05:55:25 +00:00
			`REST URI Reference`
			`==================`

Updated all saltapi import paths to salt.netapi 2014-06-19 02:54:47 +00:00			`.. py:currentmodule:: salt.netapi.rest_cherrypy.app`
Added rest_cherrypy docs 2012-11-16 04:08:16 +00:00
Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/``
			`-----`

Moved most the docs into the rest_cherrypy module 2012-11-16 17:40:36 +00:00			`.. autoclass:: LowDataAdapter`
			`:members: GET, POST`
Added rest_cherrypy docs 2012-11-16 04:08:16 +00:00
Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/login``
			`----------`

Moved most the docs into the rest_cherrypy module 2012-11-16 17:40:36 +00:00			`.. autoclass:: Login`
			`:members: GET, POST`
Include docs on /minions and /jobs 2012-12-05 02:47:33 +00:00
Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/logout``
			`-----------`

Added Logout view to docs 2013-03-20 23:13:05 +00:00			`.. autoclass:: Logout`
			`:members: POST`

Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/minions``
			`------------`

Include docs on /minions and /jobs 2012-12-05 02:47:33 +00:00			`.. autoclass:: Minions`
			`:members: GET, POST`

Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/jobs``
			`---------`

Include docs on /minions and /jobs 2012-12-05 02:47:33 +00:00			`.. autoclass:: Jobs`
			`:members: GET`
Added /run to docs 2013-03-21 01:22:30 +00:00
Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/run``
			`--------`

Added /run to docs 2013-03-21 01:22:30 +00:00			`.. autoclass:: Run`
			`:members: POST`
Added docs on the Events URL 2013-08-02 18:14:37 +00:00
Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/events``
			`-----------`

Added docs on the Events URL 2013-08-02 18:14:37 +00:00			`.. autoclass:: Events`
			`:members: GET`
Added Webhook to docs 2014-01-30 19:05:10 +00:00
Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/hook``
			`---------`
Add websocket support 2014-05-19 14:58:16 +00:00
Added Webhook to docs 2014-01-30 19:05:10 +00:00			`.. autoclass:: Webhook`
Moved docs from method to module level 2014-01-30 21:32:09 +00:00			`:members: POST`
Added docs for the /stats URL 2014-03-10 23:06:51 +00:00
Url should be '/keys' 2014-11-20 03:16:58 +00:00			``/keys``
Added missing docs for the /key rest_cherrypy entry point Should have been part of #16706. 2014-10-29 21:35:04 +00:00			`---------`

			`.. autoclass:: Keys`
			`:members: GET, POST`

			``/ws``
			`-------`

			`.. autoclass:: WebsocketEndpoint`
			`:members: GET`

Added local TOC for the rest_cherrypy URL list 2014-06-18 03:38:13 +00:00			``/stats``
			`----------`

Added docs for the /stats URL 2014-03-10 23:06:51 +00:00			`.. autoclass:: Stats`
Move the local TOC up since it's such a large docstring 2017-05-12 18:03:26 +00:00			`:members: GET`