Configure Synchronizer APIs

A Synchronizer exposes two main APIs, the Admin API and the Public API, while the Participant Node exposes the Ledger API and the Admin API. In this section, we explain what the APIs do and how they can be configured.

For details on how to configure endpoints and their addresses, ports, keep alive, and so on, see the general API documentation.

Configure Sequencer Public API

The Sequencer Public API provides the services to other nodes to connect, authenticate, and exchange messages with a Synchronizer. To learn more about the Sequencer’s role, visit the Sequencer overview page.

Configure the Public API public-api under a Sequencer node configuration:

sequencers {
  sequencer1 {
    storage.type = memory
    public-api.port = 5001
    admin-api.port = 5002
    sequencer.type = BFT
  }
}

All Sequencer Public API configuration parameters have defaults. For example, the default address to listen on is 127.0.0.1. To find out more about the parameters, check the reference documentation.

Configure Sequencer Admin API

The Sequencer Admin API can be configured in the standard way under the Sequencer node configuration (at the same level as the Public API).

Configure Mediator Admin API

The Mediator Admin API can be configured in the standard way under the Mediator node configuration:

mediators {
  mediator1 {
    storage.type = memory
    admin-api.port = 5202
  }
}