drppy-client 4.16.0
Python Library to interact with the digitalrebar API.
Requires Python: >=3.5

# drppy-client
# An RestFUL API-driven Provisioner and DHCP server

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 4.14.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
- For more information, please visit [https://doc.rackn.io/](https://docs.rackn.io/)

## Requirements.
Python 3.4+

## Installation & Usage
### pip install
This should be done in a virtual environment and not directly installed into the system python.

To install directly from public pypi use the following command:

```sh
pip install drppy_client
```

Once installed use the following code to import the package for use:

```python
import drppy_client
```

To use the development version of this library install directly from gitlab using:

```sh
pip install git+https://gitlab.com/rackn/drppy_client.git
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python -m pip install .
```


Then import the package:
```python
import drppy_client
```

## Getting Started
Examples are provided in the examples/ directory, and make an excellent initial place to start exploring for how to use the
library. The examples are implemented as a basic drpcli example.

Below is a basic example that can be created once the library is installed to verify things are working. It assumes at least 1 machine exists,
and also uses the default credentials and endpoint location. Be sure to adjust the host, username, and password as needed to match your environment.

```python
from pprint import pprint

from drppy_client.configuration import Configuration
from drppy_client.api_client import ApiClient
from drppy_client.api.machines_api import MachinesApi


config = Configuration()
config.host = 'https://localhost:8092/api/v3'
config.username = "rocketskates"
config.password = "r0cketsk8ts"
config.verify_ssl = False

client = ApiClient(config)

machines = MachinesApi(client)

my_machines = machines.list_machines()

print(my_machines[0])
```
## DRPCLI example using Python

The drpcli.py example is implemented using Python Click. Be sure click is installed if you plan to use the example
```sh
pip install click
```

Locate the examples directory. The examples are generally stored in $VENV_ROOT/share/drppy_client/examples

From the examples directory run:

```sh
$ python drpcli.py --help

Usage: drpcli.py [OPTIONS] COMMAND [ARGS]...

Main entry point for the CLI.

Options:
--endpoint TEXT  API host URL
--token TEXT     API token
--key TEXT       user:password  Used for basic auth
--help           Show this message and exit.

Commands:
contents  Contents Specific Commands.
machines  Machine Specific Commands.
params    Parameter Specific Commands.
profiles  Profiles Specific Commands.
subnets   Subnets Specific Commands.

$ python drpcli.py machines list
```
If you do not want to run the examples and just want to look at the code to see how to use the SDK open up the file for the thing you want to learn.
Machine examples are in the machines.py file, Profile examples in the profiles.py file etc.. The examples implemented are minimal by design to give
you a starting point. If you are having trouble using them, or finding an example that demonstrates the feature you need please send a support request
to support@rackn.com

## Documentation for API Endpoints

All URIs are relative to *https://localhost/api/v3*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ActivitiesApi* | [**create_activity**](docs/ActivitiesApi.md#create_activity) | **POST** /activities | Create a Activity
*ActivitiesApi* | [**delete_activity**](docs/ActivitiesApi.md#delete_activity) | **DELETE** /activities/{id} | Delete a Activity
*ActivitiesApi* | [**get_activity**](docs/ActivitiesApi.md#get_activity) | **GET** /activities/{id} | Get a Activity
*ActivitiesApi* | [**get_activity_action**](docs/ActivitiesApi.md#get_activity_action) | **GET** /activities/{id}/actions/{cmd} | List specific action for a activities Activity
*ActivitiesApi* | [**get_activity_actions**](docs/ActivitiesApi.md#get_activity_actions) | **GET** /activities/{id}/actions | List activities actions Activity
*ActivitiesApi* | [**head_activity**](docs/ActivitiesApi.md#head_activity) | **HEAD** /activities/{id} | See if a Activity exists
*ActivitiesApi* | [**list_activities**](docs/ActivitiesApi.md#list_activities) | **GET** /activities | Lists Activities filtered by some parameters.
*ActivitiesApi* | [**list_stats_activities**](docs/ActivitiesApi.md#list_stats_activities) | **HEAD** /activities | Stats of the List Activities filtered by some parameters.
*ActivitiesApi* | [**patch_activity**](docs/ActivitiesApi.md#patch_activity) | **PATCH** /activities/{id} | Patch a Activity
*ActivitiesApi* | [**post_activity_action**](docs/ActivitiesApi.md#post_activity_action) | **POST** /activities/{id}/actions/{cmd} | Call an action on the node.
*ActivitiesApi* | [**put_activity**](docs/ActivitiesApi.md#put_activity) | **PUT** /activities/{id} | Put a Activity
*AlertsApi* | [**create_alert**](docs/AlertsApi.md#create_alert) | **POST** /alerts | Create a Alert
*AlertsApi* | [**delete_alert**](docs/AlertsApi.md#delete_alert) | **DELETE** /alerts/{uuid} | Delete a Alert
*AlertsApi* | [**delete_alert_param**](docs/AlertsApi.md#delete_alert_param) | **DELETE** /alerts/{uuid}/params/{key} | Delete a single alerts parameter
*AlertsApi* | [**get_alert**](docs/AlertsApi.md#get_alert) | **GET** /alerts/{uuid} | Get a Alert
*AlertsApi* | [**get_alert_action**](docs/AlertsApi.md#get_alert_action) | **GET** /alerts/{uuid}/actions/{cmd} | List specific action for a alerts Alert
*AlertsApi* | [**get_alert_actions**](docs/AlertsApi.md#get_alert_actions) | **GET** /alerts/{uuid}/actions | List alerts actions Alert
*AlertsApi* | [**get_alert_param**](docs/AlertsApi.md#get_alert_param) | **GET** /alerts/{uuid}/params/{key} | Get a single alerts parameter
*AlertsApi* | [**get_alert_params**](docs/AlertsApi.md#get_alert_params) | **GET** /alerts/{uuid}/params | List alerts params Alert
*AlertsApi* | [**get_alert_pub_key**](docs/AlertsApi.md#get_alert_pub_key) | **GET** /alerts/{uuid}/pubkey | Get the public key for secure params on a alerts
*AlertsApi* | [**head_alert**](docs/AlertsApi.md#head_alert) | **HEAD** /alerts/{uuid} | See if a Alert exists
*AlertsApi* | [**list_alerts**](docs/AlertsApi.md#list_alerts) | **GET** /alerts | Lists Alerts filtered by some parameters.
*AlertsApi* | [**list_stats_alerts**](docs/AlertsApi.md#list_stats_alerts) | **HEAD** /alerts | Stats of the List Alerts filtered by some parameters.
*AlertsApi* | [**patch_alert**](docs/AlertsApi.md#patch_alert) | **PATCH** /alerts/{uuid} | Patch a Alert
*AlertsApi* | [**patch_alert_params**](docs/AlertsApi.md#patch_alert_params) | **PATCH** /alerts/{uuid}/params | Update all params on the object (merges with existing data)
*AlertsApi* | [**post_alert_ack**](docs/AlertsApi.md#post_alert_ack) | **POST** /alerts/{uuid}/acknowledge | Acknowledge an alert by {uuid}
*AlertsApi* | [**post_alert_action**](docs/AlertsApi.md#post_alert_action) | **POST** /alerts/{uuid}/actions/{cmd} | Call an action on the node.
*AlertsApi* | [**post_alert_param**](docs/AlertsApi.md#post_alert_param) | **POST** /alerts/{uuid}/params/{key} | Set a single parameter on an object
*AlertsApi* | [**post_alert_params**](docs/AlertsApi.md#post_alert_params) | **POST** /alerts/{uuid}/params | Replaces all parameters on the object
*AlertsApi* | [**put_alert**](docs/AlertsApi.md#put_alert) | **PUT** /alerts/{uuid} | Put a Alert
*BatchesApi* | [**create_batch**](docs/BatchesApi.md#create_batch) | **POST** /batches | Create a Batch
*BatchesApi* | [**delete_batch**](docs/BatchesApi.md#delete_batch) | **DELETE** /batches/{uuid} | Delete a Batch
*BatchesApi* | [**get_batch**](docs/BatchesApi.md#get_batch) | **GET** /batches/{uuid} | Get a Batch
*BatchesApi* | [**get_batch_action**](docs/BatchesApi.md#get_batch_action) | **GET** /batches/{uuid}/actions/{cmd} | List specific action for a batches Batch
*BatchesApi* | [**get_batch_actions**](docs/BatchesApi.md#get_batch_actions) | **GET** /batches/{uuid}/actions | List batches actions Batch
*BatchesApi* | [**head_batch**](docs/BatchesApi.md#head_batch) | **HEAD** /batches/{uuid} | See if a Batch exists
*BatchesApi* | [**list_batches**](docs/BatchesApi.md#list_batches) | **GET** /batches | Lists Batches filtered by some parameters.
*BatchesApi* | [**list_stats_batches**](docs/BatchesApi.md#list_stats_batches) | **HEAD** /batches | Stats of the List Batches filtered by some parameters.
*BatchesApi* | [**patch_batch**](docs/BatchesApi.md#patch_batch) | **PATCH** /batches/{uuid} | Patch a Batch
*BatchesApi* | [**post_batch_action**](docs/BatchesApi.md#post_batch_action) | **POST** /batches/{uuid}/actions/{cmd} | Call an action on the node.
*BatchesApi* | [**put_batch**](docs/BatchesApi.md#put_batch) | **PUT** /batches/{uuid} | Put a Batch
*BlueprintsApi* | [**create_blueprint**](docs/BlueprintsApi.md#create_blueprint) | **POST** /blueprints | Create a Blueprint
*BlueprintsApi* | [**delete_blueprint**](docs/BlueprintsApi.md#delete_blueprint) | **DELETE** /blueprints/{name} | Delete a Blueprint
*BlueprintsApi* | [**delete_blueprint_param**](docs/BlueprintsApi.md#delete_blueprint_param) | **DELETE** /blueprints/{name}/params/{key} | Delete a single blueprints parameter
*BlueprintsApi* | [**get_blueprint**](docs/BlueprintsApi.md#get_blueprint) | **GET** /blueprints/{name} | Get a Blueprint
*BlueprintsApi* | [**get_blueprint_action**](docs/BlueprintsApi.md#get_blueprint_action) | **GET** /blueprints/{name}/actions/{cmd} | List specific action for a blueprints Blueprint
*BlueprintsApi* | [**get_blueprint_actions**](docs/BlueprintsApi.md#get_blueprint_actions) | **GET** /blueprints/{name}/actions | List blueprints actions Blueprint
*BlueprintsApi* | [**get_blueprint_param**](docs/BlueprintsApi.md#get_blueprint_param) | **GET** /blueprints/{name}/params/{key} | Get a single blueprints parameter
*BlueprintsApi* | [**get_blueprint_params**](docs/BlueprintsApi.md#get_blueprint_params) | **GET** /blueprints/{name}/params | List blueprints params Blueprint
*BlueprintsApi* | [**get_blueprint_pub_key**](docs/BlueprintsApi.md#get_blueprint_pub_key) | **GET** /blueprints/{name}/pubkey | Get the public key for secure params on a blueprints
*BlueprintsApi* | [**head_blueprint**](docs/BlueprintsApi.md#head_blueprint) | **HEAD** /blueprints/{name} | See if a Blueprint exists
*BlueprintsApi* | [**list_blueprints**](docs/BlueprintsApi.md#list_blueprints) | **GET** /blueprints | Lists Blueprints filtered by some parameters.
*BlueprintsApi* | [**list_stats_blueprints**](docs/BlueprintsApi.md#list_stats_blueprints) | **HEAD** /blueprints | Stats of the List Blueprints filtered by some parameters.
*BlueprintsApi* | [**patch_blueprint**](docs/BlueprintsApi.md#patch_blueprint) | **PATCH** /blueprints/{name} | Patch a Blueprint
*BlueprintsApi* | [**patch_blueprint_params**](docs/BlueprintsApi.md#patch_blueprint_params) | **PATCH** /blueprints/{name}/params | Update all params on the object (merges with existing data)
*BlueprintsApi* | [**post_blueprint_action**](docs/BlueprintsApi.md#post_blueprint_action) | **POST** /blueprints/{name}/actions/{cmd} | Call an action on the node.
*BlueprintsApi* | [**post_blueprint_param**](docs/BlueprintsApi.md#post_blueprint_param) | **POST** /blueprints/{name}/params/{key} | Set a single parameter on an object
*BlueprintsApi* | [**post_blueprint_params**](docs/BlueprintsApi.md#post_blueprint_params) | **POST** /blueprints/{name}/params | Replaces all parameters on the object
*BlueprintsApi* | [**put_blueprint**](docs/BlueprintsApi.md#put_blueprint) | **PUT** /blueprints/{name} | Put a Blueprint
*BootEnvsApi* | [**create_boot_env**](docs/BootEnvsApi.md#create_boot_env) | **POST** /bootenvs | Create a BootEnv
*BootEnvsApi* | [**delete_boot_env**](docs/BootEnvsApi.md#delete_boot_env) | **DELETE** /bootenvs/{name} | Delete a BootEnv
*BootEnvsApi* | [**get_boot_env**](docs/BootEnvsApi.md#get_boot_env) | **GET** /bootenvs/{name} | Get a BootEnv
*BootEnvsApi* | [**get_boot_env_action**](docs/BootEnvsApi.md#get_boot_env_action) | **GET** /bootenvs/{name}/actions/{cmd} | List specific action for a bootenvs BootEnv
*BootEnvsApi* | [**get_boot_env_actions**](docs/BootEnvsApi.md#get_boot_env_actions) | **GET** /bootenvs/{name}/actions | List bootenvs actions BootEnv
*BootEnvsApi* | [**head_boot_env**](docs/BootEnvsApi.md#head_boot_env) | **HEAD** /bootenvs/{name} | See if a BootEnv exists
*BootEnvsApi* | [**list_boot_envs**](docs/BootEnvsApi.md#list_boot_envs) | **GET** /bootenvs | Lists BootEnvs filtered by some parameters.
*BootEnvsApi* | [**list_stats_boot_envs**](docs/BootEnvsApi.md#list_stats_boot_envs) | **HEAD** /bootenvs | Stats of the List BootEnvs filtered by some parameters.
*BootEnvsApi* | [**patch_boot_env**](docs/BootEnvsApi.md#patch_boot_env) | **PATCH** /bootenvs/{name} | Patch a BootEnv
*BootEnvsApi* | [**post_boot_env_action**](docs/BootEnvsApi.md#post_boot_env_action) | **POST** /bootenvs/{name}/actions/{cmd} | Call an action on the node.
*BootEnvsApi* | [**purge_local_boot_env**](docs/BootEnvsApi.md#purge_local_boot_env) | **DELETE** /bootenvs/{name}/purgeLocal | Purge local install files (ISOS and install trees) for a bootenv
*BootEnvsApi* | [**put_boot_env**](docs/BootEnvsApi.md#put_boot_env) | **PUT** /bootenvs/{name} | Put a BootEnv
*CatalogItemsApi* | [**create_catalog_item**](docs/CatalogItemsApi.md#create_catalog_item) | **POST** /catalog_items | Create a CatalogItem
*CatalogItemsApi* | [**delete_catalog_item**](docs/CatalogItemsApi.md#delete_catalog_item) | **DELETE** /catalog_items/{id} | Delete a CatalogItem
*CatalogItemsApi* | [**get_catalog_item**](docs/CatalogItemsApi.md#get_catalog_item) | **GET** /catalog_items/{id} | Get a CatalogItem
*CatalogItemsApi* | [**get_catalog_item_action**](docs/CatalogItemsApi.md#get_catalog_item_action) | **GET** /catalog_items/{id}/actions/{cmd} | List specific action for a catalog_items CatalogItem
*CatalogItemsApi* | [**get_catalog_item_actions**](docs/CatalogItemsApi.md#get_catalog_item_actions) | **GET** /catalog_items/{id}/actions | List catalog_items actions CatalogItem
*CatalogItemsApi* | [**head_catalog_item**](docs/CatalogItemsApi.md#head_catalog_item) | **HEAD** /catalog_items/{id} | See if a CatalogItem exists
*CatalogItemsApi* | [**list_catalog_items**](docs/CatalogItemsApi.md#list_catalog_items) | **GET** /catalog_items | Lists CatalogItems filtered by some parameters.
*CatalogItemsApi* | [**list_stats_catalog_items**](docs/CatalogItemsApi.md#list_stats_catalog_items) | **HEAD** /catalog_items | Stats of the List CatalogItems filtered by some parameters.
*CatalogItemsApi* | [**patch_catalog_item**](docs/CatalogItemsApi.md#patch_catalog_item) | **PATCH** /catalog_items/{id} | Patch a CatalogItem
*CatalogItemsApi* | [**post_catalog_item_action**](docs/CatalogItemsApi.md#post_catalog_item_action) | **POST** /catalog_items/{id}/actions/{cmd} | Call an action on the node.
*CatalogItemsApi* | [**put_catalog_item**](docs/CatalogItemsApi.md#put_catalog_item) | **PUT** /catalog_items/{id} | Put a CatalogItem
*ClustersApi* | [**cleanup_cluster**](docs/ClustersApi.md#cleanup_cluster) | **DELETE** /clusters/{uuid}/cleanup | Cleanup a Cluster
*ClustersApi* | [**create_cluster**](docs/ClustersApi.md#create_cluster) | **POST** /clusters | Create a Cluster
*ClustersApi* | [**delete_cluster**](docs/ClustersApi.md#delete_cluster) | **DELETE** /clusters/{uuid} | Delete a Cluster
*ClustersApi* | [**delete_cluster_group_param**](docs/ClustersApi.md#delete_cluster_group_param) | **DELETE** /clusters/{uuid}/group/params/{key} | Delete a single Cluster group profile parameter
*ClustersApi* | [**delete_cluster_param**](docs/ClustersApi.md#delete_cluster_param) | **DELETE** /clusters/{uuid}/params/{key} | Delete a single clusters parameter
*ClustersApi* | [**get_cluster**](docs/ClustersApi.md#get_cluster) | **GET** /clusters/{uuid} | Get a Cluster
*ClustersApi* | [**get_cluster_action**](docs/ClustersApi.md#get_cluster_action) | **GET** /clusters/{uuid}/actions/{cmd} | List specific action for a clusters Cluster
*ClustersApi* | [**get_cluster_actions**](docs/ClustersApi.md#get_cluster_actions) | **GET** /clusters/{uuid}/actions | List clusters actions Cluster
*ClustersApi* | [**get_cluster_group_param**](docs/ClustersApi.md#get_cluster_group_param) | **GET** /clusters/{uuid}/group/params/{key} | Get a single Cluster group profile parameter
*ClustersApi* | [**get_cluster_group_params**](docs/ClustersApi.md#get_cluster_group_params) | **GET** /clusters/{uuid}/group/params | List Cluster group profile params Cluster
*ClustersApi* | [**get_cluster_group_pub_key**](docs/ClustersApi.md#get_cluster_group_pub_key) | **GET** /clusters/{uuid}/group/pubkey | Get the public key for secure params on a Cluster group profile
*ClustersApi* | [**get_cluster_param**](docs/ClustersApi.md#get_cluster_param) | **GET** /clusters/{uuid}/params/{key} | Get a single clusters parameter
*ClustersApi* | [**get_cluster_params**](docs/ClustersApi.md#get_cluster_params) | **GET** /clusters/{uuid}/params | List clusters params Cluster
*ClustersApi* | [**get_cluster_pub_key**](docs/ClustersApi.md#get_cluster_pub_key) | **GET** /clusters/{uuid}/pubkey | Get the public key for secure params on a clusters
*ClustersApi* | [**get_cluster_render**](docs/ClustersApi.md#get_cluster_render) | **POST** /clusters/{uuid}/render | Render a blob on a machine
*ClustersApi* | [**get_cluster_token**](docs/ClustersApi.md#get_cluster_token) | **GET** /clusters/{uuid}/token | Get a Cluster Token
*ClustersApi* | [**head_cluster**](docs/ClustersApi.md#head_cluster) | **HEAD** /clusters/{uuid} | See if a Cluster exists
*ClustersApi* | [**list_clusters**](docs/ClustersApi.md#list_clusters) | **GET** /clusters | Lists Clusters filtered by some parameters.
*ClustersApi* | [**list_stats_clusters**](docs/ClustersApi.md#list_stats_clusters) | **HEAD** /clusters | Stats of the List Clusters filtered by some parameters.
*ClustersApi* | [**patch_cluster**](docs/ClustersApi.md#patch_cluster) | **PATCH** /clusters/{uuid} | Patch a Cluster
*ClustersApi* | [**patch_cluster_group_params**](docs/ClustersApi.md#patch_cluster_group_params) | **PATCH** /clusters/{uuid}/group/params | Update group profile parameters (merges with existing data)
*ClustersApi* | [**patch_cluster_params**](docs/ClustersApi.md#patch_cluster_params) | **PATCH** /clusters/{uuid}/params | Update all params on the object (merges with existing data)
*ClustersApi* | [**post_cluster_action**](docs/ClustersApi.md#post_cluster_action) | **POST** /clusters/{uuid}/actions/{cmd} | Call an action on the node.
*ClustersApi* | [**post_cluster_group_param**](docs/ClustersApi.md#post_cluster_group_param) | **POST** /clusters/{uuid}/group/params/{key} | Set a single Parameter in the group
*ClustersApi* | [**post_cluster_group_params**](docs/ClustersApi.md#post_cluster_group_params) | **POST** /clusters/{uuid}/group/params | Sets the group parameters (replaces)
*ClustersApi* | [**post_cluster_param**](docs/ClustersApi.md#post_cluster_param) | **POST** /clusters/{uuid}/params/{key} | Set a single parameter on an object
*ClustersApi* | [**post_cluster_params**](docs/ClustersApi.md#post_cluster_params) | **POST** /clusters/{uuid}/params | Replaces all parameters on the object
*ClustersApi* | [**post_cluster_release_to_pool**](docs/ClustersApi.md#post_cluster_release_to_pool) | **POST** /clusters/{uuid}/releaseToPool | Releases a cluster in this pool.
*ClustersApi* | [**put_cluster**](docs/ClustersApi.md#put_cluster) | **PUT** /clusters/{uuid} | Put a Cluster
*ClustersApi* | [**start_cluster**](docs/ClustersApi.md#start_cluster) | **PATCH** /clusters/{uuid}/start | Start a Cluster
*ConnectionsApi* | [**get_connection**](docs/ConnectionsApi.md#get_connection) | **GET** /connections/{id} | Close a websocket Connection
*ConnectionsApi* | [**get_connection_0**](docs/ConnectionsApi.md#get_connection_0) | **DELETE** /connections/{remoteaddr} | Close a websocket Connection
*ConnectionsApi* | [**list_connections**](docs/ConnectionsApi.md#list_connections) | **GET** /clusters/:uuid/connections | Lists Connections filtered by some parameters.
*ConnectionsApi* | [**list_connections_0**](docs/ConnectionsApi.md#list_connections_0) | **GET** /connections | Lists Connections filtered by some parameters
*ConnectionsApi* | [**list_connections_1**](docs/ConnectionsApi.md#list_connections_1) | **GET** /machines/:uuid/connections | Lists Connections filtered by some parameters.
*ConnectionsApi* | [**list_connections_2**](docs/ConnectionsApi.md#list_connections_2) | **GET** /resource_brokers/:uuid/connections | Lists Connections filtered by some parameters.
*ContentsApi* | [**create_content**](docs/ContentsApi.md#create_content) | **POST** /contents | Create content into Digital Rebar Provision
*ContentsApi* | [**delete_content**](docs/ContentsApi.md#delete_content) | **DELETE** /contents/{name} | Delete a content set.
*ContentsApi* | [**get_content**](docs/ContentsApi.md#get_content) | **GET** /contents/{name} | Get a specific content with {name}
*ContentsApi* | [**list_contents**](docs/ContentsApi.md#list_contents) | **GET** /contents | Lists possible contents on the system to serve DHCP
*ContentsApi* | [**upload_content**](docs/ContentsApi.md#upload_content) | **PUT** /contents/{name} | Replace content in Digital Rebar Provision
*ContextsApi* | [**create_context**](docs/ContextsApi.md#create_context) | **POST** /contexts | Create a Context
*ContextsApi* | [**delete_context**](docs/ContextsApi.md#delete_context) | **DELETE** /contexts/{name} | Delete a Context
*ContextsApi* | [**get_context**](docs/ContextsApi.md#get_context) | **GET** /contexts/{name} | Get a Context
*ContextsApi* | [**get_context_action**](docs/ContextsApi.md#get_context_action) | **GET** /contexts/{name}/actions/{cmd} | List specific action for a contexts Context
*ContextsApi* | [**get_context_actions**](docs/ContextsApi.md#get_context_actions) | **GET** /contexts/{name}/actions | List contexts actions Context
*ContextsApi* | [**head_context**](docs/ContextsApi.md#head_context) | **HEAD** /contexts/{name} | See if a Context exists
*ContextsApi* | [**list_contexts**](docs/ContextsApi.md#list_contexts) | **GET** /contexts | Lists Contexts filtered by some parameters.
*ContextsApi* | [**list_stats_contexts**](docs/ContextsApi.md#list_stats_contexts) | **HEAD** /contexts | Stats of the List Contexts filtered by some parameters.
*ContextsApi* | [**patch_context**](docs/ContextsApi.md#patch_context) | **PATCH** /contexts/{name} | Patch a Context
*ContextsApi* | [**post_context_action**](docs/ContextsApi.md#post_context_action) | **POST** /contexts/{name}/actions/{cmd} | Call an action on the node.
*ContextsApi* | [**put_context**](docs/ContextsApi.md#put_context) | **PUT** /contexts/{name} | Put a Context
*EndpointsApi* | [**create_endpoint**](docs/EndpointsApi.md#create_endpoint) | **POST** /endpoints | Create a Endpoint
*EndpointsApi* | [**delete_endpoint**](docs/EndpointsApi.md#delete_endpoint) | **DELETE** /endpoints/{id} | Delete a Endpoint
*EndpointsApi* | [**delete_endpoint_param**](docs/EndpointsApi.md#delete_endpoint_param) | **DELETE** /endpoints/{id}/params/{key} | Delete a single endpoints parameter
*EndpointsApi* | [**get_endpoint**](docs/EndpointsApi.md#get_endpoint) | **GET** /endpoints/{id} | Get a Endpoint
*EndpointsApi* | [**get_endpoint_action**](docs/EndpointsApi.md#get_endpoint_action) | **GET** /endpoints/{id}/actions/{cmd} | List specific action for a endpoint Endpoint
*EndpointsApi* | [**get_endpoint_actions**](docs/EndpointsApi.md#get_endpoint_actions) | **GET** /endpoints/{id}/actions | List endpoint actions Endpoint
*EndpointsApi* | [**get_endpoint_param**](docs/EndpointsApi.md#get_endpoint_param) | **GET** /endpoints/{id}/params/{key} | Get a single endpoints parameter
*EndpointsApi* | [**get_endpoint_params**](docs/EndpointsApi.md#get_endpoint_params) | **GET** /endpoints/{id}/params | List endpoints params Endpoint
*EndpointsApi* | [**get_endpoint_pub_key**](docs/EndpointsApi.md#get_endpoint_pub_key) | **GET** /endpoints/{id}/pubkey | Get the public key for secure params on a endpoints
*EndpointsApi* | [**head_endpoint**](docs/EndpointsApi.md#head_endpoint) | **HEAD** /endpoints/{id} | See if a Endpoint exists
*EndpointsApi* | [**list_endpoints**](docs/EndpointsApi.md#list_endpoints) | **GET** /endpoints | Lists Endpoints filtered by some parameters.
*EndpointsApi* | [**list_stats_endpoints**](docs/EndpointsApi.md#list_stats_endpoints) | **HEAD** /endpoints | Stats of the List Endpoints filtered by some parameters.
*EndpointsApi* | [**patch_endpoint**](docs/EndpointsApi.md#patch_endpoint) | **PATCH** /endpoints/{id} | Patch a Endpoint
*EndpointsApi* | [**patch_endpoint_params**](docs/EndpointsApi.md#patch_endpoint_params) | **PATCH** /endpoints/{id}/params | Update all params on the object (merges with existing data)
*EndpointsApi* | [**post_endpoint_action**](docs/EndpointsApi.md#post_endpoint_action) | **POST** /endpoints/{id}/actions/{cmd} | Call an action on the node.
*EndpointsApi* | [**post_endpoint_param**](docs/EndpointsApi.md#post_endpoint_param) | **POST** /endpoints/{id}/params/{key} | Set a single parameter on an object
*EndpointsApi* | [**post_endpoint_params**](docs/EndpointsApi.md#post_endpoint_params) | **POST** /endpoints/{id}/params | Replaces all parameters on the object
*EndpointsApi* | [**put_endpoint**](docs/EndpointsApi.md#put_endpoint) | **PUT** /endpoints/{id} | Put a Endpoint
*EventsApi* | [**post_event**](docs/EventsApi.md#post_event) | **POST** /events | Create an Event
*FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /files/{path} | Delete a file to a specific {path} in the tree under files.
*FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /files/{path} | Get a specific File with {path}
*FilesApi* | [**head_file**](docs/FilesApi.md#head_file) | **HEAD** /files/{path} | See if a file exists and return a checksum in the header
*FilesApi* | [**head_iso**](docs/FilesApi.md#head_iso) | **HEAD** /isos/{path} | See if a iso exists and return a checksum in the header
*FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /files | Lists files in files directory or subdirectory per query parameter
*FilesApi* | [**upload_file**](docs/FilesApi.md#upload_file) | **POST** /files/{path} | Upload a file to a specific {path} in the tree under files.
*FiltersApi* | [**create_filter**](docs/FiltersApi.md#create_filter) | **POST** /filters | Create a Filter
*FiltersApi* | [**delete_filter**](docs/FiltersApi.md#delete_filter) | **DELETE** /filters/{id} | Delete a Filter
*FiltersApi* | [**delete_filter_param**](docs/FiltersApi.md#delete_filter_param) | **DELETE** /filters/{id}/params/{key} | Delete a single filters parameter
*FiltersApi* | [**get_filter**](docs/FiltersApi.md#get_filter) | **GET** /filters/{id} | Get a Filter
*FiltersApi* | [**get_filter_action**](docs/FiltersApi.md#get_filter_action) | **GET** /filters/{id}/actions/{cmd} | List specific action for a filters Filter
*FiltersApi* | [**get_filter_actions**](docs/FiltersApi.md#get_filter_actions) | **GET** /filters/{id}/actions | List filters actions Filter
*FiltersApi* | [**get_filter_param**](docs/FiltersApi.md#get_filter_param) | **GET** /filters/{id}/params/{key} | Get a single filters parameter
*FiltersApi* | [**get_filter_params**](docs/FiltersApi.md#get_filter_params) | **GET** /filters/{id}/params | List filters params Filter
*FiltersApi* | [**get_filter_pub_key**](docs/FiltersApi.md#get_filter_pub_key) | **GET** /filters/{id}/pubkey | Get the public key for secure params on a filters
*FiltersApi* | [**head_filter**](docs/FiltersApi.md#head_filter) | **HEAD** /filters/{id} | See if a Filter exists
*FiltersApi* | [**list_filters**](docs/FiltersApi.md#list_filters) | **GET** /filters | Lists Filters filtered by some parameters.
*FiltersApi* | [**list_stats_filters**](docs/FiltersApi.md#list_stats_filters) | **HEAD** /filters | Stats of the List Filters filtered by some parameters.
*FiltersApi* | [**patch_filter**](docs/FiltersApi.md#patch_filter) | **PATCH** /filters/{id} | Patch a Filter
*FiltersApi* | [**patch_filter_params**](docs/FiltersApi.md#patch_filter_params) | **PATCH** /filters/{id}/params | Update all params on the object (merges with existing data)
*FiltersApi* | [**post_filter_action**](docs/FiltersApi.md#post_filter_action) | **POST** /filters/{id}/actions/{cmd} | Call an action on the node.
*FiltersApi* | [**post_filter_param**](docs/FiltersApi.md#post_filter_param) | **POST** /filters/{id}/params/{key} | Set a single parameter on an object
*FiltersApi* | [**post_filter_params**](docs/FiltersApi.md#post_filter_params) | **POST** /filters/{id}/params | Replaces all parameters on the object
*FiltersApi* | [**put_filter**](docs/FiltersApi.md#put_filter) | **PUT** /filters/{id} | Put a Filter
*IdentityProvidersApi* | [**create_identity_provider**](docs/IdentityProvidersApi.md#create_identity_provider) | **POST** /identity_providers | Create a IdentityProvider
*IdentityProvidersApi* | [**delete_identity_provider**](docs/IdentityProvidersApi.md#delete_identity_provider) | **DELETE** /identity_providers/{name} | Delete a IdentityProvider
*IdentityProvidersApi* | [**get_identity_provider**](docs/IdentityProvidersApi.md#get_identity_provider) | **GET** /identity_providers/{name} | Get a IdentityProvider
*IdentityProvidersApi* | [**get_identity_provider_action**](docs/IdentityProvidersApi.md#get_identity_provider_action) | **GET** /identity_providers/{name}/actions/{cmd} | List specific action for a identity_providers IdentityProvider
*IdentityProvidersApi* | [**get_identity_provider_actions**](docs/IdentityProvidersApi.md#get_identity_provider_actions) | **GET** /identity_providers/{name}/actions | List identity_providers actions IdentityProvider
*IdentityProvidersApi* | [**head_identity_provider**](docs/IdentityProvidersApi.md#head_identity_provider) | **HEAD** /identity_providers/{name} | See if a IdentityProvider exists
*IdentityProvidersApi* | [**list_identity_providers**](docs/IdentityProvidersApi.md#list_identity_providers) | **GET** /identity_providers | Lists IdentityProviders filtered by some parameters.
*IdentityProvidersApi* | [**list_stats_identity_providers**](docs/IdentityProvidersApi.md#list_stats_identity_providers) | **HEAD** /identity_providers | Stats of the List IdentityProviders filtered by some parameters.
*IdentityProvidersApi* | [**patch_identity_provider**](docs/IdentityProvidersApi.md#patch_identity_provider) | **PATCH** /identity_providers/{name} | Patch a IdentityProvider
*IdentityProvidersApi* | [**post_identity_provider_action**](docs/IdentityProvidersApi.md#post_identity_provider_action) | **POST** /identity_providers/{name}/actions/{cmd} | Call an action on the node.
*IdentityProvidersApi* | [**put_identity_provider**](docs/IdentityProvidersApi.md#put_identity_provider) | **PUT** /identity_providers/{name} | Put a IdentityProvider
*IndexesApi* | [**get_index**](docs/IndexesApi.md#get_index) | **GET** /indexes/{prefix} | Get static indexes for a specific object type
*IndexesApi* | [**get_single_index**](docs/IndexesApi.md#get_single_index) | **GET** /indexes/{prefix}/{param} | Get information on a specific index for a specific object type.
*IndexesApi* | [**list_indexes**](docs/IndexesApi.md#list_indexes) | **GET** /indexes | List all static indexes for objects
*InfoApi* | [**get_info**](docs/InfoApi.md#get_info) | **GET** /info | Return current system info.
*InterfacesApi* | [**get_interface**](docs/InterfacesApi.md#get_interface) | **GET** /interfaces/{name} | Get a specific interface with {name}
*InterfacesApi* | [**list_interfaces**](docs/InterfacesApi.md#list_interfaces) | **GET** /interfaces | Lists possible interfaces on the system to serve DHCP
*IsosApi* | [**delete_iso**](docs/IsosApi.md#delete_iso) | **DELETE** /isos/{path} | Delete an iso to a specific {path} in the tree under isos.
*IsosApi* | [**get_iso**](docs/IsosApi.md#get_iso) | **GET** /isos/{path} | Get a specific Iso with {path}
*IsosApi* | [**list_isos**](docs/IsosApi.md#list_isos) | **GET** /isos | Lists isos in isos directory
*IsosApi* | [**upload_iso**](docs/IsosApi.md#upload_iso) | **POST** /isos/{path} | Upload an iso to a specific {path} in the tree under isos.
*JobsApi* | [**create_job**](docs/JobsApi.md#create_job) | **POST** /jobs | Create a Job
*JobsApi* | [**delete_job**](docs/JobsApi.md#delete_job) | **DELETE** /jobs/{uuid} | Delete a Job
*JobsApi* | [**get_job**](docs/JobsApi.md#get_job) | **GET** /jobs/{uuid} | Get a Job
*JobsApi* | [**get_job_action**](docs/JobsApi.md#get_job_action) | **GET** /jobs/{uuid}/plugin_actions/{cmd} | List specific action for a job Job
*JobsApi* | [**get_job_actions**](docs/JobsApi.md#get_job_actions) | **GET** /jobs/{uuid}/actions | Get actions for this job
*JobsApi* | [**get_job_log**](docs/JobsApi.md#get_job_log) | **GET** /jobs/{uuid}/log | Get the log for this job
*JobsApi* | [**get_job_log_archive**](docs/JobsApi.md#get_job_log_archive) | **GET** /jobs/{uuid}/archive | Get the log archive entry for this job
*JobsApi* | [**get_job_plugin_actions**](docs/JobsApi.md#get_job_plugin_actions) | **GET** /jobs/{uuid}/plugin_actions | List job plugin_actions Job
*JobsApi* | [**head_job**](docs/JobsApi.md#head_job) | **HEAD** /jobs/{uuid} | See if a Job exists
*JobsApi* | [**head_job_log**](docs/JobsApi.md#head_job_log) | **HEAD** /jobs/{uuid}/log | Get the log for this job
*JobsApi* | [**list_jobs**](docs/JobsApi.md#list_jobs) | **GET** /jobs | Lists Jobs filtered by some parameters.
*JobsApi* | [**list_stats_jobs**](docs/JobsApi.md#list_stats_jobs) | **HEAD** /jobs | Stats of the List Jobs filtered by some parameters.
*JobsApi* | [**patch_job**](docs/JobsApi.md#patch_job) | **PATCH** /jobs/{uuid} | Patch a Job
*JobsApi* | [**post_job_action**](docs/JobsApi.md#post_job_action) | **POST** /jobs/{uuid}/plugin_actions/{cmd} | Call an action on the node.
*JobsApi* | [**put_job**](docs/JobsApi.md#put_job) | **PUT** /jobs/{uuid} | Put a Job
*JobsApi* | [**put_job_log**](docs/JobsApi.md#put_job_log) | **PUT** /jobs/{uuid}/log | Append the string to the end of the job&#39;s log.
*LeasesApi* | [**create_lease**](docs/LeasesApi.md#create_lease) | **POST** /leases | Create a Lease
*LeasesApi* | [**delete_lease**](docs/LeasesApi.md#delete_lease) | **DELETE** /leases/{address} | Delete a Lease
*LeasesApi* | [**get_lease**](docs/LeasesApi.md#get_lease) | **GET** /leases/{address} | Get a Lease
*LeasesApi* | [**get_lease_action**](docs/LeasesApi.md#get_lease_action) | **GET** /leases/{address}/actions/{cmd} | List specific action for a leases Lease
*LeasesApi* | [**get_lease_actions**](docs/LeasesApi.md#get_lease_actions) | **GET** /leases/{address}/actions | List leases actions Lease
*LeasesApi* | [**head_lease**](docs/LeasesApi.md#head_lease) | **HEAD** /leases/{address} | See if a Lease exists
*LeasesApi* | [**list_leases**](docs/LeasesApi.md#list_leases) | **GET** /leases | Lists Leases filtered by some parameters.
*LeasesApi* | [**list_stats_leases**](docs/LeasesApi.md#list_stats_leases) | **HEAD** /leases | Stats of the List Leases filtered by some parameters.
*LeasesApi* | [**patch_lease**](docs/LeasesApi.md#patch_lease) | **PATCH** /leases/{address} | Patch a Lease
*LeasesApi* | [**post_lease_action**](docs/LeasesApi.md#post_lease_action) | **POST** /leases/{address}/actions/{cmd} | Call an action on the node.
*LeasesApi* | [**put_lease**](docs/LeasesApi.md#put_lease) | **PUT** /leases/{address} | Put a Lease
*LogsApi* | [**get_logs**](docs/LogsApi.md#get_logs) | **GET** /logs | Return current contents of the log buffer
*MachinesApi* | [**cleanup_machine**](docs/MachinesApi.md#cleanup_machine) | **DELETE** /machines/{uuid}/cleanup | Cleanup a Machine
*MachinesApi* | [**create_machine**](docs/MachinesApi.md#create_machine) | **POST** /machines | Create a Machine
*MachinesApi* | [**delete_machine**](docs/MachinesApi.md#delete_machine) | **DELETE** /machines/{uuid} | Delete a Machine
*MachinesApi* | [**delete_machine_param**](docs/MachinesApi.md#delete_machine_param) | **DELETE** /machines/{uuid}/params/{key} | Delete a single machines parameter
*MachinesApi* | [**get_machine**](docs/MachinesApi.md#get_machine) | **GET** /machines/{uuid} | Get a Machine
*MachinesApi* | [**get_machine_action**](docs/MachinesApi.md#get_machine_action) | **GET** /machines/{uuid}/actions/{cmd} | List specific action for a machines Machine
*MachinesApi* | [**get_machine_actions**](docs/MachinesApi.md#get_machine_actions) | **GET** /machines/{uuid}/actions | List machines actions Machine
*MachinesApi* | [**get_machine_param**](docs/MachinesApi.md#get_machine_param) | **GET** /machines/{uuid}/params/{key} | Get a single machines parameter
*MachinesApi* | [**get_machine_params**](docs/MachinesApi.md#get_machine_params) | **GET** /machines/{uuid}/params | List machines params Machine
*MachinesApi* | [**get_machine_pub_key**](docs/MachinesApi.md#get_machine_pub_key) | **GET** /machines/{uuid}/pubkey | Get the public key for secure params on a machines
*MachinesApi* | [**get_machine_render**](docs/MachinesApi.md#get_machine_render) | **POST** /machines/{uuid}/render | Render a blob on a machine
*MachinesApi* | [**get_machine_token**](docs/MachinesApi.md#get_machine_token) | **GET** /machines/{uuid}/token | Get a Machine Token
*MachinesApi* | [**head_machine**](docs/MachinesApi.md#head_machine) | **HEAD** /machines/{uuid} | See if a Machine exists
*MachinesApi* | [**list_machines**](docs/MachinesApi.md#list_machines) | **GET** /machines | Lists Machines filtered by some parameters.
*MachinesApi* | [**list_stats_machines**](docs/MachinesApi.md#list_stats_machines) | **HEAD** /machines | Stats of the List Machines filtered by some parameters.
*MachinesApi* | [**patch_machine**](docs/MachinesApi.md#patch_machine) | **PATCH** /machines/{uuid} | Patch a Machine
*MachinesApi* | [**patch_machine_params**](docs/MachinesApi.md#patch_machine_params) | **PATCH** /machines/{uuid}/params | Update all params on the object (merges with existing data)
*MachinesApi* | [**pick_machine_work_order**](docs/MachinesApi.md#pick_machine_work_order) | **POST** /machines/{id}/pick/{key} | Pick a workorder for this agent.  This can return the current work order.
*MachinesApi* | [**post_machine_action**](docs/MachinesApi.md#post_machine_action) | **POST** /machines/{uuid}/actions/{cmd} | Call an action on the node.
*MachinesApi* | [**post_machine_param**](docs/MachinesApi.md#post_machine_param) | **POST** /machines/{uuid}/params/{key} | Set a single parameter on an object
*MachinesApi* | [**post_machine_params**](docs/MachinesApi.md#post_machine_params) | **POST** /machines/{uuid}/params | Replaces all parameters on the object
*MachinesApi* | [**post_machine_release_to_pool**](docs/MachinesApi.md#post_machine_release_to_pool) | **POST** /machines/{id}/releaseToPool | Releases a machine in this pool.
*MachinesApi* | [**put_machine**](docs/MachinesApi.md#put_machine) | **PUT** /machines/{uuid} | Put a Machine
*MachinesApi* | [**start_machine**](docs/MachinesApi.md#start_machine) | **PATCH** /machines/{uuid}/start | Start a Machine
*MetaApi* | [**get_meta**](docs/MetaApi.md#get_meta) | **GET** /meta/{type}/{id} | Get Metadata for an Object of {type} idendified by {id}
*MetaApi* | [**patch_meta**](docs/MetaApi.md#patch_meta) | **PATCH** /meta/{type}/{id} | Patch metadata on an Object of {type} with an ID of {id}
*ObjectsApi* | [**list_objects**](docs/ObjectsApi.md#list_objects) | **GET** /objects | Lists the object types in the system
*ParamsApi* | [**create_param**](docs/ParamsApi.md#create_param) | **POST** /params | Create a Param
*ParamsApi* | [**delete_param**](docs/ParamsApi.md#delete_param) | **DELE