eliona.api_client.NodesApi

All URIs are relative to https://name.eliona.io/v2

Method	HTTP request	Description
get_node_by_ident	GET /nodes/{node-ident}	Information about a node
get_nodes	GET /nodes	Information about nodes
post_node	POST /nodes	Create a node
put_node	PUT /nodes	Create or update a node
put_node_by_ident	PUT /nodes/{node-ident}	Update a node

get_node_by_ident

Node get_node_by_ident(node_ident)

Information about a node

Gets information about a node.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import nodes_api
from eliona.api_client.model.node import Node
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nodes_api.NodesApi(api_client)
    node_ident = "4711" # str | The UUID identifier of the node

    # example passing only required values which don't have defaults set
    try:
        # Information about a node
        api_response = api_instance.get_node_by_ident(node_ident)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling NodesApi->get_node_by_ident: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_ident	str	The UUID identifier of the node

Return type

Node

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a node	-
404	Node ident not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_nodes

[Node] get_nodes()

Information about nodes

Gets information about nodes.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import nodes_api
from eliona.api_client.model.node import Node
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nodes_api.NodesApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Information about nodes
        api_response = api_instance.get_nodes()
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling NodesApi->get_nodes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[Node]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a list of nodes	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_node

Node post_node(node)

Create a node

Create a new node.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import nodes_api
from eliona.api_client.model.node import Node
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nodes_api.NodesApi(api_client)
    node = Node(
        password="password_example",
        asset_id=4711,
        vendor="vendor_example",
        model="model_example",
        description="Node east plant",
        enable=False,
    ) # Node | 

    # example passing only required values which don't have defaults set
    try:
        # Create a node
        api_response = api_instance.post_node(node)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling NodesApi->post_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
node	Node

Return type

Node

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successfully created a new node	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_node

Node put_node(node)

Create or update a node

Deprecated - Use POST /nodes to create PUT /nodes/{node-ident} to update.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import nodes_api
from eliona.api_client.model.node import Node
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nodes_api.NodesApi(api_client)
    node = Node(
        password="password_example",
        asset_id=4711,
        vendor="vendor_example",
        model="model_example",
        description="Node east plant",
        enable=False,
    ) # Node | 

    # example passing only required values which don't have defaults set
    try:
        # Create or update a node
        api_response = api_instance.put_node(node)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling NodesApi->put_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
node	Node

Return type

Node

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully created a new or updated an existing node	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_node_by_ident

Node put_node_by_ident(node_ident, node)

Update a node

Update a node.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import nodes_api
from eliona.api_client.model.node import Node
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nodes_api.NodesApi(api_client)
    node_ident = "4711" # str | The UUID identifier of the node
    node = Node(
        password="password_example",
        asset_id=4711,
        vendor="vendor_example",
        model="model_example",
        description="Node east plant",
        enable=False,
    ) # Node | 

    # example passing only required values which don't have defaults set
    try:
        # Update a node
        api_response = api_instance.put_node_by_ident(node_ident, node)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling NodesApi->put_node_by_ident: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_ident	str	The UUID identifier of the node
node	Node

Return type

Node

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully updated an existing node	-
404	Node ident not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

NodesApi.md

Latest commit

History

NodesApi.md

File metadata and controls

eliona.api_client.NodesApi

get_node_by_ident

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_nodes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_node

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_node

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_node_by_ident

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details