Roll Back Security Configuration API

Introduced 3.3

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, join the discussion on the OpenSearch forum.

Restores a previous version of the security configuration. Specify a version ID to roll back to that version, or omit it to roll back to the version immediately preceding the current one.

A rollback replaces the entire security configuration, including users, roles, role mappings, action groups, and tenants. Retrieve the target version with the Get Security Configuration Versions API and confirm its contents before rolling back.

A rollback is itself a configuration change, so OpenSearch records a new version for it. For example, rolling back a cluster running v6 to v5 leaves the cluster on the v5 configuration and adds v7 to the version history.

Endpoints

POST /_plugins/_security/api/version/rollback
POST /_plugins/_security/api/version/rollback/{version_id}

Path parameters

The following table lists the available path parameters. All path parameters are optional.

Example request

The following request restores the preceding version:

POST /_plugins/_security/api/version/rollback

The following request restores the v2 version:

POST /_plugins/_security/api/version/rollback/v2

Example response

The response names the version that OpenSearch restored. A cluster running v6 returns the following response when rolling back to the preceding version:

{
  "status": "OK",
  "message": "config rolled back to version v5"
}

A request that names v2 returns the following response:

{
  "status": "OK",
  "message": "config rolled back to version v2"
}

If the requested version does not exist, OpenSearch returns 404 Not Found and leaves the configuration unchanged:

{
  "status": "NOT_FOUND",
  "message": "Version v99 not found"
}

Response body fields

The response body is a JSON object with the following fields.