corda.rest heading-link-icon

Configuration schema for the REST section.

  • address - The address at which the REST API is exposed.
    Default value: 0.0.0.0:8888
    • context - Context information to be included in the Open API definition.
      • description - The description of the API.
        Default value: Exposing REST interfaces as OpenAPI WebServices.
      • title - The title of the API.
        Default value: REST
    • endpoint - Settings for endpoints.
      • timeoutMs - The length of time in milliseconds that the backend message bus waits for a response to a remote operation before timing out the REST call.
        Default value: 12000
        Minimum value: 100
        Maximum value: 2147483647
    • maxContentLength - The maximum length in bytes that can be sent over HTTP.
      Default value: 200000000
      Minimum value: 1024
      Maximum value: 2147483647
      • websocket - Settings for WebSockets.
        • idleTimeoutMs - The length of time in milliseconds that a websocket connection can be idle (no messages are either sent or received) before timing out and closing the connection. A value of 0 disables idle checks.
          Default value: 30000
          Minimum value: 0
          Maximum value: 2147483647

      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.