Ranger REST API: PublicAPIs

GET /public/api/policy

Response Body
media type	data type	description
application/json	VXPolicyList (JSON)

Example

Request

GET /public/api/policy
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vXPolicies" : [ {
    "policyName" : "...",
    "resourceName" : "...",
    "description" : "...",
    "repositoryName" : "...",
    "repositoryType" : "...",
    "permMapList" : [ {
      "userList" : [ "...", "..." ],
      "groupList" : [ "...", "..." ],
      "permList" : [ "...", "..." ],
      "ipAddress" : "..."
    }, {
      "userList" : [ "...", "..." ],
      "groupList" : [ "...", "..." ],
      "permList" : [ "...", "..." ],
      "ipAddress" : "..."
    } ],
    "tables" : "...",
    "columnFamilies" : "...",
    "columns" : "...",
    "databases" : "...",
    "udfs" : "...",
    "tableType" : "...",
    "columnType" : "...",
    "topologies" : "...",
    "services" : "...",
    "hiveServices" : "...",
    "isEnabled" : true,
    "isRecursive" : true,
    "isAuditEnabled" : true,
    "version" : "...",
    "grantor" : "...",
    "replacePerm" : true,
    "policyLabel" : "...",
    "myClassType" : 12345,
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "..."
  }, {
    "policyName" : "...",
    "resourceName" : "...",
    "description" : "...",
    "repositoryName" : "...",
    "repositoryType" : "...",
    "permMapList" : [ {
      "userList" : [ "...", "..." ],
      "groupList" : [ "...", "..." ],
      "permList" : [ "...", "..." ],
      "ipAddress" : "..."
    }, {
      "userList" : [ "...", "..." ],
      "groupList" : [ "...", "..." ],
      "permList" : [ "...", "..." ],
      "ipAddress" : "..."
    } ],
    "tables" : "...",
    "columnFamilies" : "...",
    "columns" : "...",
    "databases" : "...",
    "udfs" : "...",
    "tableType" : "...",
    "columnType" : "...",
    "topologies" : "...",
    "services" : "...",
    "hiveServices" : "...",
    "isEnabled" : true,
    "isRecursive" : true,
    "isAuditEnabled" : true,
    "version" : "...",
    "grantor" : "...",
    "replacePerm" : true,
    "policyLabel" : "...",
    "myClassType" : 12345,
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "..."
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

POST /public/api/policy

Request Body
media type	data type
application/json	VXPolicy (JSON)

Response Body
media type	data type	description
application/json	VXPolicy (JSON)

Example

Request

POST /public/api/policy
Content-Type: application/json
Accept: application/json

                
{
  "policyName" : "...",
  "resourceName" : "...",
  "description" : "...",
  "repositoryName" : "...",
  "repositoryType" : "...",
  "permMapList" : [ {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  }, {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  } ],
  "tables" : "...",
  "columnFamilies" : "...",
  "columns" : "...",
  "databases" : "...",
  "udfs" : "...",
  "tableType" : "...",
  "columnType" : "...",
  "topologies" : "...",
  "services" : "...",
  "hiveServices" : "...",
  "isEnabled" : true,
  "isRecursive" : true,
  "isAuditEnabled" : true,
  "version" : "...",
  "grantor" : "...",
  "replacePerm" : true,
  "policyLabel" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "policyName" : "...",
  "resourceName" : "...",
  "description" : "...",
  "repositoryName" : "...",
  "repositoryType" : "...",
  "permMapList" : [ {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  }, {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  } ],
  "tables" : "...",
  "columnFamilies" : "...",
  "columns" : "...",
  "databases" : "...",
  "udfs" : "...",
  "tableType" : "...",
  "columnType" : "...",
  "topologies" : "...",
  "services" : "...",
  "hiveServices" : "...",
  "isEnabled" : true,
  "isRecursive" : true,
  "isAuditEnabled" : true,
  "version" : "...",
  "grantor" : "...",
  "replacePerm" : true,
  "policyLabel" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /public/api/repository

Response Body
media type	data type	description
application/json	VXRepositoryList (JSON)

Example

Request

GET /public/api/repository
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vXRepositories" : [ {
    "name" : "...",
    "description" : "...",
    "repositoryType" : "...",
    "config" : "...",
    "isActive" : true,
    "version" : "...",
    "myClassType" : 12345,
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "..."
  }, {
    "name" : "...",
    "description" : "...",
    "repositoryType" : "...",
    "config" : "...",
    "isActive" : true,
    "version" : "...",
    "myClassType" : 12345,
    "id" : 12345,
    "createDate" : 12345,
    "updateDate" : 12345,
    "owner" : "...",
    "updatedBy" : "..."
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

POST /public/api/repository

Request Body
media type	data type
application/json	VXRepository (JSON)

Response Body
media type	data type	description
application/json	VXRepository (JSON)

Example

Request

POST /public/api/repository
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "...",
  "repositoryType" : "...",
  "config" : "...",
  "isActive" : true,
  "version" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "repositoryType" : "...",
  "config" : "...",
  "isActive" : true,
  "version" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /public/api/policy/count

Response Body
media type	data type	description
application/json	VXLong (JSON)

Example

Request

GET /public/api/policy/count
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /public/api/policy/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /public/api/policy/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/api/policy/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	VXPolicy (JSON)

Example

Request

GET /public/api/policy/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "policyName" : "...",
  "resourceName" : "...",
  "description" : "...",
  "repositoryName" : "...",
  "repositoryType" : "...",
  "permMapList" : [ {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  }, {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  } ],
  "tables" : "...",
  "columnFamilies" : "...",
  "columns" : "...",
  "databases" : "...",
  "udfs" : "...",
  "tableType" : "...",
  "columnType" : "...",
  "topologies" : "...",
  "services" : "...",
  "hiveServices" : "...",
  "isEnabled" : true,
  "isRecursive" : true,
  "isAuditEnabled" : true,
  "version" : "...",
  "grantor" : "...",
  "replacePerm" : true,
  "policyLabel" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /public/api/policy/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	VXPolicy (JSON)

Response Body
media type	data type	description
application/json	VXPolicy (JSON)

Example

Request

PUT /public/api/policy/{id}
Content-Type: application/json
Accept: application/json

                
{
  "policyName" : "...",
  "resourceName" : "...",
  "description" : "...",
  "repositoryName" : "...",
  "repositoryType" : "...",
  "permMapList" : [ {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  }, {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  } ],
  "tables" : "...",
  "columnFamilies" : "...",
  "columns" : "...",
  "databases" : "...",
  "udfs" : "...",
  "tableType" : "...",
  "columnType" : "...",
  "topologies" : "...",
  "services" : "...",
  "hiveServices" : "...",
  "isEnabled" : true,
  "isRecursive" : true,
  "isAuditEnabled" : true,
  "version" : "...",
  "grantor" : "...",
  "replacePerm" : true,
  "policyLabel" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "policyName" : "...",
  "resourceName" : "...",
  "description" : "...",
  "repositoryName" : "...",
  "repositoryType" : "...",
  "permMapList" : [ {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  }, {
    "userList" : [ "...", "..." ],
    "groupList" : [ "...", "..." ],
    "permList" : [ "...", "..." ],
    "ipAddress" : "..."
  } ],
  "tables" : "...",
  "columnFamilies" : "...",
  "columns" : "...",
  "databases" : "...",
  "udfs" : "...",
  "tableType" : "...",
  "columnType" : "...",
  "topologies" : "...",
  "services" : "...",
  "hiveServices" : "...",
  "isEnabled" : true,
  "isRecursive" : true,
  "isAuditEnabled" : true,
  "version" : "...",
  "grantor" : "...",
  "replacePerm" : true,
  "policyLabel" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

GET /public/api/repository/count

Response Body
media type	data type	description
application/json	VXLong (JSON)

Example

Request

GET /public/api/repository/count
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "value" : 12345,
  "myClassType" : 12345
}

DELETE /public/api/repository/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /public/api/repository/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/api/repository/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	VXRepository (JSON)

Example

Request

GET /public/api/repository/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "repositoryType" : "...",
  "config" : "...",
  "isActive" : true,
  "version" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PUT /public/api/repository/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	VXRepository (JSON)

Response Body
media type	data type	description
application/json	VXRepository (JSON)

Example

Request

PUT /public/api/repository/{id}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "description" : "...",
  "repositoryType" : "...",
  "config" : "...",
  "isActive" : true,
  "version" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "description" : "...",
  "repositoryType" : "...",
  "config" : "...",
  "isActive" : true,
  "version" : "...",
  "myClassType" : 12345,
  "id" : 12345,
  "createDate" : 12345,
  "updateDate" : 12345,
  "owner" : "...",
  "updatedBy" : "..."
}

PublicAPIs Resource

GET /public/api/policy

Example

Request

Response

POST /public/api/policy

Example

Request

Response

GET /public/api/repository

Example

Request

Response

POST /public/api/repository

Example

Request

Response

GET /public/api/policy/count

Example

Request

Response

DELETE /public/api/policy/{id}

Example

Request

Response

GET /public/api/policy/{id}

Example

Request

Response

PUT /public/api/policy/{id}

Example

Request

Response

GET /public/api/repository/count

Example

Request

Response

DELETE /public/api/repository/{id}

Example

Request

Response

GET /public/api/repository/{id}

Example

Request

Response

PUT /public/api/repository/{id}

Example

Request

Response