Flocker REST API

In general the API allows for modifying the desired configuration of the cluster. When you use the API to change the configuration, e.g. creating a new dataset:

You will need to provide API end users with a certificate for authentication before they can use the API. For more information, see Generating an API Client Certificate.

  1. A successful response indicates a change in configuration, not a change to cluster state.
  2. Convergence agents will then take the necessary actions and eventually the cluster’s state will match the requested configuration.
  3. The actual cluster state will then reflect the requested change. For example, you can retrieve the current cluster datasets via GET /v1/state/datasets.

For more information read the cluster architecture documentation.


Leases prevent multiple applications from requesting the same dataset on different nodes at the same time.