Admin API v1
======================

This page contains all endpoints for the Admin API v1.


Some calls require your API Key to be sent via the ``X-Reseller-Api-Key`` header, those
not requiring the API Key will be marked as so. A ``401 UNAUTHORIZED``
status code will be sent back if credentials are missing. All the requests needs to have the port 9534.


.. autoflask:: portal.app:get_app()
   :undoc-static:
   :blueprints: reseller_api_admin_v1


Ormuco objects types and descriptions
-------------------------------------

A description of the different type of objects used in the Ormuco platform and returned by the API.

**Provider**

+----------------+---------+---------------------------------------------------------------+
| Attribute      | Type    | Description                                                   |
+----------------+---------+---------------------------------------------------------------+
| id             | string  | Main identifier of the provider.                              |
+----------------+---------+---------------------------------------------------------------+
| name           | string  | The name of the provider.                                     |
+----------------+---------+---------------------------------------------------------------+
| os_version     | string  | The Openstack version of the provider.                        |
+----------------+---------+---------------------------------------------------------------+
| public_api_url | string  | | The public API endpoint to communicate with the Openstack   |
|                |         | | represented by this provider.                               |
+----------------+---------+---------------------------------------------------------------+
| is_private     | boolean | Whether the provider is private.                              |
+----------------+---------+---------------------------------------------------------------+