Corda 5 Developer Preview 2 is now available.

REST API

The Corda REST API enables operators to interact with a running version of Corda. To access and invoke the REST API:

  1. To access the RPC endpoint of a Corda cluster, forward the port by running the following command in a terminal window:

    kubectl port-forward -n corda deploy/corda-rpc-worker 8888
    

    You can then access the Swagger documentation for the RPC endpoint at https://localhost:8888/api/v1/swagger.

  2. To invoke the RPC endpoint from the Swagger UI, use the user name admin and password admin. Alternatively, you can use curl. For example:

    curl -u admin:admin -k https://localhost:8888/api/v1/hello
    

You can also view the REST API documentation here.

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.