GET/api/clients

Get current cluster clients list

Query parameters:

Key	Type	Description	Required
pageNumber	integer	Paging: position	false
pageSize	integer	Paging: returned items count	false

Headers

Header	Value	Required
Accept	application/json	true
Authorization	Your authorization token	true
x-api-version	2.0	true

Request Example

curl -X GET "https://qrm1.kekker.com/api/clients"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 3,
  "data": [
    {
      "clusterId": "abb755c40618426ead3384f81807586d",
      "key": "QRM1",
      "publicCertificates": [],
      "info": "QRM1 public data"
    },
    {
      "clusterId": "abb755c40618426ead3384f81807586d",
      "key": "QRM2",
      "publicCertificates": [],
      "info": "QRM2 public data"
    },
    {
      "clusterId": "abb755c40618426ead3384f81807586d",
      "key": "QRM3",
      "publicCertificates": [],
      "info": "QRM3 public data"
    }
  ]
}

Returned if the authentication credentials are incorrect or missing.

Content Type	Value
any	Depends on authentication proxy

Returned in case of unpredictable error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
    "errorMessage": "Internal error"
}

GET/api/cluster

Get current cluster information

Query parameters:

none

Headers

Header	Value	Required
Accept	application/json	true
Authorization	Your authorization token	true
x-api-version	2.0	true

Request Example

curl -X GET "https://qrm1.kekker.com/api/cluster"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
  "clusterId": "QRM",
  "description": "Kekker Sandbox",
  "techInfo": "Quorum private cluster",
  "applications": [],
  "operatorInfo": "Kekker",
  "clientsNumber": 3
}

Returned in case of request validation error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
    "errorMessage": "Cluster not found"
}

Returned if the authentication credentials are incorrect or missing.

Content Type	Value
any	Depends on authentication proxy

Returned in case of unpredictable error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
    "errorMessage": "Internal error"
}

GET/api/clusters

Get clusters list

Query parameters:

Key	Type	Description	Required
pageNumber	integer	Paging: position	false
pageSize	integer	Paging: returned items count	false

Headers

Header	Value	Required
Accept	application/json	true
Authorization	Your authorization token	true
x-api-version	2.0	true

Request Example

curl -X GET "https://qrm1.kekker.com/api/clusters"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

[
  {
    "clusterId": "QRM",
    "versionInfo": "1.0",
    "clientsNumber": 3
  },
  {
    "clusterId": "HLF",
    "versionInfo": "1.0",
    "clientsNumber": 3
  },
  {
    "clusterId": "ETH",
    "versionInfo": "1.0",
    "clientsNumber": 2
  }
]

Returned if the authentication credentials are incorrect or missing.

Content Type	Value
any	Depends on authentication proxy

Returned in case of unpredictable error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
    "errorMessage": "Internal error"
}

GET/api/clusters/{clusterId}

Get cluster information

Query parameters:

Header	Type	Description	Type
clusterId	string	Unique identifier for the cluster	string

Headers

Header	Value	Required
Accept	application/json	true
Authorization	Your authorization token	true
x-api-version	2.0	true

Request Example

curl -X GET "https://qrm1.kekker.com/cluster/QRM"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "channel: {CHANNEL}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
  "clusterId": "QRM",
  "description": "Kekker Sandbox",
  "techInfo": "Quorum private cluster",
  "applications": [],
  "operatorInfo": "Kekker",
  "clientsNumber": 3
}

Returned in case of request validation error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
  "errorMessage": "Cluster not found"
}

Returned if the authentication credentials are incorrect or missing.

Content Type	Value
any	Depends on authentication proxy

Returned in case of unpredictable error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
    "errorMessage": "Internal error"
}

GET/api/clusters/{clusterId}/clients

Get cluster clients

Query parameters:

Header	Type	Description	Required
clusterId	string	Unique identifier for the cluster	true
pageNumber	integer	Paging: position	false
pageSize	integer	Paging: returned items count	false

Headers

Header	Value	Required
Accept	application/json	true
Authorization	Your authorization token	true
x-api-version	2.0	true

Request Example

curl -X GET "https://qrm1.kekker.com/cluster/QRM/clients"
-H "accept: application/json"
-H "Authorization: {AUTHORIZATION}"
-H "channel: {CHANNEL}"
-H "x-api-version: 2.0"

Response

Returned if the request is successful.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 3,
  "data": [
    {
      "clusterId": "abb755c40618426ead3384f81807586d",
      "key": "QRM1",
      "publicCertificates": [],
      "info": "QRM1 public data"
    },
    {
      "clusterId": "abb755c40618426ead3384f81807586d",
      "key": "QRM2",
      "publicCertificates": [],
      "info": "QRM2 public data"
    },
    {
      "clusterId": "abb755c40618426ead3384f81807586d",
      "key": "QRM3",
      "publicCertificates": [],
      "info": "QRM3 public data"
    }
  ]
}

Returned in case of request validation error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
  "errorMessage": "Cluster not found"
}

Returned if the authentication credentials are incorrect or missing.

Content Type	Value
any	Depends on authentication proxy

Returned in case of unpredictable error.

Headers	Value
content-type	application/json; charset=utf-8
api-supported-versions	Supported versions. Example: 1.0, 2.0

Content Type	Value
application/json

Example body:

{
    "errorMessage": "Internal error"
}

Get Started

Scenarios

API

About

Pricing

FAQ

GET/api/clients

Query parameters:

Headers

Request Example

Response

GET/api/cluster

Query parameters:

Headers

Request Example

Response

GET/api/clusters

Query parameters:

Headers

Request Example

Response

GET/api/clusters/{clusterId}

Query parameters:

Headers

Request Example

Response

GET/api/clusters/{clusterId}/clients

Query parameters:

Headers

Request Example

Response

Test the platform’s powerful features now

Get Started

Scenarios

API

About

Pricing

FAQ