API Token
==========

API Tokens provide access to the Syminet Cloud API, which is a modern, RESTful JSON interface providing endpoints 
for the panel functions and more.  This allows developers to write their own applications that can seamlessly 
interface with the Syminet Cloud on the backend, automating and enhancing it's capabilities.   

.. Note::
    :doc:`Regular subusers <../users/index>` do not have API access enabled by default.  You can enable it 
    on their :doc:`edit user permissions <../users/edit_permissions>` page.  Also, if an :doc:`Admin <../users/index>` 
    revokes API Access for a :doc:`regular user <../users/index>`, their token is not deleted.  Upon re-enabling 
    API Access, their existing token will be re-enabled.  


Create an API Token
-------------------

#. Click :guilabel:`Create API Token`
#. A window will appear requesting you give your token a unique name.  Enter a name, and click :guilabel:`Create Token`
#. Another window will appear with your token.  **For security reasons, this is the only time we can show you your 
   token**.  Once you close the window, it cannot be recovered.  If you lose it, you will need to delete your token 
   and create a new one.

.. Danger::
   Your API token is the equivalent of both your panel username and password in a single piece of data.  It is 
   imperative that you are diligent about keeping your token safe and secure.


Delete or rename a Token
------------------------

You can rename your token by clicking :guilabel:`Rename`, or delete it by clicking :guilabel:`Delete`.

.. WARNING::
   Once a token is deleted, there is no way to recover it.  You will need to create a new one.

API Documentation
-----------------

The Syminet Cloud API has a separate reference documentation for the API.  You can view it here:

https://docs.syminet.com/api