Python Library to interact with the digitalrebar API.
Project description
drppy_client
A RestFUL API-driven Provisioner and DHCP server
This Python package is automatically generated by the Swagger Codegen project:
- API version: 4.0.0
- Package version: 0.0.3
- Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit http://docs.rackn.io
The generated code may have been modified by the Engineering Team at RackN.
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:
pip install drppy_client
Once installed use the following code to import the package for use:
import drppy_client
To use the development version of this library install directly from gitlab using:
pip install git+https://gitlab.com/rackn/drppy_client.git
Setuptools
Install via Setuptools.
python setup.py install --user
Then import the package:
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 meant to be run from the examples directory
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.
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 it is installed if you plan to use the tool
pip install click
From the examples directory run:
$ 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.
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 | get_activity | GET /activities/{uuid} | Get a Activity |
| ActivitiesApi | get_activity_action | GET /activities/{uuid}/actions/{cmd} | List specific action for a activity Activity |
| ActivitiesApi | get_activity_actions | GET /activities/{uuid}/actions | List activity actions Activity |
| ActivitiesApi | head_activity | HEAD /activities/{uuid} | See if a Activity exists |
| ActivitiesApi | list_activities | GET /activities | Lists Activities filtered by some parameters. |
| ActivitiesApi | list_stats_activities | HEAD /activities | Stats of the List Activities filtered by some parameters. |
| ActivitiesApi | post_activity_action | POST /activities/{uuid}/actions/{cmd} | Call an action on the node. |
| AlertsApi | create_alert | POST /alerts | Create a Alert |
| AlertsApi | delete_alert | DELETE /alerts/{uuid} | Delete a Alert |
| AlertsApi | delete_alert_param | DELETE /alerts/{uuid}/params/{key} | Delete a single alert parameter |
| AlertsApi | get_alert | GET /alerts/{uuid} | Get a Alert |
| AlertsApi | get_alert_action | GET /alerts/{uuid}/actions/{cmd} | List specific action for a alert Alert |
| AlertsApi | get_alert_actions | GET /alerts/{uuid}/actions | List alert actions Alert |
| AlertsApi | get_alert_param | GET /alerts/{uuid}/params/{key} | Get a single alert parameter |
| AlertsApi | get_alert_params | GET /alerts/{uuid}/params | List alert params Alert |
| AlertsApi | get_alert_pub_key | GET /alerts/{uuid}/pubkey | Get the public key for secure params on a alert |
| AlertsApi | head_alert | HEAD /alerts/{uuid} | See if a Alert exists |
| AlertsApi | list_alerts | GET /alerts | Lists Alerts filtered by some parameters. |
| AlertsApi | list_stats_alerts | HEAD /alerts | Stats of the List Alerts filtered by some parameters. |
| AlertsApi | patch_alert | PATCH /alerts/{uuid} | Patch a Alert |
| AlertsApi | patch_alert_params | PATCH /alerts/{uuid}/params | |
| AlertsApi | post_alert_ack | POST /alerts/{uuid}/acknowledge | |
| AlertsApi | post_alert_action | POST /alerts/{uuid}/actions/{cmd} | Call an action on the node. |
| AlertsApi | post_alert_param | POST /alerts/{uuid}/params/{key} | |
| AlertsApi | post_alert_params | POST /alerts/{uuid}/params | |
| AlertsApi | put_alert | PUT /alerts/{uuid} | Put a Alert |
| BatchesApi | create_batch | POST /batches | Create a Batch |
| BatchesApi | delete_batch | DELETE /batches/{uuid} | Delete a Batch |
| BatchesApi | get_batch | GET /batches/{uuid} | Get a Batch |
| BatchesApi | get_batch_action | GET /batches/{uuid}/actions/{cmd} | List specific action for a batch Batch |
| BatchesApi | get_batch_actions | GET /batches/{uuid}/actions | List batch actions Batch |
| BatchesApi | head_batch | HEAD /batches/{uuid} | See if a Batch exists |
| BatchesApi | list_batches | GET /batches | Lists Batches filtered by some parameters. |
| BatchesApi | list_stats_batches | HEAD /batches | Stats of the List Batches filtered by some parameters. |
| BatchesApi | patch_batch | PATCH /batches/{uuid} | Patch a Batch |
| BatchesApi | post_batch_action | POST /batches/{uuid}/actions/{cmd} | Call an action on the node. |
| BatchesApi | put_batch | PUT /batches/{uuid} | Put a Batch |
| BlueprintsApi | create_blueprint | POST /blueprints | Create a Blueprint |
| BlueprintsApi | delete_blueprint | DELETE /blueprints/{name} | Delete a Blueprint |
| BlueprintsApi | delete_blueprint_param | DELETE /blueprints/{name}/params/{key} | Delete a single blueprint parameter |
| BlueprintsApi | get_blueprint | GET /blueprints/{name} | Get a Blueprint |
| BlueprintsApi | get_blueprint_action | GET /blueprints/{name}/actions/{cmd} | List specific action for a blueprint Blueprint |
| BlueprintsApi | get_blueprint_actions | GET /blueprints/{name}/actions | List blueprint actions Blueprint |
| BlueprintsApi | get_blueprint_param | GET /blueprints/{name}/params/{key} | Get a single blueprint parameter |
| BlueprintsApi | get_blueprint_params | GET /blueprints/{name}/params | List blueprint params Blueprint |
| BlueprintsApi | get_blueprint_pub_key | GET /blueprints/{name}/pubkey | Get the public key for secure params on a blueprint |
| BlueprintsApi | head_blueprint | HEAD /blueprints/{name} | See if a Blueprint exists |
| BlueprintsApi | list_blueprints | GET /blueprints | Lists Blueprints filtered by some parameters. |
| BlueprintsApi | list_stats_blueprints | HEAD /blueprints | Stats of the List Blueprints filtered by some parameters. |
| BlueprintsApi | patch_blueprint | PATCH /blueprints/{name} | Patch a Blueprint |
| BlueprintsApi | patch_blueprint_params | PATCH /blueprints/{name}/params | |
| BlueprintsApi | post_blueprint_action | POST /blueprints/{name}/actions/{cmd} | Call an action on the node. |
| BlueprintsApi | post_blueprint_param | POST /blueprints/{name}/params/{key} | |
| BlueprintsApi | post_blueprint_params | POST /blueprints/{name}/params | |
| BlueprintsApi | put_blueprint | PUT /blueprints/{name} | Put a Blueprint |
| BootEnvsApi | create_boot_env | POST /bootenvs | Create a BootEnv |
| BootEnvsApi | delete_boot_env | DELETE /bootenvs/{name} | Delete a BootEnv |
| BootEnvsApi | get_boot_env | GET /bootenvs/{name} | Get a BootEnv |
| BootEnvsApi | get_boot_env_action | GET /bootenvs/{name}/actions/{cmd} | List specific action for a bootenv BootEnv |
| BootEnvsApi | get_boot_env_actions | GET /bootenvs/{name}/actions | List bootenv actions BootEnv |
| BootEnvsApi | head_boot_env | HEAD /bootenvs/{name} | See if a BootEnv exists |
| BootEnvsApi | list_boot_envs | GET /bootenvs | Lists BootEnvs filtered by some parameters. |
| BootEnvsApi | list_stats_boot_envs | HEAD /bootenvs | Stats of the List BootEnvs filtered by some parameters. |
| BootEnvsApi | patch_boot_env | PATCH /bootenvs/{name} | Patch a BootEnv |
| BootEnvsApi | post_boot_env_action | POST /bootenvs/{name}/actions/{cmd} | Call an action on the node. |
| BootEnvsApi | purge_local_boot_env | DELETE /bootenvs/{name}/purgeLocal | Purge local install files (ISOS and install trees) for a bootenv |
| BootEnvsApi | put_boot_env | PUT /bootenvs/{name} | Put a BootEnv |
| CatalogItemsApi | create_catalog_item | POST /catalog_items | Create a CatalogItem |
| CatalogItemsApi | delete_catalog_item | DELETE /catalog_items/{id} | Delete a CatalogItem |
| CatalogItemsApi | get_catalog_item | GET /catalog_items/{id} | Get a CatalogItem |
| CatalogItemsApi | head_catalog_item | HEAD /catalog_items/{id} | See if a CatalogItem exists |
| CatalogItemsApi | list_catalog_items | GET /catalog_items | Lists CatalogItems filtered by some parameters. |
| CatalogItemsApi | list_stats_catalog_items | HEAD /catalog_items | Stats of the List CatalogItems filtered by some parameters. |
| CatalogItemsApi | patch_catalog_item | PATCH /catalog_items/{id} | Patch a CatalogItem |
| CatalogItemsApi | put_catalog_item | PUT /catalog_items/{id} | Put a CatalogItem |
| ClustersApi | cleanup_cluster | DELETE /clusters/{uuid}/cleanup | Cleanup a Cluster |
| ClustersApi | create_cluster | POST /clusters | Create a Cluster |
| ClustersApi | delete_cluster | DELETE /clusters/{uuid} | Delete a Cluster |
| ClustersApi | delete_cluster_group_param | DELETE /clusters/{uuid}/group/params/{key} | Delete a single cluster group profile parameter |
| ClustersApi | delete_cluster_param | DELETE /clusters/{uuid}/params/{key} | Delete a single cluster parameter |
| ClustersApi | get_cluster | GET /clusters/{uuid} | Get a Cluster |
| ClustersApi | get_cluster_action | GET /clusters/{uuid}/actions/{cmd} | List specific action for a cluster Cluster |
| ClustersApi | get_cluster_actions | GET /clusters/{uuid}/actions | List cluster actions Cluster |
| ClustersApi | get_cluster_group_param | GET /clusters/{uuid}/group/params/{key} | Get a single cluster group profile parameter |
| ClustersApi | get_cluster_group_params | GET /clusters/{uuid}/group/params | List cluster group profile params Cluster |
| ClustersApi | 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 | GET /clusters/{uuid}/params/{key} | Get a single cluster parameter |
| ClustersApi | get_cluster_params | GET /clusters/{uuid}/params | List cluster params Cluster |
| ClustersApi | get_cluster_pub_key | GET /clusters/{uuid}/pubkey | Get the public key for secure params on a cluster |
| ClustersApi | get_cluster_token | GET /clusters/{uuid}/token | Get a Cluster Token |
| ClustersApi | head_cluster | HEAD /clusters/{uuid} | See if a Cluster exists |
| ClustersApi | list_clusters | GET /clusters | Lists Clusters filtered by some parameters. |
| ClustersApi | list_stats_clusters | HEAD /clusters | Stats of the List Clusters filtered by some parameters. |
| ClustersApi | patch_cluster | PATCH /clusters/{uuid} | Patch a Cluster |
| ClustersApi | patch_cluster_group_params | PATCH /clusters/{uuid}/group/params | |
| ClustersApi | patch_cluster_params | PATCH /clusters/{uuid}/params | |
| ClustersApi | post_cluster_action | POST /clusters/{uuid}/actions/{cmd} | Call an action on the node. |
| ClustersApi | post_cluster_group_param | POST /clusters/{uuid}/group/params/{key} | |
| ClustersApi | post_cluster_group_params | POST /clusters/{uuid}/group/params | |
| ClustersApi | post_cluster_param | POST /clusters/{uuid}/params/{key} | |
| ClustersApi | post_cluster_params | POST /clusters/{uuid}/params | |
| ClustersApi | put_cluster | PUT /clusters/{uuid} | Put a Cluster |
| ClustersApi | start_cluster | PATCH /clusters/{uuid}/start | Start a Cluster |
| ConnectionsApi | get_connection | DELETE /connections/{remoteaddr} | Close a websocket Connection |
| ConnectionsApi | list_connections | GET /clusters/:uuid/connections | Lists Connections filtered by some parameters. |
| ConnectionsApi | list_connections_0 | GET /connections | Lists Connections filtered by some parameters |
| ConnectionsApi | list_connections_1 | GET /machines/:uuid/connections | Lists Connections filtered by some parameters. |
| ConnectionsApi | list_connections_2 | GET /resource_brokers/:uuid/connections | Lists Connections filtered by some parameters. |
| ContentsApi | create_content | POST /contents | |
| ContentsApi | delete_content | DELETE /contents/{name} | Delete a content set. |
| ContentsApi | get_content | GET /contents/{name} | Get a specific content with {name} |
| ContentsApi | list_contents | GET /contents | |
| ContentsApi | upload_content | PUT /contents/{name} | |
| ContextsApi | create_context | POST /contexts | Create a Context |
| ContextsApi | delete_context | DELETE /contexts/{name} | Delete a Context |
| ContextsApi | get_context | GET /contexts/{name} | Get a Context |
| ContextsApi | get_context_action | GET /contexts/{name}/actions/{cmd} | List specific action for a context Context |
| ContextsApi | get_context_actions | GET /contexts/{name}/actions | List context actions Context |
| ContextsApi | head_context | HEAD /contexts/{name} | See if a Context exists |
| ContextsApi | list_contexts | GET /contexts | Lists Contexts filtered by some parameters. |
| ContextsApi | list_stats_contexts | HEAD /contexts | Stats of the List Contexts filtered by some parameters. |
| ContextsApi | patch_context | PATCH /contexts/{name} | Patch a Context |
| ContextsApi | post_context_action | POST /contexts/{name}/actions/{cmd} | Call an action on the node. |
| ContextsApi | put_context | PUT /contexts/{name} | Put a Context |
| EndpointsApi | create_endpoint | POST /endpoints | Create a Endpoint |
| EndpointsApi | delete_endpoint | DELETE /endpoints/{id} | Delete a Endpoint |
| EndpointsApi | delete_endpoint_param | DELETE /endpoints/{uuid}/params/{key} | Delete a single endpoint parameter |
| EndpointsApi | get_endpoint | GET /endpoints/{id} | Get a Endpoint |
| EndpointsApi | get_endpoint_action | GET /endpoints/{id}/actions/{cmd} | List specific action for a endpoint Endpoint |
| EndpointsApi | get_endpoint_actions | GET /endpoints/{id}/actions | List endpoint actions Endpoint |
| EndpointsApi | get_endpoint_param | GET /endpoints/{id}/params/{key} | Get a single endpoint parameter |
| EndpointsApi | get_endpoint_params | GET /endpoints/{id}/params | List endpoint params Endpoint |
| EndpointsApi | get_endpoint_pub_key | GET /endpoints/{id}/pubkey | Get the public key for secure params on a endpoint |
| EndpointsApi | head_endpoint | HEAD /endpoints/{id} | See if a Endpoint exists |
| EndpointsApi | list_endpoints | GET /endpoints | Lists Endpoints filtered by some parameters. |
| EndpointsApi | list_stats_endpoints | HEAD /endpoints | Stats of the List Endpoints filtered by some parameters. |
| EndpointsApi | patch_endpoint | PATCH /endpoints/{id} | Patch a Endpoint |
| EndpointsApi | patch_endpoint_params | PATCH /endpoints/{id}/params | |
| EndpointsApi | post_endpoint_action | POST /endpoints/{id}/actions/{cmd} | Call an action on the node. |
| EndpointsApi | post_endpoint_param | POST /endpoints/{id}/params/{key} | |
| EndpointsApi | post_endpoint_params | POST /endpoints/{id}/params | |
| EndpointsApi | put_endpoint | PUT /endpoints/{id} | Put a Endpoint |
| EventsApi | post_event | POST /events | Create an Event |
| FilesApi | delete_file | DELETE /files/{path} | Delete a file to a specific {path} in the tree under files. |
| FilesApi | get_file | GET /files/{path} | Get a specific File with {path} |
| FilesApi | head_file | HEAD /files/{path} | See if a file exists and return a checksum in the header |
| FilesApi | head_iso | HEAD /isos/{path} | See if a iso exists and return a checksum in the header |
| FilesApi | list_files | GET /files | Lists files in files directory or subdirectory per query parameter |
| FilesApi | upload_file | POST /files/{path} | Upload a file to a specific {path} in the tree under files. |
| FiltersApi | create_filter | POST /filters | Create a Filter |
| FiltersApi | delete_filter | DELETE /filters/{id} | Delete a Filter |
| FiltersApi | get_filter | GET /filters/{id} | Get a Filter |
| FiltersApi | get_filter_action | GET /filters/{id}/actions/{cmd} | List specific action for a task Filter |
| FiltersApi | get_filter_actions | GET /filters/{id}/actions | List task actions Filter |
| FiltersApi | head_filter | HEAD /filters/{id} | See if a Filter exists |
| FiltersApi | list_filters | GET /filters | Lists Filters filtered by some parameters. |
| FiltersApi | list_stats_filters | HEAD /filters | Stats of the List Filters filtered by some parameters. |
| FiltersApi | patch_filter | PATCH /filters/{id} | Patch a Filter |
| FiltersApi | post_filter_action | POST /filters/{id}/actions/{cmd} | Call an action on the node. |
| FiltersApi | put_filter | PUT /filters/{id} | Put a Filter |
| IdentityProvidersApi | create_identity_provider | POST /identity_providers | Create a IdentityProvider |
| IdentityProvidersApi | delete_identity_provider | DELETE /identity_providers/{name} | Delete a IdentityProvider |
| IdentityProvidersApi | get_identity_provider | GET /identity_providers/{name} | Get a IdentityProvider |
| IdentityProvidersApi | get_identity_provider_action | GET /identity_providers/{name}/actions/{cmd} | List specific action for a identity_provider IdentityProvider |
| IdentityProvidersApi | get_identity_provider_actions | GET /identity_providers/{name}/actions | List identity_provider actions IdentityProvider |
| IdentityProvidersApi | head_identity_provider | HEAD /identity_providers/{name} | See if a IdentityProvider exists |
| IdentityProvidersApi | list_identity_providers | GET /identity_providers | Lists IdentityProviders filtered by some parameters. |
| IdentityProvidersApi | list_stats_identity_providers | HEAD /identity_providers | Stats of the List IdentityProviders filtered by some parameters. |
| IdentityProvidersApi | patch_identity_provider | PATCH /identity_providers/{name} | Patch a IdentityProvider |
| IdentityProvidersApi | post_identity_provider_action | POST /identity_providers/{name}/actions/{cmd} | Call an action on the node. |
| IdentityProvidersApi | put_identity_provider | PUT /identity_providers/{name} | Put a IdentityProvider |
| IndexesApi | get_index | GET /indexes/{prefix} | |
| IndexesApi | get_single_index | GET /indexes/{prefix}/{param} | Get information on a specific index for a specific object type. |
| IndexesApi | list_indexes | GET /indexes | |
| InfoApi | get_info | GET /info | Return current system info. |
| InterfacesApi | get_interface | GET /interfaces/{name} | Get a specific interface with {name} |
| InterfacesApi | list_interfaces | GET /interfaces | |
| IsosApi | delete_iso | DELETE /isos/{path} | Delete an iso to a specific {path} in the tree under isos. |
| IsosApi | get_iso | GET /isos/{path} | Get a specific Iso with {path} |
| IsosApi | list_isos | GET /isos | Lists isos in isos directory |
| IsosApi | upload_iso | POST /isos/{path} | Upload an iso to a specific {path} in the tree under isos. |
| JobsApi | create_job | POST /jobs | Create a Job |
| JobsApi | delete_job | DELETE /jobs/{uuid} | Delete a Job |
| JobsApi | get_job | GET /jobs/{uuid} | Get a Job |
| JobsApi | get_job_action | GET /jobs/{uuid}/plugin_actions/{cmd} | List specific action for a job Job |
| JobsApi | get_job_actions | GET /jobs/{uuid}/actions | Get actions for this job |
| JobsApi | get_job_log | GET /jobs/{uuid}/log | Get the log for this job |
| JobsApi | get_job_log_archive | GET /jobs/{uuid}/archive | Get the log archive entry for this job |
| JobsApi | get_job_plugin_actions | GET /jobs/{uuid}/plugin_actions | List job plugin_actions Job |
| JobsApi | head_job | HEAD /jobs/{uuid} | See if a Job exists |
| JobsApi | head_job_log | HEAD /jobs/{uuid}/log | Get the log for this job |
| JobsApi | list_jobs | GET /jobs | Lists Jobs filtered by some parameters. |
| JobsApi | list_stats_jobs | HEAD /jobs | Stats of the List Jobs filtered by some parameters. |
| JobsApi | patch_job | PATCH /jobs/{uuid} | Patch a Job |
| JobsApi | post_job_action | POST /jobs/{uuid}/plugin_actions/{cmd} | Call an action on the node. |
| JobsApi | put_job | PUT /jobs/{uuid} | Put a Job |
| JobsApi | put_job_log | PUT /jobs/{uuid}/log | Append the string to the end of the job's log. |
| LeasesApi | delete_lease | DELETE /leases/{address} | Delete a Lease |
| LeasesApi | get_lease | GET /leases/{address} | Get a Lease |
| LeasesApi | get_lease_action | GET /leases/{address}/actions/{cmd} | List specific action for a lease Lease |
| LeasesApi | get_lease_actions | GET /leases/{address}/actions | List lease actions Lease |
| LeasesApi | head_lease | HEAD /leases/{address} | See if a Lease exists |
| LeasesApi | list_leases | GET /leases | Lists Leases filtered by some parameters. |
| LeasesApi | list_stats_leases | HEAD /leases | Stats of the List Leases filtered by some parameters. |
| LeasesApi | post_lease_action | POST /leases/{address}/actions/{cmd} | Call an action on the node. |
| LogsApi | get_logs | GET /logs | |
| MachinesApi | cleanup_machine | DELETE /machines/{uuid}/cleanup | Cleanup a Machine |
| MachinesApi | create_machine | POST /machines | Create a Machine |
| MachinesApi | delete_machine | DELETE /machines/{uuid} | Delete a Machine |
| MachinesApi | delete_machine_param | DELETE /machines/{uuid}/params/{key} | Delete a single machine parameter |
| MachinesApi | get_machine | GET /machines/{uuid} | Get a Machine |
| MachinesApi | get_machine_action | GET /machines/{uuid}/actions/{cmd} | List specific action for a machine Machine |
| MachinesApi | get_machine_actions | GET /machines/{uuid}/actions | List machine actions Machine |
| MachinesApi | get_machine_param | GET /machines/{uuid}/params/{key} | Get a single machine parameter |
| MachinesApi | get_machine_params | GET /machines/{uuid}/params | List machine params Machine |
| MachinesApi | get_machine_pub_key | GET /machines/{uuid}/pubkey | Get the public key for secure params on a machine |
| MachinesApi | get_machine_token | GET /machines/{uuid}/token | Get a Machine Token |
| MachinesApi | head_machine | HEAD /machines/{uuid} | See if a Machine exists |
| MachinesApi | list_machines | GET /machines | Lists Machines filtered by some parameters. |
| MachinesApi | list_stats_machines | HEAD /machines | Stats of the List Machines filtered by some parameters. |
| MachinesApi | patch_machine | PATCH /machines/{uuid} | Patch a Machine |
| MachinesApi | patch_machine_params | PATCH /machines/{uuid}/params | |
| MachinesApi | 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 | POST /machines/{uuid}/actions/{cmd} | Call an action on the node. |
| MachinesApi | post_machine_param | POST /machines/{uuid}/params/{key} | |
| MachinesApi | post_machine_params | POST /machines/{uuid}/params | |
| MachinesApi | put_machine | PUT /machines/{uuid} | Put a Machine |
| MachinesApi | start_machine | PATCH /machines/{uuid}/start | Start a Machine |
| MetaApi | get_meta | GET /meta/{type}/{id} | Get Metadata for an Object of {type} idendified by {id} |
| MetaApi | patch_meta | PATCH /meta/{type}/{id} | Patch metadata on an Object of {type} with an ID of {id} |
| ObjectsApi | list_objects | GET /objects | |
| ParamsApi | create_param | POST /params | Create a Param |
| ParamsApi | delete_param | DELETE /params/{name} | Delete a Param |
| ParamsApi | get_param | GET /params/{name} | Get a Param |
| ParamsApi | head_param | HEAD /params/{name} | See if a Param exists |
| ParamsApi | list_params | GET /params | Lists Params filtered by some parameters. |
| ParamsApi | list_stats_params | HEAD /params | Stats of the List Params filtered by some parameters. |
| ParamsApi | patch_param | PATCH /params/{name} | Patch a Param |
| ParamsApi | put_param | PUT /params/{name} | Put a Param |
| PluginProvidersApi | delete_plugin_provider | DELETE /plugin_providers/{name} | Delete a plugin provider |
| PluginProvidersApi | get_plugin_provider | GET /plugin_providers/{name} | Get a specific plugin with {name} |
| PluginProvidersApi | head_plugin_provider | HEAD /plugin_providers/{name} | See if a Plugin Provider exists |
| PluginProvidersApi | head_plugin_providers | HEAD /plugin_providers | |
| PluginProvidersApi | iso_response | GET /plugin_providers/{name}/binary | Get the binary for a specific plugin provider by {name} |
| PluginProvidersApi | list_plugin_providers | GET /plugin_providers | |
| PluginProvidersApi | upload_plugin_provider | POST /plugin_providers/{name} | Upload a plugin provider to a specific {name}. |
| PluginsApi | create_plugin | POST /plugins | Create a Plugin |
| PluginsApi | delete_plugin | DELETE /plugins/{name} | Delete a Plugin |
| PluginsApi | delete_plugin_param | DELETE /plugins/{uuid}/params/{key} | Delete a single plugin parameter |
| PluginsApi | get_plugin | GET /plugins/{name} | Get a Plugin |
| PluginsApi | get_plugin_action | GET /plugins/{name}/actions/{cmd} | List specific action for a plugin Plugin |
| PluginsApi | get_plugin_actions | GET /plugins/{name}/actions | List plugin actions Plugin |
| PluginsApi | get_plugin_param | GET /plugins/{name}/params/{key} | Get a single plugin parameter |
| PluginsApi | get_plugin_params | GET /plugins/{name}/params | List plugin params Plugin |
| PluginsApi | get_plugin_pub_key | GET /plugins/{name}/pubkey | Get the public key for secure params on a plugin |
| PluginsApi | head_plugin | HEAD /plugins/{name} | See if a Plugin exists |
| PluginsApi | list_plugins | GET /plugins | Lists Plugins filtered by some parameters. |
| PluginsApi | list_stats_plugins | HEAD /plugins | Stats of the List Plugins filtered by some parameters. |
| PluginsApi | patch_plugin | PATCH /plugins/{name} | Patch a Plugin |
| PluginsApi | patch_plugin_params | PATCH /plugins/{name}/params | |
| PluginsApi | post_plugin_action | POST /plugins/{name}/actions/{cmd} | Call an action on the node. |
| PluginsApi | post_plugin_param | POST /plugins/{name}/params/{key} | |
| PluginsApi | post_plugin_params | POST /plugins/{name}/params | |
| PluginsApi | put_plugin | PUT /plugins/{name} | Put a Plugin |
| PoolsApi | create_pool | POST /pools | Create a Pool |
| PoolsApi | delete_pool | DELETE /pools/{id} | Delete a Pool |
| PoolsApi | get_pool | GET /pools/{id} | Get a Pool |
| PoolsApi | get_pool_action | GET /pools/{id}/actions/{cmd} | List specific action for a task Pool |
| PoolsApi | get_pool_actions | GET /pools/{id}/actions | List task actions Pool |
| PoolsApi | get_pool_status | GET /pools/{id}/status | |
| PoolsApi | head_pool | HEAD /pools/{id} | See if a Pool exists |
| PoolsApi | list_active_pools | GET /pools-active | Lists active Pools |
| PoolsApi | list_pools | GET /pools | Lists Pools filtered by some parameters. |
| PoolsApi | list_stats_pools | HEAD /pools | Stats of the List Pools filtered by some parameters. |
| PoolsApi | patch_pool | PATCH /pools/{id} | Patch a Pool |
| PoolsApi | post_pool_action | POST /pools/{id}/actions/{cmd} | Call an action on the node. |
| PoolsApi | post_pool_add_machines | POST /pools/{id}/addMachines | Add machines to this pool from default. |
| PoolsApi | post_pool_allocate_machines | POST /pools/{id}/allocateMachines | Allocate machines in this pool. |
| PoolsApi | post_pool_release_machines | POST /pools/{id}/releaseMachines | Release machines in this pool. |
| PoolsApi | post_pool_remove_machines | POST /pools/{id}/removeMachines | Remove machines from this pool to default. |
| PoolsApi | put_pool | PUT /pools/{id} | Put a Pool |
| PrefsApi | list_prefs | GET /prefs | Lists Prefs |
| PrefsApi | set_prefs | POST /prefs | Create a Pref |
| ProfilesApi | create_profile | POST /profiles | Create a Profile |
| ProfilesApi | delete_profile | DELETE /profiles/{name} | Delete a Profile |
| ProfilesApi | delete_profile_param | DELETE /profiles/{uuid}/params/{key} | Delete a single profile parameter |
| ProfilesApi | get_profile | GET /profiles/{name} | Get a Profile |
| ProfilesApi | get_profile_action | GET /profiles/{name}/actions/{cmd} | List specific action for a profile Profile |
| ProfilesApi | get_profile_actions | GET /profiles/{name}/actions | List profile actions Profile |
| ProfilesApi | get_profile_param | GET /profiles/{name}/params/{key} | Get a single profile parameter |
| ProfilesApi | get_profile_params | GET /profiles/{name}/params | List profile params Profile |
| ProfilesApi | get_profile_pub_key | GET /profiles/{name}/pubkey | Get the public key for secure params on a profile |
| ProfilesApi | head_profile | HEAD /profiles/{name} | See if a Profile exists |
| ProfilesApi | list_profiles | GET /profiles | Lists Profiles filtered by some parameters. |
| ProfilesApi | list_stats_profiles | HEAD /profiles | Stats of the List Profiles filtered by some parameters. |
| ProfilesApi | patch_profile | PATCH /profiles/{name} | Patch a Profile |
| ProfilesApi | patch_profile_params | PATCH /profiles/{name}/params | |
| ProfilesApi | post_profile_action | POST /profiles/{name}/actions/{cmd} | Call an action on the node. |
| ProfilesApi | post_profile_param | POST /profiles/{name}/params/{key} | |
| ProfilesApi | post_profile_params | POST /profiles/{name}/params | |
| ProfilesApi | put_profile | PUT /profiles/{name} | Put a Profile |
| ReservationsApi | create_reservation | POST /reservations | Create a Reservation |
| ReservationsApi | delete_reservation | DELETE /reservations/{address} | Delete a Reservation |
| ReservationsApi | get_reservation | GET /reservations/{address} | Get a Reservation |
| ReservationsApi | get_reservation_action | GET /reservations/{address}/actions/{cmd} | List specific action for a reservation Reservation |
| ReservationsApi | get_reservation_actions | GET /reservations/{address}/actions | List reservation actions Reservation |
| ReservationsApi | head_reservation | HEAD /reservations/{address} | See if a Reservation exists |
| ReservationsApi | list_reservations | GET /reservations | Lists Reservations filtered by some parameters. |
| ReservationsApi | list_stats_reservations | HEAD /reservations | Stats of the List Reservations filtered by some parameters. |
| ReservationsApi | patch_reservation | PATCH /reservations/{address} | Patch a Reservation |
| ReservationsApi | post_reservation_action | POST /reservations/{address}/actions/{cmd} | Call an action on the node. |
| ReservationsApi | put_reservation | PUT /reservations/{address} | Put a Reservation |
| ResourceBrokersApi | cleanup_resource_broker | DELETE /resource_brokers/{uuid}/cleanup | Cleanup a ResourceBroker |
| ResourceBrokersApi | create_resource_broker | POST /resource_brokers | Create a ResourceBroker |
| ResourceBrokersApi | delete_resource_broker | DELETE /resource_brokers/{uuid} | Delete a ResourceBroker |
| ResourceBrokersApi | delete_resource_broker_group_param | DELETE /resource_brokers/{uuid}/group/params/{key} | Delete a single resource_broker group profile parameter |
| ResourceBrokersApi | delete_resource_broker_param | DELETE /resource_brokers/{uuid}/params/{key} | Delete a single resource_broker parameter |
| ResourceBrokersApi | get_resource_broker | GET /resource_brokers/{uuid} | Get a ResourceBroker |
| ResourceBrokersApi | get_resource_broker_action | GET /resource_brokers/{uuid}/actions/{cmd} | List specific action for a resource_broker ResourceBroker |
| ResourceBrokersApi | get_resource_broker_actions | GET /resource_brokers/{uuid}/actions | List resource_broker actions ResourceBroker |
| ResourceBrokersApi | get_resource_broker_group_param | GET /resource_brokers/{uuid}/group/params/{key} | Get a single resource_broker group profile parameter |
| ResourceBrokersApi | get_resource_broker_group_params | GET /resource_brokers/{uuid}/group/params | List resource_broker group profile params ResourceBroker |
| ResourceBrokersApi | get_resource_broker_group_pub_key | GET /resource_brokers/{uuid}/group/pubkey | Get the public key for secure params on a resource_broker group profile |
| ResourceBrokersApi | get_resource_broker_param | GET /resource_brokers/{uuid}/params/{key} | Get a single resource_broker parameter |
| ResourceBrokersApi | get_resource_broker_params | GET /resource_brokers/{uuid}/params | List resource_broker params ResourceBroker |
| ResourceBrokersApi | get_resource_broker_pub_key | GET /resource_brokers/{uuid}/pubkey | Get the public key for secure params on a resource_broker |
| ResourceBrokersApi | get_resource_broker_token | GET /resource_brokers/{uuid}/token | Get a ResourceBroker Token |
| ResourceBrokersApi | head_resource_broker | HEAD /resource_brokers/{uuid} | See if a ResourceBroker exists |
| ResourceBrokersApi | list_resource_brokers | GET /resource_brokers | Lists ResourceBrokers filtered by some parameters. |
| ResourceBrokersApi | list_stats_resource_brokers | HEAD /resource_brokers | Stats of the List ResourceBrokers filtered by some parameters. |
| ResourceBrokersApi | patch_resource_broker | PATCH /resource_brokers/{uuid} | Patch a ResourceBroker |
| ResourceBrokersApi | patch_resource_broker_group_params | PATCH /resource_brokers/{uuid}/group/params | |
| ResourceBrokersApi | patch_resource_broker_params | PATCH /resource_brokers/{uuid}/params | |
| ResourceBrokersApi | post_release_to_pool | POST /clusters/{uuid}/releaseToPool | Releases a resource_broker in this pool. |
| ResourceBrokersApi | post_release_to_pool_0 | POST /machines/{id}/releaseToPool | Releases a resource_broker in this pool. |
| ResourceBrokersApi | post_release_to_pool_1 | POST /resource_brokers/{id}/releaseToPool | Releases a resource_broker in this pool. |
| ResourceBrokersApi | post_resource_broker_action | POST /resource_brokers/{uuid}/actions/{cmd} | Call an action on the node. |
| ResourceBrokersApi | post_resource_broker_group_param | POST /resource_brokers/{uuid}/group/params/{key} | |
| ResourceBrokersApi | post_resource_broker_group_params | POST /resource_brokers/{uuid}/group/params | |
| ResourceBrokersApi | post_resource_broker_param | POST /resource_brokers/{uuid}/params/{key} | |
| ResourceBrokersApi | post_resource_broker_params | POST /resource_brokers/{uuid}/params | |
| ResourceBrokersApi | put_resource_broker | PUT /resource_brokers/{uuid} | Put a ResourceBroker |
| ResourceBrokersApi | start_resource_broker | PATCH /resource_brokers/{uuid}/start | Start a ResourceBroker |
| RolesApi | create_role | POST /roles | Create a Role |
| RolesApi | delete_role | DELETE /roles/{name} | Delete a Role |
| RolesApi | get_role | GET /roles/{name} | Get a Role |
| RolesApi | get_role_action | GET /roles/{name}/actions/{cmd} | List specific action for a role Role |
| RolesApi | get_role_actions | GET /roles/{name}/actions | List role actions Role |
| RolesApi | head_role | HEAD /roles/{name} | See if a Role exists |
| RolesApi | list_roles | GET /roles | Lists Roles filtered by some parameters. |
| RolesApi | list_stats_roles | HEAD /roles | Stats of the List Roles filtered by some parameters. |
| RolesApi | patch_role | PATCH /roles/{name} | Patch a Role |
| RolesApi | post_role_action | POST /roles/{name}/actions/{cmd} | Call an action on the node. |
| RolesApi | put_role | PUT /roles/{name} | Put a Role |
| StagesApi | create_stage | POST /stages | Create a Stage |
| StagesApi | delete_stage | DELETE /stages/{name} | Delete a Stage |
| StagesApi | delete_stage_param | DELETE /stages/{name}/params/{key} | Delete a single stage parameter |
| StagesApi | get_stage | GET /stages/{name} | Get a Stage |
| StagesApi | get_stage_action | GET /stages/{name}/actions/{cmd} | List specific action for a stage Stage |
| StagesApi | get_stage_actions | GET /stages/{name}/actions | List stage actions Stage |
| StagesApi | get_stage_param | GET /stages/{name}/params/{key} | Get a single stage parameter |
| StagesApi | get_stage_params | GET /stages/{name}/params | List stage params Stage |
| StagesApi | get_stage_pub_key | GET /stages/{name}/pubkey | Get the public key for secure params on a stage |
| StagesApi | head_stage | HEAD /stages/{name} | See if a Stage exists |
| StagesApi | list_stages | GET /stages | Lists Stages filtered by some parameters. |
| StagesApi | list_stats_stages | HEAD /stages | Stats of the List Stages filtered by some parameters. |
| StagesApi | patch_stage | PATCH /stages/{name} | Patch a Stage |
| StagesApi | patch_stage_params | PATCH /stages/{name}/params | |
| StagesApi | post_stage_action | POST /stages/{name}/actions/{cmd} | Call an action on the node. |
| StagesApi | post_stage_param | POST /stages/{name}/params/{key} | |
| StagesApi | post_stage_params | POST /stages/{name}/params | |
| StagesApi | put_stage | PUT /stages/{name} | Put a Stage |
| SubnetsApi | create_subnet | POST /subnets | Create a Subnet |
| SubnetsApi | delete_subnet | DELETE /subnets/{name} | Delete a Subnet |
| SubnetsApi | get_subnet | GET /subnets/{name} | Get a Subnet |
| SubnetsApi | get_subnet_action | GET /subnets/{name}/actions/{cmd} | List specific action for a subnet Subnet |
| SubnetsApi | get_subnet_actions | GET /subnets/{name}/actions | List subnet actions Subnet |
| SubnetsApi | head_subnet | HEAD /subnets/{name} | See if a Subnet exists |
| SubnetsApi | list_stats_subnets | HEAD /subnets | Stats of the List Subnets filtered by some parameters. |
| SubnetsApi | list_subnets | GET /subnets | Lists Subnets filtered by some parameters. |
| SubnetsApi | patch_subnet | PATCH /subnets/{name} | Patch a Subnet |
| SubnetsApi | post_subnet_action | POST /subnets/{name}/actions/{cmd} | Call an action on the node. |
| SubnetsApi | put_subnet | PUT /subnets/{name} | Put a Subnet |
| SystemApi | get_system_action | GET /system/actions/{cmd} | List specific action for System |
| SystemApi | get_system_actions | GET /system/actions | List system actions System |
| SystemApi | post_system_action | POST /system/actions/{cmd} | Call an action on the system. |
| SystemApi | system_update | POST /system/upgrade | Upload a file to upgrade the DRP system |
| SystemApi | system_update_exec | POST /system/upgrade/exec | Execute a previously staged upgrade |
| SystemApi | system_update_run | POST /system/upgrade/run | Perform a rolling upgrade of a dr-provision cluster. |
| SystemApi | system_update_stage | POST /system/upgrade/stage | Upload a file to perform a staged upgrade of a dr-provision cluster |
| SystemApi | system_update_unstage | DELETE /system/upgrade/stage | Unstage a pending staged update. This will fail if an update us running. |
| TasksApi | create_task | POST /tasks | Create a Task |
| TasksApi | delete_task | DELETE /tasks/{name} | Delete a Task |
| TasksApi | get_task | GET /tasks/{name} | Get a Task |
| TasksApi | get_task_action | GET /tasks/{name}/actions/{cmd} | List specific action for a task Task |
| TasksApi | get_task_actions | GET /tasks/{name}/actions | List task actions Task |
| TasksApi | head_task | HEAD /tasks/{name} | See if a Task exists |
| TasksApi | list_stats_tasks | HEAD /tasks | Stats of the List Tasks filtered by some parameters. |
| TasksApi | list_tasks | GET /tasks | Lists Tasks filtered by some parameters. |
| TasksApi | patch_task | PATCH /tasks/{name} | Patch a Task |
| TasksApi | post_task_action | POST /tasks/{name}/actions/{cmd} | Call an action on the node. |
| TasksApi | put_task | PUT /tasks/{name} | Put a Task |
| TemplatesApi | create_template | POST /templates | Create a Template |
| TemplatesApi | delete_template | DELETE /templates/{id} | Delete a Template |
| TemplatesApi | get_template | GET /templates/{id} | Get a Template |
| TemplatesApi | get_template_action | GET /templates/{id}/actions/{cmd} | List specific action for a template Template |
| TemplatesApi | get_template_actions | GET /templates/{id}/actions | List template actions Template |
| TemplatesApi | head_template | HEAD /templates/{id} | See if a Template exists |
| TemplatesApi | list_stats_templates | HEAD /templates | Stats of the List Templates filtered by some parameters. |
| TemplatesApi | list_templates | GET /templates | Lists Templates filtered by some parameters. |
| TemplatesApi | patch_template | PATCH /templates/{id} | Patch a Template |
| TemplatesApi | post_template_action | POST /templates/{id}/actions/{cmd} | Call an action on the node. |
| TemplatesApi | put_template | PUT /templates/{id} | Put a Template |
| TenantsApi | create_tenant | POST /tenants | Create a Tenant |
| TenantsApi | delete_tenant | DELETE /tenants/{name} | Delete a Tenant |
| TenantsApi | get_tenant | GET /tenants/{name} | Get a Tenant |
| TenantsApi | get_tenant_action | GET /tenants/{name}/actions/{cmd} | List specific action for a tenant Tenant |
| TenantsApi | get_tenant_actions | GET /tenants/{name}/actions | List tenant actions Tenant |
| TenantsApi | head_tenant | HEAD /tenants/{name} | See if a Tenant exists |
| TenantsApi | list_stats_tenants | HEAD /tenants | Stats of the List Tenants filtered by some parameters. |
| TenantsApi | list_tenants | GET /tenants | Lists Tenants filtered by some parameters. |
| TenantsApi | patch_tenant | PATCH /tenants/{name} | Patch a Tenant |
| TenantsApi | post_tenant_action | POST /tenants/{name}/actions/{cmd} | Call an action on the node. |
| TenantsApi | put_tenant | PUT /tenants/{name} | Put a Tenant |
| TriggerProvidersApi | create_trigger_provider | POST /trigger_providers | Create a TriggerProvider |
| TriggerProvidersApi | delete_trigger_provider | DELETE /trigger_providers/{name} | Delete a TriggerProvider |
| TriggerProvidersApi | delete_trigger_provider_param | DELETE /trigger_providers/{name}/params/{key} | Delete a single trigger_provider parameter |
| TriggerProvidersApi | get_trigger_provider | GET /trigger_providers/{name} | Get a TriggerProvider |
| TriggerProvidersApi | get_trigger_provider_action | GET /trigger_providers/{name}/actions/{cmd} | List specific action for a trigger_provider TriggerProvider |
| TriggerProvidersApi | get_trigger_provider_actions | GET /trigger_providers/{name}/actions | List trigger_provider actions TriggerProvider |
| TriggerProvidersApi | get_trigger_provider_param | GET /trigger_providers/{name}/params/{key} | Get a single trigger_provider parameter |
| TriggerProvidersApi | get_trigger_provider_params | GET /trigger_providers/{name}/params | List trigger_provider params TriggerProvider |
| TriggerProvidersApi | get_trigger_provider_pub_key | GET /trigger_providers/{name}/pubkey | Get the public key for secure params on a trigger_provider |
| TriggerProvidersApi | head_trigger_provider | HEAD /trigger_providers/{name} | See if a TriggerProvider exists |
| TriggerProvidersApi | list_stats_trigger_providers | HEAD /trigger_providers | Stats of the List TriggerProviders filtered by some parameters. |
| TriggerProvidersApi | list_trigger_providers | GET /trigger_providers | Lists TriggerProviders filtered by some parameters. |
| TriggerProvidersApi | patch_trigger_provider | PATCH /trigger_providers/{name} | Patch a TriggerProvider |
| TriggerProvidersApi | patch_trigger_provider_params | PATCH /trigger_providers/{name}/params | |
| TriggerProvidersApi | post_trigger_provider_action | POST /trigger_providers/{name}/actions/{cmd} | Call an action on the node. |
| TriggerProvidersApi | post_trigger_provider_param | POST /trigger_providers/{name}/params/{key} | |
| TriggerProvidersApi | post_trigger_provider_params | POST /trigger_providers/{name}/params | |
| TriggerProvidersApi | put_trigger_provider | PUT /trigger_providers/{name} | Put a TriggerProvider |
| TriggersApi | create_trigger | POST /triggers | Create a Trigger |
| TriggersApi | delete_trigger | DELETE /triggers/{name} | Delete a Trigger |
| TriggersApi | delete_trigger_param | DELETE /triggers/{name}/params/{key} | Delete a single trigger parameter |
| TriggersApi | get_trigger | GET /triggers/{name} | Get a Trigger |
| TriggersApi | get_trigger_action | GET /triggers/{name}/actions/{cmd} | List specific action for a trigger Trigger |
| TriggersApi | get_trigger_actions | GET /triggers/{name}/actions | List trigger actions Trigger |
| TriggersApi | get_trigger_param | GET /triggers/{name}/params/{key} | Get a single trigger parameter |
| TriggersApi | get_trigger_params | GET /triggers/{name}/params | List trigger params Trigger |
| TriggersApi | get_trigger_pub_key | GET /triggers/{name}/pubkey | Get the public key for secure params on a trigger |
| TriggersApi | head_trigger | HEAD /triggers/{name} | See if a Trigger exists |
| TriggersApi | list_stats_triggers | HEAD /triggers | Stats of the List Triggers filtered by some parameters. |
| TriggersApi | list_triggers | GET /triggers | Lists Triggers filtered by some parameters. |
| TriggersApi | patch_trigger | PATCH /triggers/{name} | Patch a Trigger |
| TriggersApi | patch_trigger_params | PATCH /triggers/{name}/params | |
| TriggersApi | post_trigger_action | POST /triggers/{name}/actions/{cmd} | Call an action on the node. |
| TriggersApi | post_trigger_param | POST /triggers/{name}/params/{key} | |
| TriggersApi | post_trigger_params | POST /triggers/{name}/params | |
| TriggersApi | put_trigger | PUT /triggers/{name} | Put a Trigger |
| UsersApi | create_user | POST /users | Create a User |
| UsersApi | delete_user | DELETE /users/{name} | Delete a User |
| UsersApi | get_user | GET /users/{name} | Get a User |
| UsersApi | get_user_action | GET /users/{name}/actions/{cmd} | List specific action for a user User |
| UsersApi | get_user_actions | GET /users/{name}/actions | List user actions User |
| UsersApi | get_user_token | GET /users/{name}/token | Get a User Token |
| UsersApi | head_user | HEAD /users/{name} | See if a User exists |
| UsersApi | list_stats_users | HEAD /users | Stats of the List Users filtered by some parameters. |
| UsersApi | list_users | GET /users | Lists Users filtered by some parameters. |
| UsersApi | patch_user | PATCH /users/{name} | Patch a User |
| UsersApi | post_user_action | POST /users/{name}/actions/{cmd} | Call an action on the node. |
| UsersApi | put_user | PUT /users/{name} | Put a User |
| UsersApi | put_user_password | PUT /users/{name}/password | Set the password for a user. |
| UxOptionsApi | create_ux_option | POST /ux_options | Create a UxOption |
| UxOptionsApi | delete_ux_option | DELETE /ux_options/{id} | Delete a UxOption |
| UxOptionsApi | get_ux_option | GET /ux_options/{id} | Get a UxOption |
| UxOptionsApi | get_ux_option_action | GET /ux_options/{id}/actions/{cmd} | List specific action for a task UxOption |
| UxOptionsApi | get_ux_option_actions | GET /ux_options/{id}/actions | List task actions UxOption |
| UxOptionsApi | head_ux_option | HEAD /ux_options/{id} | See if a UxOption exists |
| UxOptionsApi | list_stats_ux_options | HEAD /ux_options | Stats of the List UxOptions filtered by some parameters. |
| UxOptionsApi | list_ux_options | GET /ux_options | Lists UxOptions filtered by some parameters. |
| UxOptionsApi | patch_ux_option | PATCH /ux_options/{id} | Patch a UxOption |
| UxOptionsApi | post_ux_option_action | POST /ux_options/{id}/actions/{cmd} | Call an action on the node. |
| UxOptionsApi | put_ux_option | PUT /ux_options/{id} | Put a UxOption |
| UxSettingsApi | create_ux_setting | POST /ux_settings | Create a UxSetting |
| UxSettingsApi | delete_ux_setting | DELETE /ux_settings/{id} | Delete a UxSetting |
| UxSettingsApi | get_ux_setting | GET /ux_settings/{id} | Get a UxSetting |
| UxSettingsApi | get_ux_setting_action | GET /ux_settings/{id}/actions/{cmd} | List specific action for a task UxSetting |
| UxSettingsApi | get_ux_setting_actions | GET /ux_settings/{id}/actions | List task actions UxSetting |
| UxSettingsApi | head_ux_setting | HEAD /ux_settings/{id} | See if a UxSetting exists |
| UxSettingsApi | list_stats_ux_settings | HEAD /ux_settings | Stats of the List UxSettings filtered by some parameters. |
| UxSettingsApi | list_ux_settings | GET /ux_settings | Lists UxSettings filtered by some parameters. |
| UxSettingsApi | patch_ux_setting | PATCH /ux_settings/{id} | Patch a UxSetting |
| UxSettingsApi | post_ux_setting_action | POST /ux_settings/{id}/actions/{cmd} | Call an action on the node. |
| UxSettingsApi | put_ux_setting | PUT /ux_settings/{id} | Put a UxSetting |
| UxViewsApi | create_ux_view | POST /ux_views | Create a UxView |
| UxViewsApi | delete_ux_view | DELETE /ux_views/{id} | Delete a UxView |
| UxViewsApi | get_ux_view | GET /ux_views/{id} | Get a UxView |
| UxViewsApi | get_ux_view_action | GET /ux_views/{id}/actions/{cmd} | List specific action for a task UxView |
| UxViewsApi | get_ux_view_actions | GET /ux_views/{id}/actions | List task actions UxView |
| UxViewsApi | head_ux_view | HEAD /ux_views/{id} | See if a UxView exists |
| UxViewsApi | list_stats_ux_views | HEAD /ux_views | Stats of the List UxViews filtered by some parameters. |
| UxViewsApi | list_ux_views | GET /ux_views | Lists UxViews filtered by some parameters. |
| UxViewsApi | patch_ux_view | PATCH /ux_views/{id} | Patch a UxView |
| UxViewsApi | post_ux_view_action | POST /ux_views/{id}/actions/{cmd} | Call an action on the node. |
| UxViewsApi | put_ux_view | PUT /ux_views/{id} | Put a UxView |
| VersionSetsApi | create_version_set | POST /version_sets | Create a VersionSet |
| VersionSetsApi | delete_version_set | DELETE /version_sets/{id} | Delete a VersionSet |
| VersionSetsApi | get_version_set | GET /version_sets/{id} | Get a VersionSet |
| VersionSetsApi | get_version_set_action | GET /version_sets/{id}/actions/{cmd} | List specific action for a task VersionSet |
| VersionSetsApi | get_version_set_actions | GET /version_sets/{id}/actions | List task actions VersionSet |
| VersionSetsApi | head_version_set | HEAD /version_sets/{id} | See if a VersionSet exists |
| VersionSetsApi | list_stats_version_sets | HEAD /version_sets | Stats of the List VersionSets filtered by some parameters. |
| VersionSetsApi | list_version_sets | GET /version_sets | Lists VersionSets filtered by some parameters. |
| VersionSetsApi | patch_version_set | PATCH /version_sets/{id} | Patch a VersionSet |
| VersionSetsApi | post_version_set_action | POST /version_sets/{id}/actions/{cmd} | Call an action on the node. |
| VersionSetsApi | put_version_set | PUT /version_sets/{id} | Put a VersionSet |
| WhoamiApi | fill_whoami | POST /whoami | Fills a Whoami with the closest matching Machine |
| WorkOrdersApi | create_work_order | POST /work_orders | Create a WorkOrder |
| WorkOrdersApi | delete_work_order | DELETE /work_orders/{uuid} | Delete a WorkOrder |
| WorkOrdersApi | delete_work_order_param | DELETE /work_orders/{uuid}/params/{key} | Delete a single machine parameter |
| WorkOrdersApi | delete_work_orders | DELETE /work_orders | Delete WorkOrders that reference removed machines. |
| WorkOrdersApi | get_work_order | GET /work_orders/{uuid} | Get a WorkOrder |
| WorkOrdersApi | get_work_order_action | GET /work_orders/{uuid}/plugin_actions/{cmd} | List specific action for a work_order WorkOrder |
| WorkOrdersApi | get_work_order_actions | GET /work_orders/{uuid}/plugin_actions | List work_order plugin_actions WorkOrder |
| WorkOrdersApi | get_work_order_param | GET /work_orders/{uuid}/params/{key} | Get a single machine parameter |
| WorkOrdersApi | get_work_order_pub_key | GET /work_orders/{uuid}/pubkey | Get the public key for secure params on a machine |
| WorkOrdersApi | get_work_orders_params | GET /work_orders/{uuid}/params | List work_order params WorkOrders |
| WorkOrdersApi | head_work_order | HEAD /work_orders/{uuid} | See if a WorkOrder exists |
| WorkOrdersApi | list_stats_work_orders | HEAD /work_orders | Stats of the List WorkOrders filtered by some parameters. |
| WorkOrdersApi | list_work_orders | GET /work_orders | Lists WorkOrders filtered by some parameters. |
| WorkOrdersApi | patch_work_order | PATCH /work_orders/{uuid} | Patch a WorkOrder |
| WorkOrdersApi | patch_work_order_params | PATCH /work_orders/{uuid}/params | |
| WorkOrdersApi | post_work_order_action | POST /work_orders/{uuid}/plugin_actions/{cmd} | Call an action on the node. |
| WorkOrdersApi | post_work_order_param | POST /work_orders/{uuid}/params/{key} | |
| WorkOrdersApi | post_work_order_params | POST /work_orders/{uuid}/params | |
| WorkOrdersApi | put_work_order | PUT /work_orders/{uuid} | Put a WorkOrder |
| WorkflowsApi | create_workflow | POST /workflows | Create a Workflow |
| WorkflowsApi | delete_workflow | DELETE /workflows/{name} | Delete a Workflow |
| WorkflowsApi | get_workflow | GET /workflows/{name} | Get a Workflow |
| WorkflowsApi | get_workflow_action | GET /workflows/{name}/actions/{cmd} | List specific action for a workflow Workflow |
| WorkflowsApi | get_workflow_actions | GET /workflows/{name}/actions | List workflow actions Workflow |
| WorkflowsApi | head_workflow | HEAD /workflows/{name} | See if a Workflow exists |
| WorkflowsApi | list_stats_workflows | HEAD /workflows | Stats of the List Workflows filtered by some parameters. |
| WorkflowsApi | list_workflows | GET /workflows | Lists Workflows filtered by some parameters. |
| WorkflowsApi | patch_workflow | PATCH /workflows/{name} | Patch a Workflow |
| WorkflowsApi | post_workflow_action | POST /workflows/{name}/actions/{cmd} | Call an action on the node. |
| WorkflowsApi | put_workflow | PUT /workflows/{name} | Put a Workflow |
| AApi | by | GET /connections/{remoteaddr} | Get a Connection |
| AboutApi | by | GET /connections/{remoteaddr} | Get a Connection |
| ConnectionApi | by | GET /connections/{remoteaddr} | Get a Connection |
| InfoApi | by | GET /connections/{remoteaddr} | Get a Connection |
Documentation For Models
- Action
- Activity
- Alert
- ArchInfo
- AvailableAction
- Batch
- BlobInfo
- Blueprint
- BootEnv
- CatalogItem
- Cert
- Claim
- Classifier
- ClusterState
- Connection
- Content
- ContentMetaData
- ContentSummary
- Context
- DhcpOption
- Element
- ElementAction
- Endpoint
- Error
- Event
- FileData
- FilePaths
- Filter
- HaPassiveState
- IdentityProvider
- Index
- Info
- Interface
- IsoPaths
- Job
- JobAction
- JobActions
- Lease
- Level
- License
- LicenseBundle
- Line
- Machine
- MachineFingerprint
- MenuGroup
- MenuItem
- Meta
- NodeInfo
- ObjectPrefixes
- Operation
- OsInfo
- Param
- Patch
- Plugin
- PluginProvider
- PluginProviderUploadInfo
- Pool
- PoolAutoFill
- PoolResult
- PoolStatus
- PoolTransitionActions
- PrivateKey
- Profile
- Query
- Reservation
- Role
- Section
- Sections
- Stage
- Stat
- Subnet
- Task
- TaskStack
- Template
- TemplateInfo
- Tenant
- Trigger
- TriggerProvider
- User
- UserPassword
- UserToken
- UxOption
- UxSetting
- UxView
- VersionSet
- Whoami
- WhoamiResult
- WorkOrder
- Workflow
Documentation For Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
basicAuth
- Type: HTTP basic authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file drppy_client-0.0.18.tar.gz.
File metadata
- Download URL: drppy_client-0.0.18.tar.gz
- Upload date:
- Size: 587.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f98e33a80c4d578ef1e0760adfb56733e71cd132733ac9260784b5baba555056
|
|
| MD5 |
8aef3fcc2698803fed58717dfb66de7d
|
|
| BLAKE2b-256 |
da82d1a695ff21b3cce24cb3e21b720bb0ad1eb36f27682ed993e5bbf82d0ee5
|
File details
Details for the file drppy_client-0.0.18-py3-none-any.whl.
File metadata
- Download URL: drppy_client-0.0.18-py3-none-any.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cdeb4bcdca92370b63e36cc6a19263cfa3ab63c0b94e8d455080a96e37ffe3f9
|
|
| MD5 |
8c742251ca2c685ede0c3d1e1262044c
|
|
| BLAKE2b-256 |
5061bc68afaf1f36caf714de568d37fc7462889c255b90ea75c9e5816fb2fb65
|