---
title: "Create a new mirror folder"
method: POST
path: "/dam/folders/{folder_id}/mirror-folders"
tags: ["DAM: Folders"]
---

# Create a new mirror folder

`POST /dam/folders/{folder_id}/mirror-folders`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/dam/folders/{folder_id}/mirror-folders`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/dam/folders/:folder_id/mirror-folders/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `folder_id` string, required

## Request body

- object
  - `data` object, required
    - `type` string, required: Resource Type
    - `attributes` object, required: Attributes
      - `source_folder_id` string, required: ID of folder source of the new mirror folder
      - `name` string, required: Name
      - `description` string: Description
      - `show_large_folder_name` boolean, nullable
      - `hide_folder_name` boolean, nullable
      - `thumbs_scale_to_fit` boolean, nullable
      - `apply_folder_image_hue` boolean, nullable
      - `is_synced_mirror` boolean
      - `mirror_design` boolean
    - `relationships` FolderRelationships
      - `folder_thumbnail_file` object, nullable
        - `data` ResourceIdentifierObject
          - `type` string
          - `id` string

## Response `201`

created

- Folder
  - `type` 'folder', required
  - `id` string, required
  - `attributes` FolderAttributes, required
    - `name` string
    - `description` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `sort` integer
    - `child_count` integer
    - `files_count` integer
    - `files_size` integer
    - `path` string
    - `show_large_folder_name` boolean
    - `hide_folder_name` boolean
    - `thumbs_scale_to_fit` boolean
    - `apply_folder_image_hue` boolean
    - `is_archived` boolean
    - `is_synced_mirror` boolean, nullable: Only present on mirror folders
    - `mirror_design` boolean: Only present on mirror folders
  - `relationships` FolderRelationships
    - `folder_thumbnail_file` object, nullable
      - `data` ResourceIdentifierObject
        - `type` string
        - `id` string
  - `links` FolderLinks
    - `self` string, uri
  - `meta` FolderMeta
    - `folder_type` 'folder' | 'album' | 'smart_folder' | 'mirror_folder' | 'archive_folder'
    - `is_locked` boolean

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)