.. cloudplan documentation master file, created by
   sphinx-quickstart on Wed Jan  7 11:11:25 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to cloudplan's documentation!
=====================================

Check out :ref:`getting-started` if you have not used this version of the api before.

.. note:: 

   This page describes the latest version of the cloudplan api with a **new endpoint** and **different authentication** than the previous version. The old version of the cloudplan api documentation is available here: https://docs.cloudplan.net/_static/legacy/index.html


Postman Collection
------------------

There is a postman collection with all requests described in this documentation. Download here: :download:`cloudplan API.postman_collection.json <guides/cloudplan API.postman_collection.json>`.

To use the collection import it into postman and put your **api-key** and **secret** in the authentication tab of the collection settings.


Content of this Documentation
-----------------------------

.. toctree::
   :maxdepth: 1
   :caption: Guides:

   guides/getting_started


.. toctree::
   :maxdepth: 2
   :caption: API Reference:

   api/index


.. toctree::
   :maxdepth: 2
   :caption: Concepts:

   concepts/concepts_index