Get Started
===========

In order to use the API, you will need an *API Token*.

.. Note::
    Regular users do not have API access enabled by default.  **Admins** can enable it for them 
    in the cloud panel, on the :guilabel:`Users` -> :guilabel:`Edit Permissions` page.  If an **Admin** 
    revokes API access for a user, their token will stop working but is *not* deleted.  Upon re-enabling 
    API access, their existing token will be reactivated.


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

#. Login to the Syminet Cloud Manager at |location_cloud_panel|
#. Click your username in the top right, and click :guilabel:`API Token`.
#. Click :guilabel:`Create API Token`
#. Enter a unique name for your token and click :guilabel:`Create API 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.
#. Copy your token and save it to a safe place.

.. 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 keep your tokens 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 token.

.. |location_signup| raw:: html

    <a href='https://syminet.com/signup' target='_blank'>syminet.com/signup ↗</a>

.. |location_cloud_panel| raw:: html

    <a href='https://cloud.syminet.com/' target='_blank'>cloud.syminet.com ↗</a>