swagger_client.ControllerApi

All URIs are relative to http://localhost/nifi-api

Method	HTTP request	Description
create_bulletin	POST /controller/bulletin	Creates a new bulletin
create_controller_service	POST /controller/controller-services	Creates a new controller service
create_registry_client	POST /controller/registry-clients	Creates a new registry client
create_reporting_task	POST /controller/reporting-tasks	Creates a new reporting task
delete_history	DELETE /controller/history	Purges history
delete_node	DELETE /controller/cluster/nodes/{id}	Removes a node from the cluster
delete_registry_client	DELETE /controller/registry-clients/{id}	Deletes a registry client
get_cluster	GET /controller/cluster	Gets the contents of the cluster
get_controller_config	GET /controller/config	Retrieves the configuration for this NiFi Controller
get_node	GET /controller/cluster/nodes/{id}	Gets a node in the cluster
get_registry_client	GET /controller/registry-clients/{id}	Gets a registry client
get_registry_clients	GET /controller/registry-clients	Gets the listing of available registry clients
update_controller_config	PUT /controller/config	Retrieves the configuration for this NiFi
update_node	PUT /controller/cluster/nodes/{id}	Updates a node in the cluster
update_registry_client	PUT /controller/registry-clients/{id}	Updates a registry client

create_bulletin

BulletinEntity create_bulletin(body)

Creates a new bulletin

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
body = swagger_client.BulletinEntity() # BulletinEntity | The reporting task configuration details.

try: 
    # Creates a new bulletin
    api_response = api_instance.create_bulletin(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->create_bulletin: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	BulletinEntity	The reporting task configuration details.

Return type

BulletinEntity

Authorization

No authorization required

HTTP request headers

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

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

create_controller_service

ControllerServiceEntity create_controller_service(body)

Creates a new controller service

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
body = swagger_client.ControllerServiceEntity() # ControllerServiceEntity | The controller service configuration details.

try: 
    # Creates a new controller service
    api_response = api_instance.create_controller_service(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->create_controller_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ControllerServiceEntity	The controller service configuration details.

Return type

ControllerServiceEntity

Authorization

No authorization required

HTTP request headers

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

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

create_registry_client

RegistryClientEntity create_registry_client(body)

Creates a new registry client

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
body = swagger_client.RegistryClientEntity() # RegistryClientEntity | The registry configuration details.

try: 
    # Creates a new registry client
    api_response = api_instance.create_registry_client(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->create_registry_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	RegistryClientEntity	The registry configuration details.

Return type

RegistryClientEntity

Authorization

No authorization required

HTTP request headers

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

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

create_reporting_task

ReportingTaskEntity create_reporting_task(body)

Creates a new reporting task

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
body = swagger_client.ReportingTaskEntity() # ReportingTaskEntity | The reporting task configuration details.

try: 
    # Creates a new reporting task
    api_response = api_instance.create_reporting_task(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->create_reporting_task: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ReportingTaskEntity	The reporting task configuration details.

Return type

ReportingTaskEntity

Authorization

No authorization required

HTTP request headers

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

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

delete_history

HistoryEntity delete_history(end_date)

Purges history

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
end_date = 'end_date_example' # str | Purge actions before this date/time.

try: 
    # Purges history
    api_response = api_instance.delete_history(end_date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->delete_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
end_date	str	Purge actions before this date/time.

Return type

HistoryEntity

Authorization

No authorization required

HTTP request headers

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

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

delete_node

NodeEntity delete_node(id)

Removes a node from the cluster

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
id = 'id_example' # str | The node id.

try: 
    # Removes a node from the cluster
    api_response = api_instance.delete_node(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->delete_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The node id.

Return type

NodeEntity

Authorization

No authorization required

HTTP request headers

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

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

delete_registry_client

RegistryClientEntity delete_registry_client(id, version=version, client_id=client_id)

Deletes a registry client

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
id = 'id_example' # str | The registry id.
version = 'version_example' # str | The revision is used to verify the client is working with the latest version of the flow. (optional)
client_id = 'client_id_example' # str | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. (optional)

try: 
    # Deletes a registry client
    api_response = api_instance.delete_registry_client(id, version=version, client_id=client_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->delete_registry_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The registry id.
version	str	The revision is used to verify the client is working with the latest version of the flow.	[optional]
client_id	str	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.	[optional]

Return type

RegistryClientEntity

Authorization

No authorization required

HTTP request headers

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

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

get_cluster

ClusterEntity get_cluster()

Gets the contents of the cluster

Returns the contents of the cluster including all nodes and their status.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()

try: 
    # Gets the contents of the cluster
    api_response = api_instance.get_cluster()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->get_cluster: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ClusterEntity

Authorization

No authorization required

HTTP request headers

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

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

get_controller_config

ControllerConfigurationEntity get_controller_config()

Retrieves the configuration for this NiFi Controller

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()

try: 
    # Retrieves the configuration for this NiFi Controller
    api_response = api_instance.get_controller_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->get_controller_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ControllerConfigurationEntity

Authorization

No authorization required

HTTP request headers

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

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

get_node

NodeEntity get_node(id)

Gets a node in the cluster

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
id = 'id_example' # str | The node id.

try: 
    # Gets a node in the cluster
    api_response = api_instance.get_node(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->get_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The node id.

Return type

NodeEntity

Authorization

No authorization required

HTTP request headers

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

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

get_registry_client

RegistryClientEntity get_registry_client(id)

Gets a registry client

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
id = 'id_example' # str | The registry id.

try: 
    # Gets a registry client
    api_response = api_instance.get_registry_client(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->get_registry_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The registry id.

Return type

RegistryClientEntity

Authorization

No authorization required

HTTP request headers

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

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

get_registry_clients

RegistryClientsEntity get_registry_clients()

Gets the listing of available registry clients

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()

try: 
    # Gets the listing of available registry clients
    api_response = api_instance.get_registry_clients()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->get_registry_clients: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RegistryClientsEntity

Authorization

No authorization required

HTTP request headers

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

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

update_controller_config

ControllerConfigurationEntity update_controller_config(body)

Retrieves the configuration for this NiFi

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
body = swagger_client.ControllerConfigurationEntity() # ControllerConfigurationEntity | The controller configuration.

try: 
    # Retrieves the configuration for this NiFi
    api_response = api_instance.update_controller_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->update_controller_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ControllerConfigurationEntity	The controller configuration.

Return type

ControllerConfigurationEntity

Authorization

No authorization required

HTTP request headers

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

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

update_node

NodeEntity update_node(id, body)

Updates a node in the cluster

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
id = 'id_example' # str | The node id.
body = swagger_client.NodeEntity() # NodeEntity | The node configuration. The only configuration that will be honored at this endpoint is the status.

try: 
    # Updates a node in the cluster
    api_response = api_instance.update_node(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->update_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The node id.
body	NodeEntity	The node configuration. The only configuration that will be honored at this endpoint is the status.

Return type

NodeEntity

Authorization

No authorization required

HTTP request headers

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

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

update_registry_client

RegistryClientEntity update_registry_client(id, body)

Updates a registry client

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ControllerApi()
id = 'id_example' # str | The registry id.
body = swagger_client.RegistryClientEntity() # RegistryClientEntity | The registry configuration details.

try: 
    # Updates a registry client
    api_response = api_instance.update_registry_client(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerApi->update_registry_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The registry id.
body	RegistryClientEntity	The registry configuration details.

Return type

RegistryClientEntity

Authorization

No authorization required

HTTP request headers

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

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