swagger_client.InputportsApi

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

Method	HTTP request	Description
get_input_port	GET /input-ports/{id}	Gets an input port
remove_input_port	DELETE /input-ports/{id}	Deletes an input port
update_input_port	PUT /input-ports/{id}	Updates an input port

get_input_port

PortEntity get_input_port(id)

Gets an input port

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.InputportsApi()
id = 'id_example' # str | The input port id.

try: 
    # Gets an input port
    api_response = api_instance.get_input_port(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InputportsApi->get_input_port: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The input port id.

Return type

PortEntity

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]

remove_input_port

PortEntity remove_input_port(id, version=version, client_id=client_id)

Deletes an input port

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.InputportsApi()
id = 'id_example' # str | The input port 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 an input port
    api_response = api_instance.remove_input_port(id, version=version, client_id=client_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InputportsApi->remove_input_port: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The input port 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

PortEntity

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_input_port

PortEntity update_input_port(id, body)

Updates an input port

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.InputportsApi()
id = 'id_example' # str | The input port id.
body = swagger_client.PortEntity() # PortEntity | The input port configuration details.

try: 
    # Updates an input port
    api_response = api_instance.update_input_port(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InputportsApi->update_input_port: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The input port id.
body	PortEntity	The input port configuration details.

Return type

PortEntity

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]