desec-stack/docs/endpoint-reference.rst

Endpoint Reference
------------------

The following table summarizes basic information about the deSEC API endpoints used
for `User Registration and Management`_.

+------------------------------------------------+------------+---------------------------------------------+
| Endpoint ``/api/v1``...                        | Methods    | Use case                                    |
+================================================+============+=============================================+
| ...\ ``/auth/me/``                             | ``GET``    | Retrieve user account information           |
|                                                +------------+---------------------------------------------+
|                                                | ``PUT``    | Change account email address                |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/users/create/``                   | ``POST``   | Create user account                         |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/password/reset/``                 | ``POST``   | Request password reset                      |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/password/reset/confirm/``         | ``POST``   | Confirm password reset                      |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/token/create/``                   | ``POST``   | Log in and request authentication token     |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/auth/token/destroy/``                  | ``POST``   | Log out and destroy authentication token    |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/tokens/``                              | ``GET``    | Retrieve all current tokens                 |
|                                                +------------+---------------------------------------------+
|                                                | ``POST``   | Create new token                            |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/tokens/:id/``                          | ``DELETE`` | Delete token                                |
+------------------------------------------------+------------+---------------------------------------------+

The following table summarizes basic information about the deSEC API endpoints used
for `Domain Management`_ and `Retrieving and Manipulating DNS Information`_.

+------------------------------------------------+------------+---------------------------------------------+
| Endpoint ``/api/v1/domains``...                | Methods    | Use case                                    |
+================================================+============+=============================================+
| ...\ ``/``                                     | ``GET``    | Retrieve all domains you own                |
|                                                +------------+---------------------------------------------+
|                                                | ``POST``   | Create a domain                             |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/:name/``                               | ``GET``    | Retrieve a specific domain                  |
|                                                +------------+---------------------------------------------+
|                                                | ``PATCH``  | Modify a domain (deprecated)                |
|                                                +------------+---------------------------------------------+
|                                                | ``DELETE`` | Delete a domain                             |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/:name/rrsets/``                        | ``GET``    | Retrieve all RRsets from ``domain``, filter |
|                                                |            | by ``subname`` or ``type`` query parameter  |
|                                                +------------+---------------------------------------------+
|                                                | ``POST``   | Create one or more RRsets                   |
|                                                +------------+---------------------------------------------+
|                                                | ``PATCH``  | Create, modify or delete one or more RRsets |
|                                                +------------+---------------------------------------------+
|                                                | ``PUT``    | Create, modify or delete one or more RRsets |
+------------------------------------------------+------------+---------------------------------------------+
| ...\ ``/:name/rrsets/:subname.../:type/``      | ``GET``    | Retrieve a specific RRset                   |
|                                                +------------+---------------------------------------------+
|                                                | ``PATCH``  | Modify an RRset                             |
|                                                +------------+---------------------------------------------+
|                                                | ``PUT``    | Replace an RRset                            |
|                                                +------------+---------------------------------------------+
|                                                | ``DELETE`` | Delete an RRset                             |
+------------------------------------------------+------------+---------------------------------------------+