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

# Archive a file

> Stop sharing a file without deleting it.



## OpenAPI

````yaml POST /documents/{id}/archive
openapi: 3.1.0
info:
  title: Reqlick API
  description: >-
    REST API for Reqlick — link shortening, QR codes, file-to-link, custom
    domains and analytics.


    Authenticate with a workspace API key (`Authorization: Bearer rqk_...`),
    created under Settings → API Keys.


    A key is scoped to the single workspace it was created in. Using it against
    a different workspace returns 403, even when the owning user is a member of
    both.


    API access requires a paid plan.
  version: 3.0.0
  contact:
    name: Reqlick Support
    email: support@reqlick.com
servers:
  - url: https://api.reqlick.com
security:
  - bearerAuth: []
tags:
  - name: Links
  - name: QR Codes
  - name: Documents
  - name: Domains
  - name: Workspaces
  - name: Users
  - name: Subscriptions
paths:
  /documents/{id}/archive:
    post:
      tags:
        - Documents
      summary: Archive a file
      description: >-
        Stops the file being shared, reversibly. Every link pointing at it is
        archived and stops resolving; the file stays in storage and continues to
        count toward your storage quota.


        A file has no archived flag of its own — it counts as archived when
        every link pointing at it is. Returns `400` for a file with no links,
        since there is nothing to archive.


        Use `GET /workspaces/{url}/documents?status=archived` to list them, and
        `POST /documents/{id}/restore` to undo.
      operationId: archiveDocument
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Archived
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  linksArchived:
                    type: integer
        '400':
          description: The file has no links to archive
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: >-
        Missing, malformed or revoked API key — or the plan no longer includes
        API access
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated, but the key has no access to this workspace or resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: This API key does not have access to this workspace
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Workspace API key, prefixed `rqk_`.

````