Skip to content

Set file naming pattern

PATCH
/api/v1/libraries/{libraryId}/file-naming-pattern
curl --request PATCH \
--url http://127.0.0.1:58259/api/v1/libraries/1/file-naming-pattern \
--header 'Content-Type: application/json' \
--data '{ "additionalProperty": "example" }'

Set the file naming pattern for a library. Requires admin or manipulation permission.

libraryId
required
integer format: int64

ID of the library

Media type application/json

File naming pattern body

object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

File naming pattern updated successfully

Media type */*
object
id
integer format: int64
name
string
sort
object
field
string
direction
string
Allowed values: ASCENDING DESCENDING
icon
string
iconType
string
Allowed values: PRIME_NG CUSTOM_SVG
fileNamingPattern
string
watch
boolean
paths
Array<object>
object
id
integer format: int64
libraryId
integer format: int64
path
string
formatPriority
Array<string>
Allowed values: PDF EPUB CBX FB2 MOBI AZW3 AUDIOBOOK
allowedFormats
Array<string>
Allowed values: PDF EPUB CBX FB2 MOBI AZW3 AUDIOBOOK
organizationMode
string
Allowed values: BOOK_PER_FILE BOOK_PER_FOLDER AUTO_DETECT
metadataSource
string
Allowed values: EMBEDDED SIDECAR PREFER_SIDECAR PREFER_EMBEDDED NONE