Apache Ranger Public REST APIs
Also available as:
PDF

Search Service Definitions

Reference information for the Ranger REST API service/public/v2/api/servicedef.

API Name Search Service Definitions
Request Type GET
Request URL service/public/v2/api/servicedef
Request Params

Query Params

pageSize int The page size required

startIndex int The start record index

serviceType string The service definition names("hdfs","hive","hbase","knox","storm", "solr", "kafka","yarn" )

isEnabled boolean The enabled status : true if enabled; false otherwise

Example :

pageSize=25&startIndex=0

Response
[
    {
        "accessTypes": [
            {
                "impliedGrants": [],
                "itemId": 1,
                "label": "Read",
                "name": "read"
            },
            {
                "impliedGrants": [],
                "itemId": 2,
                "label": "Write",
                "name": "write"
            },
            {
                "impliedGrants": [],
                "itemId": 3,
                "label": "Execute",
                "name": "execute"
            }
        ],
        "configs": [
            {
                "itemId": 1,
                "label": "Username",
                "mandatory": true,
                "name": "username",
                "subType": "",
                "type": "string",
                "uiHint": "",
                "validationMessage": "",
                "validationRegEx": ""
            },
  ...
                "description": "Sub Resource for Test Component",
                "excludesSupported": true,
                "itemId": 2,
                "label": "Test sub resource",
                "level": 20,
                "lookupSupported": true,
                "mandatory": true,
                "matcher": "org.apache.ranger.plugin.resourcematcher.RangerDefaultResourceMatcher",
                "matcherOptions": {
                    "ignoreCase": "true",
                    "wildCard": "true"
                },
                "name": "sub",
                "parent": "root",
                "recursiveSupported": false,
                "type": "string",
                "uiHint": "",
                "validationMessage": "",
                "validationRegEx": ""
            }
        ],
        "updateTime": 1451351474000,
        "updatedBy": "Admin",
        "version": 2
    }
]