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

# project:document:restore-version

> Project-scoped Documents. Requires ProjectOwning Node access. See /reference/project-documents for limits, archive inheritance, revision preconditions and retry recovery. No object keys or credentials are returned.



## OpenAPI

````yaml /openapi.json post /api/v1/projects/{project}/documents/{entry}/restore-version
openapi: 3.1.0
info:
  title: Orbit Gateway API
  version: v1
  description: >-
    The HTTP API of the active Orbit Gateway. The CLI and the PHP SDK send every
    fleet command through these endpoints over WireGuard. See [Using the
    API](/api/overview) for transport, authentication, envelopes, and errors.
servers:
  - url: https://gateway.orbit
    description: >-
      The active Gateway on the private WireGuard network, resolved by Orbit
      private DNS.
security: []
tags:
  - name: Gateway
    description: >-
      Status and trust of the active Gateway, and the releases of the Gateway
      itself.
  - name: Nodes
    description: Machines in the fleet, their roles, access grants, and storage settings.
  - name: Clusters
    description: Groups of Nodes with one Router and one development TLD.
  - name: Firewall
    description: Named UFW rules on one Node.
  - name: Fleet rollout
    description: >-
      The rollout of each verified Gateway release to the managed Nodes, and its
      catch-up.
  - name: Tools
    description: Packages that Orbit installs on a Node through a Tool Manager.
  - name: Metrics
    description: The Prometheus and Grafana role and its exporters.
  - name: GitHub App
    description: The Gateway's own read-only GitHub App and the accounts that installed it.
  - name: Analytics
    description: >-
      The analytics role, its Plausible version, and the Stats API key the
      Gateway uses to read visits.
  - name: Projects
    description: Repository records with one type, default branch, and web root each.
  - name: Instances
    description: Development checkouts and production releases of a Project on one Node.
  - name: Environment
    description: Stored Instance environment configuration and its .env projection.
  - name: Routes
    description: Domains that reach an Instance.
  - name: Database connections
    description: The registry of mysql, pgsql, and sqlite connections.
  - name: Processes
    description: >-
      systemd services and Docker containers owned by an Instance, a Node, or a
      Project definition.
  - name: Schedules
    description: Recurring commands run by native systemd timers.
  - name: Annotations
    description: Instance annotations, T3 delivery, and replayable status events.
  - name: Tasks
    description: Commander feature groups and ordered subtasks.
  - name: Extensions
    description: Gateway-owned extension switches.
  - name: Doctor
    description: Verify-only drift checks across the fleet.
  - name: Activities
    description: The Gateway log of authorized commands.
  - name: proxycli
    description: CLIProxyAPI quota snapshots, provider pools, and account controls.
  - name: Vaultwarden
    description: The copy of database credentials into a Vaultwarden collection.
  - name: Conn
    description: >-
      Profiles, shared workspace settings, registered T3 servers, and the
      pairing links the Gateway mints on them for each Node.
  - name: Realtime
    description: >-
      The record-change event feed broadcast to Reverb, its channel
      authorization, and Reverb connection discovery.
  - name: Node callbacks
    description: Endpoints that managed Nodes and Caddy call; operators do not call them.
paths:
  /api/v1/projects/{project}/documents/{entry}/restore-version:
    post:
      tags:
        - Projects
      summary: project:document:restore-version
      description: >-
        Project-scoped Documents. Requires ProjectOwning Node access. See
        /reference/project-documents for limits, archive inheritance, revision
        preconditions and retry recovery. No object keys or credentials are
        returned.
      operationId: project-document-restore-version
      parameters:
        - name: project
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: Numeric Project ID.
        - name: entry
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: Numeric Project Document entry ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                expected_revision:
                  type: integer
                  minimum: 1
                  description: Observed revision
                version_id:
                  type: integer
                  minimum: 1
              required:
                - expected_revision
                - version_id
              additionalProperties: false
      responses:
        '200':
          description: The request succeeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DocumentEntry'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '403':
          description: >-
            The caller is not an active WireGuard peer (`peer.identity_unknown`)
            or lacks Node access to the target (`node_access.required`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            Project-scoped entry or file-scoped version not found
            (`project_documents.not_found`); a missing Project returns
            `http.404`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            Revision conflict (`project_documents.revision_conflict`, with
            entry_id and current_revision), duplicate sibling name
            (`project_documents.name_conflict`), archived destination
            (`project_documents.archived`), nonempty folder
            (`project_documents.folder_not_empty`), abandoned upload
            (`project_documents.upload_abandoned`), or unconfigured storage
            (`project_documents.storage_not_configured`). No automatic retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: >-
            Decoded content or JSON request exceeds the documented limit
            (`project_documents.content_too_large`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            Invalid fields, content encoding, names, hierarchy, query or cursor
            (`validation.failed`), folder content operation
            (`project_documents.not_file`), or content outside inline editing
            limits (`project_documents.not_editable`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: >-
            Committed body is missing or corrupt
            (`project_documents.body_unavailable`); metadata is retained.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            Storage is unavailable (`project_documents.storage_unavailable`);
            provider diagnostics are not returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: curl
          source: >
            curl -sS -X POST
            "https://gateway.orbit/api/v1/projects/4/documents/1/restore-version"
            \
              --cacert /path/to/orbit-root-ca.pem \
              -H 'Accept: application/json' \
              -H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
              -H 'Content-Type: application/json' \
              -d '{"expected_revision": 1, "version_id": 1}'
        - lang: php
          label: PHP SDK
          source: >
            <?php


            use Orbit\Sdk\GatewayConnector;

            use
            Orbit\Sdk\Requests\ProjectDocuments\RestoreProjectDocumentVersionRequest;


            $connector = new GatewayConnector(
                baseUrl: 'https://gateway.orbit',
                caPemPath: '/path/to/orbit-root-ca.pem',
            );


            $response = $connector->send(new
            RestoreProjectDocumentVersionRequest(projectId: 4, entryId: 1,
            expectedRevision: 1, versionId: 1))->dto();
components:
  schemas:
    DocumentEntry:
      type: object
      properties:
        id:
          type: integer
        project_id:
          type: integer
        kind:
          type: string
        parent_id:
          type:
            - integer
            - 'null'
        name:
          type: string
        revision:
          type: integer
        archived_at:
          type:
            - string
            - 'null'
        created_at:
          type: string
        updated_at:
          type: string
        path:
          type: string
        is_archived:
          type: boolean
        current_version:
          oneOf:
            - $ref: '#/components/schemas/DocumentVersion'
            - type: 'null'
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: >-
            The request ID the Gateway assigned or accepted; the same value is
            in the `X-Orbit-Request-Id` response header and in the Activity
            record.
      required:
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Stable error code, namespaced by family, such as
                `node.not_active` or `route.target_conflict`.
            message:
              type: string
              description: >-
                Safe message without credentials, environment values, or remote
                output.
            details:
              type: object
              additionalProperties: true
              description: >-
                Bounded, redacted details such as the conflicting record IDs or
                the failed validation rule.
            request_id:
              type: string
              format: uuid
          required:
            - code
            - message
      required:
        - error
    DocumentVersion:
      type: object
      properties:
        id:
          type: integer
        number:
          type: integer
        media_type:
          type: string
        size_bytes:
          type: integer
        sha256:
          type: string
        created_at:
          type: string
        created_by_node_id:
          type:
            - integer
            - 'null'

````

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