GET /api/kps

Description

Returns the currently defined Types, Stores and Aliases for the API Gateway Group.

---

Resource URL

https://localhost:8090/api/router/service/api-server-instance-id/api/kps

---

Parameters

NONE

---

Responses

Response Code	Description
200	Success. The response body contains the defined schema.
404	Fail. KPS has not been configured on this node.

---

Example Request and Response

GET https://localhost:8090/api/router/service/instance-1/api/kps

Via CURL: curl -k -v --user admin:changeme https://localhost:8090/api/router/service/instance-1/api/kps

HTTP 1.1 200 OK

{
    "aliases": [
        {
            "alias": "PortalApiQuotaStore", 
            "identity": "API Portal_PortalApiQuotaStore"
        }, 
        {
            "alias": "PortalApplicationStore", 
            "identity": "API Server_PortalApplicationStore"
        }, 
        {
            "alias": "employees", 
            "identity": "Employee_employee store"
        }, 
    ], 
    "description": "", 
    "stores": [
        {
            "config": {
                "indexes": [
                    "type", 
                    "quotaID", 
                    "apiID", 
                    "methodID"
                ], 
                "internal": true, 
                "key": "ID", 
                "package": "API Portal", 
                "processor0": {
                    "className": "com.vordel.kps.processorImpl.UUIDGenerator", 
                    "keyField": "ID"
                }, 
                "readConsistencyLevel": "ONE", 
                "readKey": [
                    "type", 
                    "quotaID", 
                    "apiID", 
                    "methodID"
                ], 
                "writeConsistencyLevel": "ANY"
            }, 
            "description": "API Quota Store", 
            "identity": "API Portal_PortalApiQuotaStore", 
            "implId": "com.vordel.kps.storeImpl.cassandra.CassandraStore", 
            "typeId": "API Portal_PortalApiQuota"
        }, 
        {
            "config": {
                "indexes": [
                    "organizationId", 
                    "createdBy"
                ], 
                "internal": true, 
                "key": "id", 
                "package": "API Server", 
                "processor0": {
                    "className": "com.vordel.kps.processorImpl.UUIDGenerator", 
                    "keyField": "id"
                }, 
                "readConsistencyLevel": "ONE", 
                "readKey": [
                    "id"
                ], 
                "writeConsistencyLevel": "ANY"
            }, 
            "description": "Applications registered for organizations", 
            "identity": "API Server_PortalApplicationStore", 
            "implId": "com.vordel.kps.storeImpl.cassandra.CassandraStore", 
            "typeId": "API Server_PortalApplications"
        },
        {
            "config": {
                "indexes": [
                    "email"
                ], 
                "internal": false, 
                "key": "id", 
                "package": "Employee", 
                "path": "/apigateway/groups/group-2/instance-1/conf/kps/file/Employee_employee_store.json", 
                "pathIsFile": false, 
                "processor0": {
                    "className": "com.vordel.kps.processorImpl.UUIDGenerator", 
                    "keyField": "id"
                }, 
                "readKey": [
                    "email"
                ]
            }, 
            "description": "", 
            "identity": "Employee_employee store", 
            "implId": "com.vordel.kps.storeImpl.StoreImpl", 
            "typeId": "Employee_employee store"
        }
   ], 
    "types": [
        {
            "description": "A group of constraints to apply on matching method calls", 
            "identity": "API Portal_PortalApiQuota", 
            "properties": {
                "ID": "java.lang.String", 
                "apiID": "java.lang.String", 
                "constraintIDs": "java.util.List<java.lang.String>", 
                "httpMethod": "java.lang.String", 
                "methodID": "java.lang.String", 
                "quotaID": "java.lang.String", 
                "timestamp": "java.lang.Long", 
                "type": "java.lang.String"
            }
        }, 
        {
            "description": "Portal applications", 
            "identity": "API Server_PortalApplications", 
            "properties": {
                "createdBy": "java.lang.String", 
                "createdOn": "java.lang.Long", 
                "description": "java.lang.String", 
                "email": "java.lang.String", 
                "enabled": "java.lang.Boolean", 
                "id": "java.lang.String", 
                "image": "java.lang.String", 
                "name": "java.lang.String", 
                "organizationId": "java.lang.String", 
                "phone": "java.lang.String", 
                "quotaId": "java.lang.String", 
                "tags": "java.util.Map<java.lang.String,java.lang.String>"
            }
        },
        {
            "description": null, 
            "identity": "Employee_employee store", 
            "properties": {
                "age": "java.lang.Integer", 
                "email": "java.lang.String", 
                "id": "java.lang.String", 
                "name": "java.lang.String"
            }
        }
    ], 
    "version": "1.0.0"
}