=============
hostedpi test
=============

.. program:: hostedpi-test

Test a connection to the Mythic Beasts API using API ID and secret, using configuration as described
in the :doc:`../getting_started` section.

.. code-block:: text

    Usage: hostedpi test [OPTIONS]

Options
=======

.. option:: --help

    Show this message and exit

Alias
=====

.. code-block:: text

    hostedpi connect

Usage
=====

Successful test:

.. code-block:: console

    $ hostedpi test
    Connected to the Mythic Beasts API

An error will be shown if the connection fails:

.. code-block:: console

    $ hostedpi test
    Failed to authenticate