Package org.apache.nifi.web.api

The NiFi REST API allows clients to obtain and update configuration and status information pertaining to an instance of NiFi.

See: Description

Class Summary

Class	Description
ApplicationResource	Base class for controllers.
BulletinBoardResource	RESTful endpoint for managing a Template.
ClusterResource	RESTful endpoint for managing a cluster.
ConnectionResource	RESTful endpoint for managing a Connection.
ControllerResource	RESTful endpoint for managing a Flow Controller.
FunnelResource	RESTful endpoint for managing a Funnel.
HistoryResource	RESTful endpoint for querying the history of this Controller.
InputPortResource	RESTful endpoint for managing an Input Port.
LabelResource	RESTful endpoint for managing a Label.
NodeResource	RESTful endpoint for managing a cluster connection.
OutputPortResource	RESTful endpoint for managing an Output Port.
ProcessGroupResource	RESTful endpoint for managing a Group.
ProcessorResource	RESTful endpoint for managing a Processor.
ProvenanceResource	RESTful endpoint for querying data provenance.
RemoteProcessGroupResource	RESTful endpoint for managing a Remote group.
SnippetResource	RESTful endpoint for managing a Snippet.
SystemDiagnosticsResource	RESTful endpoint for retrieving system diagnostics.
TemplateResource	RESTful endpoint for managing a Template.
UserGroupResource	RESTful endpoint for managing this Controller's user groups.
UserResource	RESTful endpoint for managing this Controller's users.

Package org.apache.nifi.web.api Description

The NiFi REST API allows clients to obtain and update configuration and status information pertaining to an instance of NiFi. The links below detail each resource. Follow the link to get more information about the resource including the supported HTTP methods and the expected parameters.

Additionally, the documentation for each resource will describe what type of data should be returned from a successful invocation. However, if the request is not successful one of the follow status codes should be returned:

• 400 (Bad Request) - A 400 status code will be returned when NiFi is unable to complete the request because it was invalid. The request should not be retried without modification.
• 401 (Unathorized) - A 401 status code indicates that the user is not known to this NiFi instance. The user may submit an account request.
• 403 (Forbidden) - A 403 status code indicates that the user is known to this NiFi instance and they do not have authority to perform the requested action.
• 404 (Not Found) - A 404 status code will be returned when the desired resource does not exist.
• 409 (Conflict) - NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. If the specified revision does not match the current base revision a 409 status code is returned. Additionally, a 409 is used when the state of the system does not allow for the request at that time. This same request may be successful later if the system is in a different state (e.g. cannot delete a processor because it is currently running).
• 500 (Internal Server Error) - A 500 status code indicates that an unexpected error has occurred.

Most unsuccessful requests will include a description of the problem in the entity body of the response.

The context path for the REST API is /nifi-api