Accessing the REST API

To access and invoke the REST API:

1. If the REST API has not been exposed externally to the cluster A complete set of worker processes. Clusters require a fully functioning virtual node infrastructure. via a load balancer, forward the port by running the following command in a terminal window, replacing <NAMESPACE> with the Kubernetes namespace that Corda is installed in:

   kubectl port-forward -n <NAMESPACE> deploy/corda-rest-worker 8888
   

   If you did not explicitly specify the username for the initial admin user at install time, the default is admin. If you did not explicitly specify the password for the initial admin user at install time, you can retrieve it using the following command:

   kubectl get secret -n <NAMESPACE> corda-rest-api-admin -o go-template="{{ .data.password | base64decode }}"
   

2. The REST API is at the path /api/v5_1. The following is an example invocation using curl when the API endpoint is exposed via port forwarding:

   REST_API_URL=https://localhost:8888/api/v5_1
   REST_API_USER=admin
   REST_API_PASSWORD=$(kubectl get secret -n <NAMESPACE> corda-rest-api-admin -o go-template="{{ .data.password | base64decode }}")
   curl -k -u $REST_API_USER:$REST_API_PASSWORD $REST_API_URL/hello
   

   The REST API is protected by a self-signed certificate.

You can access the Swagger documentation for the REST API at the path /api/v5_1/swagger. For example, when using port forwarding, the documentation is available at <REST_API_URL>/swagger.

You can also view the REST API documentation here.