All request body parameters are optional.

    1The cluster state includes:

    • Persistent cluster settings
    • Index templates
    • Legacy index templates
    • Index lifecycle policies

    Sample request

    Sample Response

    Upon success, the response returns the following JSON object:

    Except for the snapshot name, all properties are empty or 0. This is because any changes made to the volume after the snapshot was generated are lost. However, if you invoke the Get snapshot API to examine the snapshot, a fully populated snapshot object is returned.