Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Rotating the Data Key

    Couchbase Server Enterprise Edition 7.6 reaches End of Life on March 31, 2027. Please upgrade to 8.0.x by following Upgrade, or contact Couchbase Support.
    The data key can be rotated, by means of the REST API.

    HTTP Method and URI

    POST /node/controller/rotateDataKey

    Description

    This command rotates the data key. The Full Admin, Local User Security Admin, or External User Security Admin role is required.

    Curl Syntax

    curl -X POST http://127.0.0.1:8091/node/controller/rotateDataKey
  -u Administrator:password

    Responses

    Success returns 200 OK. Failure to authenticate due to incorrect credentials returns 401 Unauthorized. Attempt to authenticate with the wrong role returns 403 Forbidden, and a message such as {"message":"Forbidden. User needs the following permissions","permissions":["cluster.admin.security!write"]}. An incorrectly expressed URI fails with 404 Object Not Found.

    Example

    The following example rotates the data key.

    curl -v -X POST http://localhost:8091/node/controller/rotateDataKey -u Administrator:password

    See Also

    For a full description of system secrets and their management, see Manage System Secrets.