Authentication
When security is off (Pseudo/Simple), the authenticated user is the username specified in the user.name query parameter. If the user.name parameter is not set, the server may either set the authenticated user to a default web user, if there is any, or return an error response.
When security is on (kerberos), authentication is performed by Kerberos SPNEGO.
Below are examples using the curl command tool.
Authentication when security is off (Pseudo/Simple):
curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..."
Authentication using Kerberos SPNEGO when security is on:
curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..."
See also: Security in Falcon
The current version of the rest api's documentation is also hosted on the Falcon server and Prism Server (in distributed mode) at the url http://<HOST>:<PORT>/docs
REST Call on Admin Resource
| Call Type | Resource | Description |
|---|---|---|
| GET | api/admin/stack | Get stack of the server |
| GET | api/admin/version | Get version of the server |
| GET | api/admin/config/:config-type | Get configuration information of the server |
| GET | api/admin/setSafeMode/:mode | Set safemode to true/false in falcon server |
REST Call on Entity Resource
REST Call on Feed and Process Instances
REST Call on Metadata Lineage Resource
| Call Type | Resource | Description |
|---|---|---|
| GET | api/metadata/lineage/serialize | dump the graph |
| GET | api/metadata/lineage/vertices/all | get all vertices |
| GET | api/metadata/lineage/vertices?key=:key&value=:value | get all vertices for a key index |
| GET | api/metadata/lineage/vertices/:id | get the vertex with the specified id |
| GET | api/metadata/lineage/vertices/properties/:id?relationships=:true | get the properties of the vertex with the specified id |
| GET | api/metadata/lineage/vertices/:id/:direction | get the adjacent vertices or edges of the vertex with the specified direction |
| GET | api/metadata/lineage/edges/all | get all edges |
| GET | api/metadata/lineage/edges/:id | get the edge with the specified id |
| GET | api/metadata/lineage/entities?pipeline=:name | Get lineage graph for processes and feeds in the specified pipeline |
REST Call on Metadata Discovery Resource
| Call Type | Resource | Description |
|---|---|---|
| GET | api/metadata/discovery/:dimension-type/list | list of dimensions |
| GET | api/metadata/discovery/:dimension-type/:dimension-name/relations | Return all relations of a dimension |
REST Call on Extension Artifact
| Call Type | Resource | Description |
|---|---|---|
| GET | api/extension/enumerate | List all the extensions supported |
| GET | api/extension/describe/:extensionÂname | Return the README of the specified extension |
| GET | api/extension/definition/:extensionÂname | Return a JSON document describing the extension invocation parameters |
REST Call on Extension Job Management
| Call Type | Resource | Description |
|---|---|---|
| GET | api/extension/list/:extensionÂname | List jobs generated from an extension |
| GET | api/extension/instances/:job-name | List instances of an extension job |
| POST | api/extension/validate/:extensionÂname | Validate an extension job |
| POST | api/extension/submit/:extensionÂname | Submit an extension job |
| POST | api/extension/update/:extensionÂname | Update an extension job |
| POST | api/extension/submitAndSchedule/:extensionÂname | Submit and schedule an extension job |
| POST | api/extension/schedule/:job-name | Schedule an extension job |
| POST | api/extension/suspend/:job-name | Suspend an extension job |
| POST | api/extension/resume/:job-name | Resume an extension job |
| POST | api/extension/delete/:job-name | Delete an extension job |