> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quiva.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Restore a past version as the record's next version

> Materialises one visible put version's folded snapshot as the record's next version (or re-creates the record if it is currently deleted), validated against the current schema. A dedicated endpoint rather than a flag on the record update — the server takes the snapshot from the fold, so a caller cannot label arbitrary data as a restore, and the permission is history's, not the record's. Refuses the current version and a hidden version.



## OpenAPI

````yaml /api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/restore
openapi: 3.1.0
info:
  title: Records API
  version: 1.1.0
  description: >-
    Record configurations (schemas, views, versions) and the records that
    conform to them. Record IDs are server-generated, config IDs are
    client-supplied (`^[a-zA-Z0-9_-]+$`). Configs and records are updated with
    PUT: a config update applies only the fields sent, a record update merges
    `data`. Editing a config schema does not retroactively re-validate existing
    records. Publish a config version to snapshot the stored config; list and
    read versions to see its history.
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Record Configs
    description: >-
      Manage record configuration schemas. Each configuration defines the
      structure (fields, types, validation rules) that records must conform to.
  - name: Records
    description: >-
      Manage individual data records. Each record belongs to exactly one
      configuration and its data is validated against that configuration's
      schema.
  - name: Record Config Collections
    description: Groups of record configs.
  - name: Record Config Versions
    description: Published snapshots of a record config.
  - name: Record History
    description: The change history of a record.
  - name: Record Assessment
  - name: Strategy and Simulation
  - name: Record Metrics
paths:
  /records/{config_id}/{id}/history/{version}/restore:
    post:
      tags:
        - Record History
      summary: Restore a past version as the record's next version
      description: >-
        Materialises one visible put version's folded snapshot as the record's
        next version (or re-creates the record if it is currently deleted),
        validated against the current schema. A dedicated endpoint rather than a
        flag on the record update — the server takes the snapshot from the fold,
        so a caller cannot label arbitrary data as a restore, and the permission
        is history's, not the record's. Refuses the current version and a hidden
        version.
      operationId: restoreRecordHistoryVersion
      parameters:
        - name: config_id
          in: path
          required: true
          description: ID of the record configuration that the record belongs to
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Record ID
          schema:
            type: string
        - name: version
          in: path
          required: true
          description: >-
            The put event's version to act on. A deletion cannot be amended,
            hidden, erased or restored (400 history_target_not_put).
          schema:
            type: integer
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordHistoryReasonRequest'
      responses:
        '200':
          description: Version restored.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response'
                  - properties:
                      body:
                        $ref: '#/components/schemas/RecordHistoryRestoreResponse'
        '400':
          description: >-
            Missing/invalid config_id, id or version;
            `{"code":"history_target_not_put"}` — a delete event cannot be
            restored; `{"code":"history_reason_too_long"}`;
            `{"code":"schema_validation_failed"}` — the snapshot no longer
            matches the current schema; `{"code":"effective_at_invalid"}`; or a
            plain error when the target predates full snapshots and the record
            is currently deleted (nothing to apply values onto).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: No caller identity on the request token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            `{"code":"history_forbidden"}` — the caller's role is not in the
            config's `history.edit_roles`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            Record configuration not found, or
            `{"code":"history_version_not_found"}`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            `{"code":"history_target_is_current"}` — this is already the current
            version. `{"code":"history_target_hidden"}` — restore it is not
            possible while hidden. `{"code":"record_exists"}` /
            `{"code":"record_conflict"}` — rare races on the underlying record
            write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: >-
            `{"code":"history_read_failed"}`. `{"code":"history_write_failed"}`
            — the record was saved but its history event was not; body carries
            the saved `record`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    RecordHistoryReasonRequest:
      type: object
      description: >-
        Body of POST .../hide, .../erase and .../restore. An empty or omitted
        body is treated as no reason. `reason` is required for hide and erase
        (400 history_reason_required when empty after trimming,
        history_reason_too_long over 500 characters); optional for restore,
        where it is only echoed back in the response and stored nowhere.
      properties:
        reason:
          type: string
          maxLength: 500
          description: Free text, 1-500 characters after trimming.
      example:
        reason: Correcting a data entry error
    Response:
      type: object
      properties:
        status_code:
          type: integer
          description: HTTP status code echoed in the response body.
        body:
          type: object
          description: Response payload.
    RecordHistoryRestoreResponse:
      type: object
      description: 200 body of POST .../restore.
      properties:
        config_id:
          type: string
        record_id:
          type: string
        version:
          type: integer
          description: >-
            The version that was restored from — the same value as
            restored_from, not the record's new version (that is
            record.version).
        restored_from:
          type: integer
        reason:
          type: string
          description: Echoed from the request; omitted when none was given.
        record:
          $ref: '#/components/schemas/Record'
      example:
        config_id: exchange_rates
        record_id: aB3xY9k2Lm
        version: 3
        restored_from: 3
        record:
          id: aB3xY9k2Lm
          config_id: exchange_rates
          version: 6
          data: {}
    ErrorResponse:
      type: object
      properties:
        status_code:
          type: integer
        body:
          type: object
          properties:
            error:
              type: string
              description: Human-readable error message.
      example:
        status_code: 400
        body:
          error: field 'rating' is required
    Record:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier. Auto-generated if not provided on creation.
        config_id:
          type: string
          description: ID of the RecordConfig that defines this record's schema.
        data:
          type: object
          additionalProperties: true
          description: >-
            Key-value map of field values. Keys correspond to SchemaField IDs.
            Values must match the field type defined in the schema. Extra keys
            not defined in the schema are permitted.
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: ISO 8601 timestamp set automatically on creation.
        updated_at:
          type: string
          format: date-time
          readOnly: true
          description: ISO 8601 timestamp updated automatically on every modification.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.