Kindly EditDocumentationTry the editor

restore REST endpoint

Restore an authorized historical version after conflict checks.

Endpoint#

Restore an authorized historical version after conflict checks.

/wp-json/cantata-edit/v1/restore

Named regular-expression groups in this registered route are path parameters. Replace them with an actual matching value when constructing a request.

POST#

This operation uses a server permission callback. Browser clients need an authenticated WordPress session and REST nonce. The server checks the relevant caller capability and feature gates.

Permission expression in this release:

'permission_callback' => static fn( $req ) => current_user_can( 'edit_post', (int) $req['post_id'] ),

Registered argument schema#

{
  "post_id": {
    "type": "integer",
    "required": true
  },
  "revision_id": {
    "type": "integer",
    "required": true
  }
}

WordPress applies these registered field rules before the callback. Feature-specific validation can add further constraints.

Callback input keys#

post_id, revision_id. This literal-key inventory supplements the registered schema; nested objects and downstream validators can define additional structure.

Implementation#

Client handling#

Use HTTPS on production sites. Treat authentication failures, validation errors, missing records, and stale-revision conflicts as different outcomes. Read the returned WordPress error code and message. Before retrying a timed-out mutation, determine whether the first request succeeded. Prefer the documented higher-level editor or Ability workflow when an endpoint coordinates several metadata owners.

About this page

Documents Kindly Edit 0.9.16. Source: includes/rest.php:1039, includes/rest.php:150. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.