System API

System API Reference

System API Examples

Create the bearer_token and store in a file in a secure local directory with 0600 permissions.

Querying Blockchain Status

The archivistnode endpoint reports on the status of the blockchain.

Query the endpoint:

curl -v -X GET \
    -H "@$BEARER_TOKEN_FILE" \
    https://app.rkvst.io/archivist/v1/archivistnode

The response is:

{
    "identity": "quorum",
    "blockchain_nodes": [
        {
            "validator_pubkey": {
                "kty": "EC",
                "crv": "P-256K",
                "x": "VBKHictTWJC-3sqknXCb8MI4IxTc3c_My7lnem2C74E=",
                "y": "ItNeb5d-6vEHkvtUOcDYrEADxsZXeOCJm18pQWntenE=",
                "d": ""
            },
            "block_height": "38773",
            "connection_status": "REACHABLE"
            "genesis_hash":"0x1b526bd9c7f9bf7c43ba91ad07e5530eb7ceedf390396f9fbfeb68722e097e95",
            "state_root":"0x9606fc44a382938703678ac90581ab1260c9efd20ea8c7f90c87852bc982f3a7",
            "timestamp_committed": "2019-01-02T01:03:07Z",
            "timestamp_created": "2019-01-01T12:00:27Z",
            "syncing": null,
            "peers": [
                {
                    "validator_pubkey": {
                        "kty": "EC",
                        "crv": "P-256K",
                        "x": "o0uZ8ix5DE42srPCw1o22wYibkHGkvyCuLVqwcVAxb0=",
                        "y": "W43sUjWg-ociR2x3CcAlWeOqc6oDkYui1JLup1q-ojU=",
                        "d": ""
                    },
                    "connection_status": "REACHABLE"
                },
                {
                    "validator_pubkey": {
                        "kty": "EC",
                        "crv": "P-256K",
                        "x": "5HcU1PJgTe0LGyGxKFrIPFZWdTbxPySfi6bKxdQeO8A=",
                        "y": "dEpMURyTwEGzpgIgLdm4Csl1BgF6H39tb1Kf8wLLhVI=",
                        "d": ""
                    },
                    "connection_status": "REACHABLE"
                }
            ]
        }
    ]
}

System OpenAPI Docs

API to manage an archivist node

get  /archivist/v1/archivistnode

Get information about an archivist node

Description: Returns the identified archivist node

{
  "blockchain_nodes": [
    {
      "block_height": "38773",
      "connection_status": "REACHABLE",
      "genesis_hash": "0x1b526bd9c7f9bf7c43ba91ad07e5530eb7ceedf390396f9fbfeb68722e097e95",
      "peers": [
        {
          "connection_status": "REACHABLE",
          "validator_pubkey": {
            "crv": "P-256K",
            "d": "",
            "kty": "EC",
            "x": "o0uZ8ix5DE42srPCw1o22wYibkHGkvyCuLVqwcVAxb0=",
            "y": "W43sUjWg-ociR2x3CcAlWeOqc6oDkYui1JLup1q-ojU="
          }
        },
        {
          "connection_status": "REACHABLE",
          "validator_pubkey": {
            "crv": "P-256K",
            "d": "",
            "kty": "EC",
            "x": "5HcU1PJgTe0LGyGxKFrIPFZWdTbxPySfi6bKxdQeO8A=",
            "y": "dEpMURyTwEGzpgIgLdm4Csl1BgF6H39tb1Kf8wLLhVI="
          }
        }
      ],
      "state_root": "0x9606fc44a382938703678ac90581ab1260c9efd20ea8c7f90c87852bc982f3a7",
      "syncing": null,
      "timestamp_committed": "2019-01-01T12:00:27Z",
      "timestamp_created": "2019-01-01T12:00:27Z",
      "validator_pubkey": {
        "crv": "P-256K",
        "d": "",
        "kty": "EC",
        "x": "VBKHictTWJC-3sqknXCb8MI4IxTc3c_My7lnem2C74E=",
        "y": "ItNeb5d-6vEHkvtUOcDYrEADxsZXeOCJm18pQWntenE="
      }
    }
  ],
  "identity": "quorum-0"
}
Response ParameterTypeDescription
blockchain_nodesarray
identitystringThe identity of the archivistnode blockchain
ResponsesDescription
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to read the archivist node’s information
404Returned when the identified archivist node does not exist
429Returned when a user exceeds their subscription’s rate limit for requests.
defaultAn unexpected error response.

get  /archivist/v1/archivistnode:openapi

Get OpenAPI spec for Archivistnode

Description: Get OpenAPI v2.0 spec for Archivistnode

ResponsesDescription
200A successful response.
401Returned when the user is not authenticated to the system.
429Returned when a user exceeds their subscription’s rate limit for requests.
defaultAn unexpected error response.

get  /archivist/v1/archivistnode:openapi-ui

Get OpenAPI html for Archivistnode

Description: Get OpenAPI v2.0 html for Archivistnode

ResponsesDescription
200A successful response.
401Returned when the user is not authenticated to the system.
429Returned when a user exceeds their subscription’s rate limit for requests.
defaultAn unexpected error response.

Edit this page on GitHub