# Admin API

Admin API uses certificate-based authentication. The node admin's certificate needs to be attached to the http client in order to access the admin level operations.

These APIs are only available at the port mentioned in adminWebApiConfig.webApiEndPoint parameter of Node Config.

One way to pass the certificate is by using the curl command, as mentioned below.


$ curl --insecure -s --cert-type P12 --cert admin.p12 https://localhost:8000/nodeconfig

$ curl [options...] url
options:
 -ins| --insecure               Allow insecure server connections when using SSL
 -s| --silent                   Silent mode
 --cert-type                    Certificate type 
 --cert                         Client certificate (format: pkcs12_file:password)

Note: Another way to use miyabi-cli Admin command is by attaching the client certificate using the -cc option or directly passing the certificate path in client side configuration file.

# Get Node Config

Returns the current node configuration of the node.

# Request

  • Method: GET
  • URL: /nodeconfig
  • Query parameters in URL: None

# Response

  • Success

    • Code: 200

    • Return value:

      • {
  "value": {
    "Node Config": "Current configuration values used by the node"
  },
  "atHeight": "Current height at the time of response"
}

← Blockchain Config →