Skip to main content

updateConfig

updateConfig

Request Body REQUIRED
backup object REQUIRED
database object REQUIRED
cronExpression string REQUIRED
enabled boolean REQUIRED
keepLastAmount number REQUIRED

Possible values: 1 ≤ value

ffmpeg object REQUIRED
accel string REQUIRED

Possible values: [nvenc, qsv, vaapi, rkmpp, disabled]

accelDecode boolean REQUIRED
acceptedAudioCodecs string[] REQUIRED

Possible values: [mp3, aac, libopus, pcm_s16le]

acceptedContainers string[] REQUIRED

Possible values: [mov, mp4, ogg, webm]

acceptedVideoCodecs string[] REQUIRED

Possible values: [h264, hevc, vp9, av1]

bframes integer REQUIRED

Possible values: -1 ≤ value ≤ 16

cqMode string REQUIRED

Possible values: [auto, cqp, icq]

crf integer REQUIRED

Possible values: value ≤ 51

gopSize integer REQUIRED
maxBitrate string REQUIRED
preferredHwDevice string REQUIRED
preset string REQUIRED
refs integer REQUIRED

Possible values: value ≤ 6

targetAudioCodec string REQUIRED

Possible values: [mp3, aac, libopus, pcm_s16le]

targetResolution string REQUIRED
targetVideoCodec string REQUIRED

Possible values: [h264, hevc, vp9, av1]

temporalAQ boolean REQUIRED
threads integer REQUIRED
tonemap string REQUIRED

Possible values: [hable, mobius, reinhard, disabled]

transcode string REQUIRED

Possible values: [all, optimal, bitrate, required, disabled]

twoPass boolean REQUIRED
image object REQUIRED
colorspace string REQUIRED

Possible values: [srgb, p3]

extractEmbedded boolean REQUIRED
preview object REQUIRED
format string REQUIRED

Possible values: [jpeg, webp]

quality integer REQUIRED

Possible values: 1 ≤ value ≤ 100

size integer REQUIRED

Possible values: 1 ≤ value

thumbnail object REQUIRED
format string REQUIRED

Possible values: [jpeg, webp]

quality integer REQUIRED

Possible values: 1 ≤ value ≤ 100

size integer REQUIRED

Possible values: 1 ≤ value

job object REQUIRED
backgroundTask object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

faceDetection object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

library object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

metadataExtraction object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

migration object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

notifications object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

search object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

sidecar object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

smartSearch object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

thumbnailGeneration object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

videoConversion object REQUIRED
concurrency integer REQUIRED

Possible values: 1 ≤ value

library object REQUIRED
scan object REQUIRED
cronExpression string REQUIRED
enabled boolean REQUIRED
watch object REQUIRED
enabled boolean REQUIRED
logging object REQUIRED
enabled boolean REQUIRED
level string REQUIRED

Possible values: [verbose, debug, log, warn, error, fatal]

machineLearning object REQUIRED
clip object REQUIRED
enabled boolean REQUIRED
modelName string REQUIRED
duplicateDetection object REQUIRED
enabled boolean REQUIRED
maxDistance double REQUIRED

Possible values: 0.001 ≤ value ≤ 0.1

enabled boolean REQUIRED
facialRecognition object REQUIRED
enabled boolean REQUIRED
maxDistance double REQUIRED

Possible values: 0.1 ≤ value ≤ 2

minFaces integer REQUIRED

Possible values: 1 ≤ value

minScore double REQUIRED

Possible values: 0.1 ≤ value ≤ 1

modelName string REQUIRED
url string

This property was deprecated in v1.122.0

urls uri[] REQUIRED
map object REQUIRED
darkStyle string REQUIRED
enabled boolean REQUIRED
lightStyle string REQUIRED
metadata object REQUIRED
faces object REQUIRED
import boolean REQUIRED
newVersionCheck object REQUIRED
enabled boolean REQUIRED
notifications object REQUIRED
smtp object REQUIRED
enabled boolean REQUIRED
from string REQUIRED
replyTo string REQUIRED
transport object REQUIRED
host string REQUIRED
ignoreCert boolean REQUIRED
password string REQUIRED
port number REQUIRED

Possible values: value ≤ 65535

username string REQUIRED
oauth object REQUIRED
autoLaunch boolean REQUIRED
autoRegister boolean REQUIRED
buttonText string REQUIRED
clientId string REQUIRED
clientSecret string REQUIRED
defaultStorageQuota number REQUIRED
enabled boolean REQUIRED
issuerUrl string REQUIRED
mobileOverrideEnabled boolean REQUIRED
mobileRedirectUri string REQUIRED
profileSigningAlgorithm string REQUIRED
scope string REQUIRED
signingAlgorithm string REQUIRED
storageLabelClaim string REQUIRED
storageQuotaClaim string REQUIRED
passwordLogin object REQUIRED
enabled boolean REQUIRED
reverseGeocoding object REQUIRED
enabled boolean REQUIRED
server object REQUIRED
externalDomain string REQUIRED
loginPageMessage string REQUIRED
publicUsers boolean REQUIRED
storageTemplate object REQUIRED
enabled boolean REQUIRED
hashVerificationEnabled boolean REQUIRED
template string REQUIRED
templates object REQUIRED
email object REQUIRED
albumInviteTemplate string REQUIRED
albumUpdateTemplate string REQUIRED
welcomeTemplate string REQUIRED
theme object REQUIRED
customCss string REQUIRED
trash object REQUIRED
days integer REQUIRED
enabled boolean REQUIRED
user object REQUIRED
deleteDelay integer REQUIRED

Possible values: 1 ≤ value

Responses
200
Schema OPTIONAL
backup object
database object
cronExpression string
enabled boolean
keepLastAmount number

Possible values: 1 ≤ value

ffmpeg object
accel string

Possible values: [nvenc, qsv, vaapi, rkmpp, disabled]

accelDecode boolean
acceptedAudioCodecs string[]

Possible values: [mp3, aac, libopus, pcm_s16le]

acceptedContainers string[]

Possible values: [mov, mp4, ogg, webm]

acceptedVideoCodecs string[]

Possible values: [h264, hevc, vp9, av1]

bframes integer

Possible values: -1 ≤ value ≤ 16

cqMode string

Possible values: [auto, cqp, icq]

crf integer

Possible values: value ≤ 51

gopSize integer
maxBitrate string
preferredHwDevice string
preset string
refs integer

Possible values: value ≤ 6

targetAudioCodec string

Possible values: [mp3, aac, libopus, pcm_s16le]

targetResolution string
targetVideoCodec string

Possible values: [h264, hevc, vp9, av1]

temporalAQ boolean
threads integer
tonemap string

Possible values: [hable, mobius, reinhard, disabled]

transcode string

Possible values: [all, optimal, bitrate, required, disabled]

twoPass boolean
image object
colorspace string

Possible values: [srgb, p3]

extractEmbedded boolean
preview object
format string

Possible values: [jpeg, webp]

quality integer

Possible values: 1 ≤ value ≤ 100

size integer

Possible values: 1 ≤ value

thumbnail object
format string

Possible values: [jpeg, webp]

quality integer

Possible values: 1 ≤ value ≤ 100

size integer

Possible values: 1 ≤ value

job object
backgroundTask object
concurrency integer

Possible values: 1 ≤ value

faceDetection object
concurrency integer

Possible values: 1 ≤ value

library object
concurrency integer

Possible values: 1 ≤ value

metadataExtraction object
concurrency integer

Possible values: 1 ≤ value

migration object
concurrency integer

Possible values: 1 ≤ value

notifications object
concurrency integer

Possible values: 1 ≤ value

search object
concurrency integer

Possible values: 1 ≤ value

sidecar object
concurrency integer

Possible values: 1 ≤ value

smartSearch object
concurrency integer

Possible values: 1 ≤ value

thumbnailGeneration object
concurrency integer

Possible values: 1 ≤ value

videoConversion object
concurrency integer

Possible values: 1 ≤ value

library object
scan object
cronExpression string
enabled boolean
watch object
enabled boolean
logging object
enabled boolean
level string

Possible values: [verbose, debug, log, warn, error, fatal]

machineLearning object
clip object
enabled boolean
modelName string
duplicateDetection object
enabled boolean
maxDistance double

Possible values: 0.001 ≤ value ≤ 0.1

enabled boolean
facialRecognition object
enabled boolean
maxDistance double

Possible values: 0.1 ≤ value ≤ 2

minFaces integer

Possible values: 1 ≤ value

minScore double

Possible values: 0.1 ≤ value ≤ 1

modelName string
url string OPTIONAL

This property was deprecated in v1.122.0

urls uri[]
map object
darkStyle string
enabled boolean
lightStyle string
metadata object
faces object
import boolean
newVersionCheck object
enabled boolean
notifications object
smtp object
enabled boolean
from string
replyTo string
transport object
host string
ignoreCert boolean
password string
port number

Possible values: value ≤ 65535

username string
oauth object
autoLaunch boolean
autoRegister boolean
buttonText string
clientId string
clientSecret string
defaultStorageQuota number
enabled boolean
issuerUrl string
mobileOverrideEnabled boolean
mobileRedirectUri string
profileSigningAlgorithm string
scope string
signingAlgorithm string
storageLabelClaim string
storageQuotaClaim string
passwordLogin object
enabled boolean
reverseGeocoding object
enabled boolean
server object
externalDomain string
loginPageMessage string
publicUsers boolean
storageTemplate object
enabled boolean
hashVerificationEnabled boolean
template string
templates object
email object
albumInviteTemplate string
albumUpdateTemplate string
welcomeTemplate string
theme object
customCss string
trash object
days integer
enabled boolean
user object
deleteDelay integer

Possible values: 1 ≤ value