/api/config
Responses
200
The response contains the base configuration values.
application/json
200
The response contains the base configuration values.
{
"plugin": {
"ai-metadata": {
"config": {
"apikey": "text",
"debug": true,
"fields": [
{
"name": "text",
"question": "text",
"type": "list"
}
],
"upload_file_size": "big"
}
},
"easydb-typo3-plugin": {
"config": {
"active": true,
"profile_mapping": 1,
"send_files": true,
"send_files_max_filesize": 1
}
},
"geo-json": {
"config": {
"select": "ol",
"value": {}
}
}
},
"system": {
"config": {
"appearance": {
"background_color": "text",
"brand_color": "text",
"favicon": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"login_background": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"logo": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"logo_external_url": {
"de-DE": "text",
"en-US": "text"
},
"tag_colors": [
{
"tag_color": "text"
}
],
"tag_icons": [
{
"fa-icon": "text"
}
]
},
"colorprofiles": {
"profiles": [
{
"profile": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"profilename": "text"
}
]
},
"custom_data_type_updater": {
"active": true
},
"deep_link_access": {
"allow_access_by_column": true,
"allow_access_by_id": true,
"enabled": true,
"iiif_default_links": true,
"iiif_links": [
{
"html_code": "text",
"label": {
"de-DE": "text",
"en-US": "text"
}
}
],
"iiif_required_statement": {
"label": {
"de-DE": "text",
"en-US": "text"
},
"value": {
"de-DE": "text",
"en-US": "text"
}
},
"include_parents": true,
"merge_linked_objects": "all",
"merge_max_depth": 1
},
"detail_deep_link": {
"use_system_object_id": true
},
"email": {
"admin_emails": [
{
"email": "[email protected]"
}
],
"from": "[email protected]",
"signature": {
"de-DE": "text",
"en-US": "text"
}
},
"email_server": {
"cram_md5_auth": {
"password": "text",
"username": "text"
},
"helo_domain": "text",
"insecure_skip_verify": true,
"login_auth": {
"password": "text",
"username": "text"
},
"plain_auth": {
"identity": "text",
"password": "text",
"username": "text"
},
"server_addr": "text",
"type": "off"
},
"export": {
"xslts": [
{
"description": {
"de-DE": "text",
"en-US": "text"
},
"displayname": {
"de-DE": "text",
"en-US": "text"
},
"namespace": "text",
"oai_pmh_prefix": "text",
"schema": "text",
"use_for_api_objects": true,
"use_for_oai_pmh": true,
"xslt": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
}
}
]
},
"export_scheduler": {
"active": true
},
"file_url_expire": {
"deep_link_days": 1,
"default_days": 1,
"max_days": 1,
"oai_pmh_days": 1
},
"janitor": {
"active": true,
"event_remote_addr_expire_days": 1,
"events": {
"expire_days_ADMIN": 1,
"expire_days_DOWNLOAD": 1,
"expire_days_EXPORT": 1,
"expire_days_FRONTEND": 1,
"expire_days_INDEX": 1,
"expire_days_LOGIN_LOGOUT": 1,
"expire_days_PLUGIN": 1,
"expire_days_SYSTEM": 1,
"expire_days_TASK": 1,
"expire_days_UPLOAD": 1
},
"file_expire_days": 1,
"users": {
"archive_nonactive_after_days": 1,
"archive_types": [
"anonymous"
],
"delete_archived_after_days": 1
}
},
"languages": {
"database": [
{
"date_format": "ca",
"displayname": {
"de-DE": "text",
"en-US": "text"
},
"number_format": "ca",
"time_format": "cldr",
"value": "text"
}
],
"frontend": [
"da-DK"
]
},
"ldap": {
"bindpassword": "text",
"bindusername": "text",
"connections": [
{
"tls_ca_cert": "text",
"tls_insecure": true,
"tls_start": true,
"url": "text"
}
],
"debug": true,
"groupbasedn": "text",
"groupfilter": "text",
"groupmapping": [
{
"group": "text"
}
],
"userbasedn": "text",
"userfilter": "text",
"usermapping": [
{
"key": "company",
"value": "text"
}
],
"userupdatecolumn": "email"
},
"license": {
"license": {
"capabilities": {},
"createdAt": "2025-06-26T09:05:00.054Z",
"domains": [
"text"
],
"edition": "text",
"holder": "text",
"issuer": "text",
"key": "text",
"notes": "text",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": null
},
"type": "text",
"valid": {
"from": "2025-06-26T09:05:00.054Z",
"to": "2025-06-26T09:05:00.054Z"
}
}
},
"loca": {
"google_csv": [
{
"gid": 1,
"key": "text"
}
],
"google_overload_csv": true
},
"location_defaults": {
"backups": "backups",
"originals": "backups",
"versions": "backups"
},
"logging": {
"level": "",
"timings": true
},
"login": {
"guest": true,
"info": {
"de-DE": "text",
"en-US": "text"
},
"label": {
"de-DE": "text",
"en-US": "text"
},
"placeholder": {
"de-DE": "text",
"en-US": "text"
}
},
"name": {
"description": {
"de-DE": "text",
"en-US": "text"
},
"internal_name": "text",
"title": {
"de-DE": "text",
"en-US": "text"
}
},
"notification_scheduler": {
"active": true
},
"oai_pmh": {
"admin_email": [
{
"email": "[email protected]"
}
],
"enabled": true,
"include_parents": true,
"merge_linked_objects": "all",
"merge_max_depth": 1,
"namespace_identifier": "text",
"records_limit": 1,
"repository_name": "text",
"tagfilter_sets": [
{
"set_name": "text",
"tagfilter": {
"all": [
3
],
"any": [
3
],
"not": [
3
]
}
}
]
},
"oauth2": {
"clients": [
{
"name": "text",
"redirect_uris": [
{
"url": "text"
}
],
"secret": "text"
}
],
"expirations": {
"access_token": "text",
"refresh_token": "text"
}
},
"objectstore": {
"instance": "text",
"server": "text",
"uid": "text"
},
"openapi_spec_endpoint": {
"active": true
},
"openid": {
"userinfo": [
"address_supplement"
]
},
"password": {
"check": [
{
"regexp": "text"
}
],
"hint": {
"de-DE": "text",
"en-US": "text"
},
"showforgot": true
},
"plugin_scheduler": {
"active": true
},
"produce_config": {
"value": {
"classes": {
"audio": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"aac"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"aac"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"aac"
],
"group": "text",
"name": "text",
"params": {
"format": "aac"
},
"recipename": "text"
}
],
"watermark": true
},
"image": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"ai"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"ai"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"ai"
],
"group": "text",
"name": "text",
"params": {},
"recipename": "text"
}
],
"watermark": true
},
"office": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"csv"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"csv"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"csv"
],
"group": "text",
"name": "text",
"params": {},
"recipename": "text"
}
],
"watermark": true
},
"video": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"3gp"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"3gp"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"3gp"
],
"group": "text",
"name": "text",
"params": {
"ffmpeg_params": "text",
"height": 1,
"height_minimum": 1,
"timeout": "text"
},
"recipename": "text"
}
],
"watermark": true
}
},
"custommetadata": {
"extensions": [
"3gp"
],
"includeversions": true,
"recipename": "_metadata:ocr"
},
"uploadallowunknown": true,
"uploadmaxfilesize": "text"
}
},
"publish": {
"collectors": [
{
"display_format": "name",
"displayname": {
"de-DE": "text",
"en-US": "text"
},
"internalname": "text",
"logo": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"prefix": "text",
"type": "text",
"url": "text"
}
]
},
"purge": {
"allow_purge": true,
"purge_storage": true
},
"readonly": {
"enabled": true
},
"register": {
"enable": true,
"form": {
"address": "hide",
"company": "hide",
"department": "hide",
"displayname": "hide",
"first_name": "hide",
"last_name": "hide",
"phone": "hide",
"use_in_user_manager": true
},
"groups": [
{
"group": 1
}
],
"info": {
"de-DE": "text",
"en-US": "text"
}
},
"saml": {
"cert": "text",
"debug": true,
"groupmapping": [
{
"group": "text"
}
],
"key": "text",
"ldap": {
"bindpassword": "text",
"bindusername": "text",
"connections": [
{
"tls_ca_cert": "text",
"tls_insecure": true,
"tls_start": true,
"url": "text"
}
],
"groupbasedn": "text",
"groupfilter": "text"
},
"loginlink": {
"de-DE": "text",
"en-US": "text"
},
"loginpreferred": true,
"signrequest": "",
"url": "text",
"usermapping": [
{
"key": "company",
"value": "text"
}
],
"userupdatecolumn": "email"
},
"transition_webhook": {
"webhooks": [
{
"include_access_token": true,
"name": "text",
"secret": "text",
"send_authorization_header": true,
"timeout": 1,
"url": "text"
}
]
},
"user": {
"copy_to_event": [
"address_supplement"
],
"default_delete_policy": "archive",
"user_in_event_group": [
"ADMIN"
]
},
"webdav": {
"hotfolder": true,
"hotfolder_wait_sec": 1,
"read_write_access": true
}
}
}
}Body
Responses
200
The response contains the base configuration values.
application/json
200
The response contains the base configuration values.
{
"plugin": {
"ai-metadata": {
"config": {
"apikey": "text",
"debug": true,
"fields": [
{
"name": "text",
"question": "text",
"type": "list"
}
],
"upload_file_size": "big"
}
},
"easydb-typo3-plugin": {
"config": {
"active": true,
"profile_mapping": 1,
"send_files": true,
"send_files_max_filesize": 1
}
},
"geo-json": {
"config": {
"select": "ol",
"value": {}
}
}
},
"system": {
"config": {
"appearance": {
"background_color": "text",
"brand_color": "text",
"favicon": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"login_background": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"logo": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"logo_external_url": {
"de-DE": "text",
"en-US": "text"
},
"tag_colors": [
{
"tag_color": "text"
}
],
"tag_icons": [
{
"fa-icon": "text"
}
]
},
"colorprofiles": {
"profiles": [
{
"profile": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"profilename": "text"
}
]
},
"custom_data_type_updater": {
"active": true
},
"deep_link_access": {
"allow_access_by_column": true,
"allow_access_by_id": true,
"enabled": true,
"iiif_default_links": true,
"iiif_links": [
{
"html_code": "text",
"label": {
"de-DE": "text",
"en-US": "text"
}
}
],
"iiif_required_statement": {
"label": {
"de-DE": "text",
"en-US": "text"
},
"value": {
"de-DE": "text",
"en-US": "text"
}
},
"include_parents": true,
"merge_linked_objects": "all",
"merge_max_depth": 1
},
"detail_deep_link": {
"use_system_object_id": true
},
"email": {
"admin_emails": [
{
"email": "[email protected]"
}
],
"from": "[email protected]",
"signature": {
"de-DE": "text",
"en-US": "text"
}
},
"email_server": {
"cram_md5_auth": {
"password": "text",
"username": "text"
},
"helo_domain": "text",
"insecure_skip_verify": true,
"login_auth": {
"password": "text",
"username": "text"
},
"plain_auth": {
"identity": "text",
"password": "text",
"username": "text"
},
"server_addr": "text",
"type": "off"
},
"export": {
"xslts": [
{
"description": {
"de-DE": "text",
"en-US": "text"
},
"displayname": {
"de-DE": "text",
"en-US": "text"
},
"namespace": "text",
"oai_pmh_prefix": "text",
"schema": "text",
"use_for_api_objects": true,
"use_for_oai_pmh": true,
"xslt": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
}
}
]
},
"export_scheduler": {
"active": true
},
"file_url_expire": {
"deep_link_days": 1,
"default_days": 1,
"max_days": 1,
"oai_pmh_days": 1
},
"janitor": {
"active": true,
"event_remote_addr_expire_days": 1,
"events": {
"expire_days_ADMIN": 1,
"expire_days_DOWNLOAD": 1,
"expire_days_EXPORT": 1,
"expire_days_FRONTEND": 1,
"expire_days_INDEX": 1,
"expire_days_LOGIN_LOGOUT": 1,
"expire_days_PLUGIN": 1,
"expire_days_SYSTEM": 1,
"expire_days_TASK": 1,
"expire_days_UPLOAD": 1
},
"file_expire_days": 1,
"users": {
"archive_nonactive_after_days": 1,
"archive_types": [
"anonymous"
],
"delete_archived_after_days": 1
}
},
"languages": {
"database": [
{
"date_format": "ca",
"displayname": {
"de-DE": "text",
"en-US": "text"
},
"number_format": "ca",
"time_format": "cldr",
"value": "text"
}
],
"frontend": [
"da-DK"
]
},
"ldap": {
"bindpassword": "text",
"bindusername": "text",
"connections": [
{
"tls_ca_cert": "text",
"tls_insecure": true,
"tls_start": true,
"url": "text"
}
],
"debug": true,
"groupbasedn": "text",
"groupfilter": "text",
"groupmapping": [
{
"group": "text"
}
],
"userbasedn": "text",
"userfilter": "text",
"usermapping": [
{
"key": "company",
"value": "text"
}
],
"userupdatecolumn": "email"
},
"license": {
"license": {
"capabilities": {},
"createdAt": "2025-06-26T09:05:00.054Z",
"domains": [
"text"
],
"edition": "text",
"holder": "text",
"issuer": "text",
"key": "text",
"notes": "text",
"plugins": {
"ANY_ADDITIONAL_PROPERTY": null
},
"type": "text",
"valid": {
"from": "2025-06-26T09:05:00.054Z",
"to": "2025-06-26T09:05:00.054Z"
}
}
},
"loca": {
"google_csv": [
{
"gid": 1,
"key": "text"
}
],
"google_overload_csv": true
},
"location_defaults": {
"backups": "backups",
"originals": "backups",
"versions": "backups"
},
"logging": {
"level": "",
"timings": true
},
"login": {
"guest": true,
"info": {
"de-DE": "text",
"en-US": "text"
},
"label": {
"de-DE": "text",
"en-US": "text"
},
"placeholder": {
"de-DE": "text",
"en-US": "text"
}
},
"name": {
"description": {
"de-DE": "text",
"en-US": "text"
},
"internal_name": "text",
"title": {
"de-DE": "text",
"en-US": "text"
}
},
"notification_scheduler": {
"active": true
},
"oai_pmh": {
"admin_email": [
{
"email": "[email protected]"
}
],
"enabled": true,
"include_parents": true,
"merge_linked_objects": "all",
"merge_max_depth": 1,
"namespace_identifier": "text",
"records_limit": 1,
"repository_name": "text",
"tagfilter_sets": [
{
"set_name": "text",
"tagfilter": {
"all": [
3
],
"any": [
3
],
"not": [
3
]
}
}
]
},
"oauth2": {
"clients": [
{
"name": "text",
"redirect_uris": [
{
"url": "text"
}
],
"secret": "text"
}
],
"expirations": {
"access_token": "text",
"refresh_token": "text"
}
},
"objectstore": {
"instance": "text",
"server": "text",
"uid": "text"
},
"openapi_spec_endpoint": {
"active": true
},
"openid": {
"userinfo": [
"address_supplement"
]
},
"password": {
"check": [
{
"regexp": "text"
}
],
"hint": {
"de-DE": "text",
"en-US": "text"
},
"showforgot": true
},
"plugin_scheduler": {
"active": true
},
"produce_config": {
"value": {
"classes": {
"audio": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"aac"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"aac"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"aac"
],
"group": "text",
"name": "text",
"params": {
"format": "aac"
},
"recipename": "text"
}
],
"watermark": true
},
"image": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"ai"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"ai"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"ai"
],
"group": "text",
"name": "text",
"params": {
"background": "",
"clip": true,
"colorprofile": "",
"colorspace": "",
"enlarge": true,
"format": "jpg",
"jpegquality": 1,
"resize_mode": "",
"size": 1,
"size_minimum": 1,
"strip": true
},
"recipename": "text"
}
],
"watermark": true
},
"office": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"csv"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"csv"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"csv"
],
"group": "text",
"name": "text",
"params": {},
"recipename": "text"
}
],
"watermark": true
},
"video": {
"name": "text",
"rightsmanagement": true,
"sourceversion": "text",
"standard": true,
"uploadenabledextensions": [
"3gp"
],
"uploadmaxfilesize": "text",
"versions": [
{
"custommetadata": {
"extensions": [
"3gp"
],
"recipename": "_metadata:ocr"
},
"displayname": {
"de-DE": "Deutscher text",
"en-US": "English text"
},
"extensions": [
"3gp"
],
"group": "text",
"name": "text",
"params": {
"ffmpeg_params": "text",
"height": 1,
"height_minimum": 1,
"timeout": "text"
},
"recipename": "text"
}
],
"watermark": true
}
},
"custommetadata": {
"extensions": [
"3gp"
],
"includeversions": true,
"recipename": "_metadata:ocr"
},
"uploadallowunknown": true,
"uploadmaxfilesize": "text"
}
},
"publish": {
"collectors": [
{
"display_format": "name",
"displayname": {
"de-DE": "text",
"en-US": "text"
},
"internalname": "text",
"logo": {
"_id": 1,
"frontend_prefs": {
"ANY_ADDITIONAL_PROPERTY": null
}
},
"prefix": "text",
"type": "text",
"url": "text"
}
]
},
"purge": {
"allow_purge": true,
"purge_storage": true
},
"readonly": {
"enabled": true
},
"register": {
"enable": true,
"form": {
"address": "hide",
"company": "hide",
"department": "hide",
"displayname": "hide",
"first_name": "hide",
"last_name": "hide",
"phone": "hide",
"use_in_user_manager": true
},
"groups": [
{
"group": 1
}
],
"info": {
"de-DE": "text",
"en-US": "text"
}
},
"saml": {
"cert": "text",
"debug": true,
"groupmapping": [
{
"group": "text"
}
],
"key": "text",
"ldap": {
"bindpassword": "text",
"bindusername": "text",
"connections": [
{
"tls_ca_cert": "text",
"tls_insecure": true,
"tls_start": true,
"url": "text"
}
],
"groupbasedn": "text",
"groupfilter": "text"
},
"loginlink": {
"de-DE": "text",
"en-US": "text"
},
"loginpreferred": true,
"signrequest": "",
"url": "text",
"usermapping": [
{
"key": "company",
"value": "text"
}
],
"userupdatecolumn": "email"
},
"transition_webhook": {
"webhooks": [
{
"include_access_token": true,
"name": "text",
"secret": "text",
"send_authorization_header": true,
"timeout": 1,
"url": "text"
}
]
},
"user": {
"copy_to_event": [
"address_supplement"
],
"default_delete_policy": "archive",
"user_in_event_group": [
"ADMIN"
]
},
"webdav": {
"hotfolder": true,
"hotfolder_wait_sec": 1,
"read_write_access": true
}
}
}
}The list is a dynamic compilation of available config varibles. It includes fixed config variables of FYLR's base config as well as variables provided by plugins.
Responses
200
Success
application/json
200
Success
{
"plugins": null,
"system": {
"defs": [
{
"group": "text",
"name": "text",
"parameters": {
"name": "text",
"position": 1,
"type": "text",
"default": true
},
"require_system_right": "text",
"unauthenticated_visible": true
}
]
}
}Last updated