ClusterAdmin

Cluster Force Snapshot

Force the cluster to take a snapshot immediately

post/api/v1.cluster-admin.force-snapshot

Request body

ClusterForceSnapshotIn required

Response

snapshot_timeinteger required

The wall-clock time at which the snapshot was initiated

snapshot_log_indexinteger required

The log index at which the snapshot was initiated

snapshot_idstring nullable

If this is null, the snapshot is still building in the background

Changes

Changed in 5 of the 53 revisions of this API.21222

  • a542ced3f5931212See the full diff
    • added the new invalid-input enum value to the type response property for the response status 400

      response-property-enum-value-added

    • added the new invalid-input enum value to the type response property for the response status 401

      response-property-enum-value-added

    • added the new invalid-input enum value to the type response property for the response status 403

      response-property-enum-value-added

    • added the new invalid-input enum value to the type response property for the response status 422

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 400

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 401

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 403

      response-property-enum-value-added

    • added the new operation-error enum value to the type response property for the response status 422

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 400

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 401

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 403

      response-property-enum-value-added

    • added the new server-error enum value to the type response property for the response status 422

      response-property-enum-value-added

    • removed the invalid_input enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • added the required property type to the response with the 400 status

      response-required-property-added

    • added the required property type to the response with the 401 status

      response-required-property-added

    • added the required property type to the response with the 403 status

      response-required-property-added

    • added the required property type to the response with the 422 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c3022218176815See the full diff
    • the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • added the optional property location to the response with the 400 status

      response-optional-property-added

    • added the optional property location to the response with the 401 status

      response-optional-property-added

    • added the optional property location to the response with the 403 status

      response-optional-property-added

    • added the optional property location to the response with the 422 status

      response-optional-property-added

    • added the required property code to the response with the 422 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog