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

# Copy a folder

> Copies a folder, including its contents, into a destination bucket and optionally a destination folder.

Required scopes: `buckets:write` + `folders:write`.



## OpenAPI

````yaml /api-reference/openapi.json post /folders/copy/{folderId}
openapi: 3.1.0
info:
  title: Everabyte Storage API
  version: '2026.10'
  summary: Company-scoped storage API authenticated with API keys.
  description: >-
    The Everabyte storage API for company workspaces. Every operation here is
    reachable with an API key and has been verified against route registration
    and controller behavior.


    Authentication uses two headers: `X-Public-Key` and `X-Secret-Key`. API-key
    headers are not CORS-allowed, so this API is for server-side use only.


    Response shapes vary by layer. Success responses use `{status, message,
    data}`. Middleware errors use `{status, message, data, code}`. Controller
    errors use `{status, message, error}`. See the Conventions page for details.


    All examples are illustrative. Identifiers, sizes, and timestamps are
    placeholders, not production data.
  contact:
    name: Everabyte Support
    email: support@everabyte.com
    url: https://everabyte.com
  license:
    name: Proprietary
servers:
  - url: https://api.everabyte.io/api
    description: Production
security:
  - PublicKey: []
    SecretKey: []
tags:
  - name: Files
    description: >-
      List, upload, download, update, move, copy, delete, restore, and version
      files.
  - name: Folders
    description: Browse and manage the folder tree inside a bucket.
  - name: Buckets
    description: Discover the buckets a key can reach and read their stored size.
paths:
  /folders/copy/{folderId}:
    post:
      tags:
        - Folders
      summary: Copy a folder
      description: >-
        Copies a folder, including its contents, into a destination bucket and
        optionally a destination folder.


        Required scopes: `buckets:write` + `folders:write`.
      operationId: copyFolder
      parameters:
        - $ref: '#/components/parameters/FolderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FolderCopyRequest'
      responses:
        '200':
          description: Copy result.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - message
                  - data
                properties:
                  status:
                    type: integer
                    example: 200
                  message:
                    type: string
                    example: Folder copied
                  data:
                    type: object
                    required:
                      - originalFolderId
                      - newFolderId
                      - destinationBucketId
                      - foldersCopied
                      - filesCopied
                      - copiedFileIds
                    properties:
                      originalFolderId:
                        type: string
                        format: uuid
                        description: Identifier of the copied source folder.
                      newFolderId:
                        type: string
                        format: uuid
                        description: Identifier of the newly created root copy.
                      destinationBucketId:
                        type: string
                        format: uuid
                      foldersCopied:
                        type: integer
                        description: Number of folder rows cloned in the subtree.
                      filesCopied:
                        type: integer
                        description: Number of files copied with their bytes.
                      copiedFileIds:
                        type: array
                        items:
                          type: string
                          format: uuid
                        description: Identifiers of the newly created file records.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    FolderId:
      name: folderId
      in: path
      required: true
      description: Folder identifier.
      schema:
        type: string
        format: uuid
  schemas:
    FolderCopyRequest:
      type: object
      required:
        - destinationBucketId
      properties:
        destinationBucketId:
          type: string
          format: uuid
        destinationFolderId:
          type:
            - string
            - 'null'
          format: uuid
          description: Target folder inside the destination bucket.
      additionalProperties: false
    ErrorEnvelope:
      type: object
      description: >-
        Error shape varies by layer. Middleware errors include `code`;
        controller errors include `error`; framework errors may use
        `statusCode`.
      properties:
        status:
          type: integer
        statusCode:
          type: integer
        message:
          type: string
        error:
          type:
            - string
            - object
            - 'null'
        code:
          type: string
        data:
          type:
            - object
            - array
            - 'null'
      additionalProperties: true
  responses:
    BadRequest:
      description: Validation or request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, malformed, revoked, or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    PaymentRequired:
      description: >-
        Billing state or storage capacity prevents the operation. May include
        `SUBSCRIPTION_REQUIRED`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        Authorization failure. Stable codes include `API_COMPANY_ONLY`,
        `API_KEY_SURFACE_DENIED`, `API_BUCKET_SCOPE_DENIED`,
        `TRIAL_API_LIMIT_REACHED`, and `DEVICE_BLOCKED`. A missing scope usually
        returns no code.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found or not visible to this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: >-
        Request rate exceeded. Stable code `API_KEY_RATE_LIMITED`. No
        `Retry-After` header is documented; use exponential backoff with jitter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ServerError:
      description: Unexpected server error. Messages are sanitized in production.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    PublicKey:
      type: apiKey
      in: header
      name: X-Public-Key
      description: >-
        Public half of the company API key. Format: `pk_` followed by 64
        hexadecimal characters.
    SecretKey:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: >-
        Secret half of the company API key. Format: `sk_` followed by 64
        hexadecimal characters. Stored as a hash server-side and shown only at
        creation or rotation.

````

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