---
title: "Create a catalog"
method: PUT
path: "/catalogs"
tags: ["Catalogs"]
---

# Create a catalog

`PUT /catalogs`

Create a new catalog.

## Query parameters

- `name` string
- `path` string
- `type` 'local' | 'beets' | 'remote' | 'subsonic' | 'seafile' | 'beetsremote'
- `media_type` string
- `file_pattern` string
- `folder_pattern` string
- `username` string
- `password` string

## Request body

- CatalogCreateRequest
  - `name` string, required
  - `path` string, required
  - `type` 'local' | 'beets' | 'remote' | 'subsonic' | 'seafile' | 'beetsremote'
  - `media_type` string
  - `file_pattern` string
  - `folder_pattern` string
  - `username` string
  - `password` string — Deprecated: for privacy, send this in a form or JSON request body instead of the query string (query values land in server/proxy logs and browser history). Query-string support is retained for backward compatibility.

## Response `200`

Catalog object

- CatalogObject
  - `id` string, required
  - `name` string, nullable, required
  - `type` string, nullable, required
  - `gather_types` string, nullable, required
  - `enabled` boolean, required
  - `last_add` integer, required
  - `last_clean` integer, nullable, required
  - `last_update` integer, required
  - `path` string, required
  - `rename_pattern` string, nullable, required
  - `sort_pattern` string, nullable, required

## Other responses

- `400` — HTTP 400 Bad Request (errors 4705, 4710).
- `401` — HTTP 401 Unauthorized (error 4701).
- `403` — HTTP 403 Forbidden (errors 4700, 4703, 4742).
- `500` — HTTP 500 Internal Server Error (error 4702).

## Changes

- **2026-07-22** `e8e6b266ea29` — 7 info
  - api operation id `catalogCreate` was added
  - added optional request body
  - the `query` request parameter `name` became optional
  - the `query` request parameter `path` became optional
  - …3 more
- **2026-07-21** `2ff18e50dcc1` — 11 info
  - added the required property `enabled` to the response with the `200` status
  - added the required property `gather_types` to the response with the `200` status
  - added the required property `id` to the response with the `200` status
  - added the required property `last_add` to the response with the `200` status
  - …7 more
- **2026-07-20** `531d5bc1344e` — 1 info
  - `query` request parameter `password` was deprecated
- **2026-07-17** `9abb9bf6d3bf` — 1 info
  - removed the non-success response with the status `400`
- **2026-06-25** `7ed7a764efd9` — 1 info
  - added the non-success response with the status `400`

[Full history](https://skmtc.dev/ampache/apis/ampache-rest-api/changes/catalogs/put.md)

---

[API](https://skmtc.dev/ampache/apis/ampache-rest-api.md) · [All operations](https://skmtc.dev/ampache/apis/ampache-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ampache/ampache-rest-api/revisions/535feee32afb/schema)